testing diameter and multibfs

DrTimothyAldenDavis · DrTimothyAldenDavis · commit adcd31f75a84 · 2025-04-29T11:51:16.000-05:00
diff --git a/experimental/algorithm/LAGraph_EstimateDiameter.c b/experimental/algorithm/LAGraph_EstimateDiameter.c
@@ -12,7 +12,6 @@
 //------------------------------------------------------------------------------
 
 // FIXME: almost ready for src; need to handle GxB
-// FIXME: need the CI test for this method
 
 // Takes in a graph and estimates the diameter 
 // and optionally also finds pseudo-peripheral nodes of the graph
@@ -157,6 +156,8 @@ int LAGraph_EstimateDiameter
     else
     {
         // srcs = randomized, still of size nsrcs-1, values in range 0 to UINT64_MAX
+        // FIXME: if the graph is very sparse, select nodes at random with at
+        // least one out-going edge.
         LAGRAPH_TRY (LAGraph_Random_Seed (srcs, seed, msg)) ;
         GRB_TRY (GxB_BinaryOp_new (&Mod,
             (n > INT32_MAX) ? ((GxB_binary_function)mod64) :
diff --git a/experimental/algorithm/LAGraph_ExactDiameter.c b/experimental/algorithm/LAGraph_ExactDiameter.c
@@ -12,7 +12,6 @@
 //------------------------------------------------------------------------------
 
 // FIXME: almost ready for src; says it's not vanilla but should be OK
-// FIXME: need the CI test for this method
 
 // Takes in a graph and finds the diameter 
 // and optionally also the peripheral nodes of the graph
diff --git a/experimental/algorithm/LAGraph_MultiSourceBFS.c b/experimental/algorithm/LAGraph_MultiSourceBFS.c
@@ -12,7 +12,6 @@
 //------------------------------------------------------------------------------
 
 // FIXME: almost ready for src; need a vanilla method
-// FIXME: need the CI test for this method
 
 // Takes in a vector of source nodes and finds level and/or parent vectors for each,
 // stored together in a matrix
@@ -74,16 +73,17 @@ int LAGraph_MultiSourceBFS
     GrB_Matrix A = G->A ;
     
     GrB_Index nsrc; // holds the number of source nodes
-    GrB_Index n;
+    GrB_Index n, nvals ;
     GRB_TRY (GrB_Matrix_nrows (&n, A)) ;
+    GRB_TRY (GrB_Matrix_nvals (&nvals, A)) ;
     GRB_TRY (GrB_Vector_size (&nsrc, src)) ;
     for (int64_t s = 0; s < nsrc; s++) 
     {
         GrB_Index currsrc;
         GRB_TRY (GrB_Vector_extractElement (&currsrc, src, s)) ;
         LG_ASSERT_MSG (currsrc < n, GrB_INVALID_INDEX, "invalid source node") ;
     }
-
+    bool very_sparse = (nvals <= n/16) ;
 
     // determine the semiring type 
     GrB_Type int_type = (n > INT32_MAX) ? GrB_INT64 : GrB_INT32 ;
@@ -98,7 +98,10 @@ int LAGraph_MultiSourceBFS
 
         // create the parent matrix.  pi(i, j) is the parent id of node j in source i's BFS
         GRB_TRY (GrB_Matrix_new (&pi, int_type, nsrc, n)) ;
-        GRB_TRY (LG_SET_FORMAT_HINT (pi, LG_BITMAP + LG_FULL)) ;
+        if (!very_sparse)
+        {
+            GRB_TRY (LG_SET_FORMAT_HINT (pi, LG_BITMAP + LG_FULL)) ;
+        }
 
         // pi (i, src) = src denotes the root of that row's BFS tree
         for (int64_t s = 0; s < nsrc; s++) 
@@ -143,7 +146,10 @@ int LAGraph_MultiSourceBFS
         // create the level matrix. v(i,j) is the level of node j in source i's BFS
         // v (s, src) = 0 denotes the source node of that row
         GRB_TRY (GrB_Matrix_new (&v, int_type, nsrc, n)) ;
-        GRB_TRY (LG_SET_FORMAT_HINT (v, LG_BITMAP + LG_FULL)) ;
+        if (!very_sparse)
+        {
+            GRB_TRY (LG_SET_FORMAT_HINT (v, LG_BITMAP + LG_FULL)) ;
+        }
         for (int64_t s = 0; s < nsrc; s++) 
         {
             GrB_Index currsrc;
diff --git a/experimental/test/test_diameter.c b/experimental/test/test_diameter.c
@@ -0,0 +1,257 @@
+//------------------------------------------------------------------------------
+// LAGraph/experimental/test/test_diameter.c: test diameter
+//------------------------------------------------------------------------------
+
+// LAGraph, (c) 2019-2022 by The LAGraph Contributors, All Rights Reserved.
+// SPDX-License-Identifier: BSD-2-Clause
+//
+// For additional details (including references to third party source code and
+// other files) see the LICENSE file or contact permission@sei.cmu.edu. See
+// Contributors.txt for a full list of contributors. Created, in part, with
+// funding and support from the U.S. Government (see Acknowledgments.txt file).
+// DM22-0790
+
+// Contributed by Timothy A. Davis, Texas A&M University
+
+//------------------------------------------------------------------------------
+
+// FIXME: need to check the results with correct their values
+
+#include <stdio.h>
+#include <acutest.h>
+
+#include <LAGraphX.h>
+#include <LAGraph_test.h>
+
+char msg [LAGRAPH_MSG_LEN] ;
+LAGraph_Graph G = NULL ;
+GrB_Matrix A = NULL ;
+GrB_Matrix C = NULL ;
+GrB_Vector peripheral = NULL ;
+GrB_Matrix level = NULL ;
+GrB_Matrix parent = NULL ;
+GrB_Vector sources = NULL ;
+GrB_Vector est_peripheral = NULL ;
+GrB_Vector eccentricity = NULL ;
+GrB_Index n ;
+#define LEN 512
+char filename [LEN+1] ;
+
+typedef struct
+{
+    bool symmetric ;
+    const char *name ;
+}
+matrix_info ;
+
+const matrix_info files [ ] =
+{
+    { 1, "A.mtx" },
+    { 1, "jagmesh7.mtx" },
+    { 0, "west0067.mtx" }, // unsymmetric
+    { 1, "bcsstk13.mtx" },
+    { 1, "karate.mtx" },
+    { 1, "ldbc-cdlp-undirected-example.mtx" },
+    { 1, "ldbc-undirected-example-bool.mtx" },
+    { 1, "ldbc-undirected-example-unweighted.mtx" },
+    { 1, "ldbc-undirected-example.mtx" },
+    { 1, "ldbc-wcc-example.mtx" },
+    { 0, "" },
+} ;
+
+#undef OK
+#define OK(method) \
+{ \
+    GrB_Info info = method ; \
+    if (info != GrB_SUCCESS) \
+    { \
+        printf ("info: %d, msg: %s\n", info, msg) ; \
+        TEST_CHECK (false) ; \
+    } \
+}
+
+//------------------------------------------------------------------------------
+// test_diameter
+//------------------------------------------------------------------------------
+
+void test_diameter (void)
+{
+    OK (LAGraph_Init (msg)) ;
+    OK (LAGraph_Random_Init (msg)) ;
+    #if LAGRAPH_SUITESPARSE
+
+    for (int k = 0 ; ; k++)
+    {
+
+        // load the matrix as A
+        const char *aname = files [k].name ;
+        bool symmetric = files [k].symmetric ;
+        if (strlen (aname) == 0) break;
+        printf ("\n================================== %s:\n", aname) ;
+        TEST_CASE (aname) ;
+        snprintf (filename, LEN, LG_DATA_DIR "%s", aname) ;
+        FILE *f = fopen (filename, "r") ;
+        TEST_CHECK (f != NULL) ;
+        OK (LAGraph_MMRead (&A, f, msg)) ;
+        OK (GrB_Matrix_nrows (&n, A)) ;
+        LAGraph_PrintLevel pr = (n <= 100) ? LAGraph_COMPLETE : LAGraph_SHORT ;
+        OK (LAGraph_Matrix_Print (A, pr, stdout, msg)) ;
+
+        // construct a directed graph G with adjacency matrix S
+        int kind = symmetric ?
+            LAGraph_ADJACENCY_UNDIRECTED :
+            LAGraph_ADJACENCY_DIRECTED ;
+        OK (LAGraph_New (&G, &A, kind, msg)) ;
+        TEST_CHECK (A == NULL) ;
+
+        // compute the exact diameter
+        GrB_Index diameter = 0 ;
+        OK (LAGraph_ExactDiameter (&diameter, &peripheral, &eccentricity,
+            G, 8, msg)) ;
+
+        printf ("\ndiameter: %" PRIu64 "\n", diameter) ;
+        printf ("\nperipheral:\n") ;
+        OK (LAGraph_Vector_Print (peripheral, pr, stdout, msg)) ;
+        printf ("\neccentricity:\n") ;
+        OK (LAGraph_Vector_Print (eccentricity, pr, stdout, msg)) ;
+
+        for (int jit = 0 ; jit <= 1 ; jit++)
+        {
+            OK (GxB_Global_Option_set (GxB_JIT_C_CONTROL,
+                jit ? GxB_JIT_ON : GxB_JIT_OFF)) ;
+            // compute the estimated diameter
+            GrB_Index estimated_diameter = 0 ;
+            OK (LAGraph_EstimateDiameter (&estimated_diameter, &est_peripheral,
+                G, 8, 4, 42, msg)) ;
+            printf ("\nest diameter: %" PRIu64 "\n", estimated_diameter) ;
+            TEST_CHECK (estimated_diameter <= diameter) ;
+            printf ("\nest_peripheral:\n") ;
+            OK (LAGraph_Vector_Print (est_peripheral, pr, stdout, msg)) ;
+            OK (GrB_free (&est_peripheral)) ;
+        }
+
+        // try the multisource BFS directly
+        OK (GrB_Vector_new (&sources, GrB_INT64, 4)) ;
+        for (int i = 0 ; i < 4 ; i++)
+        {
+            OK (GrB_Vector_setElement (sources, i, i)) ;
+        }
+        OK (GrB_wait (sources, GrB_MATERIALIZE)) ;
+        printf ("\nsource nodes for multiBFS:\n") ;
+        OK (LAGraph_Vector_Print (sources, 5, stdout, msg)) ;
+        OK (LAGraph_MultiSourceBFS (&level, &parent, G, sources, msg)) ;
+        printf ("\nlevel:\n") ;
+        OK (LAGraph_Matrix_Print (level, pr, stdout, msg)) ;
+        printf ("\nparent:\n") ;
+        OK (LAGraph_Matrix_Print (parent, pr, stdout, msg)) ;
+
+        OK (GrB_free (&sources)) ;
+        OK (GrB_free (&level)) ;
+        OK (GrB_free (&parent)) ;
+        OK (GrB_free (&peripheral)) ;
+        OK (GrB_free (&eccentricity)) ;
+        OK (LAGraph_Delete (&G, msg)) ;
+    }
+
+    #else
+    printf ("test skipped\n") ;
+    #endif
+    OK (LAGraph_Random_Finalize (msg)) ;
+    OK (LAGraph_Finalize (msg)) ;
+}
+
+//------------------------------------------------------------------------------
+// test_diameter_huge
+//------------------------------------------------------------------------------
+
+void test_diameter_huge (void)
+{
+    OK (LAGraph_Init (msg)) ;
+    OK (LAGraph_Random_Init (msg)) ;
+    #if LAGRAPH_SUITESPARSE
+    OK (GxB_Global_Option_set (GxB_JIT_C_CONTROL, GxB_JIT_OFF)) ;
+
+    snprintf (filename, LEN, LG_DATA_DIR "%s", "karate.mtx") ;
+    FILE *f = fopen (filename, "r") ;
+    TEST_CHECK (f != NULL) ;
+    OK (LAGraph_MMRead (&C, f, msg)) ;
+    OK (GrB_Matrix_nrows (&n, C)) ;
+    OK (LAGraph_Matrix_Print (C, 5, stdout, msg)) ;
+
+    GrB_Index *I = NULL ;
+    OK (LAGraph_Malloc ((void **) &I, n, sizeof (uint64_t), msg)) ;
+    for (int k = 0 ; k < n ; k++)
+    {
+        I [k] = k ;
+    }
+
+    // A (0:n-1, 0:n-1) = C, where C is n-by-n
+    OK (GrB_Matrix_new (&A, GrB_BOOL, UINT32_MAX, UINT32_MAX)) ;
+    OK (GrB_assign (A, NULL, NULL, C, I, n, I, n, NULL)) ;
+
+    // construct the graph
+    OK (LAGraph_New (&G, &A, LAGraph_ADJACENCY_UNDIRECTED, msg)) ;
+    TEST_CHECK (A == NULL) ;
+
+    // compute the estimated diameter
+    GrB_Index estimated_diameter = 0 ;
+    OK (LAGraph_EstimateDiameter (&estimated_diameter, &est_peripheral,
+        G, 8, 4, 42, msg)) ;
+    printf ("\nest diameter: %" PRIu64 "\n", estimated_diameter) ;
+    printf ("\nest_peripheral:\n") ;
+    OK (LAGraph_Vector_Print (est_peripheral, 2, stdout, msg)) ;
+    OK (GrB_free (&est_peripheral)) ;
+
+    // try the multisource BFS directly
+    OK (GrB_Vector_new (&sources, GrB_INT64, 4)) ;
+    for (int i = 0 ; i < 4 ; i++)
+    {
+        OK (GrB_Vector_setElement (sources, i, i)) ;
+    }
+    OK (GrB_wait (sources, GrB_MATERIALIZE)) ;
+    printf ("\nsource nodes for multiBFS:\n") ;
+    OK (LAGraph_Vector_Print (sources, 5, stdout, msg)) ;
+    OK (LAGraph_MultiSourceBFS (&level, &parent, G, sources, msg)) ;
+    printf ("\nlevel:\n") ;
+    OK (LAGraph_Matrix_Print (level, 2, stdout, msg)) ;
+    printf ("\nparent:\n") ;
+    OK (LAGraph_Matrix_Print (parent, 2, stdout, msg)) ;
+
+    OK (GrB_free (&sources)) ;
+    OK (GrB_free (&level)) ;
+    OK (GrB_free (&parent)) ;
+    OK (GrB_free (&C)) ;
+    OK (LAGraph_Free ((void **) &I, msg)) ;
+    OK (LAGraph_Delete (&G, msg)) ;
+
+    #else
+    printf ("test skipped\n") ;
+    #endif
+    OK (LAGraph_Random_Finalize (msg)) ;
+    OK (LAGraph_Finalize (msg)) ;
+}
+
+//------------------------------------------------------------------------------
+// test_errors
+//------------------------------------------------------------------------------
+
+void test_errors (void)
+{
+    LAGraph_Init (msg) ;
+    #if LAGRAPH_SUITESPARSE
+    // FIXME
+    #else
+    printf ("test skipped\n") ;
+    #endif
+    LAGraph_Finalize (msg) ;
+}
+
+//****************************************************************************
+
+TEST_LIST = {
+    {"diameter", test_diameter},
+    {"diameter_huge", test_diameter_huge},
+    {"diameter_errors", test_errors},
+    {NULL, NULL}
+} ;
+
