potrs.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_POTRS_H_
36 #define _BLAZE_MATH_LAPACK_POTRS_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <blaze/math/Aliases.h>
48 #include <blaze/math/Exception.h>
53 #include <blaze/util/Assert.h>
55 #include <blaze/util/NumericCast.h>
56 
57 
58 namespace blaze {
59 
60 //=================================================================================================
61 //
62 // LAPACK LLH-BASED SUBSTITUTION FUNCTIONS (POTRS)
63 //
64 //=================================================================================================
65 
66 //*************************************************************************************************
69 template< typename MT, bool SO, typename VT, bool TF >
70 inline void potrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo );
71 
72 template< typename MT1, bool SO1, typename MT2, bool SO2 >
73 inline void potrs( const DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, char uplo );
75 //*************************************************************************************************
76 
77 
78 //*************************************************************************************************
160 template< typename MT // Type of the system matrix
161  , bool SO // Storage order of the system matrix
162  , typename VT // Type of the right-hand side vector
163  , bool TF > // Transpose flag of the right-hand side vector
164 inline void potrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo )
165 {
173 
174  if( !isSquare( ~A ) ) {
175  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
176  }
177 
178  if( (~b).size() != (~A).rows() ) {
179  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side vector provided" );
180  }
181 
182  if( uplo != 'L' && uplo != 'U' ) {
183  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
184  }
185 
186  int n ( numeric_cast<int>( (~A).rows() ) );
187  int nrhs( 1 );
188  int lda ( numeric_cast<int>( (~A).spacing() ) );
189  int ldb ( numeric_cast<int>( (~b).size() ) );
190  int info( 0 );
191 
192  if( n == 0 ) {
193  return;
194  }
195 
197  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
198  }
199 
200  potrs( uplo, n, nrhs, (~A).data(), lda, (~b).data(), ldb, &info );
201 
202  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
203 }
204 //*************************************************************************************************
205 
206 
207 //*************************************************************************************************
289 template< typename MT1 // Type of the system matrix
290  , bool SO1 // Storage order of the system matrix
291  , typename MT2 // Type of the right-hand side matrix
292  , bool SO2 > // Storage order of the right-hand side matrix
293 inline void potrs( const DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, char uplo )
294 {
303 
304  if( !isSquare( ~A ) ) {
305  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
306  }
307 
308  if( uplo != 'L' && uplo != 'U' ) {
309  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
310  }
311 
312  int n ( numeric_cast<int>( (~A).rows() ) );
313  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
314  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
315  int lda ( numeric_cast<int>( (~A).spacing() ) );
316  int ldb ( numeric_cast<int>( (~B).spacing() ) );
317  int info( 0 );
318 
319  if( n != mrhs ) {
320  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side matrix provided" );
321  }
322 
323  if( n == 0 ) {
324  return;
325  }
326 
328  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
329  }
330 
331  potrs( uplo, n, nrhs, (~A).data(), lda, (~B).data(), ldb, &info );
332 
333  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
334 }
335 //*************************************************************************************************
336 
337 } // namespace blaze
338 
339 #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
BLAZE_ALWAYS_INLINE size_t size(const Vector< VT, TF > &vector) noexcept
Returns the current size/dimension of the vector.
Definition: Vector.h:265
#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.
Cast operators for numeric types.
#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:80
BLAZE_ALWAYS_INLINE size_t spacing(const DenseMatrix< MT, SO > &dm) noexcept
Returns the spacing between the beginning of two rows/columns.
Definition: DenseMatrix.h:252
void potrs(char uplo, int n, int nrhs, const float *A, int lda, float *B, int ldb, int *info)
LAPACK kernel for the substitution step of solving a positive definite single precision linear system...
Definition: potrs.h:126
Constraint on the data type.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:58
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.
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:76
Header file for the CLAPACK potrs wrapper functions.
#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:506
Header file for the exception macros of the math module.
Constraint on the data type.
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: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:490
BLAZE_ALWAYS_INLINE MT::ElementType * data(DenseMatrix< MT, SO > &dm) noexcept
Low-level data access to the dense matrix elements.
Definition: DenseMatrix.h:169
Header file for the IsRowMajorMatrix type trait.
BLAZE_ALWAYS_INLINE bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:908
#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