feat: conversion of vertex and edge set lists is now supported

Author: ntamas

src/codegen/internal_functions.py.in

@@ -1,6 +1,6 @@
 import numpy.typing as npt
 
-from typing import Any, Iterable, Optional, Tuple
+from typing import Any, Iterable, List, Optional, Tuple
 
 from .conversion import *  # noqa
 from .enums import *  # noqa
@@ -17,7 +17,15 @@ from .types import (
     np_type_of_igraph_integer_t,
     np_type_of_igraph_real_t,
 )
-from .wrappers import _Graph, _Matrix, _MatrixInt, _Vector, _VectorBool, _VectorInt
+from .wrappers import (
+    _Graph,
+    _Matrix,
+    _MatrixInt,
+    _Vector,
+    _VectorBool,
+    _VectorInt,
+    _VectorIntList
+)
 
 # fmt: off
 # flake8: noqa: E743

src/codegen/internal_lib.py.in

@@ -260,6 +260,50 @@ igraph_matrix_int_e_ptr = _lib.igraph_matrix_int_e_ptr
 igraph_matrix_int_e_ptr.restype = POINTER(igraph_integer_t)
 igraph_matrix_int_e_ptr.argtypes = [POINTER(igraph_matrix_int_t), igraph_integer_t, igraph_integer_t]
 
+# List of vectors type
+
+igraph_vector_list_init = _lib.igraph_vector_list_init
+igraph_vector_list_init.restype = handle_igraph_error_t
+igraph_vector_list_init.argtypes = [POINTER(igraph_vector_list_t), igraph_integer_t]
+
+igraph_vector_list_destroy = _lib.igraph_vector_list_destroy
+igraph_vector_list_destroy.restype = None
+igraph_vector_list_destroy.argtypes = [c_void_p]
+
+igraph_vector_list_get_ptr = _lib.igraph_vector_list_get_ptr
+igraph_vector_list_get_ptr.restype = POINTER(igraph_vector_t)
+igraph_vector_list_get_ptr.argtypes = [POINTER(igraph_vector_list_t), igraph_integer_t]
+
+igraph_vector_list_push_back = _lib.igraph_vector_list_push_back
+igraph_vector_list_push_back.restype = handle_igraph_error_t
+igraph_vector_list_push_back.argtypes = [POINTER(igraph_vector_list_t), POINTER(igraph_vector_t)]
+
+igraph_vector_list_size = _lib.igraph_vector_list_size
+igraph_vector_list_size.restype = igraph_integer_t
+igraph_vector_list_size.argtypes = [POINTER(igraph_vector_list_t)]
+
+# List of integer vectors type
+
+igraph_vector_int_list_init = _lib.igraph_vector_int_list_init
+igraph_vector_int_list_init.restype = handle_igraph_error_t
+igraph_vector_int_list_init.argtypes = [POINTER(igraph_vector_int_list_t), igraph_integer_t]
+
+igraph_vector_int_list_destroy = _lib.igraph_vector_int_list_destroy
+igraph_vector_int_list_destroy.restype = None
+igraph_vector_int_list_destroy.argtypes = [c_void_p]
+
+igraph_vector_int_list_get_ptr = _lib.igraph_vector_int_list_get_ptr
+igraph_vector_int_list_get_ptr.restype = POINTER(igraph_vector_int_t)
+igraph_vector_int_list_get_ptr.argtypes = [POINTER(igraph_vector_int_list_t), igraph_integer_t]
+
+igraph_vector_int_list_push_back = _lib.igraph_vector_int_list_push_back
+igraph_vector_int_list_push_back.restype = handle_igraph_error_t
+igraph_vector_int_list_push_back.argtypes = [POINTER(igraph_vector_int_list_t), POINTER(igraph_vector_int_t)]
+
+igraph_vector_int_list_size = _lib.igraph_vector_int_list_size
+igraph_vector_int_list_size.restype = igraph_integer_t
+igraph_vector_int_list_size.argtypes = [POINTER(igraph_vector_int_list_t)]
+
 # Vertex selector type
 
 igraph_vs_none = _lib.igraph_vs_none

