Blaze 3.9
Loading...
Searching...
No Matches
pstrf.h
Go to the documentation of this file.
1//=================================================================================================
33//=================================================================================================
34
35#ifndef _BLAZE_MATH_LAPACK_PSTRF_H_
36#define _BLAZE_MATH_LAPACK_PSTRF_H_
37
38
39//*************************************************************************************************
40// Includes
41//*************************************************************************************************
42
43#include <memory>
44#include <blaze/math/Aliases.h>
53#include <blaze/util/Assert.h>
55
56
57namespace blaze {
58
59//=================================================================================================
60//
61// LAPACK LLH PIVOTING (CHOLESKY) DECOMPOSITION FUNCTIONS (PsTRF)
62//
63//=================================================================================================
64
65//*************************************************************************************************
68template< typename MT, bool SO, typename ST >
69blas_int_t pstrf( DenseMatrix<MT,SO>& A, char uplo, blas_int_t* piv, ST tol );
71//*************************************************************************************************
72
73
74//*************************************************************************************************
121template< typename MT // Type of the dense matrix
122 , bool SO // Storage order of the dense matrix
123 , typename ST > // Type of the scalar tolerance value
124inline blas_int_t pstrf( DenseMatrix<MT,SO>& A, char uplo, blas_int_t* piv, ST tol )
125{
131
132 if( !isSquare( *A ) ) {
133 BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
134 }
135
136 if( uplo != 'L' && uplo != 'U' ) {
137 BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
138 }
139
140 using ET = ElementType_t<MT>;
141
142 blas_int_t n ( numeric_cast<blas_int_t>( (*A).rows() ) );
143 blas_int_t lda ( numeric_cast<blas_int_t>( (*A).spacing() ) );
144 blas_int_t info( 0 );
145 blas_int_t rank( 0 );
146
147 if( n == 0 ) {
148 return rank;
149 }
150
152 ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
153 }
154
155 const std::unique_ptr<ET[]> work( new ET[n*2] );
156
157 pstrf( uplo, n, (*A).data(), lda, piv, &rank, tol, work.get(), &info );
158
159 BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid argument for Cholesky decomposition" );
160
161 for( size_t i=0UL; i<n; ++i ) {
162 --piv[i]; // Adapt from Fortran 1-based to C 0-based indexing
163 }
164
165 return rank;
166}
167//*************************************************************************************************
168
169} // namespace blaze
170
171#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.
Cast operators for numeric types.
Header file for the CLAPACK pstrf wrapper functions.
Base class for dense matrices.
Definition DenseMatrix.h:82
Constraint on the data type.
Header file for the DenseMatrix base class.
size_t rank(const DenseMatrix< MT, SO > &dm)
Computes the rank of the given dense matrix.
Definition DenseMatrix.h:2715
void pstrf(char uplo, blas_int_t n, float *A, blas_int_t lda, blaze::blas_int_t *piv, blaze::blas_int_t *rank, float tol, float *work, blas_int_t *info)
LAPACK kernel for the pivoting Cholesky decomposition of the given dense semi-positive definite singl...
Definition pstrf.h:155
#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
constexpr bool IsRowMajorMatrix_v
Auxiliary variable template for the IsRowMajorMatrix type trait.
Definition IsRowMajorMatrix.h:129
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
To numeric_cast(From from)
Checked conversion of values of numeric type.
Definition NumericCast.h:275
#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.