Adding *_version functions to all packages

Author: DrTimothyAldenDavis

AMD/Config/amd.h.in

@@ -313,6 +313,10 @@ void amd_l_control  (double Control [ ]) ;
 void amd_info       (double Info [ ]) ;
 void amd_l_info     (double Info [ ]) ;
 
+// amd_version: return AMD version.  The version array is returned with
+// version [0..2] = {AMD_MAIN_VERSION, AMD_SUB_VERSION, AMD_SUBSUB_VERSION}
+void amd_version (int version [3]) ;
+
 #ifdef __cplusplus
 }
 #endif

AMD/Demo/amd_demo.c

@@ -52,14 +52,17 @@ int main (void)
     double Control [AMD_CONTROL], Info [AMD_INFO] ;
     char A [24][24] ;
 
-    /* here is an example of how to use AMD_VERSION.  This code will work in
-     * any version of AMD. */
-#if defined(AMD_VERSION) && (AMD_VERSION >= AMD_VERSION_CODE(1,2))
     printf ("AMD version %d.%d.%d, date: %s\n",
         AMD_MAIN_VERSION, AMD_SUB_VERSION, AMD_SUBSUB_VERSION, AMD_DATE) ;
-#else
-    printf ("AMD version: 1.1 or earlier\n") ;
-#endif
+    int version [3] ;
+    amd_version (version) ;
+    if ((version [0] != AMD_MAIN_VERSION) ||
+        (version [1] != AMD_SUB_VERSION) ||
+        (version [2] != AMD_SUBSUB_VERSION))
+    {
+        fprintf (stderr, "version in header does not match library\n") ;
+        abort ( ) ;
+    }
 
     printf ("AMD demo, with the 24-by-24 Harwell/Boeing matrix, can_24:\n") ;
 

AMD/Demo/amd_l_demo.c

@@ -53,14 +53,17 @@ int main (void)
     double Control [AMD_CONTROL], Info [AMD_INFO] ;
     char A [24][24] ;
 
-    /* here is an example of how to use AMD_VERSION.  This code will work in
-     * any version of AMD. */
-#if defined(AMD_VERSION) && (AMD_VERSION >= AMD_VERSION_CODE(1,2))
     printf ("AMD version %d.%d.%d, date: %s\n",
         AMD_MAIN_VERSION, AMD_SUB_VERSION, AMD_SUBSUB_VERSION, AMD_DATE) ;
-#else
-    printf ("AMD version: 1.1 or earlier\n") ;
-#endif
+    int version [3] ;
+    amd_version (version) ;
+    if ((version [0] != AMD_MAIN_VERSION) ||
+        (version [1] != AMD_SUB_VERSION) ||
+        (version [2] != AMD_SUBSUB_VERSION))
+    {
+        fprintf (stderr, "version in header does not match library\n") ;
+        abort ( ) ;
+    }
 
     printf ("AMD demo, with the 24-by-24 Harwell/Boeing matrix, can_24:\n") ;
 

AMD/Doc/AMD_UserGuide.pdf

@@ -202,8 +202,8 @@ \section{Using AMD in a C program}
 \label{Cversion}
 %------------------------------------------------------------------------------
 
-The C-callable AMD library consists of seven user-callable routines and one
-include file.  There are two versions of each of the routines, with
+The C-callable AMD library consists of eight user-callable routines and one
+include file.  There are two versions of seven of the routines, with
 \verb'int32_t' and \verb'int64_t' integers.
 The routines with prefix
 {\tt amd\_l\_} use \verb'int64_t' integer arguments; the others use
@@ -303,6 +303,8 @@ \section{Using AMD in a C program}
     but it destroys the matrix on output.  Additional workspace must be passed.
     Refer to the source file {\tt AMD/Source/amd\_2.c} for a description.
 
+\item \verb'amd_version': returns the AMD version.
+
 \end{itemize}
 
 The nonzero pattern of the matrix $\m{A}$ is represented in compressed column
@@ -480,6 +482,16 @@ \section{Synopsis of C-callable routines}
 \end{verbatim}
 }
 
+The \verb'amd_version' function uses plain \verb'int':
+
+{\footnotesize
+\begin{verbatim}
+#include "amd.h"
+int version [3] ;
+amd_version (version) ;
+\end{verbatim}
+}
+
 %------------------------------------------------------------------------------
 \section{Using AMD in a Fortran program}
 %------------------------------------------------------------------------------

AMD/Doc/AMD_UserGuide.tex

@@ -2,6 +2,7 @@ Dec 30, 2023: version 3.3.0
 
     * major change to build system: by Markus Mützel
     * revised test for integer overflow: for CHOLMOD 5.1.0 tests
+    * amd_version: added to return version of AMD
 
 Sept 18, 2023: version 3.2.1
 

AMD/Doc/ChangeLog

@@ -313,6 +313,10 @@ void amd_l_control  (double Control [ ]) ;
 void amd_info       (double Info [ ]) ;
 void amd_l_info     (double Info [ ]) ;
 
+// amd_version: return AMD version.  The version array is returned with
+// version [0..2] = {AMD_MAIN_VERSION, AMD_SUB_VERSION, AMD_SUBSUB_VERSION}
+void amd_version (int version [3]) ;
+
 #ifdef __cplusplus
 }
 #endif

AMD/Include/amd.h

@@ -0,0 +1,19 @@
+//------------------------------------------------------------------------------
+// AMD/Source/amd_version: return AMD version
+//------------------------------------------------------------------------------
+
+// AMD, Copyright (c) 1996-2023, Timothy A. Davis, Patrick R. Amestoy, and
+// Iain S. Duff.  All Rights Reserved.
+// SPDX-License-Identifier: BSD-3-clause
+
+//------------------------------------------------------------------------------
+
+#include "amd_internal.h"
+
+void amd_version (int version [3])
+{
+    version [0] = AMD_MAIN_VERSION ;
+    version [1] = AMD_SUB_VERSION ;
+    version [2] = AMD_SUBSUB_VERSION ;
+}
+

AMD/Source/amd_version.c

@@ -218,6 +218,12 @@ int32_t btf_order       /* returns number of blocks found */
 int64_t btf_l_order (int64_t, int64_t *, int64_t *, double , double *,
     int64_t *, int64_t *, int64_t *, int64_t *, int64_t *) ;
 
+//------------------------------------------------------------------------------
+// btf_version: return BTF version
+//------------------------------------------------------------------------------
+
+void btf_version (int version [3]) ;
+
 #ifdef __cplusplus
 }
 #endif

BTF/Config/btf.h.in

@@ -1,6 +1,7 @@
 Dec 30, 2023: version 2.3.0
 
     * major change to build system: by Markus Mützel
+    * btf_version: added to return version of BTF
 
 Sept 18, 2023: version 2.2.1