src/codegen/types.yaml

@@ -109,7 +109,7 @@ VERTEX:
     IN: "%C% = vertexlike_to_igraph_integer_t(%I%)"
     OUT: "%C% = igraph_integer_t(0)"
 
-VERTEX_COLOR:
+VERTEX_COLORS:
   PY_TYPE: Iterable[int]
   PY_RETURN_TYPE: npt.NDArray[np_type_of_igraph_integer_t]
   INCONV:
@@ -126,6 +126,14 @@ VERTEX_INDICES:
     OUT: "%C% = _VectorInt.create(0)"
   OUTCONV: "%I% = igraph_vector_int_t_to_numpy_array(%C%)"
 
+VERTEX_INDICES_LIST:
+  PY_TYPE: Iterable[Iterable[VertexLike]]
+  PY_RETURN_TYPE: List[npt.NDArray[np_type_of_igraph_integer_t]]
+  INCONV:
+    IN: "%C% = iterable_of_vertex_index_iterable_to_igraph_vector_int_list_t(%I%)"
+    OUT: "%C% = _VectorIntList.create(0)"
+  OUTCONV: "%I% = igraph_vector_int_list_t_to_list_of_numpy_array(%C%)"
+
 VERTEX_INDEX_PAIRS:
   PY_TYPE: Iterable[VertexPair]
   INCONV:
@@ -140,12 +148,12 @@ VERTEX_SELECTOR:
     ALL: '"all"'
   CALL: "%C%.unwrap()"
 
-VERTEX_QTY:
+VERTEX_QTYS:
   PY_TYPE: Iterable[float]
   PY_RETURN_TYPE: npt.NDArray[np_type_of_igraph_real_t]
   INCONV:
-    IN: "%C% = vertex_qty_to_igraph_vector_t_view(%I%, %I1%)"
-    INOUT: "%C% = vertex_qty_to_igraph_vector_t(%I%, %I1%)"
+    IN: "%C% = vertex_qtys_to_igraph_vector_t_view(%I%, %I1%)"
+    INOUT: "%C% = vertex_qtys_to_igraph_vector_t(%I%, %I1%)"
     OUT: "%C% = _Vector.create(0)"
   OUTCONV: "%I% = igraph_vector_t_to_numpy_array(%C%)"
 
@@ -156,7 +164,7 @@ EDGE:
     IN: "%C% = edgelike_to_igraph_integer_t(%I%)"
     OUT: "%C% = igraph_integer_t(0)"
 
-EDGE_COLOR:
+EDGE_COLORS:
   PY_TYPE: Iterable[int]
   PY_RETURN_TYPE: npt.NDArray[np_type_of_igraph_integer_t]
   INCONV:
@@ -173,6 +181,14 @@ EDGE_INDICES:
     OUT: "%C% = _VectorInt.create(0)"
   OUTCONV: "%I% = igraph_vector_int_t_to_numpy_array(%C%)"
 
+EDGE_INDICES_LIST:
+  PY_TYPE: Iterable[Iterable[EdgeLike]]
+  PY_RETURN_TYPE: List[npt.NDArray[np_type_of_igraph_integer_t]]
+  INCONV:
+    IN: "%C% = iterable_of_edge_index_iterable_to_igraph_vector_int_list_t(%I%)"
+    OUT: "%C% = _VectorIntList.create(0)"
+  OUTCONV: "%I% = igraph_vector_int_list_t_to_list_of_numpy_array(%C%)"
+
 EDGE_SELECTOR:
   PY_TYPE: EdgeSelector
   INCONV:
@@ -181,7 +197,7 @@ EDGE_SELECTOR:
     ALL: '"all"'
   CALL: "%C%.unwrap()"
 
