documentation for v1.2

Author: DrTimothyAldenDavis

Config/LAGraph.h.in

@@ -248,7 +248,7 @@
  *
  * Error handling is simplified by the @sphinxref{LAGRAPH_TRY} / LAGRAPH_CATCH
  * mechanism described below.  For example, assuming the user application
- * #defines a single LAGRAPH_CATCH mechanism for all error handling, the
+ * defines a single LAGRAPH_CATCH mechanism for all error handling, the
  * above example would become:
  *
  *      GrB_Vector level, parent ;
@@ -286,7 +286,7 @@
  * The LAGRAPH_CATCH macro takes a single argument, which is the return value
  * from an LAGraph method.
  *
- * A typical example of a user function that calls LAGraph might #define
+ * A typical example of a user function that calls LAGraph might define
  * LAGRAPH_CATCH as follows.  Suppose workvector is a GrB_vector used for
  * computations internal to the mybfs function, and W is a (double *) space
  * created by malloc.
@@ -844,7 +844,7 @@ LAGRAPH_PUBLIC extern GrB_Semiring
 
 /** LAGraph_Version: determines the version of LAGraph.  The version number and
  * date can also be obtained via compile-time constants from LAGraph.h.
- * However, it is possible to compile a user application that #includes one
+ * However, it is possible to compile a user application that includes one
  * version of LAGraph.h and then links with another version of the LAGraph
  * library later on, so the version number and date may differ from the
  * compile-time constants.
@@ -2056,7 +2056,7 @@ int LAGraph_Vector_IsEqualOp
  * will affect the pseudo-random numbers generated and results are thus not
  * guaranteed in this case.
  *
- * @param[out,out] State vector to initialize with pseudo-random numbers.
+ * @param[in,out] State  vector to initialize with pseudo-random numbers.
  * @param[in] seed       scalar seed value.
  * @param[in,out] msg    any error messages.
  *
@@ -2085,7 +2085,7 @@ int LAGraph_Random_Seed // construct a random State vector
  * https://doi.org/10.18637/jss.v008.i14 and
  * https://en.wikipedia.org/wiki/Xorshift .
  *
- * @param[out,out] State vector with random numbers to be advanced.
+ * @param[in,out] State  vector with random numbers to be advanced.
  * @param[in,out] msg    any error messages.
  *
  * @retval GrB_SUCCESS if successful.

include/LAGraph.h

@@ -248,7 +248,7 @@
  *
  * Error handling is simplified by the @sphinxref{LAGRAPH_TRY} / LAGRAPH_CATCH
  * mechanism described below.  For example, assuming the user application
- * #defines a single LAGRAPH_CATCH mechanism for all error handling, the
+ * defines a single LAGRAPH_CATCH mechanism for all error handling, the
  * above example would become:
  *
  *      GrB_Vector level, parent ;
@@ -286,7 +286,7 @@
  * The LAGRAPH_CATCH macro takes a single argument, which is the return value
  * from an LAGraph method.
  *
- * A typical example of a user function that calls LAGraph might #define
+ * A typical example of a user function that calls LAGraph might define
  * LAGRAPH_CATCH as follows.  Suppose workvector is a GrB_vector used for
  * computations internal to the mybfs function, and W is a (double *) space
  * created by malloc.
@@ -844,7 +844,7 @@ LAGRAPH_PUBLIC extern GrB_Semiring
 
 /** LAGraph_Version: determines the version of LAGraph.  The version number and
  * date can also be obtained via compile-time constants from LAGraph.h.
- * However, it is possible to compile a user application that #includes one
+ * However, it is possible to compile a user application that includes one
  * version of LAGraph.h and then links with another version of the LAGraph
  * library later on, so the version number and date may differ from the
  * compile-time constants.
@@ -2056,7 +2056,7 @@ int LAGraph_Vector_IsEqualOp
  * will affect the pseudo-random numbers generated and results are thus not
  * guaranteed in this case.
  *
- * @param[out,out] State vector to initialize with pseudo-random numbers.
+ * @param[in,out] State  vector to initialize with pseudo-random numbers.
  * @param[in] seed       scalar seed value.
  * @param[in,out] msg    any error messages.
  *
@@ -2085,7 +2085,7 @@ int LAGraph_Random_Seed // construct a random State vector
  * https://doi.org/10.18637/jss.v008.i14 and
  * https://en.wikipedia.org/wiki/Xorshift .
  *
- * @param[out,out] State vector with random numbers to be advanced.
+ * @param[in,out] State  vector with random numbers to be advanced.
  * @param[in,out] msg    any error messages.
  *
  * @retval GrB_SUCCESS if successful.

rtdocs/acknowledgements.rst

@@ -9,6 +9,6 @@ This work is funded in part by:
         development center.  [DM22-0790]
     2.  The United States Department of Defense under Contract No.
         FA8650-18-2-7835 and HR0011-18-3-0007
-    3.  NVIDIA, Intel, MIT Lincoln Laboratory, MathWorks, IBM, and Julia Computing.
+    3.  NVIDIA, Intel, MIT Lincoln Laboratory, MathWorks, IBM, Julia Computing, Redis, and FalkorDB.
     4.  The National Science Foundation (1514406, OAC-1740333, CCF-1629657).
     5.  The United States Department of Energy, Office of Science, ASCR Contract No. DE-AC02-05CH11231.

rtdocs/conf.py

@@ -45,7 +45,7 @@ def configureDoxyfile(input_dir, output_dir):
 # -- Project information -----------------------------------------------------
 
 project = 'LAGraph'
-copyright = '2019-2022, LAGraph Contributors'
+copyright = '2019-2025, LAGraph Contributors'
 author = 'Tim Davis, Tim Mattson, Scott McMillan, Jim Kitchen, Erik Welch'
 
 
@@ -85,4 +85,4 @@ def configureDoxyfile(input_dir, output_dir):
 # Breathe Configuration
 breathe_default_project = 'lagraph'
 
-master_doc = 'index'
+master_doc = 'index'

rtdocs/utils.rst

@@ -59,6 +59,13 @@ Printing
 
 .. doxygenenum:: LAGraph_PrintLevel
 
+Matrix/Vector Generation
+------------------------
+
+.. doxygenfunction:: LAGraph_Random_Seed
+
+.. doxygenfunction:: LAGraph_Random_Next
+
 Pre-defined semirings
 ---------------------