Merge pull request #294 from GraphBLAS/with_GraphBLAS_v10

random number generators moved to src/utility

Author: DrTimothyAldenDavis

.github/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
         config:
         # if there are multiple items in this list, only use should
         # deployit=true for just one of them.
-#        - {grb_version: 9.4.5, deployit: false}
+         - {grb_version: 9.0.0, deployit: false}
          - {grb_version: 10.0.3, deployit: true}
     steps:
     - name: Checkout
@@ -57,7 +57,7 @@ jobs:
     strategy:
       matrix:
         config:
-#        - {grb_version: 9.4.5}
+         - {grb_version: 9.0.0}
          - {grb_version: 10.0.3}
     steps:
     - name: Checkout

TODO.txt

@@ -1,5 +1,14 @@
 LAGraph TODO:
 
+For May 14, 2025, meeting:
+
+    Propose releasing a stable v1.2 branch
+    full test coverage except RegularPathQuery
+    Requires SS:GraphBLAS v9.0.0 or later, but additional features of v10.0.0 used
+        by some methods (with an #ifdef)
+    Add LAGraph_Random* methods to src/utililty, but no other methods added to
+        src/algorithm or src/utility (do those later)
+
 Aug 21, 2024:
 
     (1) LAGraph 1.1.4 release, with latest GraphBLAS compiled in CI, not

config/LAGraph.h.in

@@ -98,8 +98,8 @@
 
 #if ( !LAGRAPH_VANILLA ) && defined ( GxB_SUITESPARSE_GRAPHBLAS )
     // use SuiteSparse, and its GxB* extensions
-    #if GxB_IMPLEMENTATION < GxB_VERSION (10,0,3)
-    #error "If using SuiteSparse::GraphBLAS, version 10.0.3 or later is required"
+    #if GxB_IMPLEMENTATION < GxB_VERSION (9,0,0)
+    #error "If using SuiteSparse::GraphBLAS, version 9.0.0 or later is required"
     #endif
     #define LAGRAPH_SUITESPARSE 1
 #else
@@ -2021,6 +2021,58 @@ int LAGraph_Vector_IsEqualOp
     char *msg
 ) ;
 
+//------------------------------------------------------------------------------
+// Random number generator
+//------------------------------------------------------------------------------
+
+// FIXME: rename these methods?
+
+/** LAGraph_Random_Seed creates a random vector.  On input, its values are
+ * ignored but its structure is used.  On output, all entries that were in
+ * the original structure are assigned random values, depending on the scalar
+ * seed value.  Each entry is considered its own pseudo-random number stream,
+ * with the overall seed value being revised for each entry in the vector,
+ * depending on their index in the vector.
+ *
+ * @param[out,out] State vector to initialize with random numbers.
+ * @param[in] seed       scalar seed value.
+ * @param[in,out] msg    any error messages.
+ *
+ * @retval GrB_SUCCESS if successful.
+ * @retval GrB_NULL_POINTER if State is NULL.
+ * @returns any GraphBLAS errors that may have been encountered.
+ */
+
+LAGRAPH_PUBLIC
+int LAGraph_Random_Seed // construct a random State vector
+(
+    // input/output:
+    GrB_Vector State,   // vector of random number States, normally GrB_UINT64
+    // input:
+    uint64_t seed,      // scalar input seed
+    char *msg
+) ;
+
+/** LAGraph_Random_Next takes as input a vector previously initialized by
+ * LAGraph_Random_Seed, and modifies all of them so that they take on their
+ * next value in its pseudo-random number stream.
+ *
+ * @param[out,out] State vector with random numbers to be advanced.
+ * @param[in,out] msg   any error messages.
+ *
+ * @retval GrB_SUCCESS if successful.
+ * @retval GrB_NULL_POINTER if State is NULL.
+ * @returns any GraphBLAS errors that may have been encountered.
+ */
+
+LAGRAPH_PUBLIC
+int LAGraph_Random_Next     // advance to next random vector
+(
+    // input/output:
+    GrB_Vector State,   // vector of random number States, normally GrB_UINT64
+    char *msg
+) ;
+
 //==============================================================================
 // LAGraph Basic algorithms
 //==============================================================================