-EDGEWEIGHTS:
+EDGE_WEIGHTS:
   PY_TYPE: Iterable[float]
   PY_RETURN_TYPE: npt.NDArray[np_type_of_igraph_real_t]
   INCONV:
@@ -190,7 +206,7 @@ EDGEWEIGHTS:
     OUT: "%C% = _Vector.create(0)"
   OUTCONV: "%I% = igraph_vector_t_to_numpy_array(%C%)"
 
-EDGE_CAPACITY:
+EDGE_CAPACITIES:
   PY_TYPE: Iterable[float]
   PY_RETURN_TYPE: npt.NDArray[np_type_of_igraph_real_t]
   INCONV:

src/igraph_ctypes/_internal/conversion.py

@@ -26,15 +26,21 @@
     igraph_vector_bool_push_back,
     igraph_vector_bool_size,
     igraph_vector_bool_view,
+    igraph_vector_e,
+    igraph_vector_e_ptr,
+    igraph_vector_init_array,
     igraph_vector_int_e,
     igraph_vector_int_e_ptr,
     igraph_vector_int_init_array,
+    igraph_vector_int_list_get_ptr,
+    igraph_vector_int_list_push_back,
+    igraph_vector_int_list_size,
     igraph_vector_int_push_back,
     igraph_vector_int_size,
     igraph_vector_int_view,
-    igraph_vector_e,
-    igraph_vector_e_ptr,
-    igraph_vector_init_array,
+    igraph_vector_list_get_ptr,
+    igraph_vector_list_push_back,
+    igraph_vector_list_size,
     igraph_vector_push_back,
     igraph_vector_size,
     igraph_vector_view,
@@ -67,6 +73,8 @@
     _Vector,
     _VectorBool,
     _VectorInt,
+    _VectorIntList,
+    _VectorList,
     _VertexSelector,
 )
 
@@ -89,7 +97,13 @@
     "igraph_vector_t_to_numpy_array",
     "igraph_vector_bool_t_to_numpy_array",
     "igraph_vector_int_t_to_numpy_array",
+    "igraph_vector_int_list_t_to_list_of_numpy_array",
+    "igraph_vector_list_t_to_list_of_numpy_array",
     "iterable_edge_indices_to_igraph_vector_int_t",
+    "iterable_of_edge_index_iterable_to_igraph_vector_int_list_t",
+    "iterable_of_iterable_to_igraph_vector_int_list_t",
+    "iterable_of_iterable_to_igraph_vector_list_t",
+    "iterable_of_vertex_index_iterable_to_igraph_vector_int_list_t",
     "iterable_to_igraph_vector_bool_t",
     "iterable_to_igraph_vector_bool_t_view",
     "iterable_to_igraph_vector_int_t",
@@ -106,8 +120,8 @@
     "vertex_selector_to_igraph_vs_t",
     "vertex_colors_to_igraph_vector_t",
     "vertex_colors_to_igraph_vector_t_view",
-    "vertex_qty_to_igraph_vector_t",
-    "vertex_qty_to_igraph_vector_t_view",
+    "vertex_qtys_to_igraph_vector_t",
+    "vertex_qtys_to_igraph_vector_t_view",
 )
 
 
@@ -289,6 +303,60 @@ def iterable_vertex_indices_to_igraph_vector_int_t(
     return result
 
 
+def iterable_of_iterable_to_igraph_vector_int_list_t(
+    items: Iterable[Iterable[int]],
+) -> _VectorIntList:
+    result = _VectorIntList.create(0)
+
+    # TODO:
+    #
+    # - if items is a sequence (i.e. we know its length), we could optimize the
+    #   conversion
+    # - we could re-use an already-constructed _VectorInt if we had an alternative
+    #   iterable_to_igraph_vector_int_t() that receives a _VectorInt from the
+    #   outside
+
+    for item in items:
+        vec = iterable_to_igraph_vector_int_t(item)
+        igraph_vector_int_list_push_back(result, vec)
+        vec.release()
+
+    return result
+
+
+def iterable_of_iterable_to_igraph_vector_list_t(
+    items: Iterable[Iterable[float]],
+) -> _VectorList:
+    result = _VectorList.create(0)
+
+    # TODO:
+    #
+    # - if items is a sequence (i.e. we know its length), we could optimize the
+    #   conversion
+    # - we could re-use an already-constructed _VectorInt if we had an alternative
+    #   iterable_to_igraph_vector_t() that receives a _VectorInt from the
+    #   outside
+
+    for item in items:
+        vec = iterable_to_igraph_vector_t(item)
+        igraph_vector_list_push_back(result, vec)
+        vec.release()
+
+    return result
+
+
+def iterable_of_edge_index_iterable_to_igraph_vector_int_list_t(
+    items: Iterable[Iterable[VertexLike]],
+) -> _VectorIntList:
+    return iterable_of_iterable_to_igraph_vector_int_list_t(items)
+
+
+def iterable_of_vertex_index_iterable_to_igraph_vector_int_list_t(
+    items: Iterable[Iterable[VertexLike]],
+) -> _VectorIntList:
+    return iterable_of_iterable_to_igraph_vector_int_list_t(items)
+
+
 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
@@ -553,14 +621,14 @@ def vertex_colors_to_igraph_vector_t_view(
     return iterable_to_igraph_vector_int_t_view(colors)
 
 
-def vertex_qty_to_igraph_vector_t(weights: Iterable[float], graph: _Graph) -> _Vector:
+def vertex_qtys_to_igraph_vector_t(weights: Iterable[float], graph: _Graph) -> _Vector:
     """Converts a Python iterable of floating-point numbers to a vector of
     vertex-related quantities.
     """
     return iterable_to_igraph_vector_t(weights)
 
 
-def vertex_qty_to_igraph_vector_t_view(
+def vertex_qtys_to_igraph_vector_t_view(
     weights: Optional[Iterable[float]], graph: _Graph
 ) -> Optional[_Vector]:
     """Converts a Python iterable of floating-point numbers to a vector of
@@ -643,3 +711,39 @@ def igraph_vector_int_t_to_numpy_array(
     if n > 0:
         memmove(result.ctypes.data, igraph_vector_int_e_ptr(vector, 0), result.nbytes)
     return result
+
+
+def igraph_vector_list_t_to_list_of_numpy_array(
+    vector_list: _VectorList,
+) -> List[npt.NDArray[np_type_of_igraph_real_t]]:
+    n = igraph_vector_list_size(vector_list)
+    vec = _Vector()
+    result = []
+
+    for i in range(n):
+        # We are re-using the same _Vector instance to wrap different
+        # low-level igraph_vector_t instances because it's only temporary
+        # until we convert it to a NumPy array
+        ptr = igraph_vector_list_get_ptr(vector_list, i)
+        vec._set_wrapped_instance(ptr.contents)
+        result.append(igraph_vector_t_to_numpy_array(vec))
+
+    return result
+
+
+def igraph_vector_int_list_t_to_list_of_numpy_array(
+    vector_list: _VectorIntList,
+) -> List[npt.NDArray[np_type_of_igraph_integer_t]]:
+    n = igraph_vector_int_list_size(vector_list)
+    vec = _VectorInt()
+    result = []
+
+    for i in range(n):
+        # We are re-using the same _VectorInt instance to wrap different
+        # low-level igraph_vector_int_t instances because it's only temporary
+        # until we convert it to a NumPy array
+        ptr = igraph_vector_int_list_get_ptr(vector_list, i)
+        vec._set_wrapped_instance(ptr.contents)
+        result.append(igraph_vector_int_t_to_numpy_array(vec))
+
+    return result