[suitesparse] 06/07: Overhaul long package descriptions.

Sébastien Villemot sebastien at debian.org
Fri Apr 10 16:05:33 UTC 2015


This is an automated email from the git hooks/post-receive script.

sebastien pushed a commit to branch master
in repository suitesparse.

commit 6a7bc455039a5f0db50a2cc9bbbc0bf0dc299cb9
Author: Sébastien Villemot <sebastien at debian.org>
Date:   Fri Apr 10 18:00:34 2015 +0200

    Overhaul long package descriptions.
    
    Closes: #633042
---
 debian/control    | 96 ++++++++++++++++++++++++++++++++++++++-----------------
 debian/control.in | 96 ++++++++++++++++++++++++++++++++++++++-----------------
 2 files changed, 134 insertions(+), 58 deletions(-)

diff --git a/debian/control b/debian/control
index 08197f1..9ca6fd1 100644
--- a/debian/control
+++ b/debian/control
@@ -24,9 +24,11 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: approximate minimum degree ordering library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- AMD         approximate minimum degree ordering
+ The AMD library provides a set of routines for pre-ordering sparse matrices
+ prior to Cholesky or LU factorization, using the "Approximate Minimum Degree
+ ordering" algorithm.
 
 Package: libbtf1.2.1
 Section: libs
@@ -36,9 +38,15 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: permutation to block triangular form library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
- .
- BTF         permutation to block triangular form (beta)
+ sparse matrices.
+ .
+ The BTF library is a software package for permuting a matrix into Block upper
+ Triangular Form. It includes a maximum transversal algorithm, which finds a
+ permutation of a square or rectangular matrix so that it has a zero-free
+ diagonal (if one exists); otherwise, it finds a maximal matching which
+ maximizes the number of nonzeros on the diagonal. The package also includes a
+ method for finding the strongly connected components of a graph. These two
+ methods together give the permutation to block upper triangular form.
 
 Package: libcamd2.4.1
 Section: libs
@@ -48,9 +56,11 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: symmetric approximate minimum degree library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- CAMD        symmetric approximate minimum degree
+ The CAMD library provides a set of routines for pre-ordering sparse matrices
+ prior to Cholesky or LU factorization, using the approximate minimum degree
+ ordering algorithm with optional ordering constraints.
 
 Package: libcolamd2.9.1
 Section: libs
@@ -60,9 +70,12 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: column approximate minimum degree ordering library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- COLAMD      column approximate minimum degree ordering
+ The COLAMD library implements the "COLumn Approximate Minimum Degree ordering"
+ algorithm. It computes a permutation vector P such that the LU factorization
+ of A (:,P) tends to be sparser than that of A. The Cholesky factorization of
+ (A (:,P))'*(A (:,P)) will also tend to be sparser than that of A'*A.
 
 Package: libccolamd2.9.1
 Section: libs
@@ -72,9 +85,13 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: constrained column approximate library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- CCOLAMD      constrained column approximate minimum degree ordering
+ The CCOLAMD library implements the "Constrained COLumn Approximate Minimum
+ Degree ordering" algorithm. It computes a permutation vector P such that the
+ LU factorization of A (:,P) tends to be sparser than that of A. The Cholesky
+ factorization of (A (:,P))'*(A (:,P)) will also tend to be sparser than that
+ of A'*A.
 
 Package: libcholmod3.0.5
 Section: libs
@@ -84,9 +101,15 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: sparse Cholesky factorization library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
- .
- CHOLMOD     sparse Cholesky factorization
+ sparse matrices.
+ .
+ The CHOLMOD library provides a set of routines for factorizing sparse
+ symmetric positive definite matrices of the form A or AA', updating/downdating
+ a sparse Cholesky factorization, solving linear systems, updating/downdating
+ the solution to the triangular system Lx=b, and many other sparse matrix
+ functions for both symmetric and unsymmetric matrices. Its supernodal Cholesky
+ factorization relies on LAPACK and the Level-3 BLAS, and obtains a substantial
+ fraction of the peak performance of the BLAS.
 
 Package: libcsparse3.1.4
 Section: libs
@@ -96,9 +119,15 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: concise sparse matrix library
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- CSparse     a concise sparse matrix package
+ The CSparse library provides several matrix algorithms. The focus is on direct
+ methods; iterative methods and solvers for eigenvalue problems are beyond the
+ scope of this package.
+ .
+ The performance of the sparse factorization methods in CSparse will not be
+ competitive with UMFPACK or CHOLMOD, but the codes are much more concise and
+ easy to understand. Other methods are competitive.
 
 Package: libcxsparse3.1.4
 Section: libs
