sytrf.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_SYTRF_H_
36 #define _BLAZE_MATH_LAPACK_SYTRF_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <boost/cast.hpp>
50 #include <blaze/util/Assert.h>
51 #include <blaze/util/Complex.h>
52 #include <blaze/util/Exception.h>
54 #include <blaze/util/UniqueArray.h>
55 
56 
57 namespace blaze {
58 
59 //=================================================================================================
60 //
61 // LAPACK FORWARD DECLARATIONS
62 //
63 //=================================================================================================
64 
65 //*************************************************************************************************
67 extern "C" {
68 
69 void ssytrf_( char* uplo, int* n, float* A, int* lda, int* ipiv, float* work, int* lwork, int* info );
70 void dsytrf_( char* uplo, int* n, double* A, int* lda, int* ipiv, double* work, int* lwork, int* info );
71 void csytrf_( char* uplo, int* n, float* A, int* lda, int* ipiv, float* work, int* lwork, int* info );
72 void zsytrf_( char* uplo, int* n, double* A, int* lda, int* ipiv, double* work, int* lwork, int* info );
73 
74 }
76 //*************************************************************************************************
77 
78 
79 
80 
81 //=================================================================================================
82 //
83 // LAPACK LDLT DECOMPOSITION FUNCTIONS (SYTRF)
84 //
85 //=================================================================================================
86 
87 //*************************************************************************************************
90 inline void sytrf( char uplo, int n, float* A, int lda, int* ipiv,
91  float* work, int lwork, int* info );
92 
93 inline void sytrf( char uplo, int n, double* A, int lda, int* ipiv,
94  double* work, int lwork, int* info );
95 
96 inline void sytrf( char uplo, int n, complex<float>* A, int lda, int* ipiv,
97  complex<float>* work, int lwork, int* info );
98 
99 inline void sytrf( char uplo, int n, complex<double>* A, int lda, int* ipiv,
100  complex<double>* work, int lwork, int* info );
101 
102 template< typename MT, bool SO >
103 inline void sytrf( DenseMatrix<MT,SO>& A, char uplo, int* ipiv );
105 //*************************************************************************************************
106 
107 
108 //*************************************************************************************************
155 inline void sytrf( char uplo, int n, float* A, int lda, int* ipiv,
156  float* work, int lwork, int* info )
157 {
158  ssytrf_( &uplo, &n, A, &lda, ipiv, work, &lwork, info );
159 }
160 //*************************************************************************************************
161 
162 
163 //*************************************************************************************************
210 inline void sytrf( char uplo, int n, double* A, int lda, int* ipiv,
211  double* work, int lwork, int* info )
212 {
213  dsytrf_( &uplo, &n, A, &lda, ipiv, work, &lwork, info );
214 }
215 //*************************************************************************************************
216 
217 
218 //*************************************************************************************************
265 inline void sytrf( char uplo, int n, complex<float>* A, int lda, int* ipiv,
266  complex<float>* work, int lwork, int* info )
267 {
268  BLAZE_STATIC_ASSERT( sizeof( complex<float> ) == 2UL*sizeof( float ) );
269 
270  csytrf_( &uplo, &n, reinterpret_cast<float*>( A ), &lda, ipiv,
271  reinterpret_cast<float*>( work ), &lwork, info );
272 }
273 //*************************************************************************************************
274 
275 
276 //*************************************************************************************************
323 inline void sytrf( char uplo, int n, complex<double>* A, int lda, int* ipiv,
324  complex<double>* work, int lwork, int* info )
325 {
326  BLAZE_STATIC_ASSERT( sizeof( complex<double> ) == 2UL*sizeof( double ) );
327 
328  zsytrf_( &uplo, &n, reinterpret_cast<double*>( A ), &lda, ipiv,
329  reinterpret_cast<double*>( work ), &lwork, info );
330 }
331 //*************************************************************************************************
332 
333 
334 //*************************************************************************************************
377 template< typename MT // Type of the dense matrix
378  , bool SO > // Storage order of the dense matrix
379 inline void sytrf( DenseMatrix<MT,SO>& A, char uplo, int* ipiv )
380 {
381  using boost::numeric_cast;
382 
387 
388  typedef typename MT::ElementType ET;
389 
390  if( !isSquare( ~A ) ) {
391  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
392  }
393 
394  if( uplo != 'L' && uplo != 'U' ) {
395  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
396  }
397 
398  int n ( numeric_cast<int>( (~A).rows() ) );
399  int lda ( numeric_cast<int>( (~A).spacing() ) );
400  int info( 0 );
401 
402  if( n == 0 ) {
403  return;
404  }
405 
406  int lwork( n*lda );
407  const UniqueArray<ET> work( new ET[lwork] );
408 
410  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
411  }
412 
413  sytrf( uplo, n, (~A).data(), lda, ipiv, work.get(), lwork, &info );
414 
415  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid argument for matrix decomposition" );
416 }
417 //*************************************************************************************************
418 
419 } // namespace blaze
420 
421 #endif
#define BLAZE_THROW_INVALID_ARGUMENT(MESSAGE)
Macro for the emission of a std::invalid_argument exceptionThis macro encapsulates the default way of...
Definition: Exception.h:187
Constraint on the data type.
Log level for high-level information.
Definition: LogLevel.h:80
#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:79
BLAZE_ALWAYS_INLINE bool isSquare(const Matrix< MT, SO > &matrix)
Checks if the given matrix is a square matrix.
Definition: Matrix.h:603
#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:118
Pointer get() const
Returns a pointer to the managed array.
Definition: UniqueArray.h:245
BLAZE_ALWAYS_INLINE size_t rows(const Matrix< MT, SO > &matrix)
Returns the current number of rows of the matrix.
Definition: Matrix.h:308
Constraint on the data type.
#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:118
Base class for dense matrices.The DenseMatrix class is a base class for all dense matrix classes...
Definition: DenseMatrix.h:70
void sytrf(char uplo, int n, float *A, int lda, int *ipiv, float *work, int lwork, int *info)
LAPACK kernel for the decomposition of the given dense symmetric indefinite single precision column-m...
Definition: sytrf.h:155
Namespace of the Blaze C++ math library.
Definition: Blaze.h:57
Compile time assertion.
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.
Type ElementType
Type of the sparse matrix elements.
Definition: CompressedMatrix.h:2586
Constraint on the data type.
Constraint on the data type.
const bool spacing
Adding an additional spacing line between two log messages.This setting gives the opportunity to add ...
Definition: Logging.h:70
Header file for run time assertion macros.
Header file for the UniqueArray smart pointer class.
#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:79
Header file for the IsRowMajorMatrix type trait.
Header file for the complex data type.
Header file for exception macros.
#define BLAZE_STATIC_ASSERT(expr)
Compile time assertion macro.In case of an invalid compile time expression, a compilation error is cr...
Definition: StaticAssert.h:143
Scope-limited management of dynamically allocated arrays.The UniqueArray class implements a scope-res...
Definition: UniqueArray.h:97
#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