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>
50 #include <blaze/math/Exception.h>
55 #include <blaze/util/Assert.h>
57 #include <blaze/util/NumericCast.h>
58 
59 
60 namespace blaze {
61 
62 //=================================================================================================
63 //
64 // LAPACK SYMMETRIC INDEFINITE LINEAR SYSTEM FUNCTIONS (SYSV)
65 //
66 //=================================================================================================
67 
68 //*************************************************************************************************
71 template< typename MT, bool SO, typename VT, bool TF >
72 inline void sysv( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo, int* ipiv );
73 
74 template< typename MT1, bool SO1, typename MT2, bool SO2 >
75 inline void sysv( DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, char uplo, int* ipiv );
77 //*************************************************************************************************
78 
79 
80 //*************************************************************************************************
140 template< typename MT // Type of the system matrix
141  , bool SO // Storage order of the system matrix
142  , typename VT // Type of the right-hand side vector
143  , bool TF > // Transpose flag of the right-hand side vector
144 inline void sysv( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo, int* ipiv )
145 {
151 
156 
157  using ET = ElementType_t<MT>;
158 
159  if( !isSquare( ~A ) ) {
160  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
161  }
162 
163  if( (~b).size() != (~A).rows() ) {
164  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side vector provided" );
165  }
166 
167  if( uplo != 'L' && uplo != 'U' ) {
168  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
169  }
170 
171  int n ( numeric_cast<int>( (~A).rows() ) );
172  int nrhs( 1 );
173  int lda ( numeric_cast<int>( (~A).spacing() ) );
174  int ldb ( numeric_cast<int>( (~b).size() ) );
175  int info( 0 );
176 
177  if( n == 0 ) {
178  return;
179  }
180 
181  if( IsRowMajorMatrix_v<MT> ) {
182  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
183  }
184 
185  int lwork( n*lda );
186  const std::unique_ptr<ET[]> work( new ET[lwork] );
187 
188  sysv( uplo, n, nrhs, (~A).data(), lda, ipiv, (~b).data(), ldb, work.get(), lwork, &info );
189 
190  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid function argument" );
191 
192  if( info > 0 ) {
193  BLAZE_THROW_LAPACK_ERROR( "Inversion of singular matrix failed" );
194  }
195 }
196 //*************************************************************************************************
197 
198 
199 //*************************************************************************************************
262 template< typename MT1 // Type of the system matrix
263  , bool SO1 // Storage order of the system matrix
264  , typename MT2 // Type of the right-hand side matrix
265  , bool SO2 > // Storage order of the right-hand side matrix
266 inline void sysv( DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, char uplo, int* ipiv )
267 {
273 
279 
280  using ET = ElementType_t<MT1>;
281 
282  if( !isSquare( ~A ) ) {
283  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
284  }
285 
286  if( uplo != 'L' && uplo != 'U' ) {
287  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
288  }
289 
290  int n ( numeric_cast<int>( (~A).rows() ) );
291  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
292  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
293  int lda ( numeric_cast<int>( (~A).spacing() ) );
294  int ldb ( numeric_cast<int>( (~B).spacing() ) );
295  int info( 0 );
296 
297  if( n != mrhs ) {
298  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side matrix provided" );
299  }
300 
301  if( n == 0 ) {
302  return;
303  }
304 
305  if( IsRowMajorMatrix_v<MT1> ) {
306  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
307  }
308 
309  int lwork( n*lda );
310  const std::unique_ptr<ET[]> work( new ET[lwork] );
311 
312  sysv( uplo, n, nrhs, (~A).data(), lda, ipiv, (~B).data(), ldb, work.get(), lwork, &info );
313 
314  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid function argument" );
315 
316  if( info > 0 ) {
317  BLAZE_THROW_RUNTIME_ERROR( "Inversion of singular matrix failed" );
318  }
319 }
320 //*************************************************************************************************
321 
322 } // namespace blaze
323 
324 #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
MT::ElementType * data(DenseMatrix< MT, SO > &dm) noexcept
Low-level data access to the dense matrix elements.
Definition: DenseMatrix.h:169
#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.
Constraint on the data type.
Cast operators for numeric types.
constexpr size_t columns(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of columns of the matrix.
Definition: Matrix.h:514
#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:80
typename T::ElementType ElementType_t
Alias declaration for nested ElementType type definitions.The ElementType_t alias declaration provide...
Definition: Aliases.h:170
size_t spacing(const DenseMatrix< MT, SO > &dm) noexcept
Returns the spacing between the beginning of two rows/columns.
Definition: DenseMatrix.h:252
#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:58
#define BLAZE_CONSTRAINT_MUST_BE_CONTIGUOUS_TYPE(T)
Constraint on the data type.In case the given data type T is not an array-like data type with contigu...
Definition: Contiguous.h:61
Header file for the DenseMatrix base class.
Base class for N-dimensional dense vectors.The DenseVector class is a base class for all arbitrarily ...
Definition: DenseVector.h:76
#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
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.
constexpr size_t size(const Matrix< MT, SO > &matrix) noexcept
Returns the total number of elements of the matrix.
Definition: Matrix.h:530
#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
constexpr size_t rows(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of rows of the matrix.
Definition: Matrix.h:498
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
bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:951
#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