hetrs.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_HETRS_H_
36 #define _BLAZE_MATH_LAPACK_HETRS_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 LDLH-BASED SUBSTITUTION FUNCTIONS (HETRS)
65 //
66 //=================================================================================================
67 
68 //*************************************************************************************************
71 template< typename MT, bool SO, typename VT, bool TF >
72 inline void hetrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo, const int* ipiv );
73 
74 template< typename MT1, bool SO1, typename MT2, bool SO2 >
75 inline void hetrs( const DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B,
76  char uplo, const int* ipiv );
78 //*************************************************************************************************
79 
80 
81 //*************************************************************************************************
166 template< typename MT // Type of the system matrix
167  , bool SO // Storage order of the system matrix
168  , typename VT // Type of the right-hand side vector
169  , bool TF > // Transpose flag of the right-hand side vector
170 inline void hetrs( const DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo, const int* ipiv )
171 {
177 
182 
183  if( !isSquare( ~A ) ) {
184  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
185  }
186 
187  if( (~b).size() != (~A).rows() ) {
188  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side vector provided" );
189  }
190 
191  if( uplo != 'L' && uplo != 'U' ) {
192  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
193  }
194 
195  int n ( numeric_cast<int>( (~A).rows() ) );
196  int nrhs( 1 );
197  int lda ( numeric_cast<int>( (~A).spacing() ) );
198  int ldb ( numeric_cast<int>( (~b).size() ) );
199  int info( 0 );
200 
201  if( n == 0 ) {
202  return;
203  }
204 
205  if( IsRowMajorMatrix_v<MT> ) {
206  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
207  }
208 
209  hetrs( uplo, n, nrhs, (~A).data(), lda, ipiv, (~b).data(), ldb, &info );
210 
211  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
212 }
213 //*************************************************************************************************
214 
215 
216 //*************************************************************************************************
301 template< typename MT1 // Type of the system matrix
302  , bool SO1 // Storage order of the system matrix
303  , typename MT2 // Type of the right-hand side matrix
304  , bool SO2 > // Storage order of the right-hand side matrix
305 inline void hetrs( const DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, char uplo, const int* ipiv )
306 {
312 
318 
319  if( !isSquare( ~A ) ) {
320  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
321  }
322 
323  if( uplo != 'L' && uplo != 'U' ) {
324  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
325  }
326 
327  int n ( numeric_cast<int>( (~A).rows() ) );
328  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
329  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
330  int lda ( numeric_cast<int>( (~A).spacing() ) );
331  int ldb ( numeric_cast<int>( (~B).spacing() ) );
332  int info( 0 );
333 
334  if( n != mrhs ) {
335  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side matrix provided" );
336  }
337 
338  if( n == 0 ) {
339  return;
340  }
341 
342  if( IsRowMajorMatrix_v<MT1> ) {
343  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
344  }
345 
346  hetrs( uplo, n, nrhs, (~A).data(), lda, ipiv, (~B).data(), ldb, &info );
347 
348  BLAZE_INTERNAL_ASSERT( info == 0, "Invalid function argument" );
349 }
350 //*************************************************************************************************
351 
352 } // namespace blaze
353 
354 #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:169
#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.
void hetrs(char uplo, int n, int nrhs, const complex< float > *A, int lda, const int *ipiv, complex< float > *B, int ldb, int *info)
LAPACK kernel for the substitution step of solving a symmetric indefinite single precision complex li...
Definition: hetrs.h:123
Constraint on the data type.
Header file for the CLAPACK hetrs wrapper functions.
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:80
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:252
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
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
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
#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