Blaze  3.6
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 <blaze/math/Aliases.h>
50 #include <blaze/math/Exception.h>
55 #include <blaze/util/Assert.h>
57 #include <blaze/util/NumericCast.h>
58 
59 
60 namespace blaze {
61 
62 //=================================================================================================
63 //
64 // LAPACK TRIANGULAR SUBSTITUTION FUNCTIONS (TRTRS)
65 //
66 //=================================================================================================
67 
68 //*************************************************************************************************
71 template< typename MT, bool SO, typename VT, bool TF >
72 void trtrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo, char trans, char diag );
73 
74 template< typename MT1, bool SO1, typename MT2, bool SO2 >
75 void trtrs( const DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, char uplo, char trans, char diag );
77 //*************************************************************************************************
78 
79 
80 //*************************************************************************************************
165 template< typename MT // Type of the system matrix
166  , bool SO // Storage order of the system matrix
167  , typename VT // Type of the right-hand side vector
168  , bool TF > // Transpose flag of the right-hand side vector
169 inline void trtrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo, char trans, char diag )
170 {
176 
181 
182  if( !isSquare( ~A ) ) {
183  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
184  }
185 
186  if( (~b).size() != (~A).rows() ) {
187  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side vector provided" );
188  }
189 
190  if( uplo != 'L' && uplo != 'U' ) {
191  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
192  }
193 
194  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
195  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
196  }
197 
198  if( diag != 'U' && diag != 'N' ) {
199  BLAZE_THROW_INVALID_ARGUMENT( "Invalid diag argument provided" );
200  }
201 
202  int n ( numeric_cast<int>( (~A).rows() ) );
203  int nrhs( 1 );
204  int lda ( numeric_cast<int>( (~A).spacing() ) );
205  int ldb ( numeric_cast<int>( (~b).size() ) );
206  int info( 0 );
207 
208  if( n == 0 ) {
209  return;
210  }
211 
212  if( IsRowMajorMatrix_v<MT> ) {
213  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
214  }
215 
216  trtrs( uplo, trans, diag, n, nrhs, (~A).data(), lda, (~b).data(), ldb, &info );
217 
218  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
219 }
220 //*************************************************************************************************
221 
222 
223 //*************************************************************************************************
312 template< typename MT1 // Type of the system matrix
313  , bool SO1 // Storage order of the system matrix
314  , typename MT2 // Type of the right-hand side matrix
315  , bool SO2 > // Storage order of the right-hand side matrix
317  char uplo, char trans, char diag )
318 {
324 
330 
331  if( !isSquare( ~A ) ) {
332  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
333  }
334 
335  if( uplo != 'L' && uplo != 'U' ) {
336  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
337  }
338 
339  if( trans != 'N' && trans != 'T' && trans != 'C' ) {
340  BLAZE_THROW_INVALID_ARGUMENT( "Invalid trans argument provided" );
341  }
342 
343  if( diag != 'U' && diag != 'N' ) {
344  BLAZE_THROW_INVALID_ARGUMENT( "Invalid diag argument provided" );
345  }
346 
347  int n ( numeric_cast<int>( (~A).rows() ) );
348  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
349  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
350  int lda ( numeric_cast<int>( (~A).spacing() ) );
351  int ldb ( numeric_cast<int>( (~B).spacing() ) );
352  int info( 0 );
353 
354  if( n != mrhs ) {
355  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side matrix provided" );
356  }
357 
358  if( n == 0 ) {
359  return;
360  }
361 
362  if( IsRowMajorMatrix_v<MT1> ) {
363  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
364  }
365 
366  trtrs( uplo, trans, diag, n, nrhs, (~A).data(), lda, (~B).data(), ldb, &info );
367 
368  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
369 }
370 //*************************************************************************************************
371 
372 } // namespace blaze
373 
374 #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
#define BLAZE_CONSTRAINT_MUST_HAVE_CONST_DATA_ACCESS(T)
Constraint on the data type.In case the given data type T does not provide low-level data access to c...
Definition: ConstDataAccess.h:61
MT::ElementType * data(DenseMatrix< MT, SO > &dm) noexcept
Low-level data access to the dense matrix elements.
Definition: DenseMatrix.h:170
#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.
Constraint on the data type.
Cast operators for numeric types.
constexpr size_t columns(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of columns of the matrix.
Definition: Matrix.h:514
#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:81
typename T::ElementType ElementType_t
Alias declaration for nested ElementType type definitions.The ElementType_t alias declaration provide...
Definition: Aliases.h:170
size_t spacing(const DenseMatrix< MT, SO > &dm) noexcept
Returns the spacing between the beginning of two rows/columns.
Definition: DenseMatrix.h:253
Constraint on the data type.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:58
#define BLAZE_CONSTRAINT_MUST_BE_CONTIGUOUS_TYPE(T)
Constraint on the data type.In case the given data type T is not an array-like data type with contigu...
Definition: Contiguous.h:61
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:76
#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
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:146
Header file for the exception macros of the math module.
Constraint on the data type.
Header file for run time assertion macros.
Constraint on the data type.
constexpr size_t size(const Matrix< MT, SO > &matrix) noexcept
Returns the total number of elements of the matrix.
Definition: Matrix.h:530
#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
constexpr size_t rows(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of rows of the matrix.
Definition: Matrix.h:498
decltype(auto) trans(const DenseMatrix< MT, SO > &dm)
Calculation of the transpose of the given dense matrix.
Definition: DMatTransExpr.h:765
Header file for the IsRowMajorMatrix type trait.
bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:951
Header file for the CLAPACK trtrs wrapper functions.
#define BLAZE_INTERNAL_ASSERT(expr, msg)
Run time assertion macro for internal checks.In case of an invalid run time expression,...
Definition: Assert.h:101