@@ -108,9 +137,10 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: concise sparse matrix library (complex, int and long int support)
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- CXSparse    CSparse extended: complex matrix, int and long int support
+ The CXSparse library is a version of CSparse (see libcsparse package) that
+ operates on both real and complex matrices.
 
 Package: libklu1.3.2
 Section: libs
@@ -120,9 +150,10 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: circuit simulation sparse LU factorization library
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- KLU         sparse LU factorization, primarily for circuit simulation
+ The KLU library provides routines for LU factorization, primarily for circuit
+ simulation.
 
 Package: libldl2.2.1
 Section: libs
@@ -132,9 +163,13 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: simple LDL' factorization library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- LDL         a simple LDL' factorization
+ The LDL library provides routines for sparse LDL' factorization and solving.
+ These routines are not terrifically fast (they do not use dense matrix
+ kernels), but the code is very short and concise. The purpose is to illustrate
+ the algorithms in a very concise and readable manner, primarily for
+ educational purposes.
 
 Package: libumfpack5.7.1
 Section: libs
@@ -144,9 +179,10 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: sparse LU factorization library
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- UMFPACK     sparse LU factorization
+ The UMFPACK library provides a set of routines solving sparse linear systems
+ via LU factorization.
 
 Package: libspqr2.0.1
 Section: libs
@@ -156,9 +192,10 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: sparse QR factorization library
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- SPQR        sparse QR factorization library
+ SuiteSparseQR (SPQR) is a multithreaded, multifrontal, rank-revealing sparse
+ QR factorization method.
 
 Package: libsuitesparseconfig4.4.4
 Section: libs
@@ -168,9 +205,10 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: configuration routines for all SuiteSparse modules
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- SuiteSparse_config    configuration routines for all SuiteSparse modules
+ The SuiteSparse_config library provides configuration routines that are common
+ to all SuiteSparse libraries.
 
 Package: libsuitesparse-dev
 Section: libdevel
@@ -291,5 +329,5 @@ Conflicts: libufsparse-doc, libumfpack4-doc
 Recommends: libatlas-doc, libblas-doc
 Description: libraries for sparse matrices computations (documentation)
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package contains the user guides for the
+ sparse matrices. This package contains the user guides for the
  libraries distributed by the SuiteSparse project.
diff --git a/debian/control.in b/debian/control.in
index 7e55616..1b8b5f2 100644
--- a/debian/control.in
+++ b/debian/control.in
@@ -19,9 +19,11 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: approximate minimum degree ordering library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- AMD         approximate minimum degree ordering
+ The AMD library provides a set of routines for pre-ordering sparse matrices
+ prior to Cholesky or LU factorization, using the "Approximate Minimum Degree
+ ordering" algorithm.
 
 Package: @BTF@
 Section: libs
@@ -31,9 +33,15 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: permutation to block triangular form library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
- .
- BTF         permutation to block triangular form (beta)
+ sparse matrices.
+ .
+ The BTF library is a software package for permuting a matrix into Block upper
+ Triangular Form. It includes a maximum transversal algorithm, which finds a
+ permutation of a square or rectangular matrix so that it has a zero-free
+ diagonal (if one exists); otherwise, it finds a maximal matching which
+ maximizes the number of nonzeros on the diagonal. The package also includes a
+ method for finding the strongly connected components of a graph. These two
+ methods together give the permutation to block upper triangular form.
 
 Package: @CAMD@
 Section: libs
@@ -43,9 +51,11 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: symmetric approximate minimum degree library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- CAMD        symmetric approximate minimum degree
+ The CAMD library provides a set of routines for pre-ordering sparse matrices
+ prior to Cholesky or LU factorization, using the approximate minimum degree
+ ordering algorithm with optional ordering constraints.
 
 Package: @COLAMD@
 Section: libs
@@ -55,9 +65,12 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: column approximate minimum degree ordering library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- COLAMD      column approximate minimum degree ordering
+ The COLAMD library implements the "COLumn Approximate Minimum Degree ordering"
+ algorithm. It computes a permutation vector P such that the LU factorization
+ of A (:,P) tends to be sparser than that of A. The Cholesky factorization of
+ (A (:,P))'*(A (:,P)) will also tend to be sparser than that of A'*A.
 
 Package: @CCOLAMD@
 Section: libs
