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 //*************************************************************************************************
161 template< typename MT // Type of the system matrix
162  , bool SO // Storage order of the system matrix
163  , typename VT // Type of the right-hand side vector
164  , bool TF > // Transpose flag of the right-hand side vector
165 inline void getrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char trans, const int* ipiv )
166 {
167  using boost::numeric_cast;
168 
173 
174  if( !isSquare( ~A ) ) {
175  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
176  }
177 
178  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
179  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
180  }
181 
182  int n ( numeric_cast<int>( (~A).rows() ) );
183  int nrhs( 1 );
184  int lda ( numeric_cast<int>( (~A).spacing() ) );
185  int ldb ( numeric_cast<int>( (~b).size() ) );
186  int info( 0 );
187 
188  if( n == 0 ) {
189  return;
190  }
191 
192  getrs( trans, n, nrhs, (~A).data(), lda, ipiv, (~b).data(), ldb, &info );
193 
194  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
195 }
196 //*************************************************************************************************
197 
198 
199 //*************************************************************************************************
287 template< typename MT1 // Type of the system matrix
288  , bool SO1 // Storage order of the system matrix
289  , typename MT2 // Type of the right-hand side matrix
290  , bool SO2 > // Storage order of the right-hand side matrix
292  char trans, const int* ipiv )
293 {
294  using boost::numeric_cast;
295 
304 
305  if( !isSquare( ~A ) ) {
306  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
307  }
308 
309  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
310  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
311  }
312 
313  int n ( numeric_cast<int>( (~A).rows() ) );
314  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
315  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
316  int lda ( numeric_cast<int>( (~A).spacing() ) );
317  int ldb ( numeric_cast<int>( (~B).spacing() ) );
318  int info( 0 );
319 
320  if( n != mrhs ) {
321  BLAZE_THROW_INVALID_ARGUMENT( "Matrix sizes do not match" );
322  }
323 
324  if( n == 0 ) {
325  return;
326  }
327 
328  getrs( trans, n, nrhs, (~A).data(), lda, ipiv, (~B).data(), ldb, &info );
329 
330  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
331 }
332 //*************************************************************************************************
333 
334 } // namespace blaze
335 
336 #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.
Log level for high-level information.
Definition: LogLevel.h:80
#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:258
#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:70
constexpr bool spacing
Adding an additional spacing line between two log messages.This setting gives the opportunity to add ...
Definition: Logging.h:70
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:330
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:133
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:314
const DMatTransExpr< MT,!SO > trans(const DenseMatrix< MT, SO > &dm)
Calculation of the transpose of the given dense matrix.
Definition: DMatTransExpr.h:950
BLAZE_ALWAYS_INLINE bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:609
#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