Merge branch 'develop' into 268-provide-grbsetmatrix-out-matrix-mask-matrix-in

Author: aleksamilisavljevic

include/CMakeLists.txt

@@ -31,7 +31,6 @@ assert_valid_variables( INCLUDE_INSTALL_DIR NO_NUMA_DEF )
 add_library( backend_headers_nodefs INTERFACE )
 target_include_directories( backend_headers_nodefs INTERFACE
 	$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
-	$<INSTALL_INTERFACE:.>
 )
 
 # regex to filter all headers files based on the extension and
@@ -55,6 +54,7 @@ set( root_files
 	"graphblas/vector.hpp" "graphblas/synchronizedNonzeroIterator.hpp"
 	"graphblas/nonzeroStorage.hpp"
 )
+
 set( GRB_INCLUDE_INSTALL_DIR "${INCLUDE_INSTALL_DIR}/graphblas")
 install( FILES ${root_files} DESTINATION "${GRB_INCLUDE_INSTALL_DIR}" )
 
@@ -74,7 +74,6 @@ install( DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/graphblas/base/"
 add_library( alp_utils_headers INTERFACE )
 target_include_directories( alp_utils_headers INTERFACE
 	$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
-	$<INSTALL_INTERFACE:.>
 )
 
 # copy utils headers
@@ -101,6 +100,9 @@ install( TARGETS backend_headers_nodefs EXPORT GraphBLASTargets
 	INCLUDES DESTINATION "${INCLUDE_INSTALL_DIR}"
 )
 
+# the utils library currently depends heavily on other ALP functionalities,
+# but could be easily split out in future; in view of this, export an
+# independent include path (incidentally the same as ALP)
 install( TARGETS alp_utils_headers EXPORT GraphBLASTargets
 	INCLUDES DESTINATION "${INCLUDE_INSTALL_DIR}"
 )
@@ -144,6 +146,7 @@ if( WITH_HYPERDAGS_BACKEND )
 	target_link_libraries( backend_hyperdags_headers INTERFACE "backend_${WITH_HYPERDAGS_USING}_headers" )
 	target_compile_definitions( backend_hyperdags_headers INTERFACE "${HYPERDAGS_INCLUDE_DEFS}" )
 	install( TARGETS backend_hyperdags_headers EXPORT GraphBLASTargets )
+
 	install( DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/graphblas/hyperdags/"
 		DESTINATION "${GRB_INCLUDE_INSTALL_DIR}/hyperdags"
 		FILES_MATCHING REGEX "${HEADERS_REGEX}"
@@ -202,9 +205,7 @@ target_link_libraries( algorithms INTERFACE backend_headers_nodefs )
 
 target_include_directories(
 	algorithms INTERFACE
-
 	$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/graphblas/algorithms>
-	$<INSTALL_INTERFACE:graphblas/algorithms>
 )
 
 install( DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/graphblas/algorithms/"
@@ -219,6 +220,7 @@ install( DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/graphblas/interfaces/"
 
 install( TARGETS algorithms EXPORT GraphBLASTargets )
 
+
 # generate the spblas header with the library prefix
 configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/transition/spblas.h.in
 	${CMAKE_CURRENT_BINARY_DIR}/transition/spblas.h @ONLY
@@ -228,21 +230,23 @@ configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/transition/spblas.h.in
 # these are plain C headers and do not have any dependences
 add_library( transition_headers INTERFACE )
 
-target_include_directories(
-	transition_headers INTERFACE
+target_include_directories( transition_headers INTERFACE
 	$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/transition/>
 	$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/transition/>
-	$<INSTALL_INTERFACE:transition/>
 )
 
+set( TRANSITION_INCLUDE_INSTALL_DIR "${INCLUDE_INSTALL_DIR}/transition" )
+
 install( FILES ${CMAKE_CURRENT_BINARY_DIR}/transition/spblas.h
-	DESTINATION "${INCLUDE_INSTALL_DIR}/transition"
+	DESTINATION "${TRANSITION_INCLUDE_INSTALL_DIR}"
 )
 
 install( DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/transition/"
-	DESTINATION "${INCLUDE_INSTALL_DIR}/transition"
+	DESTINATION "${TRANSITION_INCLUDE_INSTALL_DIR}"
 	FILES_MATCHING REGEX "${HEADERS_REGEX}"
 )
 
-install( TARGETS transition_headers EXPORT GraphBLASTargets )
+install( TARGETS transition_headers EXPORT GraphBLASTargets
+	INCLUDES DESTINATION "${TRANSITION_INCLUDE_INSTALL_DIR}"
+)
 

include/graphblas.hpp

@@ -38,16 +38,36 @@
  *  -# generalised sparse linear algebra, \ref GraphBLAS;
  *  -# vertex-centric programming, \ref Pregel.
  *
- * Additionally, to ease integration with existing software, ALP defines
- * so-called \ref TRANS libraries, which presently includes (partial)
- * implementations of the \ref SPARSEBLAS and \ref SPBLAS (de-facto) standards,
- * as well as an interface for numerical \ref TRANS_SOLVERS.
- *
  * Several other programming interfaces are under design at present.
  *
- * For authors who contributed to ALP, please see the NOTICE file.
- *
- * Contact:
+ * Additionally, to ease integration with existing software, ALP defines
+ * so-called \ref TRANS libraries. Such libraries may be employed to replace
+ * existing libraries, therefore benefitting of ALP-optimised software without
+ * having to change any source code-- simply switch out the library linked
+ * against, and transparently enjoy speedups such as enabled by the nonblocking
+ * backend.
+ *
+ * The \ref TRANS libraries are presently in a prototype stage. Presently, the
+ * following interfaces are (partially) implemented:
+ *  -# the \ref SPARSEBLAS standard (partial);
+ *  -# the \ref SPBLAS de-facto standard (partial);
+ *  -# the \ref TRANS_SOLVERS CRS/CSR-based sparse solver API (CG and PCG); and
+ *  -# the \ref kml_iss.h "KML Sparse Solver API".
+ *
+ * These transition path libraries are built and installed by default. Both
+ * sequential and shared-memory parallel libraries are provided.
+ *
+ * The maintainers are happy to consider requests for expanding the currently
+ * available transition paths, both in terms of missing functions in the
+ * presently available libraries, as well as of additional libraries; please
+ * feel free to submit feature requests on GitHub or Gitee, and/or to contact
+ * the maintainers.
+ *
+ * For the many authors who contributed to ALP, please see the NOTICE file
+ * distributed with ALP. The underwrited would like to take the opportunity here
+ * to express their sincere thanks for the many contributors over the years.
+ *
+ * Project contact information:
  *  - https://github.com/Algebraic-Programming/ALP
  *  - https://gitee.com/CSL-ALP/graphblas/
  *  - [email protected]