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 <boost/cast.hpp>
44 #include <blaze/math/Aliases.h>
49 #include <blaze/math/Exception.h>
53 #include <blaze/util/Assert.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 {
169  using boost::numeric_cast;
170 
175 
176  if( !isSquare( ~A ) ) {
177  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
178  }
179 
180  if( (~b).size() != (~A).rows() ) {
181  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side vector provided" );
182  }
183 
184  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
185  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
186  }
187 
188  int n ( numeric_cast<int>( (~A).rows() ) );
189  int nrhs( 1 );
190  int lda ( numeric_cast<int>( (~A).spacing() ) );
191  int ldb ( numeric_cast<int>( (~b).size() ) );
192  int info( 0 );
193 
194  if( n == 0 ) {
195  return;
196  }
197 
198  getrs( trans, n, nrhs, (~A).data(), lda, ipiv, (~b).data(), ldb, &info );
199 
200  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
201 }
202 //*************************************************************************************************
203 
204 
205 //*************************************************************************************************
294 template< typename MT1 // Type of the system matrix
295  , bool SO1 // Storage order of the system matrix
296  , typename MT2 // Type of the right-hand side matrix
297  , bool SO2 > // Storage order of the right-hand side matrix
299  char trans, const int* ipiv )
300 {
301  using boost::numeric_cast;
302 
311 
312  if( !isSquare( ~A ) ) {
313  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
314  }
315 
316  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
317  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
318  }
319 
320  int n ( numeric_cast<int>( (~A).rows() ) );
321  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
322  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
323  int lda ( numeric_cast<int>( (~A).spacing() ) );
324  int ldb ( numeric_cast<int>( (~B).spacing() ) );
325  int info( 0 );
326 
327  if( n != mrhs ) {
328  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side matrix provided" );
329  }
330 
331  if( n == 0 ) {
332  return;
333  }
334 
335  getrs( trans, n, nrhs, (~A).data(), lda, ipiv, (~B).data(), ldb, &info );
336 
337  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
338 }
339 //*************************************************************************************************
340 
341 } // namespace blaze
342 
343 #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.
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:102
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:261
#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.
#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:71
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:336
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:134
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:320
const DMatTransExpr< MT,!SO > trans(const DenseMatrix< MT, SO > &dm)
Calculation of the transpose of the given dense matrix.
Definition: DMatTransExpr.h:733
BLAZE_ALWAYS_INLINE bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:677
#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