getrs.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_GETRS_H_
36 #define _BLAZE_MATH_LAPACK_GETRS_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <blaze/math/Aliases.h>
50 #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 LU-BASED SUBSTITUTION FUNCTIONS (GETRS)
64 //
65 //=================================================================================================
66 
67 //*************************************************************************************************
70 template< typename MT, bool SO, typename VT, bool TF >
71 inline void getrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char trans, const int* ipiv );
72 
73 template< typename MT1, bool SO1, typename MT2, bool SO2 >
74 inline void getrs( const DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B,
75  char trans, const int* ipiv );
77 //*************************************************************************************************
78 
79 
80 //*************************************************************************************************
165 template< typename MT // Type of the system matrix
166  , bool SO // Storage order of the system matrix
167  , typename VT // Type of the right-hand side vector
168  , bool TF > // Transpose flag of the right-hand side vector
169 inline void getrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char trans, const int* ipiv )
170 {
176 
181 
182  if( !isSquare( ~A ) ) {
183  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
184  }
185 
186  if( (~b).size() != (~A).rows() ) {
187  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side vector provided" );
188  }
189 
190  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
191  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
192  }
193 
194  int n ( numeric_cast<int>( (~A).rows() ) );
195  int nrhs( 1 );
196  int lda ( numeric_cast<int>( (~A).spacing() ) );
197  int ldb ( numeric_cast<int>( (~b).size() ) );
198  int info( 0 );
199 
200  if( n == 0 ) {
201  return;
202  }
203 
204  getrs( trans, n, nrhs, (~A).data(), lda, ipiv, (~b).data(), ldb, &info );
205 
206  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
207 }
208 //*************************************************************************************************
209 
210 
211 //*************************************************************************************************
300 template< typename MT1 // Type of the system matrix
301  , bool SO1 // Storage order of the system matrix
302  , typename MT2 // Type of the right-hand side matrix
303  , bool SO2 > // Storage order of the right-hand side matrix
305  char trans, const int* ipiv )
306 {
312 
318 
319  if( !isSquare( ~A ) ) {
320  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
321  }
322 
323  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
324  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
325  }
326 
327  int n ( numeric_cast<int>( (~A).rows() ) );
328  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
329  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
330  int lda ( numeric_cast<int>( (~A).spacing() ) );
331  int ldb ( numeric_cast<int>( (~B).spacing() ) );
332  int info( 0 );
333 
334  if( n != mrhs ) {
335  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side matrix provided" );
336  }
337 
338  if( n == 0 ) {
339  return;
340  }
341 
342  getrs( trans, n, nrhs, (~A).data(), lda, ipiv, (~B).data(), ldb, &info );
343 
344  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
345 }
346 //*************************************************************************************************
347 
348 } // namespace blaze
349 
350 #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
#define BLAZE_CONSTRAINT_MUST_HAVE_CONST_DATA_ACCESS(T)
Constraint on the data type.In case the given data type T does not provide low-level data access to c...
Definition: ConstDataAccess.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
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
void getrs(char trans, int n, int nrhs, const float *A, int lda, const int *ipiv, float *B, int ldb, int *info)
LAPACK kernel for the substitution step of solving a general single precision linear system of equati...
Definition: getrs.h:136
Header file for the exception macros of the math module.
Constraint on the data type.
Header file for run time assertion macros.
Constraint on the data type.
Header file for the CLAPACK getrs wrapper functions.
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
decltype(auto) trans(const DenseMatrix< MT, SO > &dm)
Calculation of the transpose of the given dense matrix.
Definition: DMatTransExpr.h:765
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