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>
51 #include <blaze/util/Assert.h>
52 #include <blaze/util/Complex.h>
54 #include <blaze/util/Exception.h>
56 
57 
58 namespace blaze {
59 
60 //=================================================================================================
61 //
62 // LAPACK FORWARD DECLARATIONS
63 //
64 //=================================================================================================
65 
66 //*************************************************************************************************
68 extern "C" {
69 
70 void sgetrs_( char* trans, int* n, int* nrhs, float* A, int* lda, int* ipiv, float* B, int* ldb, int* info );
71 void dgetrs_( char* trans, int* n, int* nrhs, double* A, int* lda, int* ipiv, double* B, int* ldb, int* info );
72 void cgetrs_( char* trans, int* n, int* nrhs, float* A, int* lda, int* ipiv, float* B, int* ldb, int* info );
73 void zgetrs_( char* trans, int* n, int* nrhs, double* A, int* lda, int* ipiv, double* B, int* ldb, int* info );
74 
75 }
77 //*************************************************************************************************
78 
79 
80 
81 
82 //=================================================================================================
83 //
84 // LAPACK LU-BASED SUBSTITUTION FUNCTIONS (GETRS)
85 //
86 //=================================================================================================
87 
88 //*************************************************************************************************
91 inline void getrs( char trans, int n, int nrhs, const float* A, int lda, const int* ipiv,
92  float* B, int ldb, int* info );
93 
94 inline void getrs( char trans, int n, int nrhs, const double* A, int lda, const int* ipiv,
95  double* B, int ldb, int* info );
96 
97 inline void getrs( char trans, int n, int nrhs, const complex<float>* A, int lda,
98  const int* ipiv, complex<float>* B, int ldb, int* info );
99 
100 inline void getrs( char trans, int n, int nrhs, const complex<double>* A, int lda,
101  const int* ipiv, complex<double>* B, int ldb, int* info );
102 
103 template< typename MT, bool SO, typename VT, bool TF >
104 inline void getrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char trans, const int* ipiv );
105 
106 template< typename MT1, bool SO1, typename MT2, bool SO2 >
107 inline void getrs( const DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B,
108  char trans, const int* ipiv );
110 //*************************************************************************************************
111 
112 
113 //*************************************************************************************************
151 inline void getrs( char trans, int n, int nrhs, const float* A, int lda,
152  const int* ipiv, float* B, int ldb, int* info )
153 {
154  sgetrs_( &trans, &n, &nrhs, const_cast<float*>( A ), &lda,
155  const_cast<int*>( ipiv ), B, &ldb, info );
156 }
157 //*************************************************************************************************
158 
159 
160 //*************************************************************************************************
198 inline void getrs( char trans, int n, int nrhs, const double* A, int lda,
199  const int* ipiv, double* B, int ldb, int* info )
200 {
201  dgetrs_( &trans, &n, &nrhs, const_cast<double*>( A ), &lda,
202  const_cast<int*>( ipiv ), B, &ldb, info );
203 }
204 //*************************************************************************************************
205 
206 
207 //*************************************************************************************************
245 inline void getrs( char trans, int n, int nrhs, const complex<float>* A, int lda,
246  const int* ipiv, complex<float>* B, int ldb, int* info )
247 {
248  BLAZE_STATIC_ASSERT( sizeof( complex<float> ) == 2UL*sizeof( float ) );
249 
250  cgetrs_( &trans, &n, &nrhs, const_cast<float*>( reinterpret_cast<const float*>( A ) ),
251  &lda, const_cast<int*>( ipiv ), reinterpret_cast<float*>( B ), &ldb, info );
252 }
253 //*************************************************************************************************
254 
255 
256 //*************************************************************************************************
294 inline void getrs( char trans, int n, int nrhs, const complex<double>* A, int lda,
295  const int* ipiv, complex<double>* B, int ldb, int* info )
296 {
297  BLAZE_STATIC_ASSERT( sizeof( complex<double> ) == 2UL*sizeof( double ) );
298 
299  zgetrs_( &trans, &n, &nrhs, const_cast<double*>( reinterpret_cast<const double*>( A ) ),
300  &lda, const_cast<int*>( ipiv ), reinterpret_cast<double*>( B ), &ldb, info );
301 }
302 //*************************************************************************************************
303 
304 
305 //*************************************************************************************************
388 template< typename MT // Type of the system matrix
389  , bool SO // Storage order of the system matrix
390  , typename VT // Type of the right-hand side vector
391  , bool TF > // Transpose flag of the right-hand side vector
392 inline void getrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char trans, const int* ipiv )
393 {
394  using boost::numeric_cast;
395 
400 
401  if( !isSquare( ~A ) ) {
402  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
403  }
404 
405  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
406  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
407  }
408 
409  int n ( numeric_cast<int>( (~A).rows() ) );
410  int nrhs( 1 );
411  int lda ( numeric_cast<int>( (~A).spacing() ) );
412  int ldb ( numeric_cast<int>( (~b).size() ) );
413  int info( 0 );
414 
415  if( n == 0 ) {
416  return;
417  }
418 
419  getrs( trans, n, nrhs, (~A).data(), lda, ipiv, (~b).data(), ldb, &info );
420 
421  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
422 }
423 //*************************************************************************************************
424 
425 
426 //*************************************************************************************************
514 template< typename MT1 // Type of the system matrix
515  , bool SO1 // Storage order of the system matrix
516  , typename MT2 // Type of the right-hand side matrix
517  , bool SO2 > // Storage order of the right-hand side matrix
519  char trans, const int* ipiv )
520 {
521  using boost::numeric_cast;
522 
531 
532  typedef typename MT1::ElementType ET;
533 
534  if( !isSquare( ~A ) ) {
535  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
536  }
537 
538  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
539  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
540  }
541 
542  int n ( numeric_cast<int>( (~A).rows() ) );
543  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
544  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
545  int lda ( numeric_cast<int>( (~A).spacing() ) );
546  int ldb ( numeric_cast<int>( (~B).spacing() ) );
547  int info( 0 );
548 
549  if( n != mrhs ) {
550  BLAZE_THROW_INVALID_ARGUMENT( "Matrix sizes do not match" );
551  }
552 
553  if( n == 0 ) {
554  return;
555  }
556 
557  getrs( trans, n, nrhs, (~A).data(), lda, ipiv, (~B).data(), ldb, &info );
558 
559  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
560 }
561 //*************************************************************************************************
562 
563 } // namespace blaze
564 
565 #endif
#define BLAZE_THROW_INVALID_ARGUMENT(MESSAGE)
Macro for the emission of a std::invalid_argument exceptionThis macro encapsulates the default way of...
Definition: Exception.h:187
Constraint on the data type.
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:79
BLAZE_ALWAYS_INLINE bool isSquare(const Matrix< MT, SO > &matrix)
Checks if the given matrix is a square matrix.
Definition: Matrix.h:603
BLAZE_ALWAYS_INLINE size_t size(const Vector< VT, TF > &vector)
Returns the current size/dimension of the vector.
Definition: Vector.h:252
#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:118
BLAZE_ALWAYS_INLINE size_t rows(const Matrix< MT, SO > &matrix)
Returns the current number of rows of the matrix.
Definition: Matrix.h:308
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:118
Base class for dense matrices.The DenseMatrix class is a base class for all dense matrix classes...
Definition: DenseMatrix.h:70
Namespace of the Blaze C++ math library.
Definition: Blaze.h:57
Compile time assertion.
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: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:89
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:151
Type ElementType
Type of the sparse matrix elements.
Definition: CompressedMatrix.h:2586
Constraint on the data type.
Constraint on the data type.
const bool spacing
Adding an additional spacing line between two log messages.This setting gives the opportunity to add ...
Definition: Logging.h:70
Header file for run time assertion macros.
#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:79
Header file for the IsRowMajorMatrix type trait.
const DMatTransExpr< MT,!SO > trans(const DenseMatrix< MT, SO > &dm)
Calculation of the transpose of the given dense matrix.
Definition: DMatTransExpr.h:944
BLAZE_ALWAYS_INLINE size_t columns(const Matrix< MT, SO > &matrix)
Returns the current number of columns of the matrix.
Definition: Matrix.h:324
Header file for the complex data type.
Header file for exception macros.
#define BLAZE_STATIC_ASSERT(expr)
Compile time assertion macro.In case of an invalid compile time expression, a compilation error is cr...
Definition: StaticAssert.h:143
#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