academic/suitesparse: Added (collection of sparse matrix libraries)

Signed-off-by: dsomero <xgizzmo@slackbuilds.org>

1 files changed, 33 insertions, 0 deletions

diff --git a/academic/suitesparse/README b/academic/suitesparse/README
new file mode 100644
index 0000000000..577c027875
--- /dev/null
+++ b/academic/suitesparse/README
@@ -0,0 +1,33 @@
+suitesparse is a collection of libraries for computations involving sparse
+matrices.  The package includes the following libraries:
+
+  AMD         approximate minimum degree ordering
+  BTF         permutation to block triangular form (beta)
+  CAMD        constrained approximate minimum degree ordering
+  COLAMD      column approximate minimum degree ordering
+  CCOLAMD     constrained column approximate minimum degree ordering
+  CHOLMOD     sparse Cholesky factorization
+  CXSparse    CSparse extended: complex matrix, int and long int support
+  KLU         sparse LU factorization, primarily for circuit simulation
+  LDL         a simple LDL' factorization
+  SQPR        a multithread, multifrontal, rank-revealing sparse QR
+              factorization method
+  UMFPACK     sparse LU factorization
+  UFconfig    configuration file for all the above packages.
+
+This requires blas and lapack.
+
+suitesparse is an optional dependency for the octave package.
+
+NOTES:
+
+* CHOLMOD can also be compiled to use the METIS library, but it is not
+  used here because its licensing terms exclude it from Octave.
+
+* CXSparse is a superset of CSparse, and the two share common header
+  names, so it does not make sense to build both. CXSparse is built
+  by default.
+
+* SlackBuilds.org also has all the parts of this suite as individual
+  builds DO NOT try and install the individual parts and the suite pick
+  one or the other.