The Blaze library makes extensive use of the LAPACK functionality for various compute tasks (including the decomposition, inversion and the computation of the determinant of dense matrices). For this purpose, Blaze implements several convenient C++ wrapper functions for all required LAPACK functions. The following sections give a complete overview of all available LAPACK wrapper functions. For more details on the individual LAPACK functions see the Blaze function documentation or the LAPACK online documentation browser:
Most of the wrapper functions are implemented as thin wrappers around LAPACK functions. They provide the parameters of the original LAPACK functions and thus provide maximum flexibility:
Signed integer type used in the BLAS/LAPACK wrapper functions.
Definition Types.h:64
In this context, blas_int_t is either a 32-bit or 64-bit signed integral type, depending on the setting of the BLAZE_BLAS_IS_64BIT compilation switch (see BLAS Mode).
Additionally, Blaze provides wrappers that provide a higher level of abstraction. These wrappers provide a maximum of convenience:
const std::unique_ptr<blas_int_t[]> ipiv( new blas_int_t[N] ); // No initialization required
getrf( A, ipiv.get() ); // Cannot fail
getri( A, ipiv.get() ); // Reports failure via exception
Note
All functions only work for general, non-adapted matrices with float, double, complex<float>, or complex<double> element type. The attempt to call the function with adaptors or matrices of any other element type results in a compile time error!
All functions can only be used if a fitting LAPACK library is available and linked to the final executable. Otherwise a call to this function will result in a linker error.
For performance reasons all functions do only provide the basic exception safety guarantee, i.e. in case an exception is thrown the given matrix may already have been modified.
Matrix Decomposition
The following functions decompose/factorize the given dense matrix. Based on this decomposition the matrix can be inverted or used to solve a linear system of equations.
LU Decomposition
The following functions provide an interface for the LAPACK functions sgetrf(), dgetrf(), cgetrf(), and zgetrf(), which compute the LU decomposition for the given general matrix:
void getrf(blas_int_t m, blas_int_t n, float *A, blas_int_t lda, blas_int_t *ipiv, blas_int_t *info)
LAPACK kernel for the LU decomposition of the given dense general single precision column-major matri...
Definition getrf.h:140
The decomposition has the form
\f[ A = P \cdot L \cdot U, \f]\n
where P is a permutation matrix, L is a lower unitriangular matrix, and U is an upper triangular matrix. The resulting decomposition is stored within A: In case of a column-major matrix, L is stored in the lower part of A and U is stored in the upper part. The unit diagonal elements of L are not stored. In case A is a row-major matrix the result is transposed.
Note
The LU decomposition will never fail, even for singular matrices. However, in case of a singular matrix the resulting decomposition cannot be used for a matrix inversion or solving a linear system of equations.
LDLT Decomposition
The following functions provide an interface for the LAPACK functions ssytrf(), dsytrf(), csytrf(), and zsytrf(), which compute the LDLT (Bunch-Kaufman) decomposition for the given symmetric indefinite matrix:
LAPACK kernel for the decomposition of the given dense symmetric indefinite single precision column-m...
Definition sytrf.h:155
The decomposition has the form
\f[ A = U D U^{T} \texttt{ (if uplo = 'U'), or }
A = L D L^{T} \texttt{ (if uplo = 'L'), } \f]
where U (or L) is a product of permutation and unit upper (lower) triangular matrices, and D is symmetric and block diagonal with 1-by-1 and 2-by-2 diagonal blocks. The resulting decomposition is stored within A: In case uplo is set to 'L' the result is stored in the lower part of the matrix and the upper part remains untouched, in case uplo is set to 'U' the result is stored in the upper part and the lower part remains untouched.
Note
The Bunch-Kaufman decomposition will never fail, even for singular matrices. However, in case of a singular matrix the resulting decomposition cannot be used for a matrix inversion or solving a linear system of equations.
LDLH Decomposition
The following functions provide an interface for the LAPACK functions chetrf() and zsytrf(), which compute the LDLH (Bunch-Kaufman) decomposition for the given Hermitian indefinite matrix:
LAPACK kernel for the decomposition of the given dense Hermitian indefinite single precision complex ...
Definition hetrf.h:143
The decomposition has the form
\f[ A = U D U^{H} \texttt{ (if uplo = 'U'), or }
A = L D L^{H} \texttt{ (if uplo = 'L'), } \f]
where U (or L) is a product of permutation and unit upper (lower) triangular matrices, and D is Hermitian and block diagonal with 1-by-1 and 2-by-2 diagonal blocks. The resulting decomposition is stored within A: In case uplo is set to 'L' the result is stored in the lower part of the matrix and the upper part remains untouched, in case uplo is set to 'U' the result is stored in the upper part and the lower part remains untouched.
Note
The Bunch-Kaufman decomposition will never fail, even for singular matrices. However, in case of a singular matrix the resulting decomposition cannot be used for a matrix inversion or solving a linear system of equations.
Cholesky Decomposition
The following functions provide an interface for the LAPACK functions spotrf(), dpotrf(), cpotrf(), and zpotrf(), which compute the Cholesky (LLH) decomposition for the given positive definite matrix:
LAPACK kernel for the Cholesky decomposition of the given dense positive definite single precision co...
Definition potrf.h:137
The decomposition has the form
\f[ A = U^{T} U \texttt{ (if uplo = 'U'), or }
A = L L^{T} \texttt{ (if uplo = 'L'), } \f]
where U is an upper triangular matrix and L is a lower triangular matrix. The Cholesky decomposition fails if the given matrix A is not a positive definite matrix. In this case a std::invalid_argument exception is thrown.
QR Decomposition
The following functions provide an interface for the LAPACK functions sgeqrf(), dgeqrf(), cgeqrf(), and zgeqrf(), which compute the QR decomposition of the given general matrix:
void geqrf(blas_int_t m, blas_int_t n, float *A, blas_int_t lda, float *tau, float *work, blas_int_t lwork, blas_int_t *info)
LAPACK kernel for the QR decomposition of the given dense single precision column-major matrix.
Definition geqrf.h:151
The decomposition has the form
\f[ A = Q \cdot R, \f]
where the Q is represented as a product of elementary reflectors
\f[ Q = H(1) H(2) . . . H(k) \texttt{, with k = min(m,n).} \f]
Each H(i) has the form
\f[ H(i) = I - tau \cdot v \cdot v^T, \f]
where tau is a real scalar, and v is a real vector with v(0:i-1) = 0 and v(i) = 1. v(i+1:m) is stored on exit in A(i+1:m,i), and tau in tau(i). Thus on exit the elements on and above the diagonal of the matrix contain the min(m,n)-by-n upper trapezoidal matrix R (R is upper triangular if m >= n); the elements below the diagonal, with the array tau, represent the orthogonal matrix Q as a product of min(m,n) elementary reflectors.
The following functions provide an interface for the LAPACK functions sorgqr(), dorgqr(), sorg2r(), dorg2r(), cungqr(), zunqqr(), cung2r(), and zung2r(), which reconstruct the Q matrix from a QR decomposition:
LAPACK kernel for the reconstruction of the orthogonal matrix Q from a QR decomposition.
Definition ung2r.h:122
The following functions provide an interface for the LAPACK functions sormqr(), dormqr(), cunmqr(), and zunmqr(), which can be used to multiply a matrix with the Q matrix from a QR decomposition:
LAPACK kernel for the multiplication of the single precision Q from a QR decomposition with another m...
Definition ormqr.h:145
RQ Decomposition
The following functions provide an interface for the LAPACK functions sgerqf(), dgerqf(), cgerqf(), and zgerqf(), which compute the RQ decomposition of the given general matrix:
void gerqf(blas_int_t m, blas_int_t n, float *A, blas_int_t lda, float *tau, float *work, blas_int_t lwork, blas_int_t *info)
LAPACK kernel for the RQ decomposition of the given dense single precision column-major matrix.
Definition gerqf.h:152
The decomposition has the form
\f[ A = R \cdot Q, \f]
where the Q is represented as a product of elementary reflectors
\f[ Q = H(1) H(2) . . . H(k) \texttt{, with k = min(m,n).} \f]
Each H(i) has the form
\f[ H(i) = I - tau \cdot v \cdot v^T, \f]
where tau is a real scalar, and v is a real vector with v(n-k+i+1:n) = 0 and v(n-k+i) = 1. v(1:n-k+i-1) is stored on exit in A(m-k+i,1:n-k+i-1), and tau in tau(i). Thus in case m <= n, the upper triangle of the subarray A(1:m,n-m+1:n) contains the m-by-m upper triangular matrix R and in case m >= n, the elements on and above the (m-n)-th subdiagonal contain the m-by-n upper trapezoidal matrix R; the remaining elements in combination with the array tau represent the orthogonal matrix Q as a product of min(m,n) elementary reflectors.
The following functions provide an interface for the LAPACK functions sorgrq(), dorgrq(), sorgr2(), dorgr2(), cungrq(), zunqrq(), cungr2(), and zunqr2(), which reconstruct the Q matrix from a RQ decomposition:
void orgr2(blas_int_t m, blas_int_t n, blas_int_t k, float *A, blas_int_t lda, const float *tau, float *work, blas_int_t *info)
LAPACK kernel for the reconstruction of the orthogonal matrix Q from a RQ decomposition.
Definition orgr2.h:122
The following functions provide an interface for the LAPACK functions sormrq(), dormrq(), cunmrq(), and zunmrq(), which can be used to multiply a matrix with the Q matrix from a RQ decomposition:
LAPACK kernel for the multiplication of the single precision Q from a RQ decomposition with another m...
Definition ormrq.h:145
QL Decomposition
The following functions provide an interface for the LAPACK functions sgeqlf(), dgeqlf(), cgeqlf(), and zgeqlf(), which compute the QL decomposition of the given general matrix:
void geqlf(blas_int_t m, blas_int_t n, float *A, blas_int_t lda, float *tau, float *work, blas_int_t lwork, blas_int_t *info)
LAPACK kernel for the QL decomposition of the given dense single precision column-major matrix.
Definition geqlf.h:152
The decomposition has the form
\f[ A = Q \cdot L, \f]
where the Q is represented as a product of elementary reflectors
\f[ Q = H(k) . . . H(2) H(1) \texttt{, with k = min(m,n).} \f]
Each H(i) has the form
\f[ H(i) = I - tau \cdot v \cdot v^T, \f]
where tau is a real scalar, and v is a real vector with v(m-k+i+1:m) = 0 and v(m-k+i) = 1. v(1:m-k+i-1) is stored on exit in A(1:m-k+i-1,n-k+i), and tau in tau(i). Thus in case m >= n, the lower triangle of the subarray A(m-n+1:m,1:n) contains the n-by-n lower triangular matrix L and in case m <= n, the elements on and below the (n-m)-th subdiagonal contain the m-by-n lower trapezoidal matrix L; the remaining elements in combination with the array tau represent the orthogonal matrix Q as a product of min(m,n) elementary reflectors.
The following functions provide an interface for the LAPACK functions sorgql(), dorgql(), sorg2l(), dorg2l(), cungql(), zungql(), cung2l(), and zung2l(), which reconstruct the Q matrix from an QL decomposition:
LAPACK kernel for the reconstruction of the orthogonal matrix Q from a QL decomposition.
Definition ungql.h:127
The following functions provide an interface for the LAPACK functions sormql(), dormql(), cunmql(), and zunmql(), which can be used to multiply a matrix with the Q matrix from a QL decomposition:
LAPACK kernel for the multiplication of the single precision Q from a QL decomposition with another m...
Definition ormql.h:145
LQ Decomposition
The following functions provide an interface for the LAPACK functions sgelqf(), dgelqf(), cgelqf(), and zgelqf(), which compute the LQ decomposition of the given general matrix:
void gelqf(blas_int_t m, blas_int_t n, float *A, blas_int_t lda, float *tau, float *work, blas_int_t lwork, blas_int_t *info)
LAPACK kernel for the LQ decomposition of the given dense single precision column-major matrix.
Definition gelqf.h:153
The decomposition has the form
\f[ A = L \cdot Q, \f]
where the Q is represented as a product of elementary reflectors
\f[ Q = H(k) . . . H(2) H(1) \texttt{, with k = min(m,n).} \f]
Each H(i) has the form
\f[ H(i) = I - tau \cdot v \cdot v^T, \f]
where tau is a real scalar, and v is a real vector with v(0:i-1) = 0 and v(i) = 1. v(i+1:n) is stored on exit in A(i,i+1:n), and tau in tau(i). Thus on exit the elements on and below the diagonal of the matrix contain the m-by-min(m,n) lower trapezoidal matrix L (L is lower triangular if m <= n); the elements above the diagonal, with the array tau, represent the orthogonal matrix Q as a product of min(m,n) elementary reflectors.
The following functions provide an interface for the LAPACK functions sorglq(), dorglq(), sorgl2(), dorgl2(), cunglq(), zunqlq(), cungl2(), and zunql2(), which reconstruct the Q matrix from an LQ decomposition:
void orgl2(blas_int_t m, blas_int_t n, blas_int_t k, float *A, blas_int_t lda, const float *tau, float *work, blas_int_t *info)
LAPACK kernel for the reconstruction of the orthogonal matrix Q from a LQ decomposition.
Definition orgl2.h:122
The following functions provide an interface for the LAPACK functions sormlq(), dormlq(), cunmlq(), and zunmlq(), which can be used to multiply a matrix with the Q matrix from a LQ decomposition:
LAPACK kernel for the multiplication of the single precision complex Q from a LQ decomposition with a...
Definition unmlq.h:148
Matrix Inversion
Given a matrix that has already been decomposed, the following functions can be used to invert the matrix in-place.
LU-based Inversion
The following functions provide an interface for the LAPACK functions sgetri(), dgetri(), cgetri(), and zgetri(), which invert a general matrix that has already been decomposed by an LU Decomposition :
LAPACK kernel for the inversion of the given dense general single precision column-major square matri...
Definition getri.h:138
The functions fail if ...
... the given matrix is not a square matrix;
... the given matrix is singular and not invertible.
The first four functions report failure via the info argument, the fifth function throws a std::invalid_argument exception in case of an error.
LDLT-based Inversion
The following functions provide an interface for the LAPACK functions ssytri(), dsytri(), csytri(), and zsytri(), which invert a symmetric indefinite matrix that has already been decomposed by an LDLT Decomposition :
LAPACK kernel for the inversion of the given dense symmetric indefinite single precision column-major...
Definition sytri.h:139
The functions fail if ...
... the given matrix is not a square matrix;
... the given matrix is singular and not invertible.
The first four functions report failure via the info argument, the fifth function throws a std::invalid_argument exception in case of an error.
LDLH-based Inversion
The following functions provide an interface for the LAPACK functions chetri() and zhetri(), which invert an Hermitian indefinite matrix that has already been decomposed by an LDLH Decomposition :
LAPACK kernel for the inversion of the given dense Hermitian indefinite single precision complex colu...
Definition hetri.h:127
The functions fail if ...
... the given matrix is not a square matrix;
... the given matrix is singular and not invertible.
The first four functions report failure via the info argument, the fifth function throws a std::invalid_argument exception in case of an error.
Cholesky-based Inversion
The following functions provide an interface for the LAPACK functions spotri(), dpotri(), cpotri(), and zpotri(), which invert a positive definite matrix that has already been decomposed by an Cholesky Decomposition :
LAPACK kernel for the inversion of the given dense positive definite single precision column-major sq...
Definition potri.h:130
The functions fail if ...
... the given matrix is not a square matrix;
... the given uplo argument is neither 'L' nor 'U';
... the given matrix is singular and not invertible.
The first four functions report failure via the info argument, the fifth function throws a std::invalid_argument exception in case of an error.
Inversion of Triangular Matrices
The following functions provide an interface for the LAPACK functions strtri(), dtrtri(), ctrtri(), and ztrtri(), which invert the given triangular matrix in-place:
LAPACK kernel for the inversion of the given dense triangular single precision column-major matrix.
Definition trtri.h:134
The functions fail if ...
... the given matrix is not a square matrix;
... the given uplo argument is neither 'L' nor 'U';
... the given diag argument is neither 'U' nor 'N';
... the given matrix is singular and not invertible.
The first four functions report failure via the info argument, the fifth function throws a std::invalid_argument exception in case of an error.
Substitution
Given a matrix that has already been decomposed the following functions can be used to perform the forward/backward substitution step to compute the solution to a system of linear equations. Note that depending on the storage order of the system matrix and the given right-hand side the functions solve different equation systems:
Single right-hand side:
if A is column-major
if A is row-major
Multiple right-hand sides:
if both A and B are column-major
if A is row-major and B is column-major
if A is column-major and B is row-major
if both A and B are row-major
In this context the general system matrix A is a n-by-n matrix that has already been factorized by the according decomposition function, x and b are n-dimensional vectors and X and B are either row-major m-by-n matrices or column-major n-by-m matrices.
LU-based Substitution
The following functions provide an interface for the LAPACK functions sgetrs(), dgetrs(), cgetrs(), and zgetrs(), which perform the substitution step for a general matrix that has already been decomposed by an LU Decomposition :
LAPACK kernel for the substitution step of solving a general single precision linear system of equati...
Definition getrs.h:150
Note that depending on the storage order of the system matrix and the given right-hand side the functions solve different equation systems (see Substitution). If the function exits successfully, the vector b or the matrix B contain the solution(s) of the linear system of equations. The functions fail if ...
... the given system matrix is not a square matrix;
... the given trans argument is neither 'N' nor 'T' nor 'C';
... the sizes of the two given matrices do not match.
The first four functions report failure via the info argument, the last two functions throw a std::invalid_argument exception in case of an error.
LDLT-based Substitution
The following functions provide an interface for the LAPACK functions ssytrs(), dsytrs(), csytrs(), and zsytrs(), which perform the substitution step for a symmetric indefinite matrix that has already been decomposed by an LDLT Decomposition :
LAPACK kernel for the substitution step of solving a symmetric indefinite single precision linear sys...
Definition sytrs.h:141
Note that depending on the storage order of the system matrix and the given right-hand side the functions solve different equation systems (see Substitution). If the function exits successfully, the vector b or the matrix B contain the solution(s) of the linear system of equations. The functions fail if ...
... the given system matrix is not a square matrix;
... the given uplo argument is neither 'L' nor 'U';
... the sizes of the two given matrices do not match.
The first four functions report failure via the info argument, the last two functions throw a std::invalid_argument exception in case of an error.
LDLH-based Substitution
The following functions provide an interface for the LAPACK functions chetrs(), and zhetrs(), which perform the substitution step for an Hermitian indefinite matrix that has already been decomposed by an LDLH Decomposition :
LAPACK kernel for the substitution step of solving a symmetric indefinite single precision complex li...
Definition hetrs.h:131
Note that depending on the storage order of the system matrix and the given right-hand side the functions solve different equation systems (see Substitution). If the function exits successfully, the vector b or the matrix B contain the solution(s) of the linear system of equations. The functions fail if ...
... the given system matrix is not a square matrix;
... the given uplo argument is neither 'L' nor 'U';
... the sizes of the two given matrices do not match.
The first two functions report failure via the info argument, the last two functions throw a std::invalid_argument exception in case of an error.
Cholesky-based Substitution
The following functions provide an interface for the LAPACK functions spotrs(), dpotrs(), cpotrs(), and zpotrs(), which perform the substitution step for a positive definite matrix that has already been decomposed by an Cholesky Decomposition :
LAPACK kernel for the substitution step of solving a positive definite single precision linear system...
Definition potrs.h:140
Note that depending on the storage order of the system matrix and the given right-hand side the functions solve different equation systems (see Substitution). If the function exits successfully, the vector b or the matrix B contain the solution(s) of the linear system of equations. The functions fail if ...
... the given system matrix is not a square matrix;
... the given uplo argument is neither 'L' nor 'U';
... the sizes of the two given matrices do not match.
The first two functions report failure via the info argument, the last two functions throw a std::invalid_argument exception in case of an error.
Substitution for Triangular Matrices
The following functions provide an interface for the LAPACK functions strtrs(), dtrtrs(), ctrtrs(), and ztrtrs(), which perform the substitution step for a triangular matrix:
LAPACK kernel for the substitution step of solving a triangular single precision linear system of equ...
Definition trtrs.h:155
Note that depending on the storage order of the system matrix and the given right-hand side the functions solve different equation systems (see Substitution). If the function exits successfully, the vector b or the matrix B contain the solution(s) of the linear system of equations. The functions fail if ...
... the given system matrix is not a square matrix;
... the given uplo argument is neither 'L' nor 'U';
... the given trans argument is neither 'N' nor 'T' nor 'C';
... the given diag argument is neither 'U' nor 'N';
... the sizes of the two given matrices do not match.
The first four functions report failure via the info argument, the last two functions throw a std::invalid_argument exception in case of an error.
Linear System Solver
The following functions represent compound functions that perform both the decomposition step as well as the substitution step to compute the solution to a system of linear equations. Note that depending on the storage order of the system matrix and the given right-hand side the functions solve different equation systems:
Single right-hand side:
if A is column-major
if A is row-major
Multiple right-hand sides:
if both A and B are column-major
if A is row-major and B is column-major
if A is column-major and B is row-major
if both A and B are row-major
In this context the general system matrix A is a n-by-n matrix that has already been factorized by the according decomposition function, x and b are n-dimensional vectors and X and B are either row-major m-by-n matrices or column-major n-by-m matrices.
LU-based Linear System Solver
The following functions provide an interface for the LAPACK functions sgesv(), dgesv(), cgesv(), and zgesv(), which combine an LU Decomposition and the according LU-based Substitution :
LAPACK kernel for solving a general single precision linear system of equations ( ).
Definition gesv.h:145
Note that depending on the storage order of the system matrix and the given right-hand side the functions solve different equation systems (see Linear System Solver). If the function exits successfully, the vector b or the matrix B contain the solution(s) of the linear system of equations and A has been decomposed by means of an LU Decomposition.
The functions fail if ...
... the given system matrix is not a square matrix;
... the given system matrix is singular and not invertible.
The first four functions report failure via the info argument, the fifth function throws a std::invalid_argument exception in case of an error.
LDLT-based Linear System Solver
The following functions provide an interface for the LAPACK functions ssysv(), dsysv(), csysv(), and zsysv(), which combine an LDLT Decomposition and the according LDLT-based Substitution :
LAPACK kernel for solving a symmetric indefinite single precision linear system of equations ( ).
Definition sysv.h:164
Note that depending on the storage order of the system matrix and the given right-hand side the functions solve different equation systems (see Linear System Solver). If the function exits successfully, the vector b or the matrix B contain the solution(s) of the linear system of equations and A has been decomposed by means of an LDLT Decomposition.
The functions fail if ...
... the given system matrix is not a square matrix;
... the given uplo argument is neither 'L' nor 'U';
... the sizes of the two given matrices do not match;
... the given system matrix is singular and not invertible.
The first four functions report failure via the info argument, the fifth function throws a std::invalid_argument exception in case of an error.
LDLH-based Linear System Solver
The following functions provide an interface for the LAPACK functions shesv(), dhesv(), chesv(), and zhesv(), which combine an LDLH Decomposition and the according LDLH-based Substitution :
LAPACK kernel for solving a Hermitian indefinite single precision complex linear system of equations ...
Definition hesv.h:148
Note that depending on the storage order of the system matrix and the given right-hand side the functions solve different equation systems (see Linear System Solver). If the function exits successfully, the vector b or the matrix B contain the solution(s) of the linear system of equations and A has been decomposed by means of an LDLH Decomposition.
The functions fail if ...
... the given system matrix is not a square matrix;
... the given uplo argument is neither 'L' nor 'U';
... the sizes of the two given matrices do not match;
... the given system matrix is singular and not invertible.
The first two functions report failure via the info argument, the fifth function throws a std::invalid_argument exception in case of an error.
Cholesky-based Linear System Solver
The following functions provide an interface for the LAPACK functions sposv(), dposv(), cposv(), and zposv(), which combine an Cholesky Decomposition and the according Cholesky-based Substitution :
LAPACK kernel for solving a positive definite single precision linear system of equations ( ).
Definition posv.h:152
Note that depending on the storage order of the system matrix and the given right-hand side the functions solve different equation systems (see Linear System Solver). If the function exits successfully, the vector b or the matrix B contain the solution(s) of the linear system of equations and A has been decomposed by means of an Cholesky Decomposition.
The functions fail if ...
... the given system matrix is not a square matrix;
... the given uplo argument is neither 'L' nor 'U';
... the sizes of the two given matrices do not match;
... the given system matrix is singular and not invertible.
The first four functions report failure via the info argument, the fifth function throws a std::invalid_argument exception in case of an error.
Linear System Solver for Triangular Matrices
The following functions provide an interface for the LAPACK functions strsv(), dtrsv(), ctrsv(), and ztrsv():
LAPACK kernel for solving a triangular single precision linear system of equations ( ).
Definition trsv.h:146
Note that depending on the storage order of the system matrix and the given right-hand side the functions solve different equation systems (see Linear System Solver). If the function exits successfully, the vector b or the matrix B contain the solution(s) of the linear system of equations.
The functions fail if ...
... the given system matrix is not a square matrix;
... the given uplo argument is neither 'L' nor 'U';
... the given trans argument is neither 'N' nor 'T' nor 'C';
... the given diag argument is neither 'U' nor 'N'.
The last function throws a std::invalid_argument exception in case of an error. Note that none of the functions does perform any test for singularity or near-singularity. Such tests must be performed prior to calling this function!
Eigenvalues/Eigenvectors
General Matrices
The following functions provide an interface for the LAPACK functions sgeev(), dgeev(), cgeev(), and zgeev(), which compute the eigenvalues and optionally the eigenvectors of the given general matrix:
LAPACK kernel for computing the eigenvalues of the given dense general single precision column-major ...
Definition geev.h:179
The complex eigenvalues of the given matrix A are returned in the given vector w. Please note that no order of eigenvalues can be assumed, except that complex conjugate pairs of eigenvalues appear consecutively with the eigenvalue having the positive imaginary part first.
If VR is provided as an argument, the right eigenvectors are returned in the rows of VR in case VR is a row-major matrix and in the columns of VR in case VR is a column-major matrix. The right eigenvector of A satisfies
\f[ A * v[j] = lambda[j] * v[j], \f]
where is its eigenvalue.
If VL is provided as an argument, the left eigenvectors are returned in the rows of VL in case VL is a row-major matrix and in the columns of VL in case VL is a column-major matrix. The left eigenvector of A satisfies
\f[ u[j]^{H} * A = lambda[j] * u[j]^{H}, \f]
where denotes the conjugate transpose of .
w, VL, and VR are resized to the correct dimensions (if possible and necessary). The functions fail if ...
... the given matrix A is not a square matrix;
... the given matrix VL is a fixed size matrix and the dimensions don't match;
... the given vector w is a fixed size vector and the size doesn't match;
... the given matrix VR is a fixed size matrix and the dimensions don't match;
... the eigenvalue computation fails.
The first four functions report failure via the info argument, the last four functions throw an exception in case of an error.
Symmetric Matrices
The following functions provide an interface for the LAPACK functions ssyev() and dsyev(), which compute the eigenvalues and eigenvectors of the given symmetric matrix:
LAPACK kernel for computing the eigenvalues of the given dense symmetric single precision column-majo...
Definition syev.h:135
Alternatively, the following functions can be used, which provide an interface to the LAPACK functions ssyevd() and dsyevd(). In contrast to the syev() functions they use a divide-and-conquer strategy for the computation of the left and right eigenvectors:
LAPACK kernel for computing the eigenvalues of the given dense symmetric single precision column-majo...
Definition syevd.h:141
The real eigenvalues are returned in ascending order in the given vector w. w is resized to the correct size (if possible and necessary). In case A is a row-major matrix, the left eigenvectors are returned in the rows of A, in case A is a column-major matrix, the right eigenvectors are returned in the columns of A.
The functions fail if ...
... the given matrix A is not a square matrix;
... the given vector w is a fixed size vector and the size doesn't match;
... the given jobz argument is neither 'V' nor 'N';
... the given uplo argument is neither 'L' nor 'U';
... the eigenvalue computation fails.
The first two functions report failure via the info argument, the last function throws an exception in case of an error.
Via the following functions, which wrap the LAPACK functions ssyevx() and dsyevx(), it is possible to compute a subset of eigenvalues and/or eigenvectors of a symmetric matrix:
LAPACK kernel for computing the eigenvalues of the given dense symmetric single precision column-majo...
Definition syevx.h:166
The number of eigenvalues to be computed is specified by the lower bound low and the upper bound upp, which either form an integral or a floating point range.
In case low and upp are of integral type, the function computes all eigenvalues in the index range . The num resulting real eigenvalues are stored in ascending order in the given vector w, which is either resized (if possible) or expected to be a num-dimensional vector. The eigenvectors are returned in the rows of Z in case Z is row-major matrix and in the columns of Z in case Z is a column-major matrix. Z is resized (if possible) or expected to be a num-by-n row-major matrix or a n-by-num column-major matrix.
In case low and upp are of floating point type, the function computes all eigenvalues in the half-open interval . The resulting real eigenvalues are stored in ascending order in the given vector w, which is either resized (if possible) or expected to be an n-dimensional vector. The eigenvectors are returned in the rows of Z in case Z is a row-major matrix and in the columns of Z in case Z is a column-major matrix. Z is resized (if possible) or expected to be a n-by-n matrix.
The functions fail if ...
... the given matrix A is not a square matrix;
... the given vector w is a fixed size vector and the size doesn't match;
... the given matrix Z is a fixed size matrix and the dimensions don't match;
... the given uplo argument is neither 'L' nor 'U';
... the eigenvalue computation fails.
The first two functions report failure via the info argument, the last four functions throw an exception in case of an error.
Hermitian Matrices
The following functions provide an interface for the LAPACK functions cheev() and zheev(), which compute the eigenvalues and eigenvectors of the given Hermitian matrix:
LAPACK kernel for computing the eigenvalues of the given dense Hermitian single precision column-majo...
Definition heev.h:138
Alternatively, the following functions can be used, which provide an interface to the LAPACK functions cheevd() and zheevd(). In contrast to the heev() functions they use a divide-and-conquer strategy for the computation of the left and right eigenvectors:
LAPACK kernel for computing the eigenvalues of the given dense Hermitian single precision column-majo...
Definition heevd.h:143
The real eigenvalues are returned in ascending order in the given vector w. w is resized to the correct size (if possible and necessary). In case A is a row-major matrix, the left eigenvectors are returned in the rows of A, in case A is a column-major matrix, the right eigenvectors are returned in the columns of A.
The functions fail if ...
... the given matrix A is not a square matrix;
... the given vector w is a fixed size vector and the size doesn't match;
... the given jobz argument is neither 'V' nor 'N';
... the given uplo argument is neither 'L' nor 'U';
... the eigenvalue computation fails.
The first two functions report failure via the info argument, the last function throws an exception in case of an error.
Via the following functions, which wrap the LAPACK functions cheevx() and zheevx(), it is possible to compute a subset of eigenvalues and/or eigenvectors of an Hermitian matrix:
LAPACK kernel for computing the eigenvalues of the given dense Hermitian single precision complex col...
Definition heevx.h:167
The number of eigenvalues to be computed is specified by the lower bound low and the upper bound upp, which either form an integral or a floating point range.
In case low and upp are of integral type, the function computes all eigenvalues in the index range . The num resulting real eigenvalues are stored in ascending order in the given vector w, which is either resized (if possible) or expected to be a num-dimensional vector. The eigenvectors are returned in the rows of Z in case Z is row-major matrix and in the columns of Z in case Z is a column-major matrix. Z is resized (if possible) or expected to be a num-by-n row-major matrix or a n-by-num column-major matrix.
In case low and upp are of floating point type, the function computes all eigenvalues in the half-open interval . The resulting real eigenvalues are stored in ascending order in the given vector w, which is either resized (if possible) or expected to be an n-dimensional vector. The eigenvectors are returned in the rows of Z in case Z is a row-major matrix and in the columns of Z in case Z is a column-major matrix. Z is resized (if possible) or expected to be a n-by-n matrix.
The functions fail if ...
... the given matrix A is not a square matrix;
... the given vector w is a fixed size vector and the size doesn't match;
... the given matrix Z is a fixed size matrix and the dimensions don't match;
... the given uplo argument is neither 'L' nor 'U';
... the eigenvalue computation fails.
The first two functions report failure via the info argument, the last four functions throw an exception in case of an error.
Singular Values/Singular Vectors
The following functions provide an interface for the LAPACK functions sgesvd(), dgesvd(), cgesvd(), and zgesvd(), which perform a singular value decomposition (SVD) on the given general matrix:
LAPACK kernel for the singular value decomposition (SVD) of the given dense general single precision ...
Definition gesvd.h:179
Alternatively, the following functions can be used, which provide an interface to the LAPACK functions sgesdd(), dgesdd(), cgesdd(), and zgesdd(). In contrast to the gesvd() functions they compute the singular value decomposition (SVD) of the given general matrix by applying a divide-and-conquer strategy for the computation of the left and right singular vectors:
LAPACK kernel for the singular value decomposition (SVD) of the given dense general single precision ...
Definition gesdd.h:185
The resulting decomposition has the form
\f[ A = U \cdot S \cdot V, \f]
where S is a m-by-n matrix, which is zero except for its min(m,n) diagonal elements, U is an m-by-m orthogonal matrix, and V is a n-by-n orthogonal matrix. The diagonal elements of S are the singular values of A, the first min(m,n) columns of U and rows of V are the left and right singular vectors of A, respectively.
The resulting min(m,n) real and non-negative singular values are returned in descending order in the vector s, which is resized to the correct size (if possible and necessary).
Via the following functions, which wrap the LAPACK functions sgesvdx(), dgesvdx(), cgesvdx(), and zgesvdx(), it is possible to compute a subset of singular values and/or vectors:
LAPACK kernel for the singular value decomposition (SVD) of the given dense general single precision ...
Definition gesvdx.h:213
The number of singular values to be computed is specified by the lower bound low and the upper bound upp, which either form an integral or a floating point range.
In case low and upp form are of integral type, the function computes all singular values in the index range . The num resulting real and non-negative singular values are stored in descending order in the given vector s, which is either resized (if possible) or expected to be a num-dimensional vector. The resulting left singular vectors are stored in the given matrix U, which is either resized (if possible) or expected to be a m-by-num matrix. The resulting right singular vectors are stored in the given matrix V, which is either resized (if possible) or expected to be a num-by-n matrix.
In case low and upp are of floating point type, the function computes all singular values in the half-open interval . The resulting real and non-negative singular values are stored in descending order in the given vector s, which is either resized (if possible) or expected to be a min(m,n)-dimensional vector. The resulting left singular vectors are stored in the given matrix U, which is either resized (if possible) or expected to be a m-by-min(m,n) matrix. The resulting right singular vectors are stored in the given matrix V, which is either resized (if possible) or expected to be a min(m,n)-by-n matrix.
The functions fail if ...
... the given matrix U is a fixed size matrix and the dimensions don't match;
... the given vector s is a fixed size vector and the size doesn't match;
... the given matrix V is a fixed size matrix and the dimensions don't match;
... the given scalar values don't form a proper range;
... the singular value decomposition fails.
The first four functions report failure via the info argument, the remaining functions throw an exception in case of an error.