data/random_weighted_general2.mtx

@@ -1,5 +1,5 @@
 %%MatrixMarket matrix coordinate integer symmetric
-%%GraphBLAS type uint32_t
+%%GraphBLAS type uint64_t
 300 300 746
 185 90 4294420090
 227 66 4288698439

experimental/test/test_MaximalMatching.c

@@ -96,6 +96,7 @@ void test_MaximalMatching (void)
     {
         const char *aname = tests [k].name ;
         if (strlen (aname) == 0) break ;
+        printf ("\n======================= %s:\n", aname) ;
         TEST_CASE (aname) ;
 
         // old code using files
@@ -109,6 +110,7 @@ void test_MaximalMatching (void)
 
         TEST_CHECK (A != NULL) ;
         TEST_MSG ("Building of adjacency matrix failed") ;
+        GxB_print (A, 1) ;
 
         OK (LAGraph_New (&G, &A, LAGraph_ADJACENCY_DIRECTED, msg)) ;
 

include/LAGraph.h

@@ -98,8 +98,8 @@
 
 #if ( !LAGRAPH_VANILLA ) && defined ( GxB_SUITESPARSE_GRAPHBLAS )
     // use SuiteSparse, and its GxB* extensions
-    #if GxB_IMPLEMENTATION < GxB_VERSION (10,0,3)
-    #error "If using SuiteSparse::GraphBLAS, version 10.0.3 or later is required"
+    #if GxB_IMPLEMENTATION < GxB_VERSION (9,0,0)
+    #error "If using SuiteSparse::GraphBLAS, version 9.0.0 or later is required"
     #endif
     #define LAGRAPH_SUITESPARSE 1
 #else
@@ -2021,6 +2021,58 @@ int LAGraph_Vector_IsEqualOp
     char *msg
 ) ;
 
+//------------------------------------------------------------------------------
+// Random number generator
+//------------------------------------------------------------------------------
+
+// FIXME: rename these methods?
+
+/** LAGraph_Random_Seed creates a random vector.  On input, its values are
+ * ignored but its structure is used.  On output, all entries that were in
+ * the original structure are assigned random values, depending on the scalar
+ * seed value.  Each entry is considered its own pseudo-random number stream,
+ * with the overall seed value being revised for each entry in the vector,
+ * depending on their index in the vector.
+ *
+ * @param[out,out] State vector to initialize with random numbers.
+ * @param[in] seed       scalar seed value.
+ * @param[in,out] msg    any error messages.
+ *
+ * @retval GrB_SUCCESS if successful.
+ * @retval GrB_NULL_POINTER if State is NULL.
+ * @returns any GraphBLAS errors that may have been encountered.
+ */
+
+LAGRAPH_PUBLIC
+int LAGraph_Random_Seed // construct a random State vector
+(
+    // input/output:
+    GrB_Vector State,   // vector of random number States, normally GrB_UINT64
+    // input:
+    uint64_t seed,      // scalar input seed
+    char *msg
+) ;
+
+/** LAGraph_Random_Next takes as input a vector previously initialized by
+ * LAGraph_Random_Seed, and modifies all of them so that they take on their
+ * next value in its pseudo-random number stream.
+ *
+ * @param[out,out] State vector with random numbers to be advanced.
+ * @param[in,out] msg   any error messages.
+ *
+ * @retval GrB_SUCCESS if successful.
+ * @retval GrB_NULL_POINTER if State is NULL.
+ * @returns any GraphBLAS errors that may have been encountered.
+ */
+
+LAGRAPH_PUBLIC
+int LAGraph_Random_Next     // advance to next random vector
+(
+    // input/output:
+    GrB_Vector State,   // vector of random number States, normally GrB_UINT64
+    char *msg
+) ;
+
 //==============================================================================
 // LAGraph Basic algorithms
 //==============================================================================

