sysv.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_SYSV_H_
36 #define _BLAZE_MATH_LAPACK_SYSV_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <memory>
44 #include <blaze/math/Aliases.h>
49 #include <blaze/math/Exception.h>
54 #include <blaze/util/Assert.h>
56 #include <blaze/util/NumericCast.h>
57 
58 
59 namespace blaze {
60 
61 //=================================================================================================
62 //
63 // LAPACK SYMMETRIC INDEFINITE LINEAR SYSTEM FUNCTIONS (SYSV)
64 //
65 //=================================================================================================
66 
67 //*************************************************************************************************
70 template< typename MT, bool SO, typename VT, bool TF >
71 inline void sysv( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo, int* ipiv );
72 
73 template< typename MT1, bool SO1, typename MT2, bool SO2 >
74 inline void sysv( DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, char uplo, int* ipiv );
76 //*************************************************************************************************
77 
78 
79 //*************************************************************************************************
139 template< typename MT // Type of the system matrix
140  , bool SO // Storage order of the system matrix
141  , typename VT // Type of the right-hand side vector
142  , bool TF > // Transpose flag of the right-hand side vector
143 inline void sysv( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo, int* ipiv )
144 {
152 
153  using ET = ElementType_<MT>;
154 
155  if( !isSquare( ~A ) ) {
156  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
157  }
158 
159  if( (~b).size() != (~A).rows() ) {
160  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side vector provided" );
161  }
162 
163  if( uplo != 'L' && uplo != 'U' ) {
164  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
165  }
166 
167  int n ( numeric_cast<int>( (~A).rows() ) );
168  int nrhs( 1 );
169  int lda ( numeric_cast<int>( (~A).spacing() ) );
170  int ldb ( numeric_cast<int>( (~b).size() ) );
171  int info( 0 );
172 
173  if( n == 0 ) {
174  return;
175  }
176 
178  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
179  }
180 
181  int lwork( n*lda );
182  const std::unique_ptr<ET[]> work( new ET[lwork] );
183 
184  sysv( uplo, n, nrhs, (~A).data(), lda, ipiv, (~b).data(), ldb, work.get(), lwork, &info );
185 
186  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid function argument" );
187 
188  if( info > 0 ) {
189  BLAZE_THROW_LAPACK_ERROR( "Inversion of singular matrix failed" );
190  }
191 }
192 //*************************************************************************************************
193 
194 
195 //*************************************************************************************************
258 template< typename MT1 // Type of the system matrix
259  , bool SO1 // Storage order of the system matrix
260  , typename MT2 // Type of the right-hand side matrix
261  , bool SO2 > // Storage order of the right-hand side matrix
262 inline void sysv( DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, char uplo, int* ipiv )
263 {
272 
273  using ET = ElementType_<MT1>;
274 
275  if( !isSquare( ~A ) ) {
276  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
277  }
278 
279  if( uplo != 'L' && uplo != 'U' ) {
280  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
281  }
282 
283  int n ( numeric_cast<int>( (~A).rows() ) );
284  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
285  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
286  int lda ( numeric_cast<int>( (~A).spacing() ) );
287  int ldb ( numeric_cast<int>( (~B).spacing() ) );
288  int info( 0 );
289 
290  if( n != mrhs ) {
291  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side matrix provided" );
292  }
293 
294  if( n == 0 ) {
295  return;
296  }
297 
299  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
300  }
301 
302  int lwork( n*lda );
303  const std::unique_ptr<ET[]> work( new ET[lwork] );
304 
305  sysv( uplo, n, nrhs, (~A).data(), lda, ipiv, (~B).data(), ldb, work.get(), lwork, &info );
306 
307  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid function argument" );
308 
309  if( info > 0 ) {
310  BLAZE_THROW_RUNTIME_ERROR( "Inversion of singular matrix failed" );
311  }
312 }
313 //*************************************************************************************************
314 
315 } // namespace blaze
316 
317 #endif
#define BLAZE_THROW_INVALID_ARGUMENT(MESSAGE)
Macro for the emission of a std::invalid_argument exception.This macro encapsulates the default way o...
Definition: Exception.h:235
Constraint on the data type.
Header file for auxiliary alias declarations.
Data type constraint.
#define BLAZE_CONSTRAINT_MUST_HAVE_MUTABLE_DATA_ACCESS(T)
Constraint on the data type.In case the given data type T does not provide low-level data access to m...
Definition: MutableDataAccess.h:61
BLAZE_ALWAYS_INLINE size_t size(const Vector< VT, TF > &vector) noexcept
Returns the current size/dimension of the vector.
Definition: Vector.h:265
#define BLAZE_CONSTRAINT_MUST_NOT_BE_COMPUTATION_TYPE(T)
Constraint on the data type.In case the given data type T is a computational expression (i...
Definition: Computation.h:81
Header file for the DenseVector base class.
Constraint on the data type.
Cast operators for numeric types.
#define BLAZE_CONSTRAINT_MUST_NOT_BE_ADAPTOR_TYPE(T)
Constraint on the data type.In case the given data type T is an adaptor type (as for instance LowerMa...
Definition: Adaptor.h:81
Base class for dense matrices.The DenseMatrix class is a base class for all dense matrix classes...
Definition: DenseMatrix.h:78
BLAZE_ALWAYS_INLINE size_t spacing(const DenseMatrix< MT, SO > &dm) noexcept
Returns the spacing between the beginning of two rows/columns.
Definition: DenseMatrix.h:110
#define BLAZE_THROW_RUNTIME_ERROR(MESSAGE)
Macro for the emission of a std::runtime_error exception.This macro encapsulates the default way of B...
Definition: Exception.h:379
Constraint on the data type.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:57
Compile time check for row-major matrix types.This type trait tests whether or not the given template...
Definition: IsRowMajorMatrix.h:110
Header file for the DenseMatrix base class.
typename T::ElementType ElementType_
Alias declaration for nested ElementType type definitions.The ElementType_ alias declaration provides...
Definition: Aliases.h:163
Base class for N-dimensional dense vectors.The DenseVector class is a base class for all arbitrarily ...
Definition: DenseVector.h:70
#define BLAZE_CONSTRAINT_MUST_BE_SAME_TYPE(A, B)
Data type constraint.In case the two types A and B are not the same (ignoring all cv-qualifiers of bo...
Definition: SameType.h:71
BLAZE_ALWAYS_INLINE size_t columns(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of columns of the matrix.
Definition: Matrix.h:340
Header file for the CLAPACK sysv wrapper functions.
Header file for the exception macros of the math module.
Constraint on the data type.
Header file for run time assertion macros.
#define BLAZE_CONSTRAINT_MUST_BE_BLAS_COMPATIBLE_TYPE(T)
Constraint on the data type.In case the given data type T is not a BLAS compatible data type (i...
Definition: BLASCompatible.h:61
BLAZE_ALWAYS_INLINE size_t rows(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of rows of the matrix.
Definition: Matrix.h:324
Header file for the IsRowMajorMatrix type trait.
#define BLAZE_THROW_LAPACK_ERROR(MESSAGE)
Macro for the emission of an exception on detection of a LAPACK error.This macro encapsulates the def...
Definition: Exception.h:146
void sysv(char uplo, int n, int nrhs, float *A, int lda, int *ipiv, float *B, int ldb, float *work, int lwork, int *info)
LAPACK kernel for solving a symmetric indefinite single precision linear system of equations ( )...
Definition: sysv.h:146
BLAZE_ALWAYS_INLINE bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:742
#define BLAZE_INTERNAL_ASSERT(expr, msg)
Run time assertion macro for internal checks.In case of an invalid run time expression, the program execution is terminated. The BLAZE_INTERNAL_ASSERT macro can be disabled by setting the BLAZE_USER_ASSERTION flag to zero or by defining NDEBUG during the compilation.
Definition: Assert.h:101