@@ -67,9 +80,13 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: constrained column approximate library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- CCOLAMD      constrained column approximate minimum degree ordering
+ The CCOLAMD library implements the "Constrained COLumn Approximate Minimum
+ Degree ordering" algorithm. It computes a permutation vector P such that the
+ LU factorization of A (:,P) tends to be sparser than that of A. The Cholesky
+ factorization of (A (:,P))'*(A (:,P)) will also tend to be sparser than that
+ of A'*A.
 
 Package: @CHOLMOD@
 Section: libs
@@ -79,9 +96,15 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: sparse Cholesky factorization library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
- .
- CHOLMOD     sparse Cholesky factorization
+ sparse matrices.
+ .
+ The CHOLMOD library provides a set of routines for factorizing sparse
+ symmetric positive definite matrices of the form A or AA', updating/downdating
+ a sparse Cholesky factorization, solving linear systems, updating/downdating
+ the solution to the triangular system Lx=b, and many other sparse matrix
+ functions for both symmetric and unsymmetric matrices. Its supernodal Cholesky
+ factorization relies on LAPACK and the Level-3 BLAS, and obtains a substantial
+ fraction of the peak performance of the BLAS.
 
 Package: @CSparse@
 Section: libs
@@ -91,9 +114,15 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: concise sparse matrix library
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- CSparse     a concise sparse matrix package
+ The CSparse library provides several matrix algorithms. The focus is on direct
+ methods; iterative methods and solvers for eigenvalue problems are beyond the
+ scope of this package.
+ .
+ The performance of the sparse factorization methods in CSparse will not be
+ competitive with UMFPACK or CHOLMOD, but the codes are much more concise and
+ easy to understand. Other methods are competitive.
 
 Package: @CXSparse@
 Section: libs
@@ -103,9 +132,10 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: concise sparse matrix library (complex, int and long int support)
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- CXSparse    CSparse extended: complex matrix, int and long int support
+ The CXSparse library is a version of CSparse (see libcsparse package) that
+ operates on both real and complex matrices.
 
 Package: @KLU@
 Section: libs
@@ -115,9 +145,10 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: circuit simulation sparse LU factorization library
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- KLU         sparse LU factorization, primarily for circuit simulation
+ The KLU library provides routines for LU factorization, primarily for circuit
+ simulation.
 
 Package: @LDL@
 Section: libs
@@ -127,9 +158,13 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: simple LDL' factorization library for sparse matrices
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- LDL         a simple LDL' factorization
+ The LDL library provides routines for sparse LDL' factorization and solving.
+ These routines are not terrifically fast (they do not use dense matrix
+ kernels), but the code is very short and concise. The purpose is to illustrate
+ the algorithms in a very concise and readable manner, primarily for
+ educational purposes.
 
 Package: @UMFPACK@
 Section: libs
@@ -139,9 +174,10 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: sparse LU factorization library
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- UMFPACK     sparse LU factorization
+ The UMFPACK library provides a set of routines solving sparse linear systems
+ via LU factorization.
 
 Package: @SPQR@
 Section: libs
@@ -151,9 +187,10 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: sparse QR factorization library
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- SPQR        sparse QR factorization library
+ SuiteSparseQR (SPQR) is a multithreaded, multifrontal, rank-revealing sparse
+ QR factorization method.
 
 Package: @SuiteSparse_config@
 Section: libs
@@ -163,9 +200,10 @@ Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: configuration routines for all SuiteSparse modules
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package includes the following dynamic library:
+ sparse matrices.
  .
- SuiteSparse_config    configuration routines for all SuiteSparse modules
+ The SuiteSparse_config library provides configuration routines that are common
+ to all SuiteSparse libraries.
 
 Package: libsuitesparse-dev
 Section: libdevel
@@ -286,5 +324,5 @@ Conflicts: libufsparse-doc, libumfpack4-doc
 Recommends: libatlas-doc, libblas-doc
 Description: libraries for sparse matrices computations (documentation)
  Suitesparse is a collection of libraries for computations involving
- sparse matrices.  This package contains the user guides for the
+ sparse matrices. This package contains the user guides for the
  libraries distributed by the SuiteSparse project.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/suitesparse.git



More information about the debian-science-commits mailing list