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>
48 #include <blaze/math/Exception.h>
52 #include <blaze/util/Assert.h>
54 #include <blaze/util/NumericCast.h>
55 
56 
57 namespace blaze {
58 
59 //=================================================================================================
60 //
61 // LAPACK LU-BASED SUBSTITUTION FUNCTIONS (GETRS)
62 //
63 //=================================================================================================
64 
65 //*************************************************************************************************
68 template< typename MT, bool SO, typename VT, bool TF >
69 inline void getrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char trans, const int* ipiv );
70 
71 template< typename MT1, bool SO1, typename MT2, bool SO2 >
72 inline void getrs( const DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B,
73  char trans, const int* ipiv );
75 //*************************************************************************************************
76 
77 
78 //*************************************************************************************************
163 template< typename MT // Type of the system matrix
164  , bool SO // Storage order of the system matrix
165  , typename VT // Type of the right-hand side vector
166  , bool TF > // Transpose flag of the right-hand side vector
167 inline void getrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char trans, const int* ipiv )
168 {
173 
174  if( !isSquare( ~A ) ) {
175  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
176  }
177 
178  if( (~b).size() != (~A).rows() ) {
179  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side vector provided" );
180  }
181 
182  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
183  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
184  }
185 
186  int n ( numeric_cast<int>( (~A).rows() ) );
187  int nrhs( 1 );
188  int lda ( numeric_cast<int>( (~A).spacing() ) );
189  int ldb ( numeric_cast<int>( (~b).size() ) );
190  int info( 0 );
191 
192  if( n == 0 ) {
193  return;
194  }
195 
196  getrs( trans, n, nrhs, (~A).data(), lda, ipiv, (~b).data(), ldb, &info );
197 
198  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
199 }
200 //*************************************************************************************************
201 
202 
203 //*************************************************************************************************
292 template< typename MT1 // Type of the system matrix
293  , bool SO1 // Storage order of the system matrix
294  , typename MT2 // Type of the right-hand side matrix
295  , bool SO2 > // Storage order of the right-hand side matrix
297  char trans, const int* ipiv )
298 {
307 
308  if( !isSquare( ~A ) ) {
309  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
310  }
311 
312  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
313  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
314  }
315 
316  int n ( numeric_cast<int>( (~A).rows() ) );
317  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
318  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
319  int lda ( numeric_cast<int>( (~A).spacing() ) );
320  int ldb ( numeric_cast<int>( (~B).spacing() ) );
321  int info( 0 );
322 
323  if( n != mrhs ) {
324  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side matrix provided" );
325  }
326 
327  if( n == 0 ) {
328  return;
329  }
330 
331  getrs( trans, n, nrhs, (~A).data(), lda, ipiv, (~B).data(), ldb, &info );
332 
333  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
334 }
335 //*************************************************************************************************
336 
337 } // namespace blaze
338 
339 #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
Constraint on the data type.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:57
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
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.
Header file for the CLAPACK getrs wrapper functions.
#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
decltype(auto) trans(const DenseMatrix< MT, SO > &dm)
Calculation of the transpose of the given dense matrix.
Definition: DMatTransExpr.h:790
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