include/LAGraphX.h

@@ -57,12 +57,12 @@ extern "C"
 //------------------------------------------------------------------------------
 
 LAGRAPHX_PUBLIC
-int LAGraph_Random_Init
+int LAGraph_Random_Init // FIXME: remove this
 (
     char *msg
 ) ;
 LAGRAPHX_PUBLIC
-int LAGraph_Random_Finalize
+int LAGraph_Random_Finalize // FIXME: remove this
 (
     char *msg
 ) ;
@@ -72,24 +72,6 @@ int LAGraph_Random_Finalize
 LAGRAPHX_PUBLIC extern bool random_hack ;
 #endif
 
-LAGRAPHX_PUBLIC
-int LAGraph_Random_Seed     // construct a random seed vector
-(
-    // input/output
-    GrB_Vector Seed,    // vector of random number seeds, normally GrB_UINT64
-    // input
-    uint64_t seed,      // scalar input seed
-    char *msg
-) ;
-
-LAGRAPHX_PUBLIC
-int LAGraph_Random_Next     // advance to next random vector
-(
-    // input/output
-    GrB_Vector Seed,
-    char *msg
-) ;
-
 LAGRAPHX_PUBLIC
 GrB_Info LAGraph_Random_Matrix    // random matrix of any built-in type
 (

src/benchmark/LAGraph_demo.h

@@ -910,7 +910,7 @@ static int readproblem          // returns 0 if successful, -1 if failure
     // typecast, if requested
     //--------------------------------------------------------------------------
 
-    GRB_TRY (GxB_Matrix_type (&atype, A)) ;     // FIXME: use GrB_get
+    GRB_TRY (GxB_Matrix_type (&atype, A)) ;
 
     if (structural)
     {

src/test/test_ConnectedComponents.c

@@ -154,6 +154,11 @@ void test_cc_matrices (void)
             TEST_CHECK (ncomponents == ncomp) ;
             OK (LG_check_cc (C2, G, msg)) ;
             OK (GrB_free (&C2)) ;
+            #else
+            printf ("\n------ CC_FastSV7: requires SS:GrB v10.0.0 or later\n") ;
+            int result7 = LG_CC_FastSV7 (&C2, G, msg) ;
+            TEST_CHECK (result7 == GrB_NOT_IMPLEMENTED) ;
+            TEST_CHECK (C2 == NULL) ;
             #endif
 
             #endif

experimental/test/test_Random.c renamed to src/test/test_Random.c

@@ -218,6 +218,8 @@ int LAGr_Init
     // create global objects
     //--------------------------------------------------------------------------
 
+    LG_Random_Init (msg) ;
+
     // LAGraph_plus_first_T: using the GrB_PLUS_MONOID_T monoid and the
     // GrB_FIRST_T multiplicative operator.  These semirings compute C=A*B
     // where only the structure of B is accessed.  In MATLAB, this can be

src/utility/LAGr_Init.c

@@ -30,6 +30,8 @@ int LAGraph_Finalize (char *msg)
     // free global objects
     //--------------------------------------------------------------------------
 
+    LG_TRY (LG_Random_Finalize (msg)) ;
+
     GRB_TRY (GrB_Semiring_free (&LAGraph_plus_first_int8  )) ;
     GRB_TRY (GrB_Semiring_free (&LAGraph_plus_first_int16 )) ;
     GRB_TRY (GrB_Semiring_free (&LAGraph_plus_first_int32 )) ;
@@ -82,3 +84,4 @@ int LAGraph_Finalize (char *msg)
     GRB_TRY (GrB_finalize ( )) ;
     return (GrB_SUCCESS) ;
 }
+