Merge pull request #985 from DrTimothyAldenDavis/dev2

revise type/op names to gaurd against name collisions (LAGraph & GrB)

Author: DrTimothyAldenDavis

GraphBLAS/Demo/Include/usercomplex.c

@@ -10,9 +10,9 @@
 #ifndef USERCOMPLEX_H
 #define USERCOMPLEX_H
 
- typedef struct { double re ; double im ; } mycx ;
+ typedef struct { double re ; double im ; } gb_mycx ;
 #define MYCX_DEFN \
-"typedef struct { double re ; double im ; } mycx ;"
+"typedef struct { double re ; double im ; } gb_mycx ;"
 
 //------------------------------------------------------------------------------
 // 10 binary functions, z=f(x,y), where CxC -> C
@@ -93,63 +93,63 @@ GrB_Info Complex_finalize (void) ;
 // function prototypes
 //------------------------------------------------------------------------------
 
-void mycx_first (mycx *z, const mycx *x, const mycx *y) ;
-void mycx_second (mycx *z, const mycx *x, const mycx *y) ;
-void mycx_pair (mycx *z, const mycx *x, const mycx *y) ;
-void mycx_plus (mycx *z, const mycx *x, const mycx *y) ;
-void mycx_minus (mycx *z, const mycx *x, const mycx *y) ;
-void mycx_rminus (mycx *z, const mycx *x, const mycx *y) ;
-void mycx_times (mycx *z, const mycx *x, const mycx *y) ;
-void mycx_div (mycx *z, const mycx *x, const mycx *y) ;
-void mycx_rdiv (mycx *z, const mycx *x, const mycx *y) ;
-void fx64_min (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
-void mycx_min (mycx *z, const mycx *x, const mycx *y) ;
-void fx64_max (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
-void mycx_max (mycx *z, const mycx *x, const mycx *y) ;
-void mycx_iseq (mycx *z, const mycx *x, const mycx *y) ;
-void mycx_isne (mycx *z, const mycx *x, const mycx *y) ;
-void fx64_isgt (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
-void mycx_isgt (mycx *z, const mycx *x, const mycx *y) ;
-void fx64_islt (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
-void mycx_islt (mycx *z, const mycx *x, const mycx *y) ;
-void fx64_isge (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
-void mycx_isge (mycx *z, const mycx *x, const mycx *y) ;
-void fx64_isle (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
-void mycx_isle (mycx *z, const mycx *x, const mycx *y) ;
-void fx64_or (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
-void mycx_or (mycx *z, const mycx *x, const mycx *y) ;
-void fx64_and (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
-void mycx_and (mycx *z, const mycx *x, const mycx *y) ;
-void fx64_xor (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
-void mycx_xor (mycx *z, const mycx *x, const mycx *y) ;
-void mycx_eq (bool *z, const mycx *x, const mycx *y) ;
-void mycx_ne (bool *z, const mycx *x, const mycx *y) ;
-void fx64_gt (bool *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
-void mycx_gt (bool *z, const mycx *x, const mycx *y) ;
-void fx64_lt (bool *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
-void mycx_lt (bool *z, const mycx *x, const mycx *y) ;
-void fx64_ge (bool *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
-void mycx_ge (bool *z, const mycx *x, const mycx *y) ;
-void fx64_le (bool *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
-void mycx_le (bool *z, const mycx *x, const mycx *y) ;
-void mycx_cmplx (mycx *z, const double *x, const double *y) ;
-void mycx_one (mycx *z, const mycx *x) ;
-void mycx_identity (mycx *z, const mycx *x) ;
-void mycx_ainv (mycx *z, const mycx *x) ;
-void mycx_minv (mycx *z, const mycx *x) ;
-void mycx_conj (mycx *z, const mycx *x) ;
-void fx64_abs (GxB_FC64_t *z, const GxB_FC64_t *x) ;
-void mycx_abs (mycx *z, const mycx *x) ;
-void fx64_not (GxB_FC64_t *z, const GxB_FC64_t *x) ;
-void mycx_not (mycx *z, const mycx *x) ;
-void mycx_real (double *z, const mycx *x) ;
-void mycx_imag (double *z, const mycx *x) ;
-void mycx_cabs (double *z, const mycx *x) ;
-void mycx_angle (double *z, const mycx *x) ;
-void fx64_cmplx_real (GxB_FC64_t *z, const double *x) ;
-void mycx_cmplx_real (mycx *z, const double *x) ;
-void fx64_cmplx_imag (GxB_FC64_t *z, const double *x) ;
-void mycx_cmplx_imag (mycx *z, const double *x) ;
+void gb_mycx_first (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_mycx_second (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_mycx_pair (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_mycx_plus (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_mycx_minus (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_mycx_rminus (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_mycx_times (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_mycx_div (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_mycx_rdiv (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_fx64_min (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
+void gb_mycx_min (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_fx64_max (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
+void gb_mycx_max (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_mycx_iseq (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_mycx_isne (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_fx64_isgt (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
+void gb_mycx_isgt (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_fx64_islt (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
+void gb_mycx_islt (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_fx64_isge (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
+void gb_mycx_isge (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_fx64_isle (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
+void gb_mycx_isle (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_fx64_or (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
+void gb_mycx_or (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_fx64_and (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
+void gb_mycx_and (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_fx64_xor (GxB_FC64_t *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
+void gb_mycx_xor (gb_mycx *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_mycx_eq (bool *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_mycx_ne (bool *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_fx64_gt (bool *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
+void gb_mycx_gt (bool *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_fx64_lt (bool *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
+void gb_mycx_lt (bool *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_fx64_ge (bool *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
+void gb_mycx_ge (bool *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_fx64_le (bool *z, const GxB_FC64_t *x, const GxB_FC64_t *y) ;
+void gb_mycx_le (bool *z, const gb_mycx *x, const gb_mycx *y) ;
+void gb_mycx_cmplx (gb_mycx *z, const double *x, const double *y) ;
+void gb_mycx_one (gb_mycx *z, const gb_mycx *x) ;
+void gb_mycx_identity (gb_mycx *z, const gb_mycx *x) ;
+void gb_mycx_ainv (gb_mycx *z, const gb_mycx *x) ;
+void gb_mycx_minv (gb_mycx *z, const gb_mycx *x) ;
+void gb_mycx_conj (gb_mycx *z, const gb_mycx *x) ;
+void gb_fx64_abs (GxB_FC64_t *z, const GxB_FC64_t *x) ;
+void gb_mycx_abs (gb_mycx *z, const gb_mycx *x) ;
+void gb_fx64_not (GxB_FC64_t *z, const GxB_FC64_t *x) ;
+void gb_mycx_not (gb_mycx *z, const gb_mycx *x) ;
+void gb_mycx_real (double *z, const gb_mycx *x) ;
+void gb_mycx_imag (double *z, const gb_mycx *x) ;
+void gb_mycx_cabs (double *z, const gb_mycx *x) ;
+void gb_mycx_angle (double *z, const gb_mycx *x) ;
+void gb_fx64_cmplx_real (GxB_FC64_t *z, const double *x) ;
+void gb_mycx_cmplx_real (gb_mycx *z, const double *x) ;
+void gb_fx64_cmplx_imag (GxB_FC64_t *z, const double *x) ;
+void gb_mycx_cmplx_imag (gb_mycx *z, const double *x) ;
 
 //------------------------------------------------------------------------------
 // C++ compatibility

GraphBLAS/Demo/Include/usercomplex.h

@@ -8,6 +8,7 @@ July 25, 2025: version 10.1.1
     * JIT file lock/unlock: removed; if multiple user processes use
         GraphBLAS at the same time, each must set their own unique JIT cache.
     * (65) bug fix: theta type definitions for user-defined index binary ops
+        were incorrectly typedef'd in the JIT kernels.
 
 June 1, 2025: version 10.1.0
 

GraphBLAS/Doc/ChangeLog

@@ -426,6 +426,9 @@ \subsubsection{{\sf GxB\_BinaryOp\_new:} create a named user-defined binary oper
   "void absdiff (double *z, double *x, double *y) { (*z) = fabs ((*x) - (*y)) ; }",
   GxB_JIT_C_DEFINITION) ;\end{verbatim}}
 
+To avoid name collisions with LAGraph and GraphBLAS, avoid
+function names that start with \verb'LG_' and \verb'gb_'.
+
 %-------------------------------------------------------------------------------
 \subsubsection{{\sf GrB\_BinaryOp\_wait:} wait for a binary operator}
 %-------------------------------------------------------------------------------

GraphBLAS/Doc/GraphBLAS_UserGuide.pdf

@@ -194,6 +194,9 @@ \subsubsection{{\sf GxB\_IndexBinaryOp\_new:} create a user-defined index-binary
     GrB_Vector_new (&c, Tuple, nrows, 1)) ;
     GrB_mxv (c, NULL, NULL, Semiring, A, y, NULL) ; \end{verbatim}}
 
+To avoid name collisions with LAGraph and GraphBLAS, avoid
+function names that start with \verb'LG_' and \verb'gb_'.
+
 \newpage
 %-------------------------------------------------------------------------------
 \subsubsection{{\sf GxB\_IndexBinaryOp\_wait:} wait for an index-binary operator}

GraphBLAS/Doc/UserGuide/GrB_objects_BinaryOp.tex

@@ -219,6 +219,10 @@ \subsubsection{{\sf GxB\_IndexUnaryOp\_new:} create a named user-defined index-u
     GrB_set (Banded, "banded_idx", GxB_JIT_C_NAME)) ;
     GrB_set (Banded, BANDED_IDX_DEFN, GxB_JIT_C_DEFINITION)) ;\end{verbatim}}
 
+To avoid name collisions with LAGraph and GraphBLAS, avoid
+function names that start with \verb'LG_' and \verb'gb_'.
+
+\newpage
 %-------------------------------------------------------------------------------
 \subsubsection{{\sf GrB\_IndexUnaryOp\_wait:} wait for an index-unary operator}
 %-------------------------------------------------------------------------------
@@ -240,7 +244,6 @@ \subsubsection{{\sf GrB\_IndexUnaryOp\_wait:} wait for an index-unary operator}
 SuiteSparse:GraphBLAS currently does nothing except to ensure that the
 \verb'op' is valid.
 
-\newpage
 %-------------------------------------------------------------------------------
 \subsubsection{{\sf GrB\_IndexUnaryOp\_free:} free a user-defined index-unary operator}
 %-------------------------------------------------------------------------------

GraphBLAS/Doc/UserGuide/GrB_objects_IndexBinaryOp.tex

@@ -212,6 +212,9 @@ \subsubsection{{\sf GxB\_Type\_new:} create a user-defined type (with name and d
     GrB_set (MyQtype, "typedef struct { float x [4][4] ; int color ; } myquaternion ;"
         GxB_JIT_C_DEFINITION) ; \end{verbatim}}
 
+To avoid name collisions with LAGraph and GraphBLAS, avoid
+type names that start with \verb'LG_' and \verb'gb_'.
+
 %-------------------------------------------------------------------------------
 \subsubsection{{\sf GrB\_Type\_wait:} wait for a type}
 %-------------------------------------------------------------------------------

GraphBLAS/Doc/UserGuide/GrB_objects_IndexUnaryOp.tex

@@ -313,6 +313,9 @@ \subsubsection{{\sf GxB\_UnaryOp\_new:} create a named user-defined unary operat
     GrB_set (Square, "void square (double *z, double *x) { (*z) = (*x) * (*x) ; } ;",
         GxB_JIT_C_DEFINITION) ; \end{verbatim}}
 
+To avoid name collisions with LAGraph and GraphBLAS, avoid
+function names that start with \verb'LG_' and \verb'gb_'.
+
 % \newpage
 %-------------------------------------------------------------------------------
 \subsubsection{{\sf GrB\_UnaryOp\_wait:} wait for a unary operator}

GraphBLAS/Doc/UserGuide/GrB_objects_Type.tex

@@ -16,7 +16,7 @@ \section{Release Notes}
     \item JIT file lock/unlock: removed; if multiple user processes use
         GraphBLAS at the same time, each must set their own unique JIT cache.
     \item (65) bug fix: theta type definitions for user-defined index
-        binary ops.
+        binary ops were incorrectly typedef'd in the JIT kernels.
     \end{itemize}
 
 \item June 1, 2025: version 10.1.0