Blaze 3.9
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>
55#include <blaze/util/Assert.h>
58
59
60namespace blaze {
61
62//=================================================================================================
63//
64// LAPACK TRIANGULAR SUBSTITUTION FUNCTIONS (TRTRS)
65//
66//=================================================================================================
67
68//*************************************************************************************************
71template< typename MT, bool SO, typename VT, bool TF >
72void trtrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo, char trans, char diag );
73
74template< typename MT1, bool SO1, typename MT2, bool SO2 >
75void trtrs( const DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, char uplo, char trans, char diag );
77//*************************************************************************************************
78
79
80//*************************************************************************************************
165template< 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
169inline 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 blas_int_t n ( numeric_cast<blas_int_t>( (*A).rows() ) );
203 blas_int_t nrhs( 1 );
204 blas_int_t lda ( numeric_cast<blas_int_t>( (*A).spacing() ) );
205 blas_int_t ldb ( numeric_cast<blas_int_t>( (*b).size() ) );
206 blas_int_t 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//*************************************************************************************************
312template< 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 blas_int_t n ( numeric_cast<blas_int_t>( (*A).rows() ) );
348 blas_int_t mrhs( numeric_cast<blas_int_t>( SO2 ? (*B).rows() : (*B).columns() ) );
349 blas_int_t nrhs( numeric_cast<blas_int_t>( SO2 ? (*B).columns() : (*B).rows() ) );
350 blas_int_t lda ( numeric_cast<blas_int_t>( (*A).spacing() ) );
351 blas_int_t ldb ( numeric_cast<blas_int_t>( (*B).spacing() ) );
352 blas_int_t 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
Constraint on the data type.
Header file for auxiliary alias declarations.
typename T::ElementType ElementType_t
Alias declaration for nested ElementType type definitions.
Definition: Aliases.h:190
Header file for run time assertion macros.
Constraint on the data type.
Constraint on the data type.
Constraint on the data type.
Header file for the IsRowMajorMatrix type trait.
Constraint on the data type.
Cast operators for numeric types.
Data type constraint.
Header file for the CLAPACK trtrs wrapper functions.
Base class for dense matrices.
Definition: DenseMatrix.h:82
Base class for N-dimensional dense vectors.
Definition: DenseVector.h:77
Constraint on the data type.
Header file for the DenseMatrix base class.
Header file for the DenseVector base class.
#define BLAZE_CONSTRAINT_MUST_BE_SAME_TYPE(A, B)
Data type constraint.
Definition: SameType.h:71
decltype(auto) trans(const DenseMatrix< MT, SO > &dm)
Calculation of the transpose of the given dense matrix.
Definition: DMatTransExpr.h:766
void trtrs(const DenseMatrix< MT1, SO1 > &A, DenseMatrix< MT2, SO2 > &B, char uplo, char trans, char diag)
LAPACK kernel for the substitution step of solving a triangular linear system of equations ( ).
Definition: trtrs.h:316
#define BLAZE_CONSTRAINT_MUST_BE_BLAS_COMPATIBLE_TYPE(T)
Constraint on the data type.
Definition: BLASCompatible.h:61
#define BLAZE_CONSTRAINT_MUST_BE_CONTIGUOUS_TYPE(T)
Constraint on the data type.
Definition: Contiguous.h:61
#define BLAZE_CONSTRAINT_MUST_NOT_BE_COMPUTATION_TYPE(T)
Constraint on the data type.
Definition: Computation.h:81
#define BLAZE_CONSTRAINT_MUST_NOT_BE_ADAPTOR_TYPE(T)
Constraint on the data type.
Definition: Adaptor.h:81
#define BLAZE_CONSTRAINT_MUST_HAVE_MUTABLE_DATA_ACCESS(T)
Constraint on the data type.
Definition: MutableDataAccess.h:61
#define BLAZE_CONSTRAINT_MUST_HAVE_CONST_DATA_ACCESS(T)
Constraint on the data type.
Definition: ConstDataAccess.h:61
int32_t blas_int_t
Signed integer type used in the BLAS/LAPACK wrapper functions.
Definition: Types.h:64
bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:1383
#define BLAZE_INTERNAL_ASSERT(expr, msg)
Run time assertion macro for internal checks.
Definition: Assert.h:101
#define BLAZE_THROW_INVALID_ARGUMENT(MESSAGE)
Macro for the emission of a std::invalid_argument exception.
Definition: Exception.h:235
Header file for the exception macros of the math module.