Files
Abdelrahman Said a11edf0c53 Add graph references
2026-06-28 13:49:01 +01:00

2818 lines
93 KiB
YAML

# vim:set ts=4 sw=4 sts=4 et:
#
# This file is a YAML representation of the signatures of most igraph
# functions. They are currently used by some of the higher level interfaces to
# generate code using our internal tool called Stimulus
#
# See https://github.com/igraph/stimulus for more information
#######################################
# The basic interface
#######################################
igraph_empty:
PARAMS: OUT GRAPH graph, INTEGER n=0, BOOLEAN directed=True
FLAGS: no_rng
igraph_add_edges:
PARAMS: INOUT GRAPH graph, VERTEX_INDEX_PAIRS edges, ATTRIBUTES attr
DEPS: edges ON graph
FLAGS: no_rng
igraph_empty_attrs:
PARAMS: OUT GRAPH graph, INTEGER n, BOOLEAN directed, ATTRIBUTES attr
FLAGS: no_rng
igraph_add_vertices:
PARAMS: INOUT GRAPH graph, INTEGER nv, ATTRIBUTES attr
FLAGS: no_rng
igraph_copy:
PARAMS: OUT GRAPH to, IN GRAPH from
FLAGS: no_rng
igraph_delete_edges:
PARAMS: INOUT GRAPH graph, EDGE_SELECTOR edges
DEPS: edges ON graph
FLAGS: no_rng
igraph_delete_vertices:
PARAMS: INOUT GRAPH graph, VERTEX_SELECTOR vertices
DEPS: vertices ON graph
FLAGS: no_rng
igraph_delete_vertices_map:
PARAMS: |-
INOUT GRAPH graph, VERTEX_SELECTOR vertices,
OPTIONAL OUT VECTOR_INT idx,
OPTIONAL OUT VECTOR_INT invidx
DEPS: vertices ON graph
FLAGS: no_rng
igraph_vcount:
PARAMS: GRAPH graph
RETURN: INTEGER
FLAGS: no_rng
igraph_ecount:
PARAMS: GRAPH graph
RETURN: INTEGER
FLAGS: no_rng
igraph_neighbors:
PARAMS: |-
GRAPH graph, OUT VERTEX_INDICES neis, VERTEX vid, NEIMODE mode=ALL,
LOOPS loops=TWICE, BOOLEAN multiple=True
DEPS: vid ON graph, neis ON graph
FLAGS: no_rng
igraph_is_directed:
PARAMS: GRAPH graph
RETURN: BOOLEAN
FLAGS: no_rng
igraph_degree:
PARAMS: |-
GRAPH graph, OUT VECTOR_INT res, VERTEX_SELECTOR vids=ALL, NEIMODE mode=ALL,
LOOPS loops=TWICE
DEPS: vids ON graph
FLAGS: no_rng
igraph_edge:
PARAMS: GRAPH graph, INTEGER eid, OUT INTEGER from, OUT INTEGER to
FLAGS: no_rng
igraph_edges:
PARAMS: GRAPH graph, EDGE_SELECTOR eids, OUT VECTOR_INT edges, BOOLEAN bycol=False
DEPS: eids ON graph
FLAGS: no_rng
igraph_get_eid:
PARAMS: |-
GRAPH graph, OUT EDGE eid, VERTEX from, VERTEX to,
BOOLEAN directed=True, BOOLEAN error=True
DEPS: eid ON graph, from ON graph, to ON graph
FLAGS: no_rng
igraph_get_eids:
PARAMS: |-
GRAPH graph, OUT EDGE_INDICES eids, VERTEX_INDEX_PAIRS pairs,
BOOLEAN directed=True, BOOLEAN error=True
DEPS: eids ON graph, pairs ON graph
FLAGS: no_rng
igraph_get_all_eids_between:
PARAMS: |-
GRAPH graph, OUT EDGE_INDICES eids, VERTEX from, VERTEX to,
BOOLEAN directed=True
DEPS: eids ON graph, from ON graph, to ON graph
FLAGS: no_rng
igraph_incident:
PARAMS: GRAPH graph, OUT EDGE_INDICES eids, VERTEX vid, NEIMODE mode=ALL, LOOPS loops=TWICE
DEPS: eids ON graph, vid ON graph
FLAGS: no_rng
igraph_is_same_graph:
PARAMS: GRAPH graph1, GRAPH graph2, OUT BOOLEAN res
FLAGS: no_rng
#######################################
# Constructors, deterministic
#######################################
igraph_create:
PARAMS: OUT GRAPH graph, VECTOR_INT edges, INTEGER n=0, BOOLEAN directed=True
FLAGS: no_rng
igraph_adjacency:
PARAMS: |-
OUT GRAPH graph, MATRIX adjmatrix, ADJACENCY_MODE mode=DIRECTED, LOOPS loops=ONCE
igraph_sparse_adjacency:
# adjmatrix is declared as INOUT because it might be modified during the
# construction to eliminate duplicate elements from the representation
PARAMS: |-
OUT GRAPH graph, INOUT SPARSEMAT adjmatrix, ADJACENCY_MODE mode=DIRECTED, LOOPS loops=ONCE
igraph_sparse_weighted_adjacency:
# adjmatrix is declared as INOUT because it might be modified during the
# construction to eliminate duplicate elements from the representation
PARAMS: |-
OUT GRAPH graph, INOUT SPARSEMAT adjmatrix, ADJACENCY_MODE mode=DIRECTED,
OUT EDGE_WEIGHTS weights, LOOPS loops=ONCE
DEPS: weights ON graph
igraph_weighted_adjacency:
PARAMS: |-
OUT GRAPH graph, MATRIX adjmatrix, ADJACENCY_MODE mode=DIRECTED,
OUT EDGE_WEIGHTS weights, LOOPS loops=ONCE
DEPS: weights ON graph
igraph_star:
PARAMS: OUT GRAPH graph, INTEGER n, STAR_MODE mode=OUT, INTEGER center=0
igraph_wheel:
PARAMS: OUT GRAPH graph, INTEGER n, WHEEL_MODE mode=OUT, INTEGER center=0
igraph_hypercube:
PARAMS: OUT GRAPH graph, INTEGER n, BOOLEAN directed=False
igraph_square_lattice:
PARAMS: |-
OUT GRAPH graph, VECTOR_INT dimvector, INTEGER nei=1,
BOOLEAN directed=False, BOOLEAN mutual=False, OPTIONAL VECTOR_BOOL periodic
igraph_triangular_lattice:
PARAMS: |-
OUT GRAPH graph, VECTOR_INT dimvector, BOOLEAN directed=False, BOOLEAN mutual=False
igraph_ring:
PARAMS: |-
OUT GRAPH graph, INTEGER n, BOOLEAN directed=False, BOOLEAN mutual=False,
BOOLEAN circular=True
igraph_path_graph:
PARAMS: |-
OUT GRAPH graph, INTEGER n, BOOLEAN directed=False, BOOLEAN mutual=False
igraph_cycle_graph:
PARAMS: |-
OUT GRAPH graph, INTEGER n, BOOLEAN directed=False, BOOLEAN mutual=False
igraph_kary_tree:
PARAMS: OUT GRAPH graph, INTEGER n, INTEGER children=2, TREE_MODE type=OUT
igraph_symmetric_tree:
PARAMS: OUT GRAPH graph, VECTOR_INT branches, TREE_MODE type=OUT
igraph_regular_tree:
PARAMS: OUT GRAPH graph, INTEGER h, INTEGER k=3, TREE_MODE type=UNDIRECTED
igraph_full:
PARAMS: OUT GRAPH graph, INTEGER n, BOOLEAN directed=False, BOOLEAN loops=False
FLAGS: no_rng
igraph_full_citation:
PARAMS: OUT GRAPH graph, INTEGER n, BOOLEAN directed=True
igraph_atlas:
PARAMS: OUT GRAPH graph, INTEGER number=0
igraph_extended_chordal_ring:
PARAMS: OUT GRAPH graph, INTEGER nodes, MATRIX_INT W, BOOLEAN directed=False
igraph_connect_neighborhood:
PARAMS: INOUT GRAPH graph, INTEGER order=2, NEIMODE mode=ALL
igraph_graph_power:
PARAMS: IN GRAPH graph, OUT GRAPH res, INTEGER order, BOOLEAN directed=False
igraph_linegraph:
PARAMS: GRAPH graph, OUT GRAPH linegraph
igraph_de_bruijn:
PARAMS: OUT GRAPH graph, INTEGER m, INTEGER n
FLAGS: no_rng
igraph_kautz:
PARAMS: OUT GRAPH graph, INTEGER m, INTEGER n
FLAGS: no_rng
igraph_famous:
PARAMS: OUT GRAPH graph, CSTRING name
FLAGS: no_rng
igraph_lcf:
PARAMS: OUT GRAPH graph, INTEGER n, VECTOR_INT shifts, INTEGER repeats=1
igraph_mycielski_graph:
PARAMS: OUT GRAPH graph, INTEGER k
igraph_adjlist:
PARAMS: |-
OUT GRAPH graph, ADJLIST adjlist, NEIMODE mode=OUT,
BOOLEAN duplicate=True
igraph_full_bipartite:
PARAMS: |-
OUT GRAPH graph, OPTIONAL OUT BIPARTITE_TYPES types, INTEGER n1,
INTEGER n2, BOOLEAN directed=False, NEIMODE mode=ALL
igraph_full_multipartite:
PARAMS: |-
OUT GRAPH graph, OPTIONAL OUT INDEX_VECTOR types, VECTOR_INT n,
BOOLEAN directed=False, NEIMODE mode=ALL
igraph_realize_degree_sequence:
PARAMS: |-
OUT GRAPH graph, VECTOR_INT out_deg, OPTIONAL VECTOR_INT in_deg,
EDGE_TYPE_SW allowed_edge_types=SIMPLE, REALIZE_DEGSEQ_METHOD method=SMALLEST
igraph_realize_bipartite_degree_sequence:
PARAMS: |-
OUT GRAPH graph, VECTOR_INT degrees1, VECTOR_INT degrees2,
EDGE_TYPE_SW allowed_edge_types=SIMPLE, REALIZE_DEGSEQ_METHOD method=SMALLEST
igraph_circulant:
PARAMS: OUT GRAPH graph, INTEGER n, VECTOR_INT shifts, BOOLEAN directed=False
igraph_generalized_petersen:
PARAMS: OUT GRAPH graph, INTEGER n, INTEGER k
igraph_turan:
PARAMS: |-
OUT GRAPH graph, OPTIONAL OUT INDEX_VECTOR types, INTEGER n, INTEGER r
#######################################
# Constructors, games
#######################################
igraph_barabasi_game:
PARAMS: |-
OUT GRAPH graph, INTEGER n, REAL power=1.0, INTEGER m=1,
OPTIONAL VECTOR_INT outseq, BOOLEAN outpref=False, REAL A=1.0,
BOOLEAN directed=True, BARABASI_ALGORITHM algo=BAG,
OPTIONAL GRAPH start_from
igraph_erdos_renyi_game_gnp:
PARAMS: |-
OUT GRAPH graph, INTEGER n, REAL p, BOOLEAN directed=False,
EDGE_TYPE_SW allowed_edge_types=SIMPLE,
BOOLEAN edge_labeled=False
igraph_erdos_renyi_game_gnm:
PARAMS: |-
OUT GRAPH graph, INTEGER n, INTEGER m, BOOLEAN directed=False,
EDGE_TYPE_SW allowed_edge_types=SIMPLE,
BOOLEAN edge_labeled=False
igraph_iea_game:
PARAMS: OUT GRAPH graph, INTEGER n, INTEGER m, BOOLEAN directed=False, BOOLEAN loops=False
igraph_degree_sequence_game:
PARAMS: |-
OUT GRAPH graph, VECTOR_INT out_deg, OPTIONAL VECTOR_INT in_deg,
DEGSEQ_MODE method=CONFIGURATION
igraph_growing_random_game:
PARAMS: |-
OUT GRAPH graph, INTEGER n, INTEGER m=1, BOOLEAN directed=False,
BOOLEAN citation=False
igraph_barabasi_aging_game:
PARAMS: |-
OUT GRAPH graph, INTEGER nodes, INTEGER m=1, OPTIONAL VECTOR_INT outseq,
BOOLEAN outpref=False, REAL pa_exp=1.0, REAL aging_exp=0.0, INTEGER aging_bin=1,
REAL zero_deg_appeal=1.0, REAL zero_age_appeal=0.0, REAL deg_coef=1.0,
REAL age_coef=1.0, BOOLEAN directed=True
igraph_recent_degree_game:
PARAMS: |-
OUT GRAPH graph, INTEGER n, REAL power=1.0, INTEGER window=1,
INTEGER m=1, OPTIONAL VECTOR_INT outseq, BOOLEAN outpref=False,
REAL zero_appeal=1.0, BOOLEAN directed=True
igraph_recent_degree_aging_game:
PARAMS: |-
OUT GRAPH graph, INTEGER nodes, INTEGER m=1, OPTIONAL VECTOR_INT outseq,
BOOLEAN outpref=False, REAL pa_exp=1.0, REAL aging_exp=0.0, INTEGER aging_bin=1,
INTEGER window=1, REAL zero_appeal=1.0, BOOLEAN directed=True
igraph_callaway_traits_game:
PARAMS: |-
OUT GRAPH graph, INTEGER nodes, INTEGER types,
INTEGER edges_per_step=1, VECTOR type_dist, MATRIX pref_matrix,
BOOLEAN directed=False, OPTIONAL OUT VECTOR_INT node_type_vec
igraph_establishment_game:
PARAMS: |-
OUT GRAPH graph, INTEGER nodes, INTEGER types, INTEGER k=1,
VECTOR type_dist, MATRIX pref_matrix, BOOLEAN directed=True,
OPTIONAL OUT VECTOR_INT node_type_vec
igraph_grg_game:
PARAMS: |-
OUT GRAPH graph, INTEGER nodes, REAL radius, BOOLEAN torus=False,
OPTIONAL OUT VECTOR x, OPTIONAL OUT VECTOR y
igraph_preference_game:
PARAMS: |-
OUT GRAPH graph, INTEGER nodes, INTEGER types,
VECTOR type_dist, BOOLEAN fixed_sizes=False,
MATRIX pref_matrix, OUT VECTOR_INT node_type_vec,
BOOLEAN directed=False, BOOLEAN loops=False
igraph_asymmetric_preference_game:
PARAMS: |-
OUT GRAPH graph, INTEGER nodes, INTEGER out_types, INTEGER in_types,
MATRIX type_dist_matrix, MATRIX pref_matrix,
OUT VECTOR_INT node_type_out_vec, OUT VECTOR_INT node_type_in_vec,
BOOLEAN loops=False
igraph_rewire_edges:
PARAMS: |-
INOUT GRAPH graph, REAL prob,
EDGE_TYPE_SW allowed_edge_types=SIMPLE
igraph_rewire_directed_edges:
PARAMS: |-
INOUT GRAPH graph, REAL prob, BOOLEAN loops=False,
NEIMODE mode=OUT
igraph_watts_strogatz_game:
PARAMS: |-
OUT GRAPH graph, INTEGER dim, INTEGER size, INTEGER nei,
REAL p, EDGE_TYPE_SW allowed_edge_types=SIMPLE
igraph_lastcit_game:
PARAMS: |-
OUT GRAPH graph, INTEGER nodes, INTEGER edges_per_node=1,
INTEGER agebins=1, VECTOR preference, BOOLEAN directed=True
igraph_cited_type_game:
PARAMS: |-
OUT GRAPH graph, INTEGER nodes, INDEX_VECTOR types, VECTOR pref,
INTEGER edges_per_step=1, BOOLEAN directed=True
igraph_citing_cited_type_game:
PARAMS: |-
OUT GRAPH graph, INTEGER nodes, INDEX_VECTOR types, MATRIX pref,
INTEGER edges_per_step=1, BOOLEAN directed=True
igraph_forest_fire_game:
PARAMS: |-
OUT GRAPH graph, INTEGER nodes, REAL fw_prob, REAL bw_factor=1,
INTEGER ambs=1, BOOLEAN directed=True
igraph_simple_interconnected_islands_game:
PARAMS: |-
OUT GRAPH graph, INTEGER islands_n, INTEGER islands_size,
REAL islands_pin, INTEGER n_inter
# Use a default of loops=True, as this is what's in the original Chung-Lu paper
igraph_chung_lu_game:
PARAMS: |-
OUT GRAPH graph, VECTOR out_weights, OPTIONAL VECTOR in_weights,
BOOLEAN loops=True, CHUNG_LU_VARIANT variant=ORIGINAL
igraph_static_fitness_game:
PARAMS: |-
OUT GRAPH graph, INTEGER no_of_edges, VECTOR fitness_out,
OPTIONAL VECTOR fitness_in,
EDGE_TYPE_SW allowed_edge_types=SIMPLE
igraph_static_power_law_game:
PARAMS: |-
OUT GRAPH graph, INTEGER no_of_nodes, INTEGER no_of_edges,
REAL exponent_out, REAL exponent_in=-1,
EDGE_TYPE_SW allowed_edge_types=SIMPLE,
BOOLEAN finite_size_correction=True
igraph_k_regular_game:
PARAMS: |-
OUT GRAPH graph, INTEGER no_of_nodes, INTEGER k,
BOOLEAN directed=False, BOOLEAN multiple=False
igraph_sbm_game:
PARAMS: |-
OUT GRAPH graph, MATRIX pref_matrix,
VECTOR_INT block_sizes, BOOLEAN directed=False,
EDGE_TYPE_SW allowed_edge_types=SIMPLE
igraph_hsbm_game:
INTERNAL: true
PARAMS: |-
OUT GRAPH graph, INTEGER n, INTEGER m,
VECTOR rho, MATRIX C, REAL p
igraph_hsbm_list_game:
INTERNAL: true
PARAMS: |-
OUT GRAPH graph, INTEGER n, VECTOR_INT mlist,
VECTOR_LIST rholist, MATRIX_LIST Clist, REAL p
igraph_correlated_game:
PARAMS: |-
OUT GRAPH new_graph, GRAPH old_graph,
REAL corr, REAL p=edge_density(old_graph), OPTIONAL INDEX_VECTOR permutation
igraph_correlated_pair_game:
PARAMS: |-
OUT GRAPH graph1, OUT GRAPH graph2, INTEGER n, REAL corr,
REAL p, BOOLEAN directed=False,
OPTIONAL INDEX_VECTOR permutation
igraph_dot_product_game:
PARAMS: OUT GRAPH graph, MATRIX vecs, BOOLEAN directed=False
#######################################
# Basic query functions
#######################################
igraph_are_adjacent:
PARAMS: GRAPH graph, VERTEX v1, VERTEX v2, OUT BOOLEAN res
DEPS: v1 ON graph, v2 ON graph
#######################################
# Structural properties
#######################################
igraph_diameter:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT REAL res, OUT INTEGER from, OUT INTEGER to,
OPTIONAL OUT VECTOR_INT vertex_path,
OPTIONAL OUT VECTOR_INT edge_path,
BOOLEAN directed=True, BOOLEAN unconnected=True
DEPS: weights ON graph
igraph_closeness:
PARAMS: |-
GRAPH graph, OUT VERTEX_QTY res,
OPTIONAL OUT VECTOR_INT reachable_count,
OPTIONAL OUT BOOLEAN all_reachable,
VERTEX_SELECTOR vids=ALL,
NEIMODE mode=OUT, OPTIONAL EDGE_WEIGHTS weights,
BOOLEAN normalized=False
DEPS: vids ON graph, weights ON graph, res ON graph vids
igraph_closeness_cutoff:
PARAMS: |-
GRAPH graph, OUT VERTEX_QTY res,
OPTIONAL OUT VECTOR_INT reachable_count,
OPTIONAL OUT BOOLEAN all_reachable,
VERTEX_SELECTOR vids=ALL,
NEIMODE mode=OUT, OPTIONAL EDGE_WEIGHTS weights,
BOOLEAN normalized=False, REAL cutoff=UNLIMITED
DEPS: vids ON graph, weights ON graph, res ON graph vids
igraph_distances:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT MATRIX res,
VERTEX_SELECTOR from=ALL, VERTEX_SELECTOR to=ALL, NEIMODE mode=OUT
DEPS: weights ON graph, from ON graph, to ON graph
igraph_distances_cutoff:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT MATRIX res,
VERTEX_SELECTOR from=ALL, VERTEX_SELECTOR to=ALL, NEIMODE mode=OUT, REAL cutoff=UNLIMITED
DEPS: weights ON graph, from ON graph, to ON graph
igraph_get_shortest_path:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OPTIONAL OUT VERTEX_INDICES vertices, OPTIONAL OUT EDGE_INDICES edges,
VERTEX from, VERTEX to, NEIMODE mode=OUT
DEPS: weights ON graph, from ON graph, to ON graph, vertices ON graph, edges ON graph
igraph_get_shortest_path_bellman_ford:
PARAMS: |-
GRAPH graph,
OPTIONAL OUT VERTEX_INDICES vertices, OPTIONAL OUT EDGE_INDICES edges,
VERTEX from, VERTEX to, OPTIONAL EDGE_WEIGHTS weights, NEIMODE mode=OUT
DEPS: from ON graph, to ON graph, weights ON graph, vertices ON graph, edges ON graph
igraph_get_shortest_path_dijkstra:
PARAMS: |-
GRAPH graph,
OPTIONAL OUT VERTEX_INDICES vertices, OPTIONAL OUT EDGE_INDICES edges,
VERTEX from, VERTEX to, OPTIONAL EDGE_WEIGHTS weights, NEIMODE mode=OUT
DEPS: from ON graph, to ON graph, weights ON graph, vertices ON graph, edges ON graph
igraph_get_shortest_path_astar:
PARAMS: |-
GRAPH graph,
OPTIONAL OUT VERTEX_INDICES vertices, OPTIONAL OUT EDGE_INDICES edges,
VERTEX from, VERTEX to, OPTIONAL EDGE_WEIGHTS weights, NEIMODE mode=OUT,
OPTIONAL ASTAR_HEURISTIC_FUNC heuristic, OPTIONAL EXTRA extra
DEPS: from ON graph, to ON graph, weights ON graph, vertices ON graph, edges ON graph
igraph_get_shortest_paths:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OPTIONAL OUT VERTEX_INDICES_LIST vertices, OPTIONAL OUT EDGE_INDICES_LIST edges,
VERTEX from, VERTEX_SELECTOR to=ALL, NEIMODE mode=OUT,
OPTIONAL OUT VECTOR_INT parents,
OPTIONAL OUT VECTOR_INT inbound_edges
DEPS: weights ON graph, edges ON graph, from ON graph, to ON graph
igraph_get_all_shortest_paths:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OPTIONAL OUT VERTEX_INDICES_LIST vertices, OPTIONAL OUT EDGE_INDICES_LIST edges,
OPTIONAL OUT VECTOR_INT nrgeo, VERTEX from, VERTEX_SELECTOR to, NEIMODE mode=OUT
DEPS: weights ON graph, edges ON graph, from ON graph, to ON graph
igraph_distances_dijkstra:
PARAMS: |-
GRAPH graph, OUT MATRIX res, VERTEX_SELECTOR from=ALL,
VERTEX_SELECTOR to=ALL, OPTIONAL EDGE_WEIGHTS weights, NEIMODE mode=OUT
DEPS: from ON graph, to ON graph, weights ON graph
igraph_distances_dijkstra_cutoff:
PARAMS: |-
GRAPH graph, OUT MATRIX res, VERTEX_SELECTOR from=ALL,
VERTEX_SELECTOR to=ALL, OPTIONAL EDGE_WEIGHTS weights, NEIMODE mode=OUT, REAL cutoff=UNLIMITED
DEPS: from ON graph, to ON graph, weights ON graph
igraph_get_shortest_paths_dijkstra:
PARAMS: |-
GRAPH graph, OPTIONAL OUT VERTEX_INDICES_LIST vertices,
OPTIONAL OUT EDGE_INDICES_LIST edges, VERTEX from, VERTEX_SELECTOR to=ALL,
OPTIONAL EDGE_WEIGHTS weights, NEIMODE mode=OUT,
OPTIONAL OUT VECTOR_INT parents,
OPTIONAL OUT VECTOR_INT inbound_edges
DEPS: |-
vertices ON graph, edges ON graph, from ON graph, to ON graph,
weights ON graph
igraph_get_shortest_paths_bellman_ford:
PARAMS: |-
GRAPH graph, OPTIONAL OUT VERTEX_INDICES_LIST vertices,
OPTIONAL OUT EDGE_INDICES_LIST edges, VERTEX from, VERTEX_SELECTOR to=ALL,
OPTIONAL EDGE_WEIGHTS weights, NEIMODE mode=OUT,
OPTIONAL OUT VECTOR_INT parents,
OPTIONAL OUT VECTOR_INT inbound_edges
DEPS: |-
vertices ON graph, edges ON graph, from ON graph, to ON graph,
weights ON graph
igraph_get_all_shortest_paths_dijkstra:
PARAMS: |-
GRAPH graph, OPTIONAL OUT VERTEX_INDICES_LIST vertices,
OPTIONAL OUT EDGE_INDICES_LIST edges, OPTIONAL OUT VECTOR_INT nrgeo,
VERTEX from, VERTEX_SELECTOR to=ALL, OPTIONAL EDGE_WEIGHTS weights,
NEIMODE mode=OUT
DEPS: |-
weights ON graph, from ON graph, to ON graph, vertices ON graph, edges ON graph
igraph_distances_bellman_ford:
PARAMS: |-
GRAPH graph, OUT MATRIX res, VERTEX_SELECTOR from=ALL,
VERTEX_SELECTOR to=ALL, OPTIONAL EDGE_WEIGHTS weights, NEIMODE mode=OUT
DEPS: from ON graph, to ON graph, weights ON graph
igraph_distances_johnson:
PARAMS: |-
GRAPH graph, OUT MATRIX res, VERTEX_SELECTOR from=ALL,
VERTEX_SELECTOR to=ALL, OPTIONAL EDGE_WEIGHTS weights, NEIMODE mode=OUT
DEPS: from ON graph, to ON graph, weights ON graph
igraph_distances_floyd_warshall:
PARAMS: |-
GRAPH graph, OUT MATRIX res, VERTEX_SELECTOR from=ALL,
VERTEX_SELECTOR to=ALL, OPTIONAL EDGE_WEIGHTS weights, NEIMODE mode=OUT,
FWALGORITHM method=AUTOMATIC
DEPS: from ON graph, to ON graph, weights ON graph
igraph_voronoi:
PARAMS: |-
GRAPH graph, OUT VECTOR_INT membership, OUT VECTOR distances,
VERTEX_INDICES generators, OPTIONAL EDGE_WEIGHTS weights, NEIMODE mode=OUT, VORONOI_TIEBREAKER tiebreaker=RANDOM
DEPS: weights ON graph, generators ON graph
igraph_get_all_simple_paths:
PARAMS: |-
GRAPH graph, OUT VERTEX_INDICES_LIST res, VERTEX from,
VERTEX_SELECTOR to=ALL, NEIMODE mode=OUT,
INTEGER minlen=UNLIMITED, INTEGER maxlen=UNLIMITED,
INTEGER max_results=UNLIMITED
DEPS: from ON graph, to ON graph, res ON graph
igraph_get_k_shortest_paths:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OPTIONAL OUT VERTEX_INDICES_LIST vertex_paths,
OPTIONAL OUT EDGE_INDICES_LIST edge_paths,
INTEGER k, VERTEX from, VERTEX to, NEIMODE mode=OUT
DEPS: |-
from ON graph, to ON graph, weights ON graph, vertex_paths ON graph, edge_paths ON graph
igraph_get_widest_path:
PARAMS: |-
GRAPH graph,
OPTIONAL OUT VERTEX_INDICES vertices, OPTIONAL OUT EDGE_INDICES edges,
VERTEX from, VERTEX to, EDGE_WEIGHTS weights, NEIMODE mode=OUT
DEPS: |-
from ON graph, to ON graph, weights ON graph, vertices ON graph, edges ON graph
igraph_get_widest_paths:
PARAMS: |-
GRAPH graph,
OPTIONAL OUT VERTEX_INDICES_LIST vertices, OPTIONAL OUT EDGE_INDICES_LIST edges,
VERTEX from, VERTEX_SELECTOR to=ALL, EDGE_WEIGHTS weights,
NEIMODE mode=OUT, OPTIONAL OUT VECTOR_INT parents,
OPTIONAL OUT VECTOR_INT inbound_edges
DEPS: |-
from ON graph, to ON graph, weights ON graph, vertices ON graph,
edges ON graph
igraph_widest_path_widths_dijkstra:
PARAMS: |-
GRAPH graph, OUT MATRIX res, VERTEX_SELECTOR from=ALL,
VERTEX_SELECTOR to=ALL, EDGE_WEIGHTS weights, NEIMODE mode=OUT
DEPS: from ON graph, to ON graph, weights ON graph
igraph_widest_path_widths_floyd_warshall:
PARAMS: |-
GRAPH graph, OUT MATRIX res, VERTEX_SELECTOR from=ALL,
VERTEX_SELECTOR to=ALL, EDGE_WEIGHTS weights, NEIMODE mode=OUT
DEPS: from ON graph, to ON graph, weights ON graph
igraph_spanner:
PARAMS: |-
GRAPH graph, OUT EDGE_INDICES spanner, REAL stretch, OPTIONAL EDGE_WEIGHTS weights
DEPS: weights ON graph
igraph_subcomponent:
PARAMS: GRAPH graph, OUT VERTEX_INDICES res, VERTEX vid, NEIMODE mode=ALL
DEPS: vid ON graph, res ON graph
igraph_betweenness:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT VERTEX_QTY res,
VERTEX_SELECTOR vids=ALL, BOOLEAN directed=True, BOOLEAN normalized=False
DEPS: weights ON graph, vids ON graph, res ON graph vids
igraph_betweenness_cutoff:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT VERTEX_QTY res,
VERTEX_SELECTOR vids=ALL, BOOLEAN directed=True, BOOLEAN normalized=False,
REAL cutoff=UNLIMITED
DEPS: vids ON graph, weights ON graph, res ON graph vids
igraph_betweenness_subset:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT VERTEX_QTY res,
VERTEX_SELECTOR vids=ALL, VERTEX_SELECTOR sources=ALL, VERTEX_SELECTOR targets=ALL,
BOOLEAN directed=True, BOOLEAN normalized=False
DEPS: |-
vids ON graph, weights ON graph, res ON graph vids, sources ON graph, targets ON graph
igraph_edge_betweenness:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT VECTOR res, EDGE_SELECTOR eids=ALL,
BOOLEAN directed=True, BOOLEAN normalized=False
DEPS: eids ON graph, weights ON graph, res ON graph eids
igraph_edge_betweenness_cutoff:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT VECTOR res, EDGE_SELECTOR eids=ALL,
BOOLEAN directed=True, BOOLEAN normalized=False, REAL cutoff=UNLIMITED
DEPS: eids ON graph, weights ON graph, res ON graph eids
igraph_edge_betweenness_subset:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT VECTOR res,
VERTEX_SELECTOR sources=ALL, VERTEX_SELECTOR targets=ALL, EDGE_SELECTOR eids=ALL,
BOOLEAN directed=True, BOOLEAN normalized=False
DEPS: |-
eids ON graph, weights ON graph, res ON graph eids, sources ON graph, targets ON graph
igraph_harmonic_centrality:
PARAMS: |-
GRAPH graph, OUT VERTEX_QTY res, VERTEX_SELECTOR vids=ALL,
NEIMODE mode=OUT, OPTIONAL EDGE_WEIGHTS weights, BOOLEAN normalized=False
DEPS: weights ON graph, vids ON graph, res ON graph vids
igraph_harmonic_centrality_cutoff:
PARAMS: |-
GRAPH graph, OUT VERTEX_QTY res, VERTEX_SELECTOR vids=ALL,
NEIMODE mode=OUT, OPTIONAL EDGE_WEIGHTS weights, BOOLEAN normalized=False,
REAL cutoff=UNLIMITED
DEPS: vids ON graph, weights ON graph, res ON graph vids
igraph_pagerank:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT VERTEX_QTY vector, OUT REAL value,
REAL damping=0.85, BOOLEAN directed=True,
VERTEX_SELECTOR vids=ALL,
PAGERANKALGO algo=PRPACK,
OPTIONAL INOUT PAGERANKOPT options
DEPS: |-
vids ON graph, weights ON graph, vector ON graph vids,
options ON algo
igraph_personalized_pagerank:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT VERTEX_QTY vector, OUT REAL value,
OPTIONAL VECTOR reset,
REAL damping=0.85, BOOLEAN directed=True,
VERTEX_SELECTOR vids=ALL,
PAGERANKALGO algo=PRPACK,
OPTIONAL INOUT PAGERANKOPT options
DEPS: |-
vids ON graph, weights ON graph, vector ON graph vids,
options ON algo
igraph_personalized_pagerank_vs:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
PRIMARY OUT VERTEX_QTY vector, OUT REAL value,
VERTEX_SELECTOR reset_vids,
REAL damping=0.85, BOOLEAN directed=True,
VERTEX_SELECTOR vids=ALL,
PAGERANKALGO algo=PRPACK,
OPTIONAL INOUT PAGERANKOPT options
DEPS: |-
vids ON graph, weights ON graph, vector ON graph vids,
options ON algo
igraph_rewire:
PARAMS: INOUT GRAPH rewire, INTEGER n, EDGE_TYPE_SW allowed_edge_types=SIMPLE, OPTIONAL OUT REWIRING_STATS stats
igraph_induced_subgraph:
PARAMS: GRAPH graph, OUT GRAPH res, VERTEX_SELECTOR vids, SUBGRAPH_IMPL impl=AUTO
DEPS: vids ON graph
igraph_subgraph_from_edges:
PARAMS: GRAPH graph, OUT GRAPH res, EDGE_SELECTOR eids, BOOLEAN delete_vertices=True
DEPS: eids ON graph
igraph_reverse_edges:
PARAMS: INOUT GRAPH graph, EDGE_SELECTOR eids=ALL
DEPS: eids ON graph
igraph_average_path_length:
PARAMS: GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, PRIMARY OUT REAL res,
OPTIONAL OUT REAL unconn_pairs, BOOLEAN directed=True, BOOLEAN unconn=True
DEPS: weights ON graph
igraph_path_length_hist:
PARAMS: |-
GRAPH graph, OUT VECTOR res, OUT REAL unconnected,
BOOLEAN directed=True
igraph_simplify:
PARAMS: |-
INOUT GRAPH graph, BOOLEAN remove_multiple=True,
BOOLEAN remove_loops=True,
EDGE_ATTRIBUTE_COMBINATION edge_attr_comb=Default
igraph_transitivity_undirected:
PARAMS: GRAPH graph, OUT REAL res, TRANSITIVITY_MODE mode=NAN
igraph_transitivity_local_undirected:
PARAMS: GRAPH graph, OUT VECTOR res, VERTEX_SELECTOR vids=ALL, TRANSITIVITY_MODE mode=NAN
DEPS: vids ON graph
igraph_transitivity_avglocal_undirected:
PARAMS: GRAPH graph, OUT REAL res, TRANSITIVITY_MODE mode=NAN
igraph_transitivity_barrat:
PARAMS: |-
GRAPH graph, OUT VECTOR res, VERTEX_SELECTOR vids=ALL,
OPTIONAL EDGE_WEIGHTS weights, TRANSITIVITY_MODE mode=NAN
DEPS: res ON graph, vids ON graph, weights ON graph
igraph_ecc:
PARAMS: |-
GRAPH graph, OUT VECTOR res, EDGE_SELECTOR eids=ALL,
INTEGER k=3, BOOLEAN offset=False, BOOLEAN normalize=True
DEPS: res ON graph, eids ON graph
igraph_reciprocity:
PARAMS: |-
GRAPH graph, OUT REAL res, BOOLEAN ignore_loops=True,
RECIP mode=DEFAULT
igraph_constraint:
PARAMS: GRAPH graph, OUT VECTOR res, VERTEX_SELECTOR vids=ALL, OPTIONAL EDGE_WEIGHTS weights
DEPS: vids ON graph, weights ON graph
igraph_maxdegree:
PARAMS: |-
GRAPH graph, OUT INTEGER res, VERTEX_SELECTOR vids=ALL, NEIMODE mode=ALL,
LOOPS loops=TWICE
DEPS: vids ON graph
igraph_density:
PARAMS: GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT REAL res, BOOLEAN loops=False
DEPS: weights ON graph
igraph_mean_degree:
PARAMS: GRAPH graph, OUT REAL res, BOOLEAN loops=True
igraph_neighborhood_size:
PARAMS: |-
GRAPH graph, OUT VECTOR_INT res, VERTEX_SELECTOR vids, INTEGER order,
NEIMODE mode=ALL, INTEGER mindist=0
DEPS: vids ON graph
igraph_neighborhood:
PARAMS: |-
GRAPH graph, OUT VERTEX_INDICES_LIST res,
VERTEX_SELECTOR vids, INTEGER order,
NEIMODE mode=ALL, INTEGER mindist=0
DEPS: res ON graph, vids ON graph
igraph_neighborhood_graphs:
PARAMS: |-
GRAPH graph, OUT GRAPH_LIST res, VERTEX_SELECTOR vids,
INTEGER order,
NEIMODE mode=ALL, INTEGER mindist=0
DEPS: vids ON graph
igraph_topological_sorting:
PARAMS: GRAPH graph, OUT VECTOR_INT res, NEIMODE mode=OUT
igraph_feedback_arc_set:
# Default algorithm is the approximate method because it is faster and the
# function is _not_ called igraph_minimum_feedback_arc_set
PARAMS: GRAPH graph, OUT EDGE_INDICES result, OPTIONAL EDGE_WEIGHTS weights, FAS_ALGORITHM algo=APPROX_EADES
DEPS: result ON graph, weights ON graph
igraph_feedback_vertex_set:
PARAMS: GRAPH graph, OUT VERTEX_INDICES result, OPTIONAL VERTEX_WEIGHTS weights, FVS_ALGORITHM algo=EXACT_IP
DEPS: result ON graph, weights ON graph
igraph_is_loop:
PARAMS: GRAPH graph, OUT VECTOR_BOOL res, EDGE_SELECTOR es=ALL
DEPS: es ON graph
igraph_is_dag:
PARAMS: GRAPH graph, OUT BOOLEAN res
igraph_is_acyclic:
PARAMS: GRAPH graph, OUT BOOLEAN res
igraph_is_simple:
PARAMS: GRAPH graph, OUT BOOLEAN res, BOOLEAN directed=True
igraph_is_multiple:
PARAMS: GRAPH graph, OUT VECTOR_BOOL res, EDGE_SELECTOR es=ALL
DEPS: es ON graph
igraph_has_loop:
PARAMS: GRAPH graph, OUT BOOLEAN res
igraph_has_multiple:
PARAMS: GRAPH graph, OUT BOOLEAN res
igraph_count_loops:
PARAMS: GRAPH graph, OUT INTEGER loop_count
igraph_count_multiple:
PARAMS: GRAPH graph, OUT VECTOR_INT res, EDGE_SELECTOR es=ALL
DEPS: es ON graph
igraph_girth:
PARAMS: GRAPH graph, OUT REAL girth, OUT VERTEX_INDICES cycle
DEPS: cycle ON graph
igraph_is_perfect:
PARAMS: GRAPH graph, OUT BOOLEAN res
igraph_add_edge:
PARAMS: INOUT GRAPH graph, INTEGER from, INTEGER to
igraph_eigenvector_centrality:
PARAMS: |-
GRAPH graph, OUT ALL_VERTEX_QTY vector, OUT REAL value,
NEIMODE mode=OUT,
OPTIONAL EDGE_WEIGHTS weights,
INOUT ARPACK_OPTIONS options=ARPACK_DEFAULTS
DEPS: weights ON graph, vector ON graph
igraph_hub_and_authority_scores:
PARAMS: |-
GRAPH graph, OUT ALL_VERTEX_QTY hub_vector, OUT ALL_VERTEX_QTY authority_vector,
OUT REAL value, OPTIONAL EDGE_WEIGHTS weights,
INOUT ARPACK_OPTIONS options=ARPACK_DEFAULTS
DEPS: weights ON graph, hub_vector ON graph, authority_vector ON graph
igraph_unfold_tree:
PARAMS: |-
GRAPH graph, OUT GRAPH tree, NEIMODE mode=ALL, VECTOR_INT roots,
OPTIONAL OUT INDEX_VECTOR vertex_index
igraph_is_mutual:
PARAMS: GRAPH graph, OUT VECTOR_BOOL res, EDGE_SELECTOR es=ALL, BOOLEAN loops=True
DEPS: es ON graph
igraph_has_mutual:
PARAMS: GRAPH graph, OUT BOOLEAN res, BOOLEAN loops=True
igraph_maximum_cardinality_search:
PARAMS: GRAPH graph, OPTIONAL OUT INDEX_VECTOR alpha, OPTIONAL OUT VERTEX_INDICES alpham1
DEPS: alpham1 ON graph
igraph_is_chordal:
PARAMS: |-
GRAPH graph, OPTIONAL INDEX_VECTOR alpha, OPTIONAL VERTEX_INDICES alpham1,
OPTIONAL OUT BOOLEAN chordal, OPTIONAL OUT VECTOR_INT fillin,
OPTIONAL OUT GRAPH newgraph
DEPS: alpham1 ON graph
igraph_avg_nearest_neighbor_degree:
PARAMS: |-
GRAPH graph, VERTEX_SELECTOR vids=ALL,
NEIMODE mode=ALL, NEIMODE neighbor_degree_mode=ALL,
OPTIONAL OUT VERTEX_QTY knn, OPTIONAL OUT VECTOR knnk,
OPTIONAL EDGE_WEIGHTS weights
DEPS: vids ON graph, weights ON graph, knn ON graph vids
igraph_degree_correlation_vector:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT VECTOR knnk,
NEIMODE from_mode=OUT, NEIMODE to_mode=IN,
BOOLEAN directed_neighbors=True
DEPS: weights ON graph
igraph_rich_club_sequence:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT VECTOR res,
INDEX_VECTOR vertex_order,
BOOLEAN normalized=True,
BOOLEAN loops=False,
BOOLEAN directed=True
DEPS: weights ON graph
igraph_strength:
PARAMS: |-
GRAPH graph, OUT VERTEX_QTY res, VERTEX_SELECTOR vids=ALL,
NEIMODE mode=ALL, LOOPS loops=TWICE, OPTIONAL EDGE_WEIGHTS weights
DEPS: vids ON graph, weights ON graph, res ON graph vids
igraph_centralization:
PARAMS: VECTOR scores, REAL theoretical_max=0, BOOLEAN normalized=True
RETURN: REAL
igraph_centralization_degree:
PARAMS: |-
GRAPH graph, OUT VECTOR res,
NEIMODE mode=ALL, LOOPS loops=TWICE,
OUT REAL centralization, OUT REAL theoretical_max,
BOOLEAN normalized=True
igraph_centralization_degree_tmax:
# The general consensus is that the 'loops' argument of this function
# should not have a default value; see this comment from @torfason:
# https://github.com/igraph/rigraph/issues/369#issuecomment-939893681
PARAMS: |-
OPTIONAL GRAPH graph, INTEGER nodes=0, NEIMODE mode=ALL,
LOOPS loops, OUT REAL res
igraph_centralization_betweenness:
PARAMS: |-
GRAPH graph, OUT VECTOR res,
BOOLEAN directed=True,
OUT REAL centralization,
OUT REAL theoretical_max,
BOOLEAN normalized=True
igraph_centralization_betweenness_tmax:
PARAMS: |-
OPTIONAL GRAPH graph, INTEGER nodes=0,
BOOLEAN directed=True, OUT REAL res
igraph_centralization_closeness:
PARAMS: |-
GRAPH graph, OUT VECTOR res,
NEIMODE mode=OUT, OUT REAL centralization,
OUT REAL theoretical_max,
BOOLEAN normalized=True
igraph_centralization_closeness_tmax:
PARAMS: |-
OPTIONAL GRAPH graph, INTEGER nodes=0,
NEIMODE mode=OUT, OUT REAL res
igraph_centralization_eigenvector_centrality:
PARAMS: |-
GRAPH graph, OUT VECTOR vector, OUT REAL value,
NEIMODE mode=OUT,
INOUT ARPACK_OPTIONS options=ARPACK_DEFAULTS,
OUT REAL centralization, OUT REAL theoretical_max,
BOOLEAN normalized=True
igraph_centralization_eigenvector_centrality_tmax:
PARAMS: |-
OPTIONAL GRAPH graph, INTEGER nodes=0,
NEIMODE mode=OUT,
OUT REAL res
igraph_assortativity_nominal:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
INDEX_VECTOR types,
OUT REAL res,
BOOLEAN directed=True, BOOLEAN normalized=True
DEPS: weights ON graph, types ON graph
igraph_assortativity:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
VECTOR values, OPTIONAL VECTOR values_in,
OUT REAL res, BOOLEAN directed=True, BOOLEAN normalized=True
DEPS: weights ON graph, values ON graph, values_in ON graph
igraph_assortativity_degree:
PARAMS: GRAPH graph, OUT REAL res, BOOLEAN directed=True
igraph_joint_degree_matrix:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT MATRIX jdm,
INTEGER max_out_degree=UNLIMITED, INTEGER max_in_degree=UNLIMITED
DEPS: weights ON graph
igraph_joint_degree_distribution:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT MATRIX p,
NEIMODE from_mode=OUT, NEIMODE to_mode=IN,
BOOLEAN directed_neighbors=True,
BOOLEAN normalized=True,
INTEGER max_from_degree=UNLIMITED, INTEGER max_to_degree=UNLIMITED
DEPS: weights ON graph
igraph_joint_type_distribution:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT MATRIX p,
INDEX_VECTOR from_types, OPTIONAL INDEX_VECTOR to_types,
BOOLEAN directed=True,
BOOLEAN normalized=True
DEPS: weights ON graph
igraph_contract_vertices:
PARAMS: |-
INOUT GRAPH graph, INDEX_VECTOR mapping,
VERTEX_ATTRIBUTE_COMBINATION vertex_attr_comb=Default
igraph_eccentricity:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT VERTEX_QTY res, VERTEX_SELECTOR vids=ALL,
NEIMODE mode=ALL
DEPS: weights ON graph, vids ON graph, res ON graph vids
igraph_graph_center:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT VERTEX_INDICES res, NEIMODE mode=ALL
DEPS: weights ON graph, res ON graph
igraph_radius:
PARAMS: GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT REAL radius, NEIMODE mode=ALL
DEPS: weights ON graph
igraph_pseudo_diameter:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT REAL diameter, VERTEX start_vid,
OPTIONAL OUT INTEGER from, OPTIONAL OUT INTEGER to,
BOOLEAN directed=True, BOOLEAN unconnected=True
DEPS: weights ON graph, start_vid ON graph
igraph_diversity:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT VERTEX_QTY res,
VERTEX_SELECTOR vids=ALL
DEPS: weights ON graph, vids ON graph, res ON graph vids
igraph_random_walk:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT VERTEX_INDICES vertices, OUT EDGE_INDICES edges,
VERTEX start, NEIMODE mode=OUT, INTEGER steps, RWSTUCK stuck=RETURN
DEPS: start ON graph, weights ON graph, vertices ON graph, edges ON graph
igraph_global_efficiency:
PARAMS: GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT REAL res, BOOLEAN directed=True
DEPS: weights ON graph
igraph_local_efficiency:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT VERTEX_QTY res,
VERTEX_SELECTOR vids=ALL, BOOLEAN directed=True, NEIMODE mode=ALL
DEPS: vids ON graph, weights ON graph, res ON graph vids
igraph_average_local_efficiency:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT REAL res,
BOOLEAN directed=True, NEIMODE mode=ALL
DEPS: weights ON graph
igraph_transitive_closure:
PARAMS: GRAPH graph, OUT GRAPH closure
igraph_trussness:
PARAMS: GRAPH graph, OUT VECTOR_INT trussness
#######################################
# Degree sequences
#######################################
igraph_is_bigraphical:
PARAMS: |-
VECTOR_INT degrees1, VECTOR_INT degrees2,
EDGE_TYPE_SW allowed_edge_types=SIMPLE, OUT BOOLEAN res
igraph_is_graphical:
PARAMS: |-
VECTOR_INT out_deg, OPTIONAL VECTOR_INT in_deg,
EDGE_TYPE_SW allowed_edge_types=SIMPLE, OUT BOOLEAN res
#######################################
# Visitors
#######################################
igraph_bfs:
PARAMS: |-
GRAPH graph, VERTEX root, OPTIONAL VERTEX_INDICES roots,
NEIMODE mode=OUT, BOOLEAN unreachable,
VERTEX_INDICES restricted,
OUT VERTEX_INDICES order, OUT VECTOR_INT rank,
OUT VECTOR_INT parents,
OUT VECTOR_INT pred, OUT VECTOR_INT succ,
OUT VECTOR_INT dist, OPTIONAL BFS_FUNC callback, OPTIONAL EXTRA extra
DEPS: root ON graph, roots ON graph, restricted ON graph, order ON graph
igraph_bfs_simple:
PARAMS: |-
GRAPH graph, VERTEX root,
NEIMODE mode=OUT,
OUT VERTEX_INDICES order,
OUT VECTOR_INT layers,
OUT VECTOR_INT parents
DEPS: root ON graph, order ON graph
igraph_dfs:
PARAMS: |-
GRAPH graph, VERTEX root, NEIMODE mode=OUT, BOOLEAN unreachable,
OUT VERTEX_INDICES order, OUT VERTEX_INDICES order_out,
OUT VECTOR_INT father, OUT VECTOR_INT dist,
OPTIONAL DFS_FUNC in_callback, OPTIONAL DFS_FUNC out_callback, OPTIONAL EXTRA extra
DEPS: root ON graph, order ON graph, order_out ON graph
#######################################
# Bipartite graphs
#######################################
igraph_bipartite_projection_size:
PARAMS: |-
GRAPH graph, BIPARTITE_TYPES types,
OUT INTEGER vcount1, OUT INTEGER ecount1,
OUT INTEGER vcount2, OUT INTEGER ecount2
DEPS: types ON graph
igraph_bipartite_projection:
PARAMS: |-
GRAPH graph, BIPARTITE_TYPES types,
OUT GRAPH proj1, OUT GRAPH proj2,
OPTIONAL OUT VECTOR_INT multiplicity1,
OPTIONAL OUT VECTOR_INT multiplicity2, INTEGER probe1=-1
DEPS: types ON graph
igraph_create_bipartite:
PARAMS: |-
OUT GRAPH graph, IN BIPARTITE_TYPES types,
VECTOR_INT edges, BOOLEAN directed=False
igraph_biadjacency:
PARAMS: |-
OUT GRAPH graph, OUT BIPARTITE_TYPES types, MATRIX biadjmatrix,
BOOLEAN directed=False, NEIMODE mode=ALL,
BOOLEAN multiple=False
igraph_weighted_biadjacency:
PARAMS: |-
OUT GRAPH graph,
OUT BIPARTITE_TYPES types, OUT EDGE_WEIGHTS weights,
MATRIX biadjmatrix,
BOOLEAN directed=False, NEIMODE mode=ALL
DEPS: |-
weights ON graph, biadjmatrix ON graph, types ON graph
igraph_get_biadjacency:
PARAMS: |-
GRAPH graph, BIPARTITE_TYPES types, OPTIONAL EDGE_WEIGHTS weights,
OUT MATRIX res,
OPTIONAL OUT INDEX_VECTOR row_ids, OPTIONAL OUT INDEX_VECTOR col_ids
DEPS: types ON graph, weights ON graph
igraph_is_bipartite:
PARAMS: GRAPH graph, OUT BOOLEAN res, OPTIONAL OUT BIPARTITE_TYPES types
igraph_bipartite_game_gnp:
PARAMS: |-
OUT GRAPH graph, OPTIONAL OUT BIPARTITE_TYPES types,
INTEGER n1, INTEGER n2, REAL p,
BOOLEAN directed=False, NEIMODE mode=ALL,
EDGE_TYPE_SW allowed_edge_types=SIMPLE, BOOLEAN edge_labeled=False
igraph_bipartite_game_gnm:
PARAMS: |-
OUT GRAPH graph, OPTIONAL OUT BIPARTITE_TYPES types,
INTEGER n1, INTEGER n2, INTEGER m,
BOOLEAN directed=False, NEIMODE mode=ALL,
EDGE_TYPE_SW allowed_edge_types=SIMPLE, BOOLEAN edge_labeled=False
igraph_bipartite_iea_game:
PARAMS: |-
OUT GRAPH graph, OPTIONAL OUT BIPARTITE_TYPES types,
INTEGER n1, INTEGER n2, INTEGER m,
BOOLEAN directed=False, NEIMODE mode=ALL
DEPS: |-
types ON graph
#######################################
# Spectral properties
#######################################
igraph_get_laplacian:
PARAMS: |-
GRAPH graph, OUT MATRIX res, NEIMODE mode=OUT,
LAPLACIAN_NORMALIZATION normalization=UNNORMALIZED, OPTIONAL EDGE_WEIGHTS weights
DEPS: weights ON graph
igraph_get_laplacian_sparse:
PARAMS: |-
GRAPH graph, OUT SPARSEMAT sparseres, NEIMODE mode=OUT,
LAPLACIAN_NORMALIZATION normalization=UNNORMALIZED, OPTIONAL EDGE_WEIGHTS weights
DEPS: weights ON graph
#######################################
# Components
#######################################
igraph_connected_components:
PARAMS: |-
GRAPH graph, PRIMARY OUT VECTOR_INT membership, OUT VECTOR_INT csize,
OUT INTEGER no, CONNECTEDNESS mode=WEAK
igraph_is_connected:
PARAMS: GRAPH graph, OUT BOOLEAN res, CONNECTEDNESS mode=WEAK
igraph_decompose:
PARAMS: |-
GRAPH graph, OUT GRAPH_LIST components, CONNECTEDNESS mode=WEAK,
INTEGER maxcompno=UNLIMITED, INTEGER minelements=1
igraph_articulation_points:
PARAMS: GRAPH graph, OUT VERTEX_INDICES res
DEPS: res ON graph
igraph_biconnected_components:
PARAMS: |-
GRAPH graph, OUT INTEGER no,
OPTIONAL OUT EDGE_INDICES_LIST tree_edges,
OPTIONAL OUT EDGE_INDICES_LIST component_edges,
OPTIONAL OUT VERTEX_INDICES_LIST components,
OUT VERTEX_INDICES articulation_points
DEPS: |-
tree_edges ON graph, component_edges ON graph,
components ON graph, articulation_points ON graph
igraph_bridges:
PARAMS: GRAPH graph, OUT EDGE_INDICES res
DEPS: res ON graph
igraph_is_biconnected:
PARAMS: GRAPH graph, OUT BOOLEAN res
igraph_count_reachable:
PARAMS: GRAPH graph, OUT VECTOR_INT counts, NEIMODE mode=OUT
#######################################
# Percolation
#######################################
igraph_bond_percolation:
PARAMS: GRAPH graph, OUT VECTOR_INT giant_size, OUT VECTOR_INT vetex_count, OPTIONAL EDGE_INDICES edge_order
DEPS: edge_order ON graph
igraph_site_percolation:
PARAMS: GRAPH graph, OUT VECTOR_INT giant_size, OUT VECTOR_INT edge_count, OPTIONAL VERTEX_INDICES vertex_order
DEPS: vertex_order ON graph
igraph_edgelist_percolation:
PARAMS: VERTEX_INDEX_PAIRS edges, OUT VECTOR_INT giant_size, OUT VECTOR_INT vertex_count
#######################################
# Cliques
#######################################
igraph_is_clique:
PARAMS: |-
GRAPH graph, VERTEX_SELECTOR candidate, BOOLEAN directed=False,
OUT BOOLEAN res
DEPS: candidate ON graph
igraph_cliques:
PARAMS: |-
GRAPH graph, OUT VERTEX_INDICES_LIST res,
INTEGER min_size=UNLIMITED, INTEGER max_size=UNLIMITED,
INTEGER max_results=UNLIMITED
DEPS: res ON graph
igraph_cliques_callback:
PARAMS: |-
GRAPH graph, INTEGER min_size=0, INTEGER max_size=0,
CLIQUE_FUNC cliquehandler_fn, OPTIONAL EXTRA arg
igraph_clique_size_hist:
PARAMS: |-
GRAPH graph, OUT VECTOR hist, INTEGER min_size=0, INTEGER max_size=0
igraph_largest_cliques:
PARAMS: GRAPH graph, OUT VERTEX_INDICES_LIST res
DEPS: res ON graph
igraph_maximal_cliques:
PARAMS: |-
GRAPH graph, OUT VERTEX_INDICES_LIST res,
INTEGER min_size=UNLIMITED, INTEGER max_size=UNLIMITED,
INTEGER max_results=UNLIMITED
DEPS: res ON graph
igraph_maximal_cliques_subset:
PARAMS: |-
GRAPH graph, VERTEX_INDICES subset, PRIMARY OUT VERTEX_INDICES_LIST res,
OUT INTEGER no, OPTIONAL OUTFILE outfile,
INTEGER min_size=UNLIMITED, INTEGER max_size=UNLIMITED,
INTEGER max_results=UNLIMITED
DEPS: subset ON graph, res ON graph
igraph_maximal_cliques_callback:
PARAMS: |-
GRAPH graph,
INTEGER min_size=0, INTEGER max_size=0,
CLIQUE_FUNC cliquehandler_fn, OPTIONAL EXTRA arg
igraph_maximal_cliques_count:
PARAMS: |-
GRAPH graph, OUT INTEGER no, INTEGER min_size=0, INTEGER max_size=0
igraph_maximal_cliques_file:
PARAMS: |-
GRAPH graph, OUTFILE res,
INTEGER min_size=UNLIMITED, INTEGER max_size=UNLIMITED,
INTEGER max_results=UNLIMITED
igraph_maximal_cliques_hist:
PARAMS: |-
GRAPH graph, OUT VECTOR hist, INTEGER min_size=0, INTEGER max_size=0
igraph_clique_number:
PARAMS: GRAPH graph, OUT INTEGER no
igraph_weighted_cliques:
PARAMS: |-
GRAPH graph, OPTIONAL VERTEX_WEIGHTS vertex_weights, OUT VERTEX_INDICES_LIST res,
BOOLEAN maximal=False,
REAL min_weight=UNLIMITED, REAL max_weight=UNLIMITED,
INTEGER max_results=UNLIMITED
DEPS: vertex_weights ON graph, res ON graph
igraph_largest_weighted_cliques:
PARAMS: |-
GRAPH graph, OPTIONAL VERTEX_WEIGHTS vertex_weights, OUT VERTEX_INDICES_LIST res
DEPS: vertex_weights ON graph, res ON graph
igraph_weighted_clique_number:
PARAMS: GRAPH graph, OPTIONAL VERTEX_WEIGHTS vertex_weights, OUT REAL res
DEPS: vertex_weights ON graph
igraph_is_independent_vertex_set:
PARAMS: GRAPH graph, VERTEX_SELECTOR candidate, OUT BOOLEAN res
DEPS: candidate ON graph
igraph_independent_vertex_sets:
PARAMS: |-
GRAPH graph, OUT VERTEX_INDICES_LIST res,
INTEGER min_size=UNLIMITED, INTEGER max_size=UNLIMITED,
INTEGER max_results=UNLIMITED
DEPS: res ON graph
igraph_largest_independent_vertex_sets:
PARAMS: GRAPH graph, OUT VERTEX_INDICES_LIST res
DEPS: res ON graph
igraph_maximal_independent_vertex_sets:
PARAMS: |-
GRAPH graph, OUT VERTEX_INDICES_LIST res,
INTEGER min_size=UNLIMITED, INTEGER max_size=UNLIMITED,
INTEGER max_results=UNLIMITED
DEPS: res ON graph
igraph_independence_number:
PARAMS: GRAPH graph, OUT INTEGER no
#######################################
# Layouts
#######################################
igraph_layout_random:
PARAMS: GRAPH graph, OUT MATRIX res
igraph_layout_circle:
PARAMS: GRAPH graph, OUT MATRIX res, VERTEX_SELECTOR order=ALL
DEPS: order ON graph
igraph_layout_star:
PARAMS: |-
GRAPH graph, OUT MATRIX res, VERTEX center=V(graph)[1],
OPTIONAL INDEX_VECTOR order
DEPS: center ON graph
igraph_layout_grid:
PARAMS: GRAPH graph, OUT MATRIX res, INTEGER width=0
igraph_layout_grid_3d:
PARAMS: GRAPH graph, OUT MATRIX res, INTEGER width=0, INTEGER height=0
igraph_layout_fruchterman_reingold:
PARAMS: |-
GRAPH graph, OPTIONAL INOUT MATRIX coords,
BOOLEAN use_seed=False, INTEGER niter=500,
REAL start_temp=sqrt(vcount(graph)),
LAYOUT_GRID grid=AUTO, OPTIONAL EDGE_WEIGHTS weights,
OPTIONAL VECTOR minx, OPTIONAL VECTOR maxx,
OPTIONAL VECTOR miny, OPTIONAL VECTOR maxy,
DEPRECATED coolexp, DEPRECATED maxdelta, DEPRECATED area,
DEPRECATED repulserad
DEPS: weights ON graph
igraph_layout_kamada_kawai:
PARAMS: |-
GRAPH graph, INOUT MATRIX coords, BOOLEAN use_seed=False,
INTEGER maxiter=500, REAL epsilon=0.0,
REAL kkconst=vcount(graph), OPTIONAL EDGE_WEIGHTS weights,
OPTIONAL VECTOR minx, OPTIONAL VECTOR maxx,
OPTIONAL VECTOR miny, OPTIONAL VECTOR maxy
DEPS: weights ON graph
igraph_layout_lgl:
PARAMS: |-
GRAPH graph, OUT MATRIX res, INTEGER maxiter=150, REAL maxdelta=VCOUNT(graph),
REAL area=VCOUNT(graph)^2, REAL coolexp=1.5, REAL repulserad=VCOUNT(graph)^3, REAL cellsize=VCOUNT(graph),
INTEGER root=-1
igraph_layout_reingold_tilford:
PARAMS: |-
GRAPH graph, OUT MATRIX res, NEIMODE mode=OUT,
OPTIONAL VERTEX_INDICES roots, OPTIONAL VECTOR_INT rootlevel
DEPS: roots ON graph
igraph_layout_reingold_tilford_circular:
PARAMS: |-
GRAPH graph, OUT MATRIX res, NEIMODE mode=OUT,
OPTIONAL VERTEX_INDICES roots, OPTIONAL VECTOR_INT rootlevel
DEPS: roots ON graph
igraph_roots_for_tree_layout:
PARAMS: |-
GRAPH graph, NEIMODE mode=OUT, OUT VERTEX_INDICES roots, ROOTCHOICE heuristic
DEPS: roots ON graph
igraph_layout_random_3d:
PARAMS: GRAPH graph, OUT MATRIX res
igraph_layout_sphere:
PARAMS: GRAPH graph, OUT MATRIX res
igraph_layout_fruchterman_reingold_3d:
PARAMS: |-
GRAPH graph, OPTIONAL INOUT MATRIX coords,
BOOLEAN use_seed=False, INTEGER niter=500,
REAL start_temp=sqrt(vcount(graph)),
OPTIONAL EDGE_WEIGHTS weights,
OPTIONAL VECTOR minx, OPTIONAL VECTOR maxx,
OPTIONAL VECTOR miny, OPTIONAL VECTOR maxy,
OPTIONAL VECTOR minz, OPTIONAL VECTOR maxz,
DEPRECATED coolexp, DEPRECATED maxdelta, DEPRECATED area,
DEPRECATED repulserad
DEPS: weights ON graph
igraph_layout_kamada_kawai_3d:
PARAMS: |-
GRAPH graph, INOUT MATRIX coords, BOOLEAN use_seed=False,
INTEGER maxiter=500, REAL epsilon=0.0,
REAL kkconst=vcount(graph), OPTIONAL EDGE_WEIGHTS weights,
OPTIONAL VECTOR minx, OPTIONAL VECTOR maxx,
OPTIONAL VECTOR miny, OPTIONAL VECTOR maxy,
OPTIONAL VECTOR minz, OPTIONAL VECTOR maxz
DEPS: weights ON graph
igraph_layout_graphopt:
PARAMS: |-
GRAPH graph, INOUT MATRIX res, INTEGER niter=500,
REAL node_charge=0.001, REAL node_mass=30,
REAL spring_length=0, REAL spring_constant=1,
REAL max_sa_movement=5, BOOLEAN use_seed=False
igraph_layout_drl:
PARAMS: |-
GRAPH graph, INOUT MATRIX res, BOOLEAN use_seed=False,
DRL_OPTIONS options=drl_defaults$default, OPTIONAL EDGE_WEIGHTS weights
DEPS: weights ON graph
igraph_layout_drl_3d:
PARAMS: |-
GRAPH graph, INOUT MATRIX res, BOOLEAN use_seed=False,
DRL_OPTIONS options=drl_defaults$default, OPTIONAL EDGE_WEIGHTS weights
DEPS: weights ON graph
igraph_layout_merge_dla:
PARAMS: GRAPH_PTR_LIST graphs, MATRIX_LIST coords, OUT MATRIX res
igraph_layout_sugiyama:
PARAMS: |-
GRAPH graph, OUT MATRIX res, OPTIONAL OUT MATRIX_LIST routing,
OPTIONAL INDEX_VECTOR layers,
REAL hgap=1, REAL vgap=1, INTEGER maxiter=100,
OPTIONAL EDGE_WEIGHTS weights
DEPS: weights ON graph
igraph_layout_mds:
PARAMS: |-
GRAPH graph, OUT MATRIX res, OPTIONAL MATRIX dist, INTEGER dim=2
igraph_layout_bipartite:
PARAMS: |-
GRAPH graph, BIPARTITE_TYPES types, OUT MATRIX res,
REAL hgap=1, REAL vgap=1, INTEGER maxiter=100
DEPS: types ON graph
igraph_layout_gem:
PARAMS: |-
GRAPH graph, INOUT MATRIX res=matrix(),
BOOLEAN use_seed=False,
INTEGER maxiter=40*vcount(graph)^2,
REAL temp_max=vcount(graph),
REAL temp_min=1/10, REAL temp_init=sqrt(vcount(graph))
igraph_layout_davidson_harel:
PARAMS: |-
GRAPH graph, INOUT MATRIX res=matrix(),
BOOLEAN use_seed=False, INTEGER maxiter=10,
INTEGER fineiter=FINEITER, REAL cool_fact=0.75,
REAL weight_node_dist=1.0, REAL weight_border=0.0,
REAL weight_edge_lengths=ELENW,
REAL weight_edge_crossings=ECROSSW,
REAL weight_node_edge_dist=NEDISTW
igraph_layout_umap:
PARAMS: |-
GRAPH graph, INOUT MATRIX res, BOOLEAN use_seed=False,
OPTIONAL VECTOR distances, REAL min_dist=0.0, INTEGER epochs=200,
BOOLEAN distances_are_weights=False
igraph_layout_umap_3d:
PARAMS: |-
GRAPH graph, INOUT MATRIX res, BOOLEAN use_seed=False,
OPTIONAL VECTOR distances, REAL min_dist=0.0, INTEGER epochs=200,
BOOLEAN distances_are_weights=False
igraph_layout_umap_compute_weights:
PARAMS: |-
GRAPH graph, VECTOR distances, INOUT VECTOR weights
igraph_layout_align:
PARAMS: GRAPH graph, INOUT MATRIX layout
#######################################
# Cocitation and other similarity measures
#######################################
igraph_cocitation:
PARAMS: GRAPH graph, OUT MATRIX res, VERTEX_SELECTOR vids=ALL
DEPS: vids ON graph
igraph_bibcoupling:
PARAMS: GRAPH graph, OUT MATRIX res, VERTEX_SELECTOR vids=ALL
DEPS: vids ON graph
igraph_similarity_dice:
PARAMS: |-
GRAPH graph, OUT MATRIX res, VERTEX_SELECTOR from=ALL, VERTEX_SELECTOR to=ALL, NEIMODE mode=ALL,
BOOLEAN loops=False
DEPS: from ON graph, to ON graph, res ON from, res ON to
igraph_similarity_dice_es:
PARAMS: |-
GRAPH graph, OUT VECTOR res, EDGE_SELECTOR es=ALL, NEIMODE mode=ALL,
BOOLEAN loops=False
DEPS: es ON graph
igraph_similarity_dice_pairs:
PARAMS: |-
GRAPH graph, OUT VECTOR res, VERTEX_INDEX_PAIRS pairs, NEIMODE mode=ALL,
BOOLEAN loops=False
DEPS: pairs ON graph
igraph_similarity_inverse_log_weighted:
PARAMS: GRAPH graph, OUT MATRIX res, VERTEX_SELECTOR vids=ALL, NEIMODE mode=ALL
DEPS: vids ON graph
igraph_similarity_jaccard:
PARAMS: |-
GRAPH graph, OUT MATRIX res, VERTEX_SELECTOR from=ALL, VERTEX_SELECTOR to=ALL, NEIMODE mode=ALL,
BOOLEAN loops=False
DEPS: from ON graph, to ON graph, res ON from, res ON to
igraph_similarity_jaccard_es:
PARAMS: |-
GRAPH graph, OUT VECTOR res, EDGE_SELECTOR es=ALL, NEIMODE mode=ALL,
BOOLEAN loops=False
DEPS: es ON graph
igraph_similarity_jaccard_pairs:
PARAMS: |-
GRAPH graph, OUT VECTOR res, VERTEX_INDEX_PAIRS pairs, NEIMODE mode=ALL,
BOOLEAN loops=False
DEPS: pairs ON graph
#######################################
# Community structure
#######################################
igraph_compare_communities:
PARAMS: |-
VECTOR_INT comm1, VECTOR_INT comm2, OUT REAL res, COMMCMP method=VI
igraph_community_spinglass:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT REAL modularity,
OUT REAL temperature, OUT VECTOR_INT membership, OUT VECTOR_INT csize,
INTEGER spins=25, BOOLEAN parupdate=False, REAL starttemp=1, REAL stoptemp=0.01,
REAL coolfact=0.99, SPINCOMMUPDATE update_rule=CONFIG, REAL gamma=1.0,
SPINGLASS_IMPLEMENTATION implementation=ORIG, REAL lambda=1.0
DEPS: weights ON graph
igraph_community_spinglass_single:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, INTEGER vertex,
OUT VECTOR_INT community, OUT REAL cohesion, OUT REAL adhesion,
OUT REAL inner_links, OUT REAL outer_links,
INTEGER spins=25, SPINCOMMUPDATE update_rule=CONFIG, REAL gamma=1.0
DEPS: weights ON graph
igraph_community_walktrap:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, INTEGER steps=4,
OUT MATRIX_INT merges, OUT VECTOR modularity, OUT VECTOR_INT membership
DEPS: weights ON graph
igraph_community_edge_betweenness:
PARAMS: |-
GRAPH graph, OUT VECTOR_INT removed_edges, OPTIONAL OUT VECTOR edge_betweenness,
OPTIONAL OUT MATRIX_INT merges, OPTIONAL OUT INDEX_VECTOR bridges,
OPTIONAL OUT VECTOR modularity, OPTIONAL OUT VECTOR_INT membership,
BOOLEAN directed=True,
OPTIONAL EDGE_WEIGHTS weights, OPTIONAL EDGE_LENGTHS lengths
DEPS: weights ON graph, lengths ON graph, edge_betweenness ON graph
igraph_community_eb_get_merges:
PARAMS: |-
GRAPH graph, BOOLEAN directed, EDGE_INDICES edges, OPTIONAL EDGE_WEIGHTS weights,
OPTIONAL OUT MATRIX_INT merges, OPTIONAL OUT INDEX_VECTOR bridges,
OPTIONAL OUT VECTOR modularity, OPTIONAL OUT VECTOR_INT membership
DEPS: weights ON graph
igraph_community_fastgreedy:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, OUT MATRIX_INT merges,
OPTIONAL OUT VECTOR modularity, OPTIONAL OUT VECTOR_INT membership
DEPS: weights ON graph
igraph_community_to_membership:
PARAMS: |-
MATRIX_INT merges, INTEGER nodes, INTEGER steps,
OPTIONAL OUT VECTOR_INT membership, OPTIONAL OUT VECTOR_INT csize
igraph_le_community_to_membership:
PARAMS: |-
MATRIX_INT merges, INTEGER steps, INOUT VECTOR_INT membership,
OPTIONAL OUT VECTOR_INT csize
igraph_modularity:
PARAMS: |-
GRAPH graph, VECTOR_INT membership, OPTIONAL EDGE_WEIGHTS weights,
REAL resolution=1.0, BOOLEAN directed=True, OUT REAL modularity
DEPS: weights ON graph
igraph_modularity_matrix:
PARAMS: |-
GRAPH graph,
OPTIONAL EDGE_WEIGHTS weights,
REAL resolution=1.0,
OUT MATRIX modmat,
BOOLEAN directed=True
DEPS: weights ON graph
igraph_reindex_membership:
PARAMS: |-
INOUT VECTOR_INT membership, OUT INDEX_VECTOR new_to_old,
OUT INTEGER nb_clusters
igraph_community_leading_eigenvector:
PARAMS: |-
GRAPH graph,
OPTIONAL EDGE_WEIGHTS weights,
OPTIONAL OUT MATRIX_INT merges,
OPTIONAL OUT VECTOR_INT membership,
INTEGER steps=-1,
INOUT ARPACK_OPTIONS options=ARPACK_DEFAULTS,
OPTIONAL OUT REAL modularity,
BOOLEAN start=False,
OPTIONAL OUT VECTOR eigenvalues,
OPTIONAL OUT VECTOR_LIST eigenvectors,
OPTIONAL OUT VECTOR_INT history,
OPTIONAL LEVC_FUNC callback,
OPTIONAL EXTRA callback_extra
DEPS: weights ON graph
igraph_community_fluid_communities:
PARAMS: |-
GRAPH graph, INTEGER no_of_communities, OUT VECTOR_INT membership
igraph_community_label_propagation:
PARAMS: |-
GRAPH graph, OUT VECTOR_INT membership, NEIMODE mode=ALL,
OPTIONAL EDGE_WEIGHTS weights, OPTIONAL INDEX_VECTOR initial,
OPTIONAL VECTOR_BOOL fixed, LPA_VARIANT lpa_variant=DOMINANCE
DEPS: weights ON graph
igraph_community_multilevel:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, REAL resolution=1.0,
OUT VECTOR_INT membership, OPTIONAL OUT MATRIX_INT memberships,
OPTIONAL OUT VECTOR modularity
DEPS: weights ON graph
igraph_community_optimal_modularity:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights, REAL resolution=1.0,
OPTIONAL OUT REAL modularity, OPTIONAL OUT VECTOR_INT membership
DEPS: weights ON graph
igraph_community_leiden:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OPTIONAL VERTEX_WEIGHTS vertex_out_weights,
OPTIONAL VERTEX_WEIGHTS vertex_in_weights,
REAL resolution, REAL beta=0.01, BOOLEAN start=False, INTEGER n_iterations=2,
OPTIONAL INOUT VECTOR_INT membership,
OUT INTEGER nb_clusters, OUT REAL quality
DEPS: weights ON graph, vertex_out_weights ON graph, vertex_in_weights ON graph
igraph_community_leiden_simple:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
LEIDEN_OBJECTIVE objective,
REAL resolution, REAL beta=0.01, BOOLEAN start=False, INTEGER n_iterations=2,
OPTIONAL INOUT VECTOR_INT membership,
OUT INTEGER nb_clusters, OUT REAL quality
DEPS: weights ON graph
igraph_split_join_distance:
PARAMS: |-
VECTOR_INT comm1, VECTOR_INT comm2, OUT INTEGER distance12,
OUT INTEGER distance21
igraph_community_infomap:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS edge_weights,
OPTIONAL VERTEX_WEIGHTS vertex_weights, INTEGER nb_trials=10,
BOOLEAN is_regularized=False, REAL regularization_strength=1,
OPTIONAL OUT VECTOR_INT membership, OPTIONAL OUT REAL codelength
DEPS: edge_weights ON graph, vertex_weights ON graph
igraph_community_voronoi:
PARAMS: |-
GRAPH graph,
OPTIONAL OUT VECTOR_INT membership,
OPTIONAL OUT VERTEX_INDICES generators,
OPTIONAL OUT REAL modularity,
OPTIONAL EDGE_LENGTHS lengths, OPTIONAL EDGE_WEIGHTS weights,
NEIMODE mode=OUT, REAL radius=-1
DEPS: generators ON graph, weights ON graph, lengths ON graph
#######################################
# Graphlets
#######################################
igraph_graphlets:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT VERTEX_INDICES_LIST cliques, OUT VECTOR Mu, INTEGER niter=1000
DEPS: weights ON graph, cliques ON graph
igraph_graphlets_candidate_basis:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT VERTEX_INDICES_LIST cliques, OUT VECTOR thresholds
DEPS: weights ON graph, cliques ON graph
igraph_graphlets_project:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
VERTEX_INDICES_LIST cliques, INOUT VECTOR Muc,
BOOLEAN startMu=False, INTEGER niter=1000
DEPS: weights ON graph
#######################################
# Hierarchical random graphs
#######################################
igraph_hrg_fit:
PARAMS: |-
GRAPH graph, INOUT HRG hrg=Default, BOOLEAN start=False,
INTEGER steps=0
igraph_hrg_sample:
PARAMS: HRG hrg, OUT GRAPH sample
igraph_hrg_sample_many:
PARAMS: HRG hrg, OUT GRAPH_LIST samples, INTEGER num_samples
igraph_hrg_game:
PARAMS: OUT GRAPH graph, HRG hrg
igraph_hrg_consensus:
PARAMS: |-
GRAPH graph, OUT VECTOR_INT parents, OUT VECTOR weights,
INOUT HRG hrg=Default, BOOLEAN start=False,
INTEGER num_samples=10000
igraph_hrg_predict:
PARAMS: |-
GRAPH graph, OUT VERTEX_INDICES edges, OUT VECTOR prob,
INOUT HRG hrg=Default, BOOLEAN start=False,
INTEGER num_samples=10000, INTEGER num_bins=25
DEPS: edges ON graph
igraph_hrg_create:
PARAMS: OUT HRG hrg, GRAPH graph, VECTOR prob
DEPS: prob ON graph
igraph_hrg_resize:
PARAMS: INOUT HRG hrg, INTEGER newsize
igraph_hrg_size:
PARAMS: HRG hrg
RETURN: INTEGER
igraph_from_hrg_dendrogram:
PARAMS: OUT GRAPH graph, HRG hrg, OUT VECTOR prob
#######################################
# Conversion
#######################################
igraph_get_adjacency:
PARAMS: |-
GRAPH graph, OUT MATRIX res, GETADJACENCY type=BOTH,
OPTIONAL EDGE_WEIGHTS weights, LOOPS loops=ONCE
DEPS: weights ON graph
igraph_get_adjacency_sparse:
PARAMS: |-
GRAPH graph, OUT SPARSEMAT sparsemat, GETADJACENCY type=BOTH,
OPTIONAL EDGE_WEIGHTS weights, LOOPS loops=ONCE
DEPS: weights ON graph
igraph_get_edgelist:
PARAMS: GRAPH graph, OUT VECTOR_INT res, BOOLEAN bycol=False
igraph_get_stochastic:
PARAMS: |-
GRAPH graph, OUT MATRIX res, BOOLEAN column_wise=False,
OPTIONAL EDGE_WEIGHTS weights
DEPS: weights ON graph
igraph_get_stochastic_sparse:
PARAMS: |-
GRAPH graph, OUT SPARSEMAT sparsemat, BOOLEAN column_wise=False,
OPTIONAL EDGE_WEIGHTS weights
DEPS: weights ON graph
igraph_to_directed:
PARAMS: INOUT GRAPH graph, TODIRECTED mode=MUTUAL
igraph_to_undirected:
PARAMS: |-
INOUT GRAPH graph, TOUNDIRECTED mode=COLLAPSE,
EDGE_ATTRIBUTE_COMBINATION edge_attr_comb=Default
#######################################
# Read and write foreign formats
#######################################
igraph_read_graph_edgelist:
PARAMS: OUT GRAPH graph, INFILE instream, INTEGER n=0, BOOLEAN directed=True
igraph_read_graph_ncol:
PARAMS: |-
OUT GRAPH graph, INFILE instream, OPTIONAL VECTOR_STR predefnames,
BOOLEAN names=True, ADD_WEIGHTS weights=True, BOOLEAN directed=True
igraph_read_graph_lgl:
PARAMS: |-
OUT GRAPH graph, INFILE instream, BOOLEAN names=True,
ADD_WEIGHTS weights=True, BOOLEAN directed=True
igraph_read_graph_pajek:
PARAMS: OUT GRAPH graph, INFILE instream
igraph_read_graph_graphml:
PARAMS: OUT GRAPH graph, INFILE instream, INTEGER index=0
igraph_read_graph_dimacs_flow:
PARAMS: |-
OUT GRAPH graph, INFILE instream,
OPTIONAL OUT VECTOR_STR problem, OPTIONAL OUT VECTOR_INT label,
OPTIONAL OUT INTEGER source, OPTIONAL OUT INTEGER target,
OPTIONAL OUT VECTOR capacity, BOOLEAN directed=True
igraph_read_graph_graphdb:
PARAMS: OUT GRAPH graph, INFILE instream, BOOLEAN directed=False
igraph_read_graph_gml:
PARAMS: OUT GRAPH graph, INFILE instream
igraph_read_graph_dl:
PARAMS: OUT GRAPH graph, INFILE instream, BOOLEAN directed=True
igraph_write_graph_edgelist:
PARAMS: GRAPH graph, OUTFILE outstream
igraph_write_graph_ncol:
PARAMS: GRAPH graph, OUTFILE outstream, CSTRING names="name", CSTRING weights="weight"
igraph_write_graph_lgl:
PARAMS: |-
GRAPH graph, OUTFILE outstream, CSTRING names="name", CSTRING weights="weight",
BOOLEAN isolates=True
igraph_write_graph_leda:
PARAMS: GRAPH graph, OUTFILE outstream, CSTRING names="name", CSTRING weights="weight"
igraph_write_graph_graphml:
PARAMS: GRAPH graph, OUTFILE outstream, BOOLEAN prefixattr=True
igraph_write_graph_pajek:
PARAMS: GRAPH graph, OUTFILE outstream
igraph_write_graph_dimacs_flow:
PARAMS: |-
GRAPH graph, OUTFILE outstream, VERTEX source=0, VERTEX target=0,
VECTOR capacity
igraph_write_graph_gml:
PARAMS: GRAPH graph, OUTFILE outstream, WRITE_GML_SW options=DEFAULT, VECTOR id, OPTIONAL CSTRING creator
igraph_write_graph_dot:
PARAMS: GRAPH graph, OUTFILE outstream
#######################################
# Motifs
#######################################
igraph_motifs_randesu:
PARAMS: GRAPH graph, OUT VECTOR hist, INTEGER size=3, OPTIONAL VECTOR cut_prob
igraph_motifs_randesu_estimate:
PARAMS: |-
GRAPH graph, OUT REAL est, INTEGER size=3, OPTIONAL VECTOR cut_prob,
INTEGER sample_size, OPTIONAL VECTOR_INT sample
igraph_motifs_randesu_no:
PARAMS: GRAPH graph, OUT REAL no, INTEGER size=3, OPTIONAL VECTOR cut_prob
igraph_dyad_census:
PARAMS: GRAPH graph, OUT REAL mut, OUT REAL asym, OUT REAL null
RETURN: ERROR
igraph_triad_census:
PARAMS: GRAPH graph, OUT VECTOR res
RETURN: ERROR
igraph_count_adjacent_triangles:
PARAMS: GRAPH graph, OUT VECTOR res, VERTEX_SELECTOR vids=ALL
DEPS: vids ON graph
igraph_count_triangles:
PARAMS: GRAPH graph, OUT REAL res
igraph_local_scan_0:
PARAMS: |-
GRAPH graph, OUT VECTOR res, OPTIONAL EDGE_WEIGHTS weights,
NEIMODE mode=OUT
DEPS: weights ON graph
igraph_local_scan_0_them:
PARAMS: |-
GRAPH us, GRAPH them, OUT VECTOR res,
OPTIONAL EDGE_WEIGHTS weights_them, NEIMODE mode=OUT
DEPS: weights_them ON them
igraph_local_scan_1_ecount:
PARAMS: |-
GRAPH graph, OUT VECTOR res, OPTIONAL EDGE_WEIGHTS weights,
NEIMODE mode=OUT
DEPS: weights ON graph
igraph_local_scan_1_ecount_them:
PARAMS: |-
GRAPH us, GRAPH them, OUT VECTOR res,
OPTIONAL EDGE_WEIGHTS weights_them, NEIMODE mode=OUT
DEPS: weights_them ON them
igraph_local_scan_k_ecount:
PARAMS: |-
GRAPH graph, INTEGER k, OUT VECTOR res, OPTIONAL EDGE_WEIGHTS weights,
NEIMODE mode=OUT
DEPS: weights ON graph
igraph_local_scan_k_ecount_them:
PARAMS: |-
GRAPH us, GRAPH them, INTEGER k, OUT VECTOR res,
OPTIONAL EDGE_WEIGHTS weights_them, NEIMODE mode=OUT
DEPS: weights_them ON them
igraph_local_scan_neighborhood_ecount:
PARAMS: |-
GRAPH graph, OUT VECTOR res, OPTIONAL EDGE_WEIGHTS weights,
VERTEX_INDICES_LIST neighborhoods
DEPS: weights ON graph
igraph_local_scan_subset_ecount:
PARAMS: |-
GRAPH graph, OUT VECTOR res, OPTIONAL EDGE_WEIGHTS weights,
VERTEX_INDICES_LIST subsets
DEPS: weights ON graph
igraph_list_triangles:
PARAMS: GRAPH graph, OUT VERTEX_INDICES res
DEPS: res ON graph
#######################################
# Graph operators
#######################################
igraph_disjoint_union:
PARAMS: OUT GRAPH res, GRAPH left, GRAPH right
igraph_disjoint_union_many:
PARAMS: OUT GRAPH res, GRAPH_PTR_LIST graphs
igraph_join:
PARAMS: OUT GRAPH res, GRAPH left, GRAPH right
igraph_union:
PARAMS: |-
OUT GRAPH res, GRAPH left, GRAPH right,
OUT INDEX_VECTOR edge_map_left, OUT INDEX_VECTOR edge_map_right
DEPS: edge_map_left ON left, edge_map_right ON right
igraph_union_many:
PARAMS: OUT GRAPH res, GRAPH_PTR_LIST graphs, OUT VECTOR_INT_LIST edgemaps
igraph_intersection:
PARAMS: |-
OUT GRAPH res, GRAPH left, GRAPH right,
OUT INDEX_VECTOR edge_map_left, OUT INDEX_VECTOR edge_map_right
DEPS: edge_map_left ON left, edge_map_right ON right
igraph_intersection_many:
PARAMS: OUT GRAPH res, GRAPH_PTR_LIST graphs, OUT VECTOR_INT_LIST edgemaps
igraph_difference:
PARAMS: OUT GRAPH res, GRAPH orig, GRAPH sub
igraph_complementer:
PARAMS: OUT GRAPH res, GRAPH graph, BOOLEAN loops=False
igraph_compose:
PARAMS: |-
OUT GRAPH res, GRAPH g1, GRAPH g2,
OUT INDEX_VECTOR edge_map1, OUT INDEX_VECTOR edge_map2
DEPS: edge_map1 ON g1, edge_map2 ON g2
igraph_induced_subgraph_map:
PARAMS: |-
GRAPH graph, OUT GRAPH res, VERTEX_SELECTOR vids, SUBGRAPH_IMPL impl=AUTO,
OPTIONAL OUT INDEX_VECTOR map, OPTIONAL OUT INDEX_VECTOR invmap
DEPS: vids ON graph
igraph_mycielskian:
PARAMS: |-
IN GRAPH graph, OUT GRAPH res, INTEGER k=1
igraph_product:
PARAMS: |-
OUT GRAPH res, GRAPH g1, GRAPH g2, GRAPH_PRODUCT_TYPE type=CARTESIAN
igraph_rooted_product:
PARAMS: |-
OUT GRAPH res, GRAPH g1, GRAPH g2, VERTEX root
DEPS: root ON g2
#######################################
# Maximum flows, minimum cuts
#######################################
igraph_gomory_hu_tree:
PARAMS: GRAPH graph, OUT GRAPH tree, OPTIONAL OUT VECTOR flows, OPTIONAL EDGE_CAPACITIES capacity
DEPS: capacity ON graph
igraph_maxflow:
PARAMS: |-
GRAPH graph, OUT REAL value, OPTIONAL OUT VECTOR flow,
OUT EDGE_INDICES cut, OPTIONAL OUT VERTEX_INDICES partition1,
OPTIONAL OUT VERTEX_INDICES partition2, VERTEX source, VERTEX target,
OPTIONAL EDGE_CAPACITIES capacity, OPTIONAL OUT MAXFLOW_STATS stats
DEPS: |-
capacity ON graph, source ON graph, target ON graph,
partition1 ON graph, partition2 ON graph, flow ON graph,
cut ON graph
igraph_maxflow_value:
PARAMS: |-
GRAPH graph, OUT REAL value, VERTEX source, VERTEX target,
OPTIONAL EDGE_CAPACITIES capacity, OPTIONAL OUT MAXFLOW_STATS stats
DEPS: source ON graph, target ON graph, capacity ON graph
igraph_mincut:
PARAMS: |-
GRAPH graph, OUT REAL value, OUT VERTEX_INDICES partition1,
OUT VERTEX_INDICES partition2, OUT EDGE_INDICES cut,
OPTIONAL EDGE_CAPACITIES capacity
DEPS: capacity ON graph, partition1 ON graph, partition2 ON graph, cut ON graph
igraph_mincut_value:
PARAMS: GRAPH graph, OUT REAL res, OPTIONAL EDGE_CAPACITIES capacity
DEPS: capacity ON graph
igraph_residual_graph:
PARAMS: |-
GRAPH graph, EDGE_CAPACITIES capacity, OUT GRAPH residual,
OUT EDGE_CAPACITIES residual_capacity, VECTOR flow
DEPS: capacity ON graph, flow ON graph, residual_capacity ON residual
igraph_reverse_residual_graph:
PARAMS: |-
GRAPH graph, EDGE_CAPACITIES capacity, OUT GRAPH residual,
VECTOR flow
DEPS: capacity ON graph, flow ON graph
igraph_st_mincut:
PARAMS: |-
GRAPH graph, OUT REAL value, OUT EDGE_INDICES cut,
OPTIONAL OUT VERTEX_INDICES partition1,
OPTIONAL OUT VERTEX_INDICES partition2,
VERTEX source, VERTEX target, OPTIONAL EDGE_CAPACITIES capacity
DEPS: |-
capacity ON graph, source ON graph, target ON graph,
partition1 ON graph, partition2 ON graph, cut ON graph
igraph_st_mincut_value:
PARAMS: |-
GRAPH graph, OUT REAL res, VERTEX source, VERTEX target,
OPTIONAL EDGE_CAPACITIES capacity
DEPS: source ON graph, target ON graph, capacity ON graph
igraph_st_vertex_connectivity:
PARAMS: |-
GRAPH graph, OUT INTEGER res, VERTEX source, VERTEX target,
VCONNNEI neighbors=NUMBER_OF_NODES
DEPS: source ON graph, target ON graph
igraph_vertex_connectivity:
PARAMS: GRAPH graph, OUT INTEGER res, BOOLEAN checks=True
igraph_st_edge_connectivity:
PARAMS: GRAPH graph, OUT INTEGER res, VERTEX source, VERTEX target
DEPS: source ON graph, target ON graph
igraph_edge_connectivity:
PARAMS: GRAPH graph, OUT INTEGER res, BOOLEAN checks=True
igraph_edge_disjoint_paths:
PARAMS: GRAPH graph, OUT INTEGER res, VERTEX source, VERTEX target
DEPS: source ON graph, target ON graph
igraph_vertex_disjoint_paths:
PARAMS: GRAPH graph, OUT INTEGER res, VERTEX source, VERTEX target
DEPS: source ON graph, target ON graph
igraph_adhesion:
PARAMS: GRAPH graph, OUT INTEGER res, BOOLEAN checks=True
igraph_cohesion:
PARAMS: GRAPH graph, OUT INTEGER res, BOOLEAN checks=True
#######################################
# Listing s-t cuts, separators
#######################################
igraph_dominator_tree:
PARAMS: |-
GRAPH graph, VERTEX root, OUT INDEX_VECTOR dom,
OPTIONAL OUT GRAPH domtree, OUT VERTEX_INDICES leftout,
NEIMODE mode=OUT
DEPS: root ON graph, leftout ON graph
igraph_all_st_cuts:
PARAMS: |-
GRAPH graph, OPTIONAL OUT EDGE_INDICES_LIST cuts,
OPTIONAL OUT VERTEX_INDICES_LIST partition1s,
VERTEX source, VERTEX target
DEPS: |-
source ON graph, target ON graph, cuts ON graph,
partition1s ON graph
igraph_all_st_mincuts:
PARAMS: |-
GRAPH graph, OUT REAL value,
OPTIONAL OUT EDGE_INDICES_LIST cuts,
OPTIONAL OUT VERTEX_INDICES_LIST partition1s,
VERTEX source, VERTEX target, OPTIONAL EDGE_CAPACITIES capacity
DEPS: |-
capacity ON graph, source ON graph, target ON graph,
cuts ON graph, partition1s ON graph
igraph_even_tarjan_reduction:
PARAMS: GRAPH graph, OUT GRAPH graphbar, OPTIONAL OUT EDGE_CAPACITIES capacity
DEPS: |-
capacity ON graphbar
igraph_is_separator:
PARAMS: GRAPH graph, VERTEX_SELECTOR candidate, OUT BOOLEAN res
DEPS: candidate ON graph
igraph_is_minimal_separator:
PARAMS: GRAPH graph, VERTEX_SELECTOR candidate, OUT BOOLEAN res
DEPS: candidate ON graph
igraph_all_minimal_st_separators:
PARAMS: GRAPH graph, OUT VERTEX_INDICES_LIST separators
DEPS: separators ON graph
igraph_minimum_size_separators:
PARAMS: GRAPH graph, OUT VERTEX_INDICES_LIST separators
DEPS: separators ON graph
igraph_cohesive_blocks:
PARAMS: |-
GRAPH graph, OUT VERTEX_INDICES_LIST blocks,
OUT VECTOR_INT cohesion, OUT INDEX_VECTOR parent,
OUT GRAPH blockTree
DEPS: blocks ON graph
#######################################
# K-Cores
#######################################
igraph_coreness:
PARAMS: GRAPH graph, OUT VECTOR_INT cores, NEIMODE mode=ALL
#######################################
# Graph isomorphism
#######################################
igraph_isoclass:
PARAMS: GRAPH graph, OUT INTEGER isoclass
igraph_isomorphic:
PARAMS: GRAPH graph1, GRAPH graph2, OUT BOOLEAN iso
igraph_automorphism_group:
PARAMS: |-
GRAPH graph, OPTIONAL VERTEX_COLORS colors, OUT VERTEX_INDICES_LIST generators
DEPS: colors ON graph, generators ON graph
igraph_count_automorphisms:
PARAMS: |-
GRAPH graph, OPTIONAL VERTEX_COLORS colors, OUT REAL result
DEPS: colors ON graph
igraph_isoclass_subgraph:
PARAMS: GRAPH graph, VERTEX_SELECTOR vids, OUT INTEGER isoclass
DEPS: vids ON graph
igraph_isoclass_create:
PARAMS: OUT GRAPH graph, INTEGER size, INTEGER number, BOOLEAN directed=True
igraph_isomorphic_vf2:
PARAMS: |-
GRAPH graph1, GRAPH graph2,
OPTIONAL VERTEX_COLORS vertex_color1,
OPTIONAL VERTEX_COLORS vertex_color2,
OPTIONAL EDGE_COLORS edge_color1,
OPTIONAL EDGE_COLORS edge_color2,
OUT BOOLEAN iso,
OPTIONAL OUT INDEX_VECTOR map12, OPTIONAL OUT INDEX_VECTOR map21,
OPTIONAL ISOCOMPAT_FUNC node_compat_fn,
OPTIONAL ISOCOMPAT_FUNC edge_compat_fn,
OPTIONAL EXTRA extra
DEPS: |-
vertex_color1 ON graph1, vertex_color2 ON graph2,
edge_color1 ON graph1, edge_color2 ON graph2
igraph_get_isomorphisms_vf2_callback:
PARAMS: |-
GRAPH graph1, GRAPH graph2,
OPTIONAL VERTEX_COLORS vertex_color1, OPTIONAL VERTEX_COLORS vertex_color2,
OPTIONAL EDGE_COLORS edge_color1, OPTIONAL EDGE_COLORS edge_color2,
OPTIONAL OUT INDEX_VECTOR map12, OPTIONAL OUT INDEX_VECTOR map21,
ISOMORPHISM_FUNC ishohandler_fn,
OPTIONAL ISOCOMPAT_FUNC node_compat_fn,
OPTIONAL ISOCOMPAT_FUNC edge_compat_fn,
OPTIONAL EXTRA arg
DEPS: |-
vertex_color1 ON graph1, vertex_color2 ON graph2,
edge_color1 ON graph1, edge_color2 ON graph2
igraph_count_isomorphisms_vf2:
PARAMS: |-
GRAPH graph1, GRAPH graph2,
OPTIONAL VERTEX_COLORS vertex_color1, OPTIONAL VERTEX_COLORS vertex_color2,
OPTIONAL EDGE_COLORS edge_color1, OPTIONAL EDGE_COLORS edge_color2,
OUT INTEGER count,
OPTIONAL ISOCOMPAT_FUNC node_compat_fn,
OPTIONAL ISOCOMPAT_FUNC edge_compat_fn,
OPTIONAL EXTRA extra
DEPS: |-
vertex_color1 ON graph1, vertex_color2 ON graph2,
edge_color1 ON graph1, edge_color2 ON graph2
igraph_get_isomorphisms_vf2:
PARAMS: |-
GRAPH graph1, GRAPH graph2,
OPTIONAL VERTEX_COLORS vertex_color1, OPTIONAL VERTEX_COLORS vertex_color2,
OPTIONAL EDGE_COLORS edge_color1, OPTIONAL EDGE_COLORS edge_color2,
OUT VECTOR_INT_LIST maps,
OPTIONAL ISOCOMPAT_FUNC node_compat_fn,
OPTIONAL ISOCOMPAT_FUNC edge_compat_fn,
OPTIONAL EXTRA extra
DEPS: |-
vertex_color1 ON graph1, vertex_color2 ON graph2,
edge_color1 ON graph1, edge_color2 ON graph2
igraph_subisomorphic:
PARAMS: GRAPH graph1, GRAPH graph2, OUT BOOLEAN iso
igraph_subisomorphic_vf2:
PARAMS: |-
GRAPH graph1, GRAPH graph2,
OPTIONAL VERTEX_COLORS vertex_color1, OPTIONAL VERTEX_COLORS vertex_color2,
OPTIONAL EDGE_COLORS edge_color1, OPTIONAL EDGE_COLORS edge_color2,
OUT BOOLEAN iso,
OPTIONAL OUT INDEX_VECTOR map12, OPTIONAL OUT INDEX_VECTOR map21,
OPTIONAL ISOCOMPAT_FUNC node_compat_fn,
OPTIONAL ISOCOMPAT_FUNC edge_compat_fn,
OPTIONAL EXTRA extra
DEPS: |-
vertex_color1 ON graph1, vertex_color2 ON graph2,
edge_color1 ON graph1, edge_color2 ON graph2
igraph_get_subisomorphisms_vf2_callback:
PARAMS: |-
GRAPH graph1, GRAPH graph2,
OPTIONAL VERTEX_COLORS vertex_color1, OPTIONAL VERTEX_COLORS vertex_color2,
OPTIONAL EDGE_COLORS edge_color1, OPTIONAL EDGE_COLORS edge_color2,
OPTIONAL OUT INDEX_VECTOR map12, OPTIONAL OUT INDEX_VECTOR map21,
ISOMORPHISM_FUNC ishohandler_fn,
OPTIONAL ISOCOMPAT_FUNC node_compat_fn,
OPTIONAL ISOCOMPAT_FUNC edge_compat_fn,
OPTIONAL EXTRA arg
DEPS: |-
vertex_color1 ON graph1, vertex_color2 ON graph2,
edge_color1 ON graph1, edge_color2 ON graph2
igraph_count_subisomorphisms_vf2:
PARAMS: |-
GRAPH graph1, GRAPH graph2,
OPTIONAL VERTEX_COLORS vertex_color1, OPTIONAL VERTEX_COLORS vertex_color2,
OPTIONAL EDGE_COLORS edge_color1, OPTIONAL EDGE_COLORS edge_color2,
OUT INTEGER count,
OPTIONAL ISOCOMPAT_FUNC node_compat_fn,
OPTIONAL ISOCOMPAT_FUNC edge_compat_fn,
OPTIONAL EXTRA extra
DEPS: |-
vertex_color1 ON graph1, vertex_color2 ON graph2,
edge_color1 ON graph1, edge_color2 ON graph2
igraph_get_subisomorphisms_vf2:
PARAMS: |-
GRAPH graph1, GRAPH graph2,
OPTIONAL VERTEX_COLORS vertex_color1, OPTIONAL VERTEX_COLORS vertex_color2,
OPTIONAL EDGE_COLORS edge_color1, OPTIONAL EDGE_COLORS edge_color2,
OUT VECTOR_INT_LIST maps,
OPTIONAL ISOCOMPAT_FUNC node_compat_fn,
OPTIONAL ISOCOMPAT_FUNC edge_compat_fn,
OPTIONAL EXTRA extra
DEPS: |-
vertex_color1 ON graph1, vertex_color2 ON graph2,
edge_color1 ON graph1, edge_color2 ON graph2
igraph_canonical_permutation:
PARAMS: |-
GRAPH graph, OPTIONAL VERTEX_COLORS colors,
OUT INDEX_VECTOR labeling
DEPS: colors ON graph
igraph_canonical_permutation_bliss:
PARAMS: |-
GRAPH graph, OPTIONAL VERTEX_COLORS colors,
OUT INDEX_VECTOR labeling, BLISSSH sh="fm", OUT BLISSINFO info
DEPS: colors ON graph
igraph_permute_vertices:
PARAMS: GRAPH graph, OUT GRAPH res, INDEX_VECTOR permutation
igraph_isomorphic_bliss:
PARAMS: |-
GRAPH graph1, GRAPH graph2,
OPTIONAL VERTEX_COLORS colors1, OPTIONAL VERTEX_COLORS colors2,
OUT BOOLEAN iso, OPTIONAL OUT INDEX_VECTOR map12,
OPTIONAL OUT INDEX_VECTOR map21, BLISSSH sh="fm",
OPTIONAL OUT BLISSINFO info1, OPTIONAL OUT BLISSINFO info2
DEPS: colors1 ON graph1, colors2 ON graph2
igraph_count_automorphisms_bliss:
PARAMS: |-
GRAPH graph, OPTIONAL VERTEX_COLORS colors, BLISSSH sh="fm", OUT BLISSINFO info
DEPS: colors ON graph
igraph_automorphism_group_bliss:
PARAMS: |-
GRAPH graph, OPTIONAL VERTEX_COLORS colors, PRIMARY OUT VERTEX_INDICES_LIST generators,
BLISSSH sh="fm", OUT BLISSINFO info
DEPS: colors ON graph, generators ON graph
igraph_subisomorphic_lad:
PARAMS: |-
GRAPH pattern, GRAPH target, OPTIONAL VERTEX_INDICES_LIST domains,
OPTIONAL OUT BOOLEAN iso, OUT INDEX_VECTOR map,
OPTIONAL OUT VECTOR_INT_LIST maps, BOOLEAN induced
igraph_simplify_and_colorize:
# Despite their names, vertex_color and edge_color are not really colors
# but _multiplicities_, so we simply use VECTOR_INT there
PARAMS: |-
GRAPH graph, OUT GRAPH res, OUT VECTOR_INT vertex_color, OUT VECTOR_INT edge_color
DEPS: vertex_color ON graph, edge_color ON graph
igraph_graph_count:
PARAMS: INTEGER n, BOOLEAN directed=False, OUT INTEGER count
#######################################
# Matching
#######################################
igraph_is_matching:
PARAMS: |-
GRAPH graph, OPTIONAL BIPARTITE_TYPES types,
INDEX_VECTOR matching, OUT BOOLEAN res
DEPS: types ON graph, matching ON graph
igraph_is_maximal_matching:
PARAMS: |-
GRAPH graph, OPTIONAL BIPARTITE_TYPES types,
INDEX_VECTOR matching, OUT BOOLEAN res
DEPS: types ON graph
igraph_maximum_bipartite_matching:
PARAMS: |-
GRAPH graph, BIPARTITE_TYPES types,
OPTIONAL OUT INTEGER matching_size,
OPTIONAL OUT REAL matching_weight,
OUT INDEX_VECTOR matching,
OPTIONAL EDGE_WEIGHTS weights, REAL eps=.Machine$double.eps
DEPS: types ON graph, weights ON graph
#######################################
# Embedding
#######################################
igraph_adjacency_spectral_embedding:
PARAMS: |-
GRAPH graph, INTEGER no, OPTIONAL EDGE_WEIGHTS weights,
EIGENWHICHPOS which=ASE, BOOLEAN scaled=True, OUT MATRIX X,
OPTIONAL OUT MATRIX Y, OPTIONAL OUT VECTOR D,
VECTOR cvec=AsmDefaultCvec,
INOUT ARPACK_OPTIONS options=ARPACK_DEFAULTS
DEPS: weights ON graph, cvec ON graph
igraph_laplacian_spectral_embedding:
PARAMS: |-
GRAPH graph, INTEGER no, OPTIONAL EDGE_WEIGHTS weights,
EIGENWHICHPOS which=ASE,
LSETYPE type=Default, BOOLEAN scaled=True, OUT MATRIX X,
OPTIONAL OUT MATRIX Y, OPTIONAL OUT VECTOR D,
INOUT ARPACK_OPTIONS options=ARPACK_DEFAULTS
DEPS: weights ON graph, type ON graph
#######################################
# Eigensolvers
#######################################
igraph_eigen_adjacency:
PARAMS: |-
GRAPH graph, EIGENALGO algorithm=ARPACK,
EIGENWHICH which=Default,
INOUT ARPACK_OPTIONS options=ARPACK_DEFAULTS,
INOUT ARPACK_STORAGE storage, OUT VECTOR values, OUT MATRIX vectors,
OUT VECTOR_COMPLEX cmplxvalues, OUT MATRIX_COMPLEX cmplxvectors
#######################################
# Fitting power laws
#######################################
igraph_power_law_fit:
PARAMS: |-
VECTOR data, OUT PLFIT res, REAL xmin=-1,
BOOLEAN force_continuous=False
#######################################
# Dynamics, on networks
#######################################
igraph_sir:
PARAMS: |-
GRAPH graph, REAL beta, REAL gamma, INTEGER no_sim=100,
OUT SIR_LIST res
#######################################
# Other, not graph related
#######################################
igraph_running_mean:
PARAMS: VECTOR data, OUT VECTOR res, INTEGER binwidth
igraph_random_sample:
PARAMS: OUT VECTOR_INT res, INTEGER l, INTEGER h, INTEGER length
igraph_convex_hull_2d:
PARAMS: MATRIX data, OUT INDEX_VECTOR resverts, OUT MATRIX rescoords
igraph_dim_select:
PARAMS: VECTOR sv, OUT INTEGER dim
igraph_almost_equals:
PARAMS: DOUBLE a, DOUBLE b, DOUBLE eps
RETURN: BOOLEAN
igraph_cmp_epsilon:
PARAMS: DOUBLE a, DOUBLE b, DOUBLE eps
RETURN: INT
igraph_eigen_matrix:
PARAMS: |-
MATRIX A, SPARSEMAT sA, ARPACK_FUNC fun, INT n, OPTIONAL EXTRA extra,
EIGENALGO algorithm, EIGENWHICH which, INOUT ARPACK_OPTIONS options=ARPACK_DEFAULTS,
INOUT ARPACK_STORAGE storage, OUT VECTOR_COMPLEX values, OUT MATRIX_COMPLEX vectors
igraph_eigen_matrix_symmetric:
PARAMS: |-
MATRIX A, SPARSEMAT sA, ARPACK_FUNC fun, INT n, OPTIONAL EXTRA extra,
EIGENALGO algorithm, EIGENWHICH which, INOUT ARPACK_OPTIONS options=ARPACK_DEFAULTS,
INOUT ARPACK_STORAGE storage, OUT VECTOR values, OUT MATRIX vectors
igraph_solve_lsap:
PARAMS: MATRIX c, INTEGER n, OUT VECTOR_INT p
#######################################
# Finding cycles
#######################################
igraph_find_cycle:
PARAMS: |-
GRAPH graph, OPTIONAL OUT VERTEX_INDICES vertices, OPTIONAL OUT EDGE_INDICES edges,
NEIMODE mode=OUT
DEPS: vertices ON graph, edges ON graph
igraph_simple_cycles:
PARAMS: |-
GRAPH graph,
OPTIONAL OUT VERTEX_INDICES_LIST vertices, OPTIONAL OUT EDGE_INDICES_LIST edges,
NEIMODE mode=OUT, INTEGER min_cycle_length=UNLIMITED, INTEGER max_cycle_length=UNLIMITED,
INTEGER max_results=UNLIMITED
DEPS: vertices ON graph, edges ON graph
igraph_simple_cycles_callback:
PARAMS: |-
GRAPH graph,
NEIMODE mode=OUT, INTEGER min_cycle_length=UNLIMITED, INTEGER max_cycle_length=UNLIMITED,
CYCLE_FUNC cycle_handler, OPTIONAL EXTRA arg
#######################################
# Eulerian functions
#######################################
igraph_is_eulerian:
PARAMS: GRAPH graph, OUT BOOLEAN has_path, OUT BOOLEAN has_cycle
igraph_eulerian_path:
PARAMS: GRAPH graph, OPTIONAL OUT EDGE_INDICES edge_res, OPTIONAL OUT VERTEX_INDICES vertex_res
DEPS: edge_res ON graph, vertex_res ON graph
igraph_eulerian_cycle:
PARAMS: GRAPH graph, OPTIONAL OUT EDGE_INDICES edge_res, OPTIONAL OUT VERTEX_INDICES vertex_res
DEPS: edge_res ON graph, vertex_res ON graph
#######################################
# Cycle bases
#######################################
igraph_fundamental_cycles:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT EDGE_INDICES_LIST basis,
OPTIONAL VERTEX start,
REAL bfs_cutoff=UNLIMITED
DEPS: weights ON graph, basis ON graph, start ON graph
igraph_minimum_cycle_basis:
PARAMS: |-
GRAPH graph, OPTIONAL EDGE_WEIGHTS weights,
OUT EDGE_INDICES_LIST basis,
REAL bfs_cutoff=UNLIMITED,
BOOLEAN complete=True, BOOLEAN use_cycle_order=True
DEPS: weights ON graph, basis ON graph
#######################################
# Trees
#######################################
igraph_is_tree:
PARAMS: GRAPH graph, PRIMARY OUT BOOLEAN res, OPTIONAL OUT VERTEX root, NEIMODE mode=OUT
DEPS: root ON graph
igraph_is_forest:
PARAMS: GRAPH graph, PRIMARY OUT BOOLEAN res, OPTIONAL OUT VERTEX_INDICES roots, NEIMODE mode=OUT
DEPS: roots ON graph
igraph_from_prufer:
PARAMS: OUT GRAPH graph, INDEX_VECTOR prufer
igraph_to_prufer:
PARAMS: GRAPH graph, OUT INDEX_VECTOR prufer
igraph_tree_from_parent_vector:
PARAMS: OUT GRAPH graph, INDEX_VECTOR parents, TREE_MODE type=OUT
igraph_is_complete:
PARAMS: GRAPH graph, OUT BOOLEAN res
igraph_minimum_spanning_tree:
PARAMS: GRAPH graph, OUT EDGE_INDICES res, OPTIONAL EDGE_WEIGHTS weights, MSTALGORITHM method=AUTOMATIC
DEPS: res ON graph, weights ON graph
igraph_random_spanning_tree:
PARAMS: GRAPH graph, OUT EDGE_INDICES res, OPTIONAL VERTEX vid
DEPS: res ON graph, vid ON graph
igraph_tree_game:
PARAMS: OUT GRAPH graph, INTEGER n, BOOLEAN directed=False, RANDOM_TREE_METHOD method=LERW
#######################################
# Spatial
#######################################
igraph_nearest_neighbor_graph:
PARAMS: OUT GRAPH graph, MATRIX points, METRIC metric, INTEGER neighbors, REAL cutoff, BOOLEAN directed
igraph_delaunay_graph:
PARAMS: OUT GRAPH graph, MATRIX points
igraph_gabriel_graph:
PARAMS: OUT GRAPH graph, MATRIX points
igraph_relative_neighborhood_graph:
PARAMS: OUT GRAPH graph, MATRIX points
igraph_lune_beta_skeleton:
PARAMS: OUT GRAPH graph, MATRIX points, REAL beta=1
igraph_circle_beta_skeleton:
PARAMS: OUT GRAPH graph, MATRIX points, REAL beta=1
igraph_beta_weighted_gabriel_graph:
PARAMS: OUT GRAPH graph, OUT EDGE_WEIGHTS weights, MATRIX points, REAL max_beta=UNLIMITED
DEPS: weights ON graph
igraph_spatial_edge_lengths:
PARAMS: GRAPH graph, OUT EDGE_LENGTHS lengths, MATRIX points, METRIC METRIC
DEPS: lengths ON graph
#######################################
# Coloring
#######################################
igraph_vertex_coloring_greedy:
PARAMS: GRAPH graph, OUT VERTEX_COLORS colors, GREEDY_COLORING_HEURISTIC heuristic=NEIGHBORS
DEPS: colors ON graph
igraph_is_vertex_coloring:
PARAMS: GRAPH graph, VERTEX_COLORS types, OUT BOOLEAN res
DEPS: types ON graph
igraph_is_bipartite_coloring:
PARAMS: GRAPH graph, BIPARTITE_TYPES types, OUT BOOLEAN res, OPTIONAL OUT NEIMODE mode
DEPS: types ON graph
igraph_is_edge_coloring:
PARAMS: GRAPH graph, EDGE_COLORS types, OUT BOOLEAN res
DEPS: types ON graph
#######################################
# Other, (yet) undocumented functions
#######################################
igraph_convergence_degree:
PARAMS: GRAPH graph, OUT VECTOR result, OUT VECTOR in, OUT VECTOR out
igraph_has_attribute_table:
RETURN: BOOLEAN
#######################################
# Progress, status handling
#######################################
igraph_progress:
PARAMS: CSTRING message, REAL percent, OPTIONAL EXTRA data
igraph_status:
PARAMS: CSTRING message, OPTIONAL EXTRA data
igraph_strerror:
PARAMS: ERROR igraph_errno
RETURN: CSTRING
#######################################
# Other functions, documented, graph related
#######################################
igraph_expand_path_to_pairs:
PARAMS: INOUT VERTEX_INDICES path
igraph_invalidate_cache:
PARAMS: GRAPH graph
RETURN: VOID
igraph_vertex_path_from_edge_path:
PARAMS: |-
GRAPH graph, OPTIONAL VERTEX start, EDGE_INDICES edge_path,
OUT VERTEX_INDICES vertex_path, NEIMODE mode=OUT
#######################################
# Meta info
#######################################
igraph_version:
PARAMS: |-
OPTIONAL OUT CSTRING version_string, OPTIONAL OUT INT major,
OPTIONAL OUT INT minor, OPTIONAL OUT INT subminor
RETURN: VOID