Merge pull request #31 from eriknw/update6.2.0

eriknw · web-flow · commit 59c61c1c6f0a · 2022-02-17T16:47:28.000-06:00
Update to SS:GB 6.2.1
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -14,11 +14,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # os: ["ubuntu-latest", "macos-latest", "windows-latest"]  # Waiting on builds
-        os: ["ubuntu-latest"]
+        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        # os: ["ubuntu-latest"]
         python-version: ["3.8", "3.9", "3.10"]
         source: ["conda-forge"]
-        graphblas-version: ["6.1.3"]
+        # source: ["source"]
+        graphblas-version: ["6.2.1"]
     steps:
     - name: Checkout
       uses: actions/checkout@v2
@@ -64,11 +65,5 @@ jobs:
     - name: create_headers.py check
       if: (! contains(matrix.os, 'windows'))
       run: |
-        # These shouldn't change, so make copies to compare to
-        cp suitesparse_graphblas/suitesparse_graphblas.h .
-        cp suitesparse_graphblas/suitesparse_graphblas_no_complex.h .
-        cp suitesparse_graphblas/source.c .
         coverage run -a --branch suitesparse_graphblas/create_headers.py
-        diff suitesparse_graphblas/suitesparse_graphblas.h suitesparse_graphblas.h
-        diff suitesparse_graphblas/suitesparse_graphblas_no_complex.h suitesparse_graphblas_no_complex.h
-        diff suitesparse_graphblas/source.c source.c
+        git diff --exit-code  # error if anything changed
diff --git a/suitesparse_graphblas/create_headers.py b/suitesparse_graphblas/create_headers.py
@@ -315,6 +315,7 @@ def groupby(index, seq):
     "CMPLX",
     "CMPLXF",
     "GB_PUBLIC",
+    "GB_restrict",
     "GRAPHBLAS_H",
     "GrB_INVALID_HANDLE",
     "GrB_NULL",
@@ -359,6 +360,7 @@ def get_groups(ast):
     seen = set()
     groups = {}
     vals = {x for x in lines if "extern GrB_Info GxB" in x} - seen
+    vals |= {x for x in lines if "extern " in x and "GxB_Iterator" in x and "GB" not in x} - seen
     seen.update(vals)
     groups["GxB methods"] = sorted(vals, key=sort_key)
 
@@ -367,6 +369,7 @@ def get_groups(ast):
     groups["GrB methods"] = sorted(vals, key=sort_key)
 
     vals = {x for x in lines if "extern GrB_Info GB" in x} - seen
+    vals |= {x for x in lines if "extern " in x and "GxB_Iterator" in x and "GB" in x} - seen
     seen.update(vals)
     groups["GB methods"] = sorted(vals, key=sort_key)
 
@@ -580,7 +583,9 @@ def visit_Decl(self, node):
                 self.functions.append(node)
 
     def handle_function_node(node):
-        if generator.visit(node.type.type) != "GrB_Info":
+        if generator.visit(node.type.type) != "GrB_Info" and "GxB_Iterator" not in generator.visit(
+            node
+        ):
             raise ValueError(generator.visit(node))
         if node.name in DEPRECATED:
             return
@@ -594,11 +599,14 @@ def handle_function_node(node):
             group = "vector"
         elif "GxB_Scalar" in text or "GrB_Scalar" in text:
             group = "scalar"
