Blaze  3.6
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 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 void getrs( const DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, char trans, const int* ipiv );
76 //*************************************************************************************************
77 
78 
79 //*************************************************************************************************
164 template< typename MT // Type of the system matrix
165  , bool SO // Storage order of the system matrix
166  , typename VT // Type of the right-hand side vector
167  , bool TF > // Transpose flag of the right-hand side vector
168 inline void getrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char trans, const int* ipiv )
169 {
175 
180 
181  if( !isSquare( ~A ) ) {
182  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
183  }
184 
185  if( (~b).size() != (~A).rows() ) {
186  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side vector provided" );
187  }
188 
189  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
190  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
191  }
192 
193  int n ( numeric_cast<int>( (~A).rows() ) );
194  int nrhs( 1 );
195  int lda ( numeric_cast<int>( (~A).spacing() ) );
196  int ldb ( numeric_cast<int>( (~b).size() ) );
197  int info( 0 );
198 
199  if( n == 0 ) {
200  return;
201  }
202 
203  getrs( trans, n, nrhs, (~A).data(), lda, ipiv, (~b).data(), ldb, &info );
204 
205  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
206 }
207 //*************************************************************************************************
208 
209 
210 //*************************************************************************************************
299 template< typename MT1 // Type of the system matrix
300  , bool SO1 // Storage order of the system matrix
301  , typename MT2 // Type of the right-hand side matrix
302  , bool SO2 > // Storage order of the right-hand side matrix
304  char trans, const int* ipiv )
305 {
311 
317 
318  if( !isSquare( ~A ) ) {
319  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
320  }
321 
322  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
323  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
324  }
325 
326  int n ( numeric_cast<int>( (~A).rows() ) );
327  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
328  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
329  int lda ( numeric_cast<int>( (~A).spacing() ) );
330  int ldb ( numeric_cast<int>( (~B).spacing() ) );
331  int info( 0 );
332 
333  if( n != mrhs ) {
334  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side matrix provided" );
335  }
336 
337  if( n == 0 ) {
338  return;
339  }
340 
341  getrs( trans, n, nrhs, (~A).data(), lda, ipiv, (~B).data(), ldb, &info );
342 
343  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
344 }
345 //*************************************************************************************************
346 
347 } // namespace blaze
348 
349 #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:170
#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:81
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:253
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:141
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,...
Definition: Assert.h:101