trtrs.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_TRTRS_H_
36 #define _BLAZE_MATH_LAPACK_TRTRS_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 strtrs_( char* uplo, char* trans, char* diag, int* n, int* nrhs, float* A, int* lda, float* B, int* ldb, int* info );
71 void dtrtrs_( char* uplo, char* trans, char* diag, int* n, int* nrhs, double* A, int* lda, double* B, int* ldb, int* info );
72 void ctrtrs_( char* uplo, char* trans, char* diag, int* n, int* nrhs, float* A, int* lda, float* B, int* ldb, int* info );
73 void ztrtrs_( char* uplo, char* trans, char* diag, int* n, int* nrhs, double* A, int* lda, double* B, int* ldb, int* info );
74 
75 }
77 //*************************************************************************************************
78 
79 
80 
81 
82 //=================================================================================================
83 //
84 // LAPACK TRIANGULAR SUBSTITUTION FUNCTIONS (TRTRS)
85 //
86 //=================================================================================================
87 
88 //*************************************************************************************************
91 inline void trtrs( char uplo, char trans, char diag, int n, int nrhs, const float* A,
92  int lda, float* B, int ldb, int* info );
93 
94 inline void trtrs( char uplo, char trans, char diag, int n, int nrhs, const double* A,
95  int lda, double* B, int ldb, int* info );
96 
97 inline void trtrs( char uplo, char trans, char diag, int n, int nrhs, const complex<float>* A,
98  int lda, complex<float>* B, int ldb, int* info );
99 
100 inline void trtrs( char uplo, char trans, char diag, int n, int nrhs, const complex<double>* A,
101  int lda, complex<double>* B, int ldb, int* info );
102 
103 template< typename MT, bool SO, typename VT, bool TF >
104 inline void trtrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b,
105  char uplo, char trans, char diag );
106 
107 template< typename MT1, bool SO1, typename MT2, bool SO2 >
108 inline void trtrs( const DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B,
109  char uplo, char trans, char diag );
111 //*************************************************************************************************
112 
113 
114 //*************************************************************************************************
152 inline void trtrs( char uplo, char trans, char diag, int n, int nrhs, const float* A, int lda,
153  float* B, int ldb, int* info )
154 {
155  strtrs_( &uplo, &trans, &diag, &n, &nrhs, const_cast<float*>( A ), &lda, B, &ldb, info );
156 }
157 //*************************************************************************************************
158 
159 
160 //*************************************************************************************************
198 inline void trtrs( char uplo, char trans, char diag, int n, int nrhs, const double* A, int lda,
199  double* B, int ldb, int* info )
200 {
201  dtrtrs_( &uplo, &trans, &diag, &n, &nrhs, const_cast<double*>( A ), &lda, B, &ldb, info );
202 }
203 //*************************************************************************************************
204 
205 
206 //*************************************************************************************************
244 inline void trtrs( char uplo, char trans, char diag, int n, int nrhs, const complex<float>* A,
245  int lda, complex<float>* B, int ldb, int* info )
246 {
247  BLAZE_STATIC_ASSERT( sizeof( complex<float> ) == 2UL*sizeof( float ) );
248 
249  ctrtrs_( &uplo, &trans, &diag, &n, &nrhs, const_cast<float*>( reinterpret_cast<const float*>( A ) ),
250  &lda, reinterpret_cast<float*>( B ), &ldb, info );
251 }
252 //*************************************************************************************************
253 
254 
255 //*************************************************************************************************
293 inline void trtrs( char uplo, char trans, char diag, int n, int nrhs, const complex<double>* A,
294  int lda, complex<double>* B, int ldb, int* info )
295 {
296  BLAZE_STATIC_ASSERT( sizeof( complex<double> ) == 2UL*sizeof( double ) );
297 
298  ztrtrs_( &uplo, &trans, &diag, &n, &nrhs, const_cast<double*>( reinterpret_cast<const double*>( A ) ),
299  &lda, reinterpret_cast<double*>( B ), &ldb, info );
300 }
301 //*************************************************************************************************
302 
303 
304 //*************************************************************************************************
387 template< typename MT // Type of the system matrix
388  , bool SO // Storage order of the system matrix
389  , typename VT // Type of the right-hand side vector
390  , bool TF > // Transpose flag of the right-hand side vector
391 inline void trtrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo, char trans, char diag )
392 {
393  using boost::numeric_cast;
394 
399 
400  if( !isSquare( ~A ) ) {
401  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
402  }
403 
404  if( uplo != 'L' && uplo != 'U' ) {
405  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
406  }
407 
408  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
409  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
410  }
411 
412  if( diag != 'U' && diag != 'N' ) {
413  BLAZE_THROW_INVALID_ARGUMENT( "Invalid diag argument provided" );
414  }
415 
416  int n ( numeric_cast<int>( (~A).rows() ) );
417  int nrhs( 1 );
418  int lda ( numeric_cast<int>( (~A).spacing() ) );
419  int ldb ( numeric_cast<int>( (~b).size() ) );
420  int info( 0 );
421 
422  if( n == 0 ) {
423  return;
424  }
425 
427  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
428  }
429 
430  trtrs( uplo, trans, diag, n, nrhs, (~A).data(), lda, (~b).data(), ldb, &info );
431 
432  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
433 }
434 //*************************************************************************************************
435 
436 
437 //*************************************************************************************************
525 template< typename MT1 // Type of the system matrix
526  , bool SO1 // Storage order of the system matrix
527  , typename MT2 // Type of the right-hand side matrix
528  , bool SO2 > // Storage order of the right-hand side matrix
530  char uplo, char trans, char diag )
531 {
532  using boost::numeric_cast;
533 
542 
543  typedef typename MT1::ElementType ET;
544 
545  if( !isSquare( ~A ) ) {
546  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
547  }
548 
549  if( uplo != 'L' && uplo != 'U' ) {
550  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
551  }
552 
553  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
554  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
555  }
556 
557  if( diag != 'U' && diag != 'N' ) {
558  BLAZE_THROW_INVALID_ARGUMENT( "Invalid diag argument provided" );
559  }
560 
561  int n ( numeric_cast<int>( (~A).rows() ) );
562  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
563  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
564  int lda ( numeric_cast<int>( (~A).spacing() ) );
565  int ldb ( numeric_cast<int>( (~B).spacing() ) );
566  int info( 0 );
567 
568  if( n != mrhs ) {
569  BLAZE_THROW_INVALID_ARGUMENT( "Matrix sizes do not match" );
570  }
571 
572  if( n == 0 ) {
573  return;
574  }
575 
577  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
578  }
579 
580  trtrs( uplo, trans, diag, n, nrhs, (~A).data(), lda, (~B).data(), ldb, &info );
581 
582  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
583 }
584 //*************************************************************************************************
585 
586 } // namespace blaze
587 
588 #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.
Compile time check for row-major matrix types.This type trait tests whether or not the given template...
Definition: IsRowMajorMatrix.h:110
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 trtrs(char uplo, char trans, char diag, int n, int nrhs, const float *A, int lda, float *B, int ldb, int *info)
LAPACK kernel for the substitution step of solving a triangular single precision linear system of equ...
Definition: trtrs.h:152
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