feat: started adding support for attribute combinations, work in progres

Author: ntamas

src/codegen/internal_functions.py.in

@@ -8,6 +8,7 @@ from .conversion import *  # noqa
 from .enums import *  # noqa
 from .lib import *  # noqa
 from .types import (
+    AttributeCombinationSpecification,
     BoolArray,
     EdgeLike,
     EdgeSelector,

src/codegen/internal_lib.py.in

@@ -34,6 +34,7 @@ from .types import (
     igraph_bliss_info_t,
     igraph_error_handler_t,
     igraph_fatal_handler_t,
+    igraph_function_pointer_t,
     igraph_hrg_t,
     igraph_layout_drl_options_t,
     igraph_maxflow_stats_t,
@@ -535,6 +536,22 @@ igraph_set_attribute_table = _lib.igraph_set_attribute_table
 igraph_set_attribute_table.restype = POINTER(igraph_attribute_table_t)
 igraph_set_attribute_table.argtypes = [POINTER(igraph_attribute_table_t)]
 
+igraph_attribute_combination_init = _lib.igraph_attribute_combination_init
+igraph_attribute_combination_init.restype = handle_igraph_error_t
+igraph_attribute_combination_init.argtypes = [POINTER(igraph_attribute_combination_t)]
+
+igraph_attribute_combination_destroy = _lib.igraph_attribute_combination_destroy
+igraph_attribute_combination_destroy.restype = None
+igraph_attribute_combination_destroy.argtypes = [POINTER(igraph_attribute_combination_t)]
+
+igraph_attribute_combination_add = _lib.igraph_attribute_combination_add
+igraph_attribute_combination_add.restype = handle_igraph_error_t
+igraph_attribute_combination_add.argtypes = [POINTER(igraph_attribute_combination_t), c_char_p, c_int, igraph_function_pointer_t]
+
+igraph_attribute_combination_query = _lib.igraph_attribute_combination_query
+igraph_attribute_combination_query.restype = handle_igraph_error_t
+igraph_attribute_combination_query.argtypes = [POINTER(igraph_attribute_combination_t), c_char_p, POINTER(c_int), POINTER(igraph_function_pointer_t)]
+
 # Error handling and interruptions
 
 igraph_error = _lib.igraph_error

src/codegen/types.yaml

@@ -1,3 +1,5 @@
+# Basic types
+
 ERROR:
   PY_TYPE: int
   CTYPES_RETURN_TYPE: handle_igraph_error_t
@@ -35,6 +37,8 @@ CSTRING:
     OUT: "%C% = c_char_p()"
   OUTCONV: "%I% = bytes_to_str(%C%)"
 
+# Vectors, matrices
+
 VECTOR:
   PY_TYPE: Iterable[float]
   PY_RETURN_TYPE: RealArray
@@ -91,6 +95,8 @@ MATRIX_INT:
     OUT: "%C% = _MatrixInt.create(0)"
   OUTCONV: "%I% = igraph_matrix_int_t_to_numpy_array(%C%)"
 
+# Graph, vertex and edge related classes
+
 GRAPH:
   PY_TYPE: Graph
   INCONV:
@@ -100,9 +106,6 @@ GRAPH:
       %I% = _create_graph_from_boxed(%C%)
     INOUT: ~
 
-ATTRIBUTES:
-  PY_TYPE: ~
-
 VERTEX:
   PY_TYPE: VertexLike
   PY_RETURN_TYPE: int
@@ -233,6 +236,27 @@ BIPARTITE_TYPES:
     INOUT: "%C% = iterable_to_igraph_vector_bool_t(%I%) if %I% is not None else None"
     OUT: "%C% = _VectorBool.create(0)"
 
+# Attribute handling
+
+ATTRIBUTES:
+  PY_TYPE: ~
+
+EDGE_ATTRIBUTE_COMBINATION:
+  PY_TYPE: AttributeCombinationSpecification
+  INCONV:
+    IN: "%C% = mapping_to_attribute_combination_t(%I%)"
+  DEFAULT:
+    Default: "None"
+
+VERTEX_ATTRIBUTE_COMBINATION:
+  PY_TYPE: AttributeCombinationSpecification
+  INCONV:
+    IN: "%C% = mapping_to_attribute_combination_t(%I%)"
+  DEFAULT:
+    Default: "None"
+
+# File I/O
+
 INFILE:
   PY_TYPE: FileLike
   PY_RETURN_TYPE: c_int
@@ -247,6 +271,8 @@ OUTFILE:
     IN: '%C% = %S%.enter_context(any_to_file_ptr(%I%, "w"))'
   FLAGS: stack
 
+# Enums
+
 ADJACENCY_MODE:
   PY_TYPE: AdjacencyMode
   INCONV:
@@ -362,6 +388,16 @@ TRANSITIVITY_MODE:
   INCONV:
     IN: "%C% = c_int(%I%)"
 
+TODIRECTED:
+  PY_TYPE: ToDirected
+  INCONV:
+    IN: "%C% = c_int(%I%)"
+
+TOUNDIRECTED:
+  PY_TYPE: ToUndirected
+  INCONV:
+    IN: "%C% = c_int(%I%)"
+
 TREE_MODE:
   PY_TYPE: TreeMode
   INCONV:

src/igraph_ctypes/_internal/conversion.py

@@ -7,13 +7,23 @@
 from contextlib import contextmanager
 from ctypes import addressof, get_errno, memmove, POINTER
 from os import strerror
-from typing import Any, IO, Iterable, Iterator, Optional, Sequence, TYPE_CHECKING
+from typing import (
+    Any,
+    Callable,
+    IO,
+    Iterable,
+    Iterator,
+    Optional,
+    Sequence,
+    TYPE_CHECKING,
+)
 
 from .attributes.utils import python_type_to_igraph_attribute_type
-from .enums import MatrixStorage
+from .enums import AttributeCombinationType, MatrixStorage
 from .lib import (
     fdopen,
     fflush,
+    igraph_attribute_combination_add,
     igraph_es_all,
     igraph_es_none,
     igraph_es_vector_copy,
@@ -62,6 +72,8 @@
     np_type_of_igraph_bool_t,
     np_type_of_igraph_integer_t,
     np_type_of_igraph_real_t,
+    AttributeCombinationSpecification,
+    AttributeCombinationSpecificationEntry,
     BoolArray,
     EdgeLike,
     EdgeSelector,
@@ -76,6 +88,7 @@
 )
 from .utils import bytes_to_str
 from .wrappers import (
+    _AttributeCombination,
     _EdgeSelector,
     _Matrix,
     _MatrixInt,
@@ -130,6 +143,7 @@
     "iterable_to_igraph_vector_t",
     "iterable_to_igraph_vector_t_view",
     "iterable_vertex_indices_to_igraph_vector_int_t",
+    "mapping_to_attribute_combination_t",
     "python_type_to_igraph_attribute_type",
     "sequence_to_igraph_matrix_int_t",
     "sequence_to_igraph_matrix_int_t_view",
@@ -442,6 +456,33 @@ def iterable_of_vertex_index_iterable_to_igraph_vector_int_list_t(
     return iterable_of_iterable_to_igraph_vector_int_list_t(items)
 
 
+def _any_to_attribute_combination_type_and_func(
+    value: AttributeCombinationSpecificationEntry,
+) -> tuple[AttributeCombinationType, Callable | None]:
+    if callable(value):
+        # TODO(ntamas): need a Python-to-C wrapper around value!
+        return AttributeCombinationType.FUNCTION, value
+    else:
+        return AttributeCombinationType.from_(value), None
+
+
+def mapping_to_attribute_combination_t(
+    mapping: Optional[AttributeCombinationSpecification],
+) -> _AttributeCombination:
+    """Converts a Python mapping from attribute names to attribute combination
+    handlers to a low-level igraph attribute combination object.
+    """
+    result = _AttributeCombination.create()
+
+    for key, value in (mapping or {}).items():
+        combination_type, func = _any_to_attribute_combination_type_and_func(value)
+        igraph_attribute_combination_add(
+            result, key.encode("utf-8"), combination_type.value, func
+        )
+
+    return result
+
+
 def sequence_to_igraph_matrix_int_t(items: MatrixIntLike) -> _MatrixInt:
     """Converts a sequence of sequences of Python integers to an igraph matrix
     of integers. Each sequence in the top-level sequence must have the same

src/igraph_ctypes/_internal/functions.py

@@ -8,6 +8,7 @@
 from .enums import *  # noqa
 from .lib import *  # noqa
 from .types import (
+    AttributeCombinationSpecification,
     BoolArray,
     EdgeLike,
     EdgeSelector,
@@ -2391,7 +2392,17 @@ def path_length_hist(graph: Graph, directed: bool = True) -> tuple[RealArray, fl
     # Construct return value
     return res, unconnected
 
-# igraph_simplify: no Python type known for type: EDGE_ATTRIBUTE_COMBINATION
+
+def simplify(graph: Graph, remove_multiple: bool = True, remove_loops: bool = True, edge_attr_comb: Optional[AttributeCombinationSpecification] = None) -> None:
+    """Type-annotated wrapper for ``igraph_simplify``."""
+    # Prepare input arguments
+    c_graph = graph
+    c_remove_multiple = any_to_igraph_bool_t(remove_multiple)
+    c_remove_loops = any_to_igraph_bool_t(remove_loops)
+    c_edge_attr_comb = mapping_to_attribute_combination_t(edge_attr_comb)
+
+    # Call wrapped function
+    igraph_simplify(c_graph, c_remove_multiple, c_remove_loops, c_edge_attr_comb)
 
 
 def transitivity_undirected(graph: Graph, mode: TransitivityMode = TransitivityMode.NAN) -> float:
@@ -3167,7 +3178,16 @@ def assortativity_degree(graph: Graph, directed: bool = True) -> float:
     # Construct return value
     return res
 
-# igraph_contract_vertices: no Python type known for type: VERTEX_ATTRIBUTE_COMBINATION
+
+def contract_vertices(graph: Graph, mapping: Iterable[int], vertex_attr_comb: Optional[AttributeCombinationSpecification] = None) -> None:
+    """Type-annotated wrapper for ``igraph_contract_vertices``."""
+    # Prepare input arguments
+    c_graph = graph
+    c_mapping = iterable_to_igraph_vector_int_t_view(mapping)
+    c_vertex_attr_comb = mapping_to_attribute_combination_t(vertex_attr_comb)
+
+    # Call wrapped function
+    igraph_contract_vertices(c_graph, c_mapping, c_vertex_attr_comb)
 
 
 def eccentricity(graph: Graph, vids: VertexSelector = "all", mode: NeighborMode = NeighborMode.ALL) -> RealArray:
@@ -3837,6 +3857,9 @@ def maximal_cliques_subset(graph: Graph, subset: Iterable[VertexLike], outfile:
         # Construct return value
         return res, no
 
+    # Help the type checker to figure out that we never get here
+    assert False, "unreachable"  # noqa: B011
+
 # igraph_maximal_cliques_callback: no Python type known for type: CLIQUE_FUNC
 
 
@@ -4961,9 +4984,26 @@ def get_stochastic(graph: Graph, column_wise: bool = False, weights: Optional[It
 
 # igraph_get_stochastic_sparse: no Python type known for type: SPARSEMAT
 
-# igraph_to_directed: no Python type known for type: TODIRECTED
 
-# igraph_to_undirected: no Python type known for type: TOUNDIRECTED
+def to_directed(graph: Graph, mode: ToDirected = ToDirected.MUTUAL) -> None:
+    """Type-annotated wrapper for ``igraph_to_directed``."""
+    # Prepare input arguments
+    c_graph = graph
+    c_mode = c_int(mode)
+
+    # Call wrapped function
+    igraph_to_directed(c_graph, c_mode)
+
+
+def to_undirected(graph: Graph, mode: ToUndirected = ToUndirected.COLLAPSE, edge_attr_comb: Optional[AttributeCombinationSpecification] = None) -> None:
+    """Type-annotated wrapper for ``igraph_to_undirected``."""
+    # Prepare input arguments
+    c_graph = graph
+    c_mode = c_int(mode)
+    c_edge_attr_comb = mapping_to_attribute_combination_t(edge_attr_comb)
+
+    # Call wrapped function
+    igraph_to_undirected(c_graph, c_mode, c_edge_attr_comb)
 
 
 def read_graph_edgelist(instream: FileLike, n: int = 0, directed: bool = True) -> Graph:
@@ -4986,6 +5026,9 @@ def read_graph_edgelist(instream: FileLike, n: int = 0, directed: bool = True) -
         # Construct return value
         return graph
 
+    # Help the type checker to figure out that we never get here
+    assert False, "unreachable"  # noqa: B011
+
 # igraph_read_graph_ncol: no Python type known for type: VECTOR_STR
 
 # igraph_read_graph_lgl: no Python type known for type: ADD_WEIGHTS
@@ -5009,6 +5052,9 @@ def read_graph_pajek(instream: FileLike) -> Graph:
         # Construct return value
         return graph
 
+    # Help the type checker to figure out that we never get here
+    assert False, "unreachable"  # noqa: B011
+
 
 def read_graph_graphml(instream: FileLike, index: int = 0) -> Graph:
     """Type-annotated wrapper for ``igraph_read_graph_graphml``."""
@@ -5029,6 +5075,9 @@ def read_graph_graphml(instream: FileLike, index: int = 0) -> Graph:
         # Construct return value
         return graph
 
+    # Help the type checker to figure out that we never get here
+    assert False, "unreachable"  # noqa: B011
+
 # igraph_read_graph_dimacs_flow: no Python type known for type: VECTOR_STR
 
 
@@ -5051,6 +5100,9 @@ def read_graph_graphdb(instream: FileLike, directed: bool = False) -> Graph:
         # Construct return value
         return graph
 
+    # Help the type checker to figure out that we never get here
+    assert False, "unreachable"  # noqa: B011
+
 
 def read_graph_gml(instream: FileLike) -> Graph:
     """Type-annotated wrapper for ``igraph_read_graph_gml``."""
@@ -5070,6 +5122,9 @@ def read_graph_gml(instream: FileLike) -> Graph:
         # Construct return value
         return graph
 
+    # Help the type checker to figure out that we never get here
+    assert False, "unreachable"  # noqa: B011
+
 
 def read_graph_dl(instream: FileLike, directed: bool = True) -> Graph:
     """Type-annotated wrapper for ``igraph_read_graph_dl``."""
@@ -5090,6 +5145,9 @@ def read_graph_dl(instream: FileLike, directed: bool = True) -> Graph:
         # Construct return value
         return graph
 
+    # Help the type checker to figure out that we never get here
+    assert False, "unreachable"  # noqa: B011
+
 
 def write_graph_edgelist(graph: Graph, outstream: FileLike) -> None:
     """Writes the graph in plain edge list format to an output stream.

src/igraph_ctypes/_internal/lib.py

@@ -34,6 +34,7 @@
     igraph_bliss_info_t,
     igraph_error_handler_t,
     igraph_fatal_handler_t,
+    igraph_function_pointer_t,
     igraph_hrg_t,
     igraph_layout_drl_options_t,
     igraph_maxflow_stats_t,
@@ -535,6 +536,22 @@ def _load_libc():
 igraph_set_attribute_table.restype = POINTER(igraph_attribute_table_t)
 igraph_set_attribute_table.argtypes = [POINTER(igraph_attribute_table_t)]
 
+igraph_attribute_combination_init = _lib.igraph_attribute_combination_init
+igraph_attribute_combination_init.restype = handle_igraph_error_t
+igraph_attribute_combination_init.argtypes = [POINTER(igraph_attribute_combination_t)]
+
+igraph_attribute_combination_destroy = _lib.igraph_attribute_combination_destroy
+igraph_attribute_combination_destroy.restype = None
+igraph_attribute_combination_destroy.argtypes = [POINTER(igraph_attribute_combination_t)]
+
+igraph_attribute_combination_add = _lib.igraph_attribute_combination_add
+igraph_attribute_combination_add.restype = handle_igraph_error_t
+igraph_attribute_combination_add.argtypes = [POINTER(igraph_attribute_combination_t), c_char_p, c_int, igraph_function_pointer_t]
+
+igraph_attribute_combination_query = _lib.igraph_attribute_combination_query
+igraph_attribute_combination_query.restype = handle_igraph_error_t
+igraph_attribute_combination_query.argtypes = [POINTER(igraph_attribute_combination_t), c_char_p, POINTER(c_int), POINTER(igraph_function_pointer_t)]
+
 # Error handling and interruptions
 
 igraph_error = _lib.igraph_error