1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
|
# IGraph R package
# Copyright (C) 2005-2012 Gabor Csardi <csardi.gabor@gmail.com>
# 334 Harvard street, Cambridge, MA 02139 USA
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 USA
#
###################################################################
###################################################################
# Constructors
###################################################################
update_es_ref <- update_vs_ref <- function(graph) {
env <- get_es_ref(graph)
if (!is.null(env)) assign("me", graph, envir = env)
}
get_es_ref <- get_vs_ref <- function(graph) {
if (is_igraph(graph) && !warn_version(graph)) {
.Call(R_igraph_copy_env, graph)
} else {
NULL
}
}
get_es_graph <- get_vs_graph <- function(seq) {
at <- attr(seq, "env")
if (inherits(at, "weakref")) {
weak_ref_key(at)$me
} else if (inherits(at, "environment")) {
get("graph", envir = at)
} else {
NULL
}
}
has_es_graph <- has_vs_graph <- function(seq) {
!is.null(weak_ref_key(attr(seq, "env")))
}
get_es_graph_id <- get_vs_graph_id <- function(seq) {
new_g <- attr(seq, "graph")
if (!is.null(new_g)) {
new_g
} else if (!is.null(attr(seq, "env"))) {
get("graph", envir = attr(seq, "env"))
} else {
NULL
}
}
#' Decide if two graphs are identical
#'
#' Two graphs are considered identical by this function if and only if
#' they are represented in exactly the same way in the internal R
#' representation. This means that the two graphs must have the same
#' list of vertices and edges, in exactly the same order, with same
#' directedness, and the two graphs must also have identical graph, vertex and
#' edge attributes.
#'
#' This is similar to `identical` in the `base` package,
#' but it ignores the mutable piece of igraph objects; those might be
#' different even if the two graphs are identical.
#'
#' Attribute comparison can be turned off with the `attrs` parameter if
#' the attributes of the two graphs are allowed to be different.
#'
#' @param g1,g2 The two graphs
#' @param attrs Whether to compare the attributes of the graphs
#' @return Logical scalar
#' @export
identical_graphs <- function(g1, g2, attrs = TRUE) {
stopifnot(is_igraph(g1), is_igraph(g2))
.Call(R_igraph_identical_graphs, g1, g2, as.logical(attrs))
}
add_vses_graph_ref <- function(vses, graph) {
ref <- get_vs_ref(graph)
if (!is.null(ref)) {
attr(vses, "env") <- make_weak_ref(ref, NULL)
attr(vses, "graph") <- get_graph_id(graph)
} else {
ne <- new.env()
assign("graph", graph, envir = ne)
attr(vses, "env") <- ne
}
vses
}
#' Get the id of a graph
#'
#' Graph ids are used to check that a vertex or edge sequence
#' belongs to a graph. If you create a new graph by changing the
#' structure of a graph, the new graph will have a new id.
#' Changing the attributes will not change the id.
#'
#' @param x A graph or a vertex sequence or an edge sequence.
#' @param ... Not used currently.
#' @return The id of the graph, a character scalar. For
#' vertex and edge sequences the id of the graph they were created from.
#'
#' @export
#' @examples
#' g <- make_ring(10)
#' graph_id(g)
#' graph_id(V(g))
#' graph_id(E(g))
#'
#' g2 <- g + 1
#' graph_id(g2)
graph_id <- function(x, ...) {
UseMethod("graph_id")
}
#' @method graph_id igraph
#' @export
graph_id.igraph <- function(x, ...) {
get_graph_id(x)
}
#' @method graph_id igraph.vs
#' @export
graph_id.igraph.vs <- function(x, ...) {
get_vs_graph_id(x) %||% NA_character_
}
#' @method graph_id igraph.es
#' @export
graph_id.igraph.es <- function(x, ...) {
get_es_graph_id(x) %||% NA_character_
}
is_complete_iterator <- function(x) {
identical(attr(x, "is_all"), TRUE)
}
set_complete_iterator <- function(x, value = TRUE) {
attr(x, "is_all") <- TRUE
x
}
inside_square_error <- function(fn_name, call = rlang::caller_env()) {
cli::cli_abort(c(
"{.fun {fn_name}} must only be used inside index or vertex sequences like {.code E(g)[]} or {.code V(g)[]}.",
i = "See {.help [{.fun [.igraph.es}](igraph::`[.igraph.es`)} or {.help [{.fun [.igraph.vs}](igraph::`[.igraph.vs`)}."
), call = call)
}
#' Helpers within vertex/index sequences
#'
#' Functions to be used only with `[.igraph.es` and `[.igraph.vs`
#'
#' @details
#'
#' See \code{\link[igraph]{[.igraph.vs}} and \code{\link[igraph]{[.igraph.es}}.
#'
#'
#' @keywords internal
#' @rdname inside-square-error
#' @param ... Not used, here for compatibility.
#' @return An error
#' @export
#'
.nei <- function(...) inside_square_error(".nei")
#' @rdname inside-square-error
#' @export
.innei <- function(...) inside_square_error(".innei")
#' @rdname inside-square-error
#' @export
.outnei <- function(...) inside_square_error(".outnei")
#' @rdname inside-square-error
#' @export
.inc <- function(...) inside_square_error(".inc")
#' @rdname inside-square-error
#' @export
.from <- function(...) inside_square_error(".from")
#' @rdname inside-square-error
#' @export
.to <- function(...) inside_square_error(".to")
#' Vertices of a graph
#'
#' Create a vertex sequence (vs) containing all vertices of a graph.
#'
#' @details
#' A vertex sequence is just what the name says it is: a sequence of
#' vertices. Vertex sequences are usually used as igraph function arguments
#' that refer to vertices of a graph.
#'
#' A vertex sequence is tied to the graph it refers to: it really denoted
#' the specific vertices of that graph, and cannot be used together with
#' another graph.
#'
#' At the implementation level, a vertex sequence is simply a vector
#' containing numeric vertex ids, but it has a special class attribute
#' which makes it possible to perform graph specific operations on it, like
#' selecting a subset of the vertices based on graph structure, or vertex
#' attributes.
#'
#' A vertex sequence is most often created by the `V()` function. The
#' result of this includes all vertices in increasing vertex id order. A
#' vertex sequence can be indexed by a numeric vector, just like a regular
#' R vector. See \code{\link{[.igraph.vs}} and additional links to other
#' vertex sequence operations below.
#'
#' @section Indexing vertex sequences:
#' Vertex sequences mostly behave like regular vectors, but there are some
#' additional indexing operations that are specific for them;
#' e.g. selecting vertices based on graph structure, or based on vertex
#' attributes. See \code{\link{[.igraph.vs}} for details.
#'
#' @section Querying or setting attributes:
#' Vertex sequences can be used to query or set attributes for the
#' vertices in the sequence. See [$.igraph.vs()] for details.
#'
#' @param graph The graph
#' @return A vertex sequence containing all vertices, in the order
#' of their numeric vertex ids.
#'
#' @family vertex and edge sequences
#' @export
#' @examples
#' # Vertex ids of an unnamed graph
#' g <- make_ring(10)
#' V(g)
#'
#' # Vertex ids of a named graph
#' g2 <- make_ring(10) %>%
#' set_vertex_attr("name", value = letters[1:10])
#' V(g2)
V <- function(graph) {
ensure_igraph(graph)
update_vs_ref(graph)
res <- seq_len(vcount(graph))
if (is_named(graph)) names(res) <- vertex_attr(graph)$name
class(res) <- "igraph.vs"
res <- set_complete_iterator(res)
add_vses_graph_ref(res, graph)
}
create_vs <- function(graph, idx, na_ok = FALSE) {
if (na_ok) idx <- ifelse(idx < 1 | idx > gorder(graph), NA, idx)
res <- simple_vs_index(V(graph), idx, na_ok = na_ok)
add_vses_graph_ref(res, graph)
}
# Internal function to quickly convert integer vectors to igraph.vs
# for use after C code, when NA and bounds checking is unnecessary.
# Also allows us to construct V(graph) outside the function call in
# lapply() so it's created only once.
unsafe_create_vs <- function(graph, idx, verts = NULL) {
if (is.null(verts)) {
verts <- V(graph)
}
res <- simple_vs_index(verts, idx, na_ok = TRUE)
add_vses_graph_ref(res, graph)
}
# Internal function to quickly convert integer vectors to igraph.es
# for use after C code, when NA and bounds checking is unnecessary
# Also allows us to construct V(graph) outside the function call in
# lapply() so it's created only once.
unsafe_create_es <- function(graph, idx, es = NULL) {
if (is.null(es)) {
es <- E(graph)
}
res <- simple_es_index(es, idx, na_ok = TRUE)
add_vses_graph_ref(res, graph)
}
#' Edges of a graph
#'
#' An edge sequence is a vector containing numeric edge ids, with a special
#' class attribute that allows custom operations: selecting subsets of
#' edges based on attributes, or graph structure, creating the
#' intersection, union of edges, etc.
#'
#' @details
#' Edge sequences are usually used as igraph function arguments that
#' refer to edges of a graph.
#'
#' An edge sequence is tied to the graph it refers to: it really denoted
#' the specific edges of that graph, and cannot be used together with
#' another graph.
#'
#' An edge sequence is most often created by the `E()` function. The
#' result includes edges in increasing edge id order by default (if. none
#' of the `P` and `path` arguments are used). An edge
#' sequence can be indexed by a numeric vector, just like a regular R
#' vector. See links to other edge sequence operations below.
#'
#' @section Indexing edge sequences:
#' Edge sequences mostly behave like regular vectors, but there are some
#' additional indexing operations that are specific for them;
#' e.g. selecting edges based on graph structure, or based on edge
#' attributes. See \code{\link{[.igraph.es}} for details.
#'
#' @section Querying or setting attributes:
#' Edge sequences can be used to query or set attributes for the
#' edges in the sequence. See [$.igraph.es()] for details.
#'
#' @param graph The graph.
#' @param P A list of vertices to select edges via pairs of vertices.
#' The first and second vertices select the first edge, the third
#' and fourth the second, etc.
#' @param path A list of vertices, to select edges along a path.
#' Note that this only works reliable for simple graphs. If the graph
#' has multiple edges, one of them will be chosen arbitrarily to
#' be included in the edge sequence.
#' @param directed Whether to consider edge directions in the `P`
#' argument, for directed graphs.
#' @return An edge sequence of the graph.
#'
#' @export
#' @family vertex and edge sequences
#' @examples
#' # Edges of an unnamed graph
#' g <- make_ring(10)
#' E(g)
#'
#' # Edges of a named graph
#' g2 <- make_ring(10) %>%
#' set_vertex_attr("name", value = letters[1:10])
#' E(g2)
E <- function(graph, P = NULL, path = NULL, directed = TRUE) {
ensure_igraph(graph)
update_es_ref(graph)
if (!is.null(P) && !is.null(path)) {
stop("Cannot give both `P' and `path' at the same time")
}
if (is.null(P) && is.null(path)) {
ec <- ecount(graph)
res <- seq_len(ec)
res <- set_complete_iterator(res)
} else if (!is.null(P)) {
on.exit(.Call(R_igraph_finalizer))
res <- .Call(
R_igraph_es_pairs, graph, as_igraph_vs(graph, P) - 1,
as.logical(directed)
) + 1
} else {
on.exit(.Call(R_igraph_finalizer))
res <- .Call(
R_igraph_es_path, graph, as_igraph_vs(graph, path) - 1,
as.logical(directed)
) + 1
}
if ("name" %in% edge_attr_names(graph)) {
names(res) <- edge_attr(graph)$name[res]
}
if (is_named(graph)) {
el <- ends(graph, es = res)
attr(res, "vnames") <- paste(el[, 1], el[, 2], sep = "|")
}
class(res) <- "igraph.es"
add_vses_graph_ref(res, graph)
}
create_es <- function(graph, idx, na_ok = FALSE) {
if (na_ok) idx <- ifelse(idx < 1 | idx > gsize(graph), NA, idx)
simple_es_index(E(graph), idx)
}
simple_vs_index <- function(x, i, na_ok = FALSE) {
res <- unclass(x)[i]
if (!na_ok && any(is.na(res))) stop("Unknown vertex selected")
class(res) <- "igraph.vs"
res
}
#' Indexing vertex sequences
#'
#' Vertex sequences can be indexed very much like a plain numeric R vector,
#' with some extras.
#'
#' @details
#' Vertex sequences can be indexed using both the single bracket and
#' the double bracket operators, and they both work the same way.
#' The only difference between them is that the double bracket operator
#' marks the result for printing vertex attributes.
#'
#' @section Multiple indices:
#' When using multiple indices within the bracket, all of them
#' are evaluated independently, and then the results are concatenated
#' using the `c()` function (except for the `na_ok` argument,
#' which is special an must be named. E.g. `V(g)[1, 2, .nei(1)]`
#' is equivalent to `c(V(g)[1], V(g)[2], V(g)[.nei(1)])`.
#'
#' @section Index types:
#' Vertex sequences can be indexed with positive numeric vectors,
#' negative numeric vectors, logical vectors, character vectors:
#' \itemize{
#' \item When indexed with positive numeric vectors, the vertices at the
#' given positions in the sequence are selected. This is the same as
#' indexing a regular R atomic vector with positive numeric vectors.
#' \item When indexed with negative numeric vectors, the vertices at the
#' given positions in the sequence are omitted. Again, this is the same
#' as indexing a regular R atomic vector.
#' \item When indexed with a logical vector, the lengths of the vertex
#' sequence and the index must match, and the vertices for which the
#' index is `TRUE` are selected.
#' \item Named graphs can be indexed with character vectors,
#' to select vertices with the given names.
#' }
#'
#' @section Vertex attributes:
#' When indexing vertex sequences, vertex attributes can be referred
#' to simply by using their names. E.g. if a graph has a `name` vertex
#' attribute, then `V(g)[name == "foo"]` is equivalent to
#' `V(g)[V(g)$name == "foo"]`. See more examples below. Note that attribute
#' names mask the names of variables present in the calling environment; if
#' you need to look up a variable and you do not want a similarly named
#' vertex attribute to mask it, use the `.env` pronoun to perform the
#' name lookup in the calling environment. In other words, use
#' `V(g)[.env$name == "foo"]` to make sure that `name` is looked up
#' from the calling environment even if there is a vertex attribute with the
#' same name. Similarly, you can use `.data` to match attribute names only.
#'
#' @section Special functions:
#' There are some special igraph functions that can be used only
#' in expressions indexing vertex sequences: \describe{
#' \item{`.nei`}{takes a vertex sequence as its argument
#' and selects neighbors of these vertices. An optional `mode`
#' argument can be used to select successors (`mode="out"`), or
#' predecessors (`mode="in"`) in directed graphs.}
#' \item{`.inc`}{Takes an edge sequence as an argument, and
#' selects vertices that have at least one incident edge in this
#' edge sequence.}
#' \item{`.from`}{Similar to `.inc`, but only considers the
#' tails of the edges.}
#' \item{`.to`}{Similar to `.inc`, but only considers the
#' heads of the edges.}
#' \item{`.innei`, `.outnei`}{`.innei(v)` is a shorthand for
#' `.nei(v, mode = "in")`, and `.outnei(v)` is a shorthand for
#' `.nei(v, mode = "out")`.
#' }
#' }
#' Note that multiple special functions can be used together, or with
#' regular indices, and then their results are concatenated. See more
#' examples below.
#'
#' @param x A vertex sequence.
#' @param ... Indices, see details below.
#' @param na_ok Whether it is OK to have `NA`s in the vertex
#' sequence.
#' @return Another vertex sequence, referring to the same graph.
#'
#' @method [ igraph.vs
#' @name igraph-vs-indexing
#' @export
#' @family vertex and edge sequences
#' @family vertex and edge sequence operations
#'
#' @examples
#' # -----------------------------------------------------------------
#' # Setting attributes for subsets of vertices
#' largest_comp <- function(graph) {
#' cl <- components(graph)
#' V(graph)[which.max(cl$csize) == cl$membership]
#' }
#' g <- sample_(
#' gnp(100, 2 / 100),
#' with_vertex_(size = 3, label = ""),
#' with_graph_(layout = layout_with_fr)
#' )
#' giant_v <- largest_comp(g)
#' V(g)$color <- "green"
#' V(g)[giant_v]$color <- "red"
#' plot(g)
#'
#' # -----------------------------------------------------------------
#' # nei() special function
#' g <- make_graph(c(1, 2, 2, 3, 2, 4, 4, 2))
#' V(g)[.nei(c(2, 4))]
#' V(g)[.nei(c(2, 4), "in")]
#' V(g)[.nei(c(2, 4), "out")]
#'
#' # -----------------------------------------------------------------
#' # The same with vertex names
#' g <- make_graph(~ A -+ B, B -+ C:D, D -+ B)
#' V(g)[.nei(c("B", "D"))]
#' V(g)[.nei(c("B", "D"), "in")]
#' V(g)[.nei(c("B", "D"), "out")]
#'
#' # -----------------------------------------------------------------
#' # Resolving attributes
#' g <- make_graph(~ A -+ B, B -+ C:D, D -+ B)
#' V(g)$color <- c("red", "red", "green", "green")
#' V(g)[color == "red"]
#'
#' # Indexing with a variable whose name matches the name of an attribute
#' # may fail; use .env to force the name lookup in the parent environment
#' V(g)$x <- 10:13
#' x <- 2
#' V(g)[.env$x]
#'
`[.igraph.vs` <- function(x, ..., na_ok = FALSE) {
args <- rlang::enquos(..., .ignore_empty = "all")
## If indexing has no argument at all, then we still get one,
## but it is "empty", a name that is ""
## Special case, no argument (but we might get an artificial
## empty one
if (length(args) < 1 ||
(length(args) == 1 && inherits(rlang::quo_get_expr(args[[1]]), "name") &&
!nzchar(as.character(rlang::quo_get_expr(args[[1]]))))) {
return(x)
}
## Special case: single numeric argument
first_arg_is_numericish <- inherits(rlang::quo_get_expr(args[[1]]), "numeric") ||
inherits(rlang::quo_get_expr(args[[1]]), "integer")
if (length(args) == 1 && first_arg_is_numericish) {
res <- simple_vs_index(x, rlang::quo_get_expr(args[[1]]), na_ok)
return(add_vses_graph_ref(res, get_vs_graph(x)))
}
## Special case: single symbol argument, no such attribute
if (length(args) == 1 && inherits(rlang::quo_get_expr(args[[1]]), "name")) {
graph <- get_vs_graph(x)
if (!(as.character(rlang::quo_get_expr(args[[1]])) %in% vertex_attr_names(graph))) {
res <- simple_vs_index(x, rlang::eval_tidy(args[[1]]), na_ok)
return(add_vses_graph_ref(res, graph))
}
}
.nei <- function(v, mode = c("all", "in", "out", "total")) {
## TRUE iff the vertex is a neighbor (any type)
## of at least one vertex in v
mode <- igraph.match.arg(mode)
mode <- switch(mode,
"out" = 1,
"in" = 2,
"all" = 3,
"total" = 3
)
if (is.logical(v)) {
v <- which(v)
}
on.exit(.Call(R_igraph_finalizer))
tmp <- .Call(
R_igraph_vs_nei, graph, x, as_igraph_vs(graph, v) - 1,
as.numeric(mode)
)
tmp[as.numeric(x)]
}
nei <- function(...) {
lifecycle::deprecate_stop("2.1.0", "nei()", ".nei()")
}
.innei <- function(v, mode = c("in", "all", "out", "total")) {
.nei(v, mode = mode[1])
}
innei <- function(...) {
lifecycle::deprecate_stop("2.1.0", "innei()", ".innei()")
}
.outnei <- function(v, mode = c("out", "all", "in", "total")) {
.nei(v, mode = mode[1])
}
outnei <- function(...) {
lifecycle::deprecate_stop("2.1.0", "outnei()", ".outnei()")
}
.inc <- function(e) {
## TRUE iff the vertex (in the vs) is incident
## to at least one edge in e
if (is.logical(e)) {
e <- which(e)
}
on.exit(.Call(R_igraph_finalizer))
tmp <- .Call(
R_igraph_vs_adj, graph, x, as_igraph_es(graph, e) - 1,
as.numeric(3)
)
tmp[as.numeric(x)]
}
inc <- function(...) {
lifecycle::deprecate_stop("2.1.0", "inc()", ".inc()")
}
adj <- function(...) {
lifecycle::deprecate_stop("2.1.0", "adj()", ".inc()")
}
.from <- function(e) {
## TRUE iff the vertex is the source of at least one edge in e
if (is.logical(e)) {
e <- which(e)
}
on.exit(.Call(R_igraph_finalizer))
tmp <- .Call(
R_igraph_vs_adj, graph, x, as_igraph_es(graph, e) - 1,
as.numeric(1)
)
tmp[as.numeric(x)]
}
from <- function(...) {
lifecycle::deprecate_stop("2.1.0", "from()", ".from()")
}
.to <- function(e) {
## TRUE iff the vertex is the target of at least one edge in e
if (is.logical(e)) {
e <- which(e)
}
on.exit(.Call(R_igraph_finalizer))
tmp <- .Call(
R_igraph_vs_adj, graph, x, as_igraph_es(graph, e) - 1,
as.numeric(2)
)
tmp[as.numeric(x)]
}
to <- function(...) {
lifecycle::deprecate_stop("2.1.0", "to()", ".to()")
}
graph <- get_vs_graph(x)
if (is.null(graph)) {
res <- lapply(
lapply(args, rlang::eval_tidy),
simple_vs_index,
x = x,
na_ok = na_ok
)
} else {
attrs <- vertex_attr(graph)
xvec <- as.vector(x)
for (i in seq_along(attrs)) attrs[[i]] <- attrs[[i]][xvec]
env <- parent.frame()
# Functions (only visible if called or if no duplicate)
top <- rlang::new_environment(list(
.nei = .nei, nei = nei,
.innei = .innei, innei = innei,
.outnei = .outnei, outnei = outnei,
.inc = .inc, inc = inc, adj = adj,
.from = .from, from = from,
.to = .to, to = to,
.data = list(attrs)
))
# Data objects (visible by default)
bottom <- rlang::new_environment(parent = top, c(
attrs,
.env = env,
.data = list(attrs)
))
data_mask <- rlang::new_data_mask(bottom, top)
res <- lapply(args, rlang::eval_tidy, data = data_mask)
res <- lapply(res, function(ii) {
if (is.null(ii)) {
return(NULL)
}
ii <- simple_vs_index(x, ii, na_ok)
attr(ii, "env") <- attr(x, "env")
attr(ii, "graph") <- attr(x, "graph")
class(ii) <- class(x)
ii
})
}
res <- drop_null(res)
if (length(res)) {
do_call(c, res)
} else {
x[FALSE]
}
}
is_single_index <- function(x) {
isTRUE(attr(x, "single"))
}
set_single_index <- function(x, value = TRUE) {
attr(x, "single") <- value
x
}
#' Select vertices and show their metadata
#'
#' The double bracket operator can be used on vertex sequences, to print
#' the meta-data (vertex attributes) of the vertices in the sequence.
#'
#' @details
#' Technically, when used with vertex sequences, the double bracket
#' operator does exactly the same as the single bracket operator,
#' but the resulting vertex sequence is printed differently: all
#' attributes of the vertices in the sequence are printed as well.
#'
#' See \code{\link{[.igraph.vs}} for more about indexing vertex sequences.
#'
#' @param x A vertex sequence.
#' @param ... Additional arguments, passed to `[`.
#' @return The double bracket operator returns another vertex sequence,
#' with meta-data (attribute) printing turned on. See details below.
#'
#' @method [[ igraph.vs
#' @name igraph-vs-indexing2
#' @family vertex and edge sequences
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_ring(10) %>%
#' set_vertex_attr("color", value = "red") %>%
#' set_vertex_attr("name", value = LETTERS[1:10])
#' V(g)
#' V(g)[[]]
#' V(g)[1:5]
#' V(g)[[1:5]]
`[[.igraph.vs` <- function(x, ...) {
res <- x[...]
set_single_index(res)
}
#' Select edges and show their metadata
#'
#' The double bracket operator can be used on edge sequences, to print
#' the meta-data (edge attributes) of the edges in the sequence.
#'
#' @details
#' Technically, when used with edge sequences, the double bracket
#' operator does exactly the same as the single bracket operator,
#' but the resulting edge sequence is printed differently: all
#' attributes of the edges in the sequence are printed as well.
#'
#' See \code{\link{[.igraph.es}} for more about indexing edge sequences.
#'
#' @param x An edge sequence.
#' @param ... Additional arguments, passed to `[`.
#' @return Another edge sequence, with metadata printing turned on.
#' See details below.
#'
#' @method [[ igraph.es
#' @name igraph-es-indexing2
#' @family vertex and edge sequences
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_(
#' ring(10),
#' with_vertex_(name = LETTERS[1:10]),
#' with_edge_(weight = 1:10, color = "green")
#' )
#' E(g)
#' E(g)[[]]
#' E(g)[[.inc("A")]]
`[[.igraph.es` <- function(x, ...) {
res <- x[...]
set_single_index(res)
}
simple_es_index <- function(x, i, na_ok = FALSE) {
if (!is.null(attr(x, "vnames"))) {
wh1 <- structure(seq_along(x), names = names(x))[i]
wh2 <- structure(seq_along(x), names = attr(x, "vnames"))[i]
wh <- ifelse(is.na(wh1), wh2, wh1)
res <- unclass(x)[wh]
names(res) <- names(x)[wh]
attr(res, "vnames") <- attr(x, "vnames")[wh]
} else {
res <- unclass(x)[i]
}
if (!na_ok && any(is.na(res))) stop("Unknown edge selected")
attr(res, "env") <- attr(x, "env")
attr(res, "graph") <- attr(x, "graph")
class(res) <- "igraph.es"
res
}
#' Indexing edge sequences
#'
#' Edge sequences can be indexed very much like a plain numeric R vector,
#' with some extras.
#'
#' @section Multiple indices:
#' When using multiple indices within the bracket, all of them
#' are evaluated independently, and then the results are concatenated
#' using the `c()` function. E.g. `E(g)[1, 2, .inc(1)]`
#' is equivalent to `c(E(g)[1], E(g)[2], E(g)[.inc(1)])`.
#'
#' @section Index types:
#' Edge sequences can be indexed with positive numeric vectors,
#' negative numeric vectors, logical vectors, character vectors:
#' \itemize{
#' \item When indexed with positive numeric vectors, the edges at the
#' given positions in the sequence are selected. This is the same as
#' indexing a regular R atomic vector with positive numeric vectors.
#' \item When indexed with negative numeric vectors, the edges at the
#' given positions in the sequence are omitted. Again, this is the same
#' as indexing a regular R atomic vector.
#' \item When indexed with a logical vector, the lengths of the edge
#' sequence and the index must match, and the edges for which the
#' index is `TRUE` are selected.
#' \item Named graphs can be indexed with character vectors,
#' to select edges with the given names. Note that a graph may
#' have edge names and vertex names, and both can be used to select
#' edges. Edge names are simply used as names of the numeric
#' edge id vector. Vertex names effectively only work in graphs without
#' multiple edges, and must be separated with a `|` bar character
#' to select an edges that incident to the two given vertices. See
#' examples below.
#' }
#'
#' @section Edge attributes:
#' When indexing edge sequences, edge attributes can be referred
#' to simply by using their names. E.g. if a graph has a `weight` edge
#' attribute, then `E(G)[weight > 1]` selects all edges with a weight
#' larger than one. See more examples below. Note that attribute names mask the
#' names of variables present in the calling environment; if you need to look up
#' a variable and you do not want a similarly named edge attribute to mask it,
#' use the `.env` pronoun to perform the name lookup in the calling
#' environment. In other words, use `E(g)[.env$weight > 1]` to make sure
#' that `weight` is looked up from the calling environment even if there is
#' an edge attribute with the same name. Similarly, you can use `.data` to
#' match attribute names only.
#'
#' @section Special functions:
#' There are some special igraph functions that can be used
#' only in expressions indexing edge sequences: \describe{
#' \item{`.inc`}{takes a vertex sequence, and selects
#' all edges that have at least one incident vertex in the vertex
#' sequence.}
#' \item{`.from`}{similar to `.inc()`, but only
#' the tails of the edges are considered.}
#' \item{`.to`}{is similar to `.inc()`, but only
#' the heads of the edges are considered.}
#' \item{`\%--\%`}{a special operator that can be
#' used to select all edges between two sets of vertices. It ignores
#' the edge directions in directed graphs.}
#' \item{`\%->\%`}{similar to `\%--\%`,
#' but edges *from* the left hand side argument, pointing
#' *to* the right hand side argument, are selected, in directed
#' graphs.}
#' \item{`\%<-\%`}{similar to `\%--\%`,
#' but edges *to* the left hand side argument, pointing
#' *from* the right hand side argument, are selected, in directed
#' graphs.}
#' }
#' Note that multiple special functions can be used together, or with
#' regular indices, and then their results are concatenated. See more
#' examples below.
#'
#' @aliases %--% %<-% %->%
#' @param x An edge sequence
#' @param ... Indices, see details below.
#' @return Another edge sequence, referring to the same graph.
#'
#' @method [ igraph.es
#' @name igraph-es-indexing
#'
#' @export
#' @family vertex and edge sequences
#' @family vertex and edge sequence operations
#' @examples
#' # -----------------------------------------------------------------
#' # Special operators for indexing based on graph structure
#' g <- sample_pa(100, power = 0.3)
#' E(g)[1:3 %--% 2:6]
#' E(g)[1:5 %->% 1:6]
#' E(g)[1:3 %<-% 2:6]
#'
#' # -----------------------------------------------------------------
#' # The edges along the diameter
#' g <- sample_pa(100, directed = FALSE)
#' d <- get_diameter(g)
#' E(g, path = d)
#'
#' # -----------------------------------------------------------------
#' # Select edges based on attributes
#' g <- sample_gnp(20, 3 / 20) %>%
#' set_edge_attr("weight", value = rnorm(gsize(.)))
#' E(g)[[weight < 0]]
#'
#' # Indexing with a variable whose name matches the name of an attribute
#' # may fail; use .env to force the name lookup in the parent environment
#' E(g)$x <- E(g)$weight
#' x <- 2
#' E(g)[.env$x]
#'
`[.igraph.es` <- function(x, ...) {
args <- rlang::enquos(..., .ignore_empty = "all")
## If indexing has no argument at all, then we still get one,
## but it is "empty", a name that is ""
if (length(args) < 1 ||
(length(args) == 1 && inherits(rlang::quo_get_expr(args[[1]]), "name") &&
!nzchar(as.character(rlang::quo_get_expr(args[[1]]))))) {
return(x)
}
.inc <- function(v) {
## TRUE iff the edge is incident to at least one vertex in v
on.exit(.Call(R_igraph_finalizer))
tmp <- .Call(
R_igraph_es_adj, graph, x, as_igraph_vs(graph, v) - 1,
as.numeric(3)
)
tmp[as.numeric(x)]
}
adj <- function(...) {
lifecycle::deprecate_stop("2.1.0", "adj()", ".inc()")
}
inc <- function(...) {
lifecycle::deprecate_stop("2.1.0", "inc()", ".inc()")
}
.from <- function(v) {
## TRUE iff the edge originates from at least one vertex in v
on.exit(.Call(R_igraph_finalizer))
tmp <- .Call(
R_igraph_es_adj, graph, x, as_igraph_vs(graph, v) - 1,
as.numeric(1)
)
tmp[as.numeric(x)]
}
from <- function(...) {
lifecycle::deprecate_stop("2.1.0", "from()", ".from()")
}
.to <- function(v) {
## TRUE iff the edge points to at least one vertex in v
on.exit(.Call(R_igraph_finalizer))
tmp <- .Call(
R_igraph_es_adj, graph, x, as_igraph_vs(graph, v) - 1,
as.numeric(2)
)
tmp[as.numeric(x)]
}
to <- function(...) {
lifecycle::deprecate_stop("2.1.0", "to()", ".to()")
}
graph <- get_es_graph(x)
if (is.null(graph)) {
res <- lapply(lapply(args, rlang::eval_tidy), simple_es_index, x = x)
} else {
attrs <- edge_attr(graph)
xvec <- as.vector(x)
for (i in seq_along(attrs)) attrs[[i]] <- attrs[[i]][xvec]
env <- parent.frame()
# Functions (only visible if called or if no duplicate)
top <- rlang::new_environment(list(
.inc = .inc, inc = inc, adj = adj,
.from = .from, from = from,
.to = .to, to = to,
`%--%` = `%--%`, `%->%` = `%->%`, `%<-%` = `%<-%`
))
# Data objects (visible by default)
bottom <- rlang::new_environment(parent = top, c(
attrs,
.igraph.from = list(.Call(R_igraph_copy_from, graph)[as.numeric(x)]),
.igraph.to = list(.Call(R_igraph_copy_to, graph)[as.numeric(x)]),
.igraph.graph = list(graph),
.env = env,
.data = list(attrs)
))
data_mask <- rlang::new_data_mask(bottom, top)
res <- lapply(args, rlang::eval_tidy, data = data_mask)
res <- lapply(res, function(ii) {
if (is.null(ii)) {
return(NULL)
}
ii <- simple_es_index(x, ii)
attr(ii, "env") <- attr(x, "env")
attr(ii, "graph") <- attr(x, "graph")
class(ii) <- class(x)
ii
})
}
res <- drop_null(res)
if (length(res) == 1) {
res[[1]]
} else if (length(res)) {
do_call(c, res)
} else {
x[FALSE]
}
}
#' @export
`%--%` <- function(f, t) {
from <- get(".igraph.from", parent.frame())
to <- get(".igraph.to", parent.frame())
graph <- get(".igraph.graph", parent.frame())
f <- as_igraph_vs(graph, f) - 1
t <- as_igraph_vs(graph, t) - 1
(from %in% f & to %in% t) | (to %in% f & from %in% t)
}
#' @export
`%->%` <- function(f, t) {
from <- get(".igraph.from", parent.frame())
to <- get(".igraph.to", parent.frame())
graph <- get(".igraph.graph", parent.frame())
f <- as_igraph_vs(graph, f) - 1
t <- as_igraph_vs(graph, t) - 1
if (is_directed(graph)) {
from %in% f & to %in% t
} else {
(from %in% f & to %in% t) | (to %in% f & from %in% t)
}
}
#' @export
`%<-%` <- function(t, value) {
from <- get(".igraph.from", parent.frame())
to <- get(".igraph.to", parent.frame())
graph <- get(".igraph.graph", parent.frame())
value <- as_igraph_vs(graph, value) - 1
t <- as_igraph_vs(graph, t) - 1
if (is_directed(graph)) {
from %in% value & to %in% t
} else {
(from %in% value & to %in% t) | (to %in% value & from %in% t)
}
}
#' @param i Index.
#' @method [[<- igraph.vs
#' @name igraph-vs-attributes
#' @export
`[[<-.igraph.vs` <- function(x, i, value) {
if (!"name" %in% names(attributes(value)) ||
!"value" %in% names(attributes(value))) {
stop("invalid indexing")
}
if (is.null(get_vs_graph(x))) stop("Graph is unknown")
value
}
#' @method [<- igraph.vs
#' @name igraph-vs-attributes
#' @export
`[<-.igraph.vs` <- `[[<-.igraph.vs`
#' @param i Index.
#' @method [[<- igraph.es
#' @name igraph-es-attributes
#' @export
`[[<-.igraph.es` <- function(x, i, value) {
if (!"name" %in% names(attributes(value)) ||
!"value" %in% names(attributes(value))) {
stop("invalid indexing")
}
if (is.null(get_es_graph(x))) stop("Graph is unknown")
value
}
#' @method [<- igraph.es
#' @name igraph-es-attributes
#' @export
`[<-.igraph.es` <- `[[<-.igraph.es`
#' Query or set attributes of the vertices in a vertex sequence
#'
#' The `$` operator is a syntactic sugar to query and set the
#' attributes of the vertices in a vertex sequence.
#'
#' @details
#' The query form of `$` is a shortcut for
#' [vertex_attr()], e.g. `V(g)[idx]$attr` is equivalent
#' to `vertex_attr(g, attr, V(g)[idx])`.
#'
#' The assignment form of `$` is a shortcut for
#' [set_vertex_attr()], e.g. `V(g)[idx]$attr <- value` is
#' equivalent to `g <- set_vertex_attr(g, attr, V(g)[idx], value)`.
#'
#' @param x A vertex sequence. For `V<-` it is a graph.
#' @param name Name of the vertex attribute to query or set.
#' @return A vector or list, containing the values of
#' attribute `name` for the vertices in the vertex sequence.
#' For numeric, character or logical attributes, it is a vector of the
#' appropriate type, otherwise it is a list.
#'
#' @method $ igraph.vs
#' @name igraph-vs-attributes
#'
#' @export
#' @family vertex and edge sequences
#' @family attributes
#' @examples
#' g <- make_(
#' ring(10),
#' with_vertex_(
#' name = LETTERS[1:10],
#' color = sample(1:2, 10, replace = TRUE)
#' )
#' )
#' V(g)$name
#' V(g)$color
#' V(g)$frame.color <- V(g)$color
#'
#' # color vertices of the largest component
#' largest_comp <- function(graph) {
#' cl <- components(graph)
#' V(graph)[which.max(cl$csize) == cl$membership]
#' }
#' g <- sample_(
#' gnp(100, 2 / 100),
#' with_vertex_(size = 3, label = ""),
#' with_graph_(layout = layout_with_fr)
#' )
#' giant_v <- largest_comp(g)
#' V(g)$color <- "blue"
#' V(g)[giant_v]$color <- "orange"
#' plot(g)
`$.igraph.vs` <- function(x, name) {
graph <- get_vs_graph(x)
if (is.null(graph)) stop("Graph is unknown")
res <- vertex_attr(graph, name, x)
if (is_single_index(x)) {
res[[1]]
} else {
res
}
}
#' Query or set attributes of the edges in an edge sequence
#'
#' The `$` operator is a syntactic sugar to query and set
#' edge attributes, for edges in an edge sequence.
#'
#' @details
#' The query form of `$` is a shortcut for [edge_attr()],
#' e.g. `E(g)[idx]$attr` is equivalent to `edge_attr(g, attr,
#' E(g)[idx])`.
#'
#' The assignment form of `$` is a shortcut for
#' [set_edge_attr()], e.g. `E(g)[idx]$attr <- value` is
#' equivalent to `g <- set_edge_attr(g, attr, E(g)[idx], value)`.
#'
#' @param x An edge sequence. For `E<-` it is a graph.
#' @param name Name of the edge attribute to query or set.
#' @return A vector or list, containing the values of the attribute
#' `name` for the edges in the sequence. For numeric, character or
#' logical attributes, it is a vector of the appropriate type, otherwise
#' it is a list.
#'
#' @method $ igraph.es
#' @name igraph-es-attributes
#'
#' @export
#' @examples
#' # color edges of the largest component
#' largest_comp <- function(graph) {
#' cl <- components(graph)
#' V(graph)[which.max(cl$csize) == cl$membership]
#' }
#' g <- sample_(
#' gnp(100, 1 / 100),
#' with_vertex_(size = 3, label = ""),
#' with_graph_(layout = layout_with_fr)
#' )
#' giant_v <- largest_comp(g)
#' E(g)$color <- "orange"
#' E(g)[giant_v %--% giant_v]$color <- "blue"
#' plot(g)
`$.igraph.es` <- function(x, name) {
graph <- get_es_graph(x)
if (is.null(graph)) stop("Graph is unknown")
res <- edge_attr(graph, name, x)
if (is_single_index(x)) {
res[[1]]
} else {
res
}
}
#' @param value New value of the attribute, for the vertices in the
#' vertex sequence.
#'
#' @method $<- igraph.vs
#' @name igraph-vs-attributes
#' @export
`$<-.igraph.vs` <- function(x, name, value) {
if (is.null(get_vs_graph(x))) stop("Graph is unknown")
attr(x, "name") <- name
attr(x, "value") <- value
x
}
#' @param value New value of the attribute, for the edges in the edge
#' sequence.
#' @method $<- igraph.es
#' @name igraph-es-attributes
#' @export
#' @family vertex and edge sequences
`$<-.igraph.es` <- function(x, name, value) {
if (is.null(get_es_graph(x))) stop("Graph is unknown")
attr(x, "name") <- name
attr(x, "value") <- value
x
}
#' @name igraph-vs-attributes
#' @export
`V<-` <- function(x, value) {
ensure_igraph(x)
if (!"name" %in% names(attributes(value)) ||
!"value" %in% names(attributes(value))) {
stop("invalid indexing")
}
i_set_vertex_attr(x, attr(value, "name"),
index = value,
value = attr(value, "value"), check = FALSE
)
}
#' @param path Select edges along a path, given by a vertex sequence See
#' [E()].
#' @param P Select edges via pairs of vertices. See [E()].
#' @param directed Whether to use edge directions for the `path` or
#' `P` arguments.
#' @name igraph-es-attributes
#' @export
`E<-` <- function(x, path = NULL, P = NULL, directed = NULL, value) {
ensure_igraph(x)
if (!"name" %in% names(attributes(value)) ||
!"value" %in% names(attributes(value))) {
stop("invalid indexing")
}
i_set_edge_attr(x, attr(value, "name"),
index = value,
value = attr(value, "value"), check = FALSE
)
}
#' Show a vertex sequence on the screen
#'
#' For long vertex sequences, the printing is truncated to fit to the
#' screen. Use [print()] explicitly and the `full` argument to
#' see the full sequence.
#'
#' Vertex sequence created with the double bracket operator are
#' printed differently, together with all attributes of the vertices
#' in the sequence, as a table.
#'
#' @param x A vertex sequence.
#' @param full Whether to show the full sequence, or truncate the output
#' to the screen size.
#' @inheritParams print.igraph
#' @param ... These arguments are currently ignored.
#' @return The vertex sequence, invisibly.
#'
#' @method print igraph.vs
#' @export
#' @family vertex and edge sequences
#' @examples
#' # Unnamed graphs
#' g <- make_ring(10)
#' V(g)
#'
#' # Named graphs
#' g2 <- make_ring(10) %>%
#' set_vertex_attr("name", value = LETTERS[1:10])
#' V(g2)
#'
#' # All vertices in the sequence
#' g3 <- make_ring(1000)
#' V(g3)
#' print(V(g3), full = TRUE)
#'
#' # Metadata
#' g4 <- make_ring(10) %>%
#' set_vertex_attr("name", value = LETTERS[1:10]) %>%
#' set_vertex_attr("color", value = "red")
#' V(g4)[[]]
#' V(g4)[[2:5, 7:8]]
print.igraph.vs <- function(x,
full = igraph_opt("print.full"),
id = igraph_opt("print.id"),
...) {
graph <- get_vs_graph(x)
if (!is.null(graph)) {
vertices <- V(graph)
} else {
vertices <- NULL
}
len <- length(x)
gid <- graph_id(x)
title <- "+ " %+% chr(len) %+% "/" %+%
(if (is.null(vertices)) "?" else chr(length(vertices))) %+%
(if (len == 1) " vertex" else " vertices") %+%
(if (!is.null(names(vertices))) ", named" else "") %+%
(if (isTRUE(id) && !is.na(gid)) paste(", from", substr(gid, 1, 7)) else "") %+%
(if (is.null(graph)) " (deleted)" else "") %+%
":\n"
cat(title)
if (is_single_index(x) && !is.null(graph) && length(vertex_attr_names(graph) > 0)) {
## Double bracket
va <- vertex_attr(graph)
if (all(sapply(va, is.atomic))) {
print(as.data.frame(va,
stringsAsFactors =
FALSE
)[as.vector(x), , drop = FALSE])
} else {
print(lapply(va, "[", as.vector(x)))
}
} else {
## Single bracket
if (!is.null(names(vertices))) {
x2 <- names(vertices)[as.vector(x)]
if (!is.null(names(x)) && !identical(names(x), x2)) {
names(x2) <- names(x)
}
} else {
x2 <- as.vector(x)
}
if (length(x2)) {
if (is.logical(full) && full) {
print(x2, quote = FALSE)
} else {
head_print(x2,
omitted_footer = "+ ... omitted several vertices\n",
quote = FALSE, max_lines = igraph_opt("auto.print.lines")
)
}
}
}
invisible(x)
}
#' Print an edge sequence to the screen
#'
#' For long edge sequences, the printing is truncated to fit to the
#' screen. Use [print()] explicitly and the `full` argument to
#' see the full sequence.
#'
#' Edge sequences created with the double bracket operator are printed
#' differently, together with all attributes of the edges in the sequence,
#' as a table.
#'
#' @param x An edge sequence.
#' @param full Whether to show the full sequence, or truncate the output
#' to the screen size.
#' @inheritParams print.igraph
#' @param ... Currently ignored.
#' @return The edge sequence, invisibly.
#'
#' @method print igraph.es
#' @export
#' @family vertex and edge sequences
#' @examples
#' # Unnamed graphs
#' g <- make_ring(10)
#' E(g)
#'
#' # Named graphs
#' g2 <- make_ring(10) %>%
#' set_vertex_attr("name", value = LETTERS[1:10])
#' E(g2)
#'
#' # All edges in a long sequence
#' g3 <- make_ring(200)
#' E(g3)
#' E(g3) %>% print(full = TRUE)
#'
#' # Metadata
#' g4 <- make_ring(10) %>%
#' set_vertex_attr("name", value = LETTERS[1:10]) %>%
#' set_edge_attr("weight", value = 1:10) %>%
#' set_edge_attr("color", value = "green")
#' E(g4)
#' E(g4)[[]]
#' E(g4)[[1:5]]
print.igraph.es <- function(x,
full = igraph_opt("print.full"),
id = igraph_opt("print.id"),
...) {
graph <- get_es_graph(x)
ml <- if (identical(full, TRUE)) NULL else igraph_opt("auto.print.lines")
.print.edges.compressed(
x = graph, edges = x, max.lines = ml, names = TRUE,
num = TRUE, id = id
)
invisible(x)
}
# these are internal
as_igraph_vs <- function(graph, v, na.ok = FALSE) {
if (inherits(v, "igraph.vs") && !is.null(graph) &&
!warn_version(graph)) {
if (get_graph_id(graph) != get_vs_graph_id(v)) {
stop("Cannot use a vertex sequence from another graph.")
}
}
if (is.character(v) && "name" %in% vertex_attr_names(graph)) {
v <- as.numeric(match(v, V(graph)$name))
if (!na.ok && any(is.na(v))) {
stop("Invalid vertex names")
}
v
} else {
if (is.logical(v)) {
res <- as.vector(V(graph))[v]
} else if (is.numeric(v) && any(v < 0, na.rm = TRUE)) {
res <- as.vector(V(graph))[v]
} else {
res <- as.numeric(v)
}
if (!na.ok && any(is.na(res))) {
stop("Invalid vertex name(s)")
}
res
}
}
as_igraph_es <- function(graph, e) {
if (inherits(e, "igraph.es") && !is.null(graph) &&
!warn_version(graph)) {
if (get_graph_id(graph) != get_es_graph_id(e)) {
stop("Cannot use an edge sequence from another graph.")
}
}
if (is.character(e)) {
Pairs <- grep("|", e, fixed = TRUE)
Names <- if (length(Pairs) == 0) seq_along(e) else -Pairs
res <- numeric(length(e))
## Based on vertex ids/names
if (length(Pairs) != 0) {
vv <- strsplit(e[Pairs], "|", fixed = TRUE)
vl <- sapply(vv, length)
if (any(vl != 2)) {
stop("Invalid edge name: ", e[Pairs][vl != 2][1])
}
vp <- unlist(vv)
if (!"name" %in% vertex_attr_names(graph)) {
vp <- as.numeric(vp)
}
res[Pairs] <- get_edge_ids(graph, vp)
}
## Based on edge ids/names
if (length(Names) != 0) {
if ("name" %in% edge_attr_names(graph)) {
res[Names] <- as.numeric(match(e[Names], E(graph)$name))
} else {
res[Names] <- as.numeric(e[Names])
}
}
} else {
res <- as.numeric(e)
}
if (any(is.na(res))) {
stop("Invalid edge names")
}
res
}
is_igraph_vs <- function(x) {
inherits(x, "igraph.vs")
}
is_igraph_es <- function(x) {
inherits(x, "igraph.es")
}
parse_op_args <- function(..., what, is_fun, as_fun, check_graph = TRUE) {
args <- list(...)
if (any(!sapply(args, is_fun))) stop("Not ", what, " sequence")
## get the ids of all graphs
graph_id <- sapply(args, get_vs_graph_id) %>%
unique()
if (length(graph_id) != 1) {
cli::cli_warn(c(
"Combining vertex/edge sequences from different graphs.",
x = "This will not work in future igraph versions."
))
}
graphs <- args %>%
lapply(get_vs_graph) %>%
drop_null()
addresses <- graphs %>%
sapply(function(x) x %&&% address(x)) %>%
unique()
if (check_graph && length(addresses) >= 2) {
cli::cli_warn(
"Combining vertex/edge sequences from different graphs",
x = "This will not work in future igraph versions."
)
}
graph <- if (length(graphs)) graphs[[1]] else NULL
args <- lapply(args, unclass)
list(graph = graph, args = args, id = graph_id)
}
parse_vs_op_args <- function(...) {
parse_op_args(...,
what = "a vertex", is_fun = is_igraph_vs,
as_fun = as_igraph_vs
)
}
parse_es_op_args <- function(...) {
parse_op_args(...,
what = "an edge", is_fun = is_igraph_es,
as_fun = as_igraph_es
)
}
create_op_result <- function(parsed, result, class, args) {
result <- add_vses_graph_ref(result, parsed$graph)
class(result) <- class
## c() drops names for zero length vectors. Why???
if (!length(result) &&
any(sapply(args, function(x) !is.null(names(x))))) {
names(result) <- character()
}
result
}
#' Remove duplicate vertices from a vertex sequence
#'
#' @param x A vertex sequence.
#' @param incomparables a vector of values that cannot be compared.
#' Passed to base function `duplicated`. See details there.
#' @param ... Passed to base function `duplicated()`.
#' @return A vertex sequence with the duplicate vertices removed.
#'
#' @method unique igraph.vs
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_(ring(10), with_vertex_(name = LETTERS[1:10]))
#' V(g)[1, 1:5, 1:10, 5:10]
#' V(g)[1, 1:5, 1:10, 5:10] %>% unique()
unique.igraph.vs <- function(x, incomparables = FALSE, ...) {
x[!duplicated(x, incomparables = incomparables, ...)]
}
#' Remove duplicate edges from an edge sequence
#'
#' @param x An edge sequence.
#' @param incomparables a vector of values that cannot be compared.
#' Passed to base function `duplicated`. See details there.
#' @param ... Passed to base function `duplicated()`.
#' @return An edge sequence with the duplicate vertices removed.
#'
#' @method unique igraph.es
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_(ring(10), with_vertex_(name = LETTERS[1:10]))
#' E(g)[1, 1:5, 1:10, 5:10]
#' E(g)[1, 1:5, 1:10, 5:10] %>% unique()
unique.igraph.es <- function(x, incomparables = FALSE, ...) {
x[!duplicated(x, incomparables = incomparables, ...)]
}
#' Concatenate vertex sequences
#'
#' @param ... The vertex sequences to concatenate. They must
#' refer to the same graph.
#' @param recursive Ignored, included for S3 compatibility with
#' the base `c` function.
#' @return A vertex sequence, the input sequences concatenated.
#'
#' @method c igraph.vs
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_(ring(10), with_vertex_(name = LETTERS[1:10]))
#' c(V(g)[1], V(g)["A"], V(g)[1:4])
c.igraph.vs <- function(..., recursive = FALSE) {
parsed <- parse_vs_op_args(...)
res <- do_call(c, .args = parsed$args)
create_op_result(parsed, res, "igraph.vs", list(...))
}
#' Concatenate edge sequences
#'
#' @param ... The edge sequences to concatenate. They must
#' all refer to the same graph.
#' @param recursive Ignored, included for S3 compatibility with the
#' base `c` function.
#' @return An edge sequence, the input sequences concatenated.
#'
#' @method c igraph.es
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_(ring(10), with_vertex_(name = LETTERS[1:10]))
#' c(E(g)[1], E(g)["A|B"], E(g)[1:4])
c.igraph.es <- function(..., recursive = FALSE) {
parsed <- parse_es_op_args(...)
res <- do_call(c, .args = parsed$args)
res <- create_op_result(parsed, res, "igraph.es", list(...))
attr(res, "vnames") <- do_call(c, .args = lapply(list(...), attr, "vnames"))
res
}
#' Union of vertex sequences
#'
#' @details
#' They must belong to the same graph. Note that this function has
#' \sQuote{set} semantics and the multiplicity of vertices is lost in the
#' result. (This is to match the behavior of the based `unique`
#' function.)
#'
#' @param ... The vertex sequences to take the union of.
#' @return A vertex sequence that contains all vertices in the given
#' sequences, exactly once.
#'
#' @method union igraph.vs
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_(ring(10), with_vertex_(name = LETTERS[1:10]))
#' union(V(g)[1:6], V(g)[5:10])
union.igraph.vs <- function(...) {
unique(c(...))
}
#' Union of edge sequences
#'
#' @details
#' They must belong to the same graph. Note that this function has
#' \sQuote{set} semantics and the multiplicity of edges is lost in the
#' result. (This is to match the behavior of the based `unique`
#' function.)
#'
#' @param ... The edge sequences to take the union of.
#' @return An edge sequence that contains all edges in the given
#' sequences, exactly once.
#'
#' @method union igraph.es
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_(ring(10), with_vertex_(name = LETTERS[1:10]))
#' union(E(g)[1:6], E(g)[5:9], E(g)["A|J"])
union.igraph.es <- union.igraph.vs
#' Intersection of vertex sequences
#'
#' @details
#' They must belong to the same graph. Note that this function has
#' \sQuote{set} semantics and the multiplicity of vertices is lost in the
#' result.
#'
#' @param ... The vertex sequences to take the intersection of.
#' @return A vertex sequence that contains vertices that appear in all
#' given sequences, each vertex exactly once.
#'
#' @method intersection igraph.vs
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_(ring(10), with_vertex_(name = LETTERS[1:10]))
#' intersection(E(g)[1:6], E(g)[5:9])
intersection.igraph.vs <- function(...) {
ifun <- function(x, y) {
unique(y[match(as.vector(x), y, 0L)])
}
Reduce(ifun, list(...))
}
#' Intersection of edge sequences
#'
#' @details
#' They must belong to the same graph. Note that this function has
#' \sQuote{set} semantics and the multiplicity of edges is lost in the
#' result.
#'
#' @param ... The edge sequences to take the intersection of.
#' @return An edge sequence that contains edges that appear in all
#' given sequences, each edge exactly once.
#'
#' @method intersection igraph.es
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_(ring(10), with_vertex_(name = LETTERS[1:10]))
#' intersection(E(g)[1:6], E(g)[5:9])
intersection.igraph.es <- intersection.igraph.vs
#' Difference of vertex sequences
#'
#' @details
#' They must belong to the same graph. Note that this function has
#' \sQuote{set} semantics and the multiplicity of vertices is lost in the
#' result.
#'
#' @param big The \sQuote{big} vertex sequence.
#' @param small The \sQuote{small} vertex sequence.
#' @param ... Ignored, included for S3 signature compatibility.
#' @return A vertex sequence that contains only vertices that are part of
#' `big`, but not part of `small`.
#'
#' @method difference igraph.vs
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_(ring(10), with_vertex_(name = LETTERS[1:10]))
#' difference(V(g), V(g)[6:10])
difference.igraph.vs <- function(big, small, ...) {
if (!length(big)) {
big
} else {
big[match(big, small, 0L) == 0L]
}
}
#' Difference of edge sequences
#'
#' @details
#' They must belong to the same graph. Note that this function has
#' \sQuote{set} semantics and the multiplicity of edges is lost in the
#' result.
#'
#' @param big The \sQuote{big} edge sequence.
#' @param small The \sQuote{small} edge sequence.
#' @param ... Ignored, included for S3 signature compatibility.
#' @return An edge sequence that contains only edges that are part of
#' `big`, but not part of `small`.
#'
#' @method difference igraph.es
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_(ring(10), with_vertex_(name = LETTERS[1:10]))
#' difference(V(g), V(g)[6:10])
difference.igraph.es <- difference.igraph.vs
#' Reverse the order in a vertex sequence
#'
#' @param x The vertex sequence to reverse.
#' @return The reversed vertex sequence.
#'
#' @method rev igraph.vs
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_(ring(10), with_vertex_(name = LETTERS[1:10]))
#' V(g) %>% rev()
rev.igraph.vs <- function(x) {
x[rev(seq_along(x))]
}
#' Reverse the order in an edge sequence
#'
#' @param x The edge sequence to reverse.
#' @return The reversed edge sequence.
#'
#' @method rev igraph.es
#' @family vertex and edge sequence operations
#' @export
#' @examples
#' g <- make_(ring(10), with_vertex_(name = LETTERS[1:10]))
#' E(g)
#' E(g) %>% rev()
rev.igraph.es <- rev.igraph.vs
#' Convert a vertex or edge sequence to an ordinary vector
#'
#' @details
#' For graphs without names, a numeric vector is returned, containing the
#' internal numeric vertex or edge ids.
#'
#' For graphs with names, and vertex sequences, the vertex names are
#' returned in a character vector.
#'
#' For graphs with names and edge sequences, a character vector is
#' returned, with the \sQuote{bar} notation: `a|b` means an edge from
#' vertex `a` to vertex `b`.
#'
#' @param seq The vertex or edge sequence.
#' @return A character or numeric vector, see details below.
#'
#' @export
#' @examples
#' g <- make_ring(10)
#' as_ids(V(g))
#' as_ids(E(g))
#'
#' V(g)$name <- letters[1:10]
#' as_ids(V(g))
#' as_ids(E(g))
#' @family vertex and edge sequences
as_ids <- function(seq) {
UseMethod("as_ids")
}
#' @method as_ids igraph.vs
#' @rdname as_ids
#' @export
as_ids.igraph.vs <- function(seq) {
names(seq) %||% as.vector(seq)
}
#' @method as_ids igraph.es
#' @rdname as_ids
#' @export
as_ids.igraph.es <- function(seq) {
attr(seq, "vnames") %||% as.vector(seq)
}
|