+        elif "GxB_Iterator" in text:
+            group = "iterator"
         else:
             group = node.name.split("_", 2)[1]
             group = {
                 # Apply our naming scheme
                 "GrB_Matrix": "matrix",
+                "Matrix": "matrix",
                 "GrB_Vector": "vector",
                 "GxB_Scalar": "scalar",
                 "SelectOp": "selectop",
@@ -610,6 +618,7 @@ def handle_function_node(node):
                 "Type": "type",
                 "UnaryOp": "unary",
                 "IndexUnaryOp": "indexunary",
+                "Iterator": "iterator",
                 # "everything else" is "core"
                 "getVersion": "core",
                 "Global": "core",
@@ -632,9 +641,15 @@ def handle_function_node(node):
     grb_nodes = [node for node in visitor.functions if node.name.startswith("GrB_")]
     gxb_nodes = [node for node in visitor.functions if node.name.startswith("GxB_")]
     gb_nodes = [node for node in visitor.functions if node.name.startswith("GB_")]
-    assert len(grb_nodes) == len(groups["GrB methods"])
-    assert len(gxb_nodes) == len(groups["GxB methods"])
-    assert len(gb_nodes) == len(groups["GB methods"])
+    assert len(grb_nodes) == len(groups["GrB methods"]), (
+        len(grb_nodes),
+        len(groups["GrB methods"]),
+    )
+    assert len(gxb_nodes) == len(groups["GxB methods"]), (
+        len(gxb_nodes),
+        len(groups["GxB methods"]),
+    )
+    assert len(gb_nodes) == len(groups["GB methods"]), (len(gb_nodes), len(groups["GB methods"]))
 
     grb_funcs = (handle_function_node(node) for node in grb_nodes)
     gxb_funcs = (handle_function_node(node) for node in gxb_nodes)
@@ -744,7 +759,7 @@ def handle_funcs(group):
     return text
 
 
-def create_source_text(*, char_defines=None):
+def create_source_text(groups, *, char_defines=None):
     if char_defines is None:
         char_defines = CHAR_DEFINES
     text = [
@@ -814,7 +829,7 @@ def main():
 
     # Create source
     print(f"Step 5: create {source_c}")
-    text = create_source_text()
+    text = create_source_text(groups)
     with open(source_c, "w") as f:
         f.write("\n".join(text))
 
diff --git a/suitesparse_graphblas/suitesparse_graphblas.h b/suitesparse_graphblas/suitesparse_graphblas.h
@@ -15,6 +15,7 @@ typedef uint64_t GrB_Index;
 /* GxB typedefs */
 typedef double _Complex GxB_FC64_t;
 typedef float _Complex GxB_FC32_t;
+typedef struct GB_Iterator_opaque *GxB_Iterator;
 typedef struct GB_Scalar_opaque *GxB_Scalar;
 typedef struct GB_SelectOp_opaque *GxB_SelectOp;
 
@@ -68,6 +69,7 @@ typedef enum
 {
   GrB_SUCCESS = 0,
   GrB_NO_VALUE = 1,
+  GxB_EXHAUSTED = 2,
   GrB_UNINITIALIZED_OBJECT = -1,
   GrB_NULL_POINTER = -2,
   GrB_INVALID_VALUE = -3,
@@ -3059,6 +3061,14 @@ extern GrB_Info GrB_Vector_wait(GrB_Vector v, GrB_WaitMode waitmode);
 /* binary */
 extern GrB_Info GB_BinaryOp_new(GrB_BinaryOp *binaryop, GxB_binary_function function, GrB_Type ztype, GrB_Type xtype, GrB_Type ytype, const char *binop_name);
 
+/* iterator */
+extern GrB_Info GB_Iterator_rc_bitmap_next(GxB_Iterator iterator);
+extern GrB_Info GB_Iterator_rc_seek(GxB_Iterator iterator, GrB_Index j, bool jth_vector);
+extern GrB_Info GB_Vector_Iterator_bitmap_seek(GxB_Iterator iterator, GrB_Index p);
+
+/* matrix */
+extern GrB_Info GB_Iterator_attach(GxB_Iterator iterator, GrB_Matrix A, GxB_Format_Value format, GrB_Descriptor desc);
+
 /* selectop */
 extern GrB_Info GB_SelectOp_new(GxB_SelectOp *selectop, GxB_select_function function, GrB_Type xtype, GrB_Type ttype, const char *name);
 
@@ -3101,8 +3111,51 @@ extern GrB_Info GxB_IndexUnaryOp_xtype_name(char *type_name, const GrB_IndexUnar
 extern GrB_Info GxB_IndexUnaryOp_ytype_name(char *type_name, const GrB_IndexUnaryOp op);
 extern GrB_Info GxB_IndexUnaryOp_ztype_name(char *type_name, const GrB_IndexUnaryOp op);
 
+/* iterator */
+extern GrB_Index GxB_Matrix_Iterator_getp(GxB_Iterator iterator);
+extern GrB_Index GxB_Matrix_Iterator_getpmax(GxB_Iterator iterator);
+extern GrB_Index GxB_Vector_Iterator_getIndex(GxB_Iterator iterator);
+extern GrB_Index GxB_Vector_Iterator_getp(GxB_Iterator iterator);
+extern GrB_Index GxB_Vector_Iterator_getpmax(GxB_Iterator iterator);
+extern GrB_Index GxB_colIterator_getColIndex(GxB_Iterator iterator);
+extern GrB_Index GxB_colIterator_getRowIndex(GxB_Iterator iterator);
+extern GrB_Index GxB_colIterator_kount(GxB_Iterator iterator);
+extern GrB_Index GxB_rowIterator_getColIndex(GxB_Iterator iterator);
+extern GrB_Index GxB_rowIterator_getRowIndex(GxB_Iterator iterator);
+extern GrB_Index GxB_rowIterator_kount(GxB_Iterator iterator);
+extern GrB_Info GxB_Iterator_free(GxB_Iterator *iterator);
+extern GrB_Info GxB_Iterator_new(GxB_Iterator *iterator);
+extern GrB_Info GxB_Matrix_Iterator_next(GxB_Iterator iterator);
+extern GrB_Info GxB_Matrix_Iterator_seek(GxB_Iterator iterator, GrB_Index p);
+extern GrB_Info GxB_Vector_Iterator_next(GxB_Iterator iterator);
+extern GrB_Info GxB_Vector_Iterator_seek(GxB_Iterator iterator, GrB_Index p);
+extern GrB_Info GxB_colIterator_kseek(GxB_Iterator iterator, GrB_Index k);
+extern GrB_Info GxB_colIterator_nextCol(GxB_Iterator iterator);
+extern GrB_Info GxB_colIterator_nextRow(GxB_Iterator iterator);
+extern GrB_Info GxB_colIterator_seekCol(GxB_Iterator iterator, GrB_Index col);
+extern GrB_Info GxB_rowIterator_kseek(GxB_Iterator iterator, GrB_Index k);
+extern GrB_Info GxB_rowIterator_nextCol(GxB_Iterator iterator);
+extern GrB_Info GxB_rowIterator_nextRow(GxB_Iterator iterator);
+extern GrB_Info GxB_rowIterator_seekRow(GxB_Iterator iterator, GrB_Index row);
+extern GxB_FC32_t GxB_Iterator_get_FC32(GxB_Iterator iterator);
+extern GxB_FC64_t GxB_Iterator_get_FC64(GxB_Iterator iterator);
+extern bool GxB_Iterator_get_BOOL(GxB_Iterator iterator);
+extern double GxB_Iterator_get_FP64(GxB_Iterator iterator);
+extern float GxB_Iterator_get_FP32(GxB_Iterator iterator);
+extern int8_t GxB_Iterator_get_INT8(GxB_Iterator iterator);
+extern int16_t GxB_Iterator_get_INT16(GxB_Iterator iterator);
+extern int32_t GxB_Iterator_get_INT32(GxB_Iterator iterator);
+extern int64_t GxB_Iterator_get_INT64(GxB_Iterator iterator);
+extern uint8_t GxB_Iterator_get_UINT8(GxB_Iterator iterator);
+extern uint16_t GxB_Iterator_get_UINT16(GxB_Iterator iterator);
+extern uint32_t GxB_Iterator_get_UINT32(GxB_Iterator iterator);
+extern uint64_t GxB_Iterator_get_UINT64(GxB_Iterator iterator);
+extern void GxB_Iterator_get_UDT(GxB_Iterator iterator, void *value);
+extern void GxB_Matrix_Iterator_getIndex(GxB_Iterator iterator, GrB_Index *row, GrB_Index *col);
+
 /* matrix */
 extern GrB_Info GxB_Col_subassign(GrB_Matrix C, const GrB_Vector mask, const GrB_BinaryOp accum, const GrB_Vector u, const GrB_Index *I, GrB_Index ni, GrB_Index j, const GrB_Descriptor desc);
+extern GrB_Info GxB_Matrix_Iterator_attach(GxB_Iterator iterator, GrB_Matrix A, GrB_Descriptor desc);
 extern GrB_Info GxB_Matrix_Option_get(GrB_Matrix A, GxB_Option_Field field, ...);
 extern GrB_Info GxB_Matrix_Option_set(GrB_Matrix A, GxB_Option_Field field, ...);
 extern GrB_Info GxB_Matrix_apply_BinaryOp1st(GrB_Matrix C, const GrB_Matrix Mask, const GrB_BinaryOp accum, const GrB_BinaryOp op, const GrB_Scalar x, const GrB_Matrix A, const GrB_Descriptor desc);
@@ -3195,6 +3248,8 @@ extern GrB_Info GxB_Matrix_unpack_HyperCSC(GrB_Matrix A, GrB_Index **Ap, GrB_Ind
 extern GrB_Info GxB_Matrix_unpack_HyperCSR(GrB_Matrix A, GrB_Index **Ap, GrB_Index **Ah, GrB_Index **Aj, void **Ax, GrB_Index *Ap_size, GrB_Index *Ah_size, GrB_Index *Aj_size, GrB_Index *Ax_size, bool *iso, GrB_Index *nvec, bool *jumbled, const GrB_Descriptor desc);
 extern GrB_Info GxB_Row_subassign(GrB_Matrix C, const GrB_Vector mask, const GrB_BinaryOp accum, const GrB_Vector u, GrB_Index i, const GrB_Index *J, GrB_Index nj, const GrB_Descriptor desc);
 extern GrB_Info GxB_Vector_diag(GrB_Vector v, const GrB_Matrix A, int64_t k, const GrB_Descriptor desc);
+extern GrB_Info GxB_colIterator_attach(GxB_Iterator iterator, GrB_Matrix A, GrB_Descriptor desc);
+extern GrB_Info GxB_rowIterator_attach(GxB_Iterator iterator, GrB_Matrix A, GrB_Descriptor desc);
 
 /* monoid */
 extern GrB_Info GxB_Monoid_fprint(GrB_Monoid monoid, const char *name, GxB_Print_Level pr, FILE *f);
@@ -3289,6 +3344,7 @@ extern GrB_Info GxB_UnaryOp_ztype(GrB_Type *ztype, GrB_UnaryOp unaryop);
 extern GrB_Info GxB_UnaryOp_ztype_name(char *type_name, const GrB_UnaryOp unaryop);
 
 /* vector */
+extern GrB_Info GxB_Vector_Iterator_attach(GxB_Iterator iterator, GrB_Vector v, GrB_Descriptor desc);
 extern GrB_Info GxB_Vector_Option_get(GrB_Vector A, GxB_Option_Field field, ...);
 extern GrB_Info GxB_Vector_Option_set(GrB_Vector A, GxB_Option_Field field, ...);
 extern GrB_Info GxB_Vector_apply_BinaryOp1st(GrB_Vector w, const GrB_Vector mask, const GrB_BinaryOp accum, const GrB_BinaryOp op, const GrB_Scalar x, const GrB_Vector u, const GrB_Descriptor desc);
diff --git a/suitesparse_graphblas/suitesparse_graphblas_no_complex.h b/suitesparse_graphblas/suitesparse_graphblas_no_complex.h
@@ -13,6 +13,7 @@ typedef struct GB_Vector_opaque *GrB_Vector;
 typedef uint64_t GrB_Index;
 
 /* GxB typedefs */
+typedef struct GB_Iterator_opaque *GxB_Iterator;
 typedef struct GB_Scalar_opaque *GxB_Scalar;
 typedef struct GB_SelectOp_opaque *GxB_SelectOp;
 
@@ -66,6 +67,7 @@ typedef enum
 {
   GrB_SUCCESS = 0,
   GrB_NO_VALUE = 1,
+  GxB_EXHAUSTED = 2,
   GrB_UNINITIALIZED_OBJECT = -1,
   GrB_NULL_POINTER = -2,
   GrB_INVALID_VALUE = -3,
@@ -2885,6 +2887,14 @@ extern GrB_Info GrB_Vector_wait(GrB_Vector v, GrB_WaitMode waitmode);
 /* binary */
 extern GrB_Info GB_BinaryOp_new(GrB_BinaryOp *binaryop, GxB_binary_function function, GrB_Type ztype, GrB_Type xtype, GrB_Type ytype, const char *binop_name);
 
+/* iterator */
+extern GrB_Info GB_Iterator_rc_bitmap_next(GxB_Iterator iterator);
+extern GrB_Info GB_Iterator_rc_seek(GxB_Iterator iterator, GrB_Index j, bool jth_vector);
+extern GrB_Info GB_Vector_Iterator_bitmap_seek(GxB_Iterator iterator, GrB_Index p);
+
+/* matrix */
+extern GrB_Info GB_Iterator_attach(GxB_Iterator iterator, GrB_Matrix A, GxB_Format_Value format, GrB_Descriptor desc);
+
 /* selectop */
 extern GrB_Info GB_SelectOp_new(GxB_SelectOp *selectop, GxB_select_function function, GrB_Type xtype, GrB_Type ttype, const char *name);
 
@@ -2927,8 +2937,49 @@ extern GrB_Info GxB_IndexUnaryOp_xtype_name(char *type_name, const GrB_IndexUnar
 extern GrB_Info GxB_IndexUnaryOp_ytype_name(char *type_name, const GrB_IndexUnaryOp op);
 extern GrB_Info GxB_IndexUnaryOp_ztype_name(char *type_name, const GrB_IndexUnaryOp op);
 
+/* iterator */
+extern GrB_Index GxB_Matrix_Iterator_getp(GxB_Iterator iterator);
+extern GrB_Index GxB_Matrix_Iterator_getpmax(GxB_Iterator iterator);
+extern GrB_Index GxB_Vector_Iterator_getIndex(GxB_Iterator iterator);
+extern GrB_Index GxB_Vector_Iterator_getp(GxB_Iterator iterator);
+extern GrB_Index GxB_Vector_Iterator_getpmax(GxB_Iterator iterator);
+extern GrB_Index GxB_colIterator_getColIndex(GxB_Iterator iterator);
+extern GrB_Index GxB_colIterator_getRowIndex(GxB_Iterator iterator);
+extern GrB_Index GxB_colIterator_kount(GxB_Iterator iterator);
+extern GrB_Index GxB_rowIterator_getColIndex(GxB_Iterator iterator);
+extern GrB_Index GxB_rowIterator_getRowIndex(GxB_Iterator iterator);
+extern GrB_Index GxB_rowIterator_kount(GxB_Iterator iterator);
+extern GrB_Info GxB_Iterator_free(GxB_Iterator *iterator);
+extern GrB_Info GxB_Iterator_new(GxB_Iterator *iterator);
+extern GrB_Info GxB_Matrix_Iterator_next(GxB_Iterator iterator);
+extern GrB_Info GxB_Matrix_Iterator_seek(GxB_Iterator iterator, GrB_Index p);
+extern GrB_Info GxB_Vector_Iterator_next(GxB_Iterator iterator);
+extern GrB_Info GxB_Vector_Iterator_seek(GxB_Iterator iterator, GrB_Index p);
+extern GrB_Info GxB_colIterator_kseek(GxB_Iterator iterator, GrB_Index k);
+extern GrB_Info GxB_colIterator_nextCol(GxB_Iterator iterator);
+extern GrB_Info GxB_colIterator_nextRow(GxB_Iterator iterator);
+extern GrB_Info GxB_colIterator_seekCol(GxB_Iterator iterator, GrB_Index col);
+extern GrB_Info GxB_rowIterator_kseek(GxB_Iterator iterator, GrB_Index k);
+extern GrB_Info GxB_rowIterator_nextCol(GxB_Iterator iterator);
+extern GrB_Info GxB_rowIterator_nextRow(GxB_Iterator iterator);
+extern GrB_Info GxB_rowIterator_seekRow(GxB_Iterator iterator, GrB_Index row);
+extern bool GxB_Iterator_get_BOOL(GxB_Iterator iterator);
+extern double GxB_Iterator_get_FP64(GxB_Iterator iterator);
+extern float GxB_Iterator_get_FP32(GxB_Iterator iterator);
+extern int8_t GxB_Iterator_get_INT8(GxB_Iterator iterator);
+extern int16_t GxB_Iterator_get_INT16(GxB_Iterator iterator);
+extern int32_t GxB_Iterator_get_INT32(GxB_Iterator iterator);
+extern int64_t GxB_Iterator_get_INT64(GxB_Iterator iterator);
+extern uint8_t GxB_Iterator_get_UINT8(GxB_Iterator iterator);
+extern uint16_t GxB_Iterator_get_UINT16(GxB_Iterator iterator);
+extern uint32_t GxB_Iterator_get_UINT32(GxB_Iterator iterator);
+extern uint64_t GxB_Iterator_get_UINT64(GxB_Iterator iterator);
+extern void GxB_Iterator_get_UDT(GxB_Iterator iterator, void *value);
+extern void GxB_Matrix_Iterator_getIndex(GxB_Iterator iterator, GrB_Index *row, GrB_Index *col);
+
 /* matrix */
 extern GrB_Info GxB_Col_subassign(GrB_Matrix C, const GrB_Vector mask, const GrB_BinaryOp accum, const GrB_Vector u, const GrB_Index *I, GrB_Index ni, GrB_Index j, const GrB_Descriptor desc);
+extern GrB_Info GxB_Matrix_Iterator_attach(GxB_Iterator iterator, GrB_Matrix A, GrB_Descriptor desc);
 extern GrB_Info GxB_Matrix_Option_get(GrB_Matrix A, GxB_Option_Field field, ...);
 extern GrB_Info GxB_Matrix_Option_set(GrB_Matrix A, GxB_Option_Field field, ...);
 extern GrB_Info GxB_Matrix_apply_BinaryOp1st(GrB_Matrix C, const GrB_Matrix Mask, const GrB_BinaryOp accum, const GrB_BinaryOp op, const GrB_Scalar x, const GrB_Matrix A, const GrB_Descriptor desc);
@@ -2995,6 +3046,8 @@ extern GrB_Info GxB_Matrix_unpack_HyperCSC(GrB_Matrix A, GrB_Index **Ap, GrB_Ind
 extern GrB_Info GxB_Matrix_unpack_HyperCSR(GrB_Matrix A, GrB_Index **Ap, GrB_Index **Ah, GrB_Index **Aj, void **Ax, GrB_Index *Ap_size, GrB_Index *Ah_size, GrB_Index *Aj_size, GrB_Index *Ax_size, bool *iso, GrB_Index *nvec, bool *jumbled, const GrB_Descriptor desc);
 extern GrB_Info GxB_Row_subassign(GrB_Matrix C, const GrB_Vector mask, const GrB_BinaryOp accum, const GrB_Vector u, GrB_Index i, const GrB_Index *J, GrB_Index nj, const GrB_Descriptor desc);
 extern GrB_Info GxB_Vector_diag(GrB_Vector v, const GrB_Matrix A, int64_t k, const GrB_Descriptor desc);
+extern GrB_Info GxB_colIterator_attach(GxB_Iterator iterator, GrB_Matrix A, GrB_Descriptor desc);
+extern GrB_Info GxB_rowIterator_attach(GxB_Iterator iterator, GrB_Matrix A, GrB_Descriptor desc);
 
 /* monoid */
 extern GrB_Info GxB_Monoid_fprint(GrB_Monoid monoid, const char *name, GxB_Print_Level pr, FILE *f);
@@ -3081,6 +3134,7 @@ extern GrB_Info GxB_UnaryOp_ztype(GrB_Type *ztype, GrB_UnaryOp unaryop);
 extern GrB_Info GxB_UnaryOp_ztype_name(char *type_name, const GrB_UnaryOp unaryop);
 
 /* vector */
+extern GrB_Info GxB_Vector_Iterator_attach(GxB_Iterator iterator, GrB_Vector v, GrB_Descriptor desc);
 extern GrB_Info GxB_Vector_Option_get(GrB_Vector A, GxB_Option_Field field, ...);
 extern GrB_Info GxB_Vector_Option_set(GrB_Vector A, GxB_Option_Field field, ...);
 extern GrB_Info GxB_Vector_apply_BinaryOp1st(GrB_Vector w, const GrB_Vector mask, const GrB_BinaryOp accum, const GrB_BinaryOp op, const GrB_Scalar x, const GrB_Vector u, const GrB_Descriptor desc);
