sysv.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_SYSV_H_
36 #define _BLAZE_MATH_LAPACK_SYSV_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>
53 #include <blaze/util/Exception.h>
55 
56 
57 namespace blaze {
58 
59 //=================================================================================================
60 //
61 // LAPACK FORWARD DECLARATIONS
62 //
63 //=================================================================================================
64 
65 //*************************************************************************************************
67 extern "C" {
68 
69 void ssysv_( char* uplo, int* n, int* nrhs, float* A, int* lda, int* ipiv, float* b, int* ldb, float* work, int* lwork, int* info );
70 void dsysv_( char* uplo, int* n, int* nrhs, double* A, int* lda, int* ipiv, double* b, int* ldb, double* work, int* lwork, int* info );
71 void csysv_( char* uplo, int* n, int* nrhs, float* A, int* lda, int* ipiv, float* b, int* ldb, float* work, int* lwork, int* info );
72 void zsysv_( char* uplo, int* n, int* nrhs, double* A, int* lda, int* ipiv, double* b, int* ldb, double* work, int* lwork, int* info );
73 
74 }
76 //*************************************************************************************************
77 
78 
79 
80 
81 //=================================================================================================
82 //
83 // LAPACK SYMMETRIC INDEFINITE LINEAR SYSTEM FUNCTIONS (SYSV)
84 //
85 //=================================================================================================
86 
87 //*************************************************************************************************
90 inline void sysv( char uplo, int n, int nrhs, float* A, int lda, int* ipiv,
91  float* B, int ldb, float* work, int lwork, int* info );
92 
93 inline void sysv( char uplo, int n, int nrhs, double* A, int lda, int* ipiv,
94  double* B, int ldb, double* work, int lwork, int* info );
95 
96 inline void sysv( char uplo, int n, int nrhs, complex<float>* A, int lda, int* ipiv,
97  complex<float>* B, int ldb, complex<float>* work, int lwork, int* info );
98 
99 inline void sysv( char uplo, int n, int nrhs, complex<double>* A, int lda, int* ipiv,
100  complex<double>* B, int ldb, complex<double>* work, int lwork, int* info );
101 
102 template< typename MT, bool SO, typename VT, bool TF >
103 inline void sysv( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo, int* ipiv );
104 
105 template< typename MT1, bool SO1, typename MT2, bool SO2 >
106 inline void sysv( DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, char uplo, int* ipiv );
108 //*************************************************************************************************
109 
110 
111 //*************************************************************************************************
159 inline void sysv( char uplo, int n, int nrhs, float* A, int lda, int* ipiv,
160  float* B, int ldb, float* work, int lwork, int* info )
161 {
162  ssysv_( &uplo, &n, &nrhs, A, &lda, ipiv, B, &ldb, work, &lwork, info );
163 }
164 //*************************************************************************************************
165 
166 
167 //*************************************************************************************************
215 inline void sysv( char uplo, int n, int nrhs, double* A, int lda, int* ipiv,
216  double* B, int ldb, double* work, int lwork, int* info )
217 {
218  dsysv_( &uplo, &n, &nrhs, A, &lda, ipiv, B, &ldb, work, &lwork, info );
219 }
220 //*************************************************************************************************
221 
222 
223 //*************************************************************************************************
271 inline void sysv( char uplo, int n, int nrhs, complex<float>* A, int lda, int* ipiv,
272  complex<float>* B, int ldb, complex<float>* work, int lwork, int* info )
273 {
274  BLAZE_STATIC_ASSERT( sizeof( complex<float> ) == 2UL*sizeof( float ) );
275 
276  csysv_( &uplo, &n, &nrhs, reinterpret_cast<float*>( A ), &lda, ipiv,
277  reinterpret_cast<float*>( B ), &ldb, reinterpret_cast<float*>( work ), &lwork, info );
278 }
279 //*************************************************************************************************
280 
281 
282 //*************************************************************************************************
330 inline void sysv( char uplo, int n, int nrhs, complex<double>* A, int lda, int* ipiv,
331  complex<double>* B, int ldb, complex<double>* work, int lwork, int* info )
332 {
333  BLAZE_STATIC_ASSERT( sizeof( complex<double> ) == 2UL*sizeof( double ) );
334 
335  zsysv_( &uplo, &n, &nrhs, reinterpret_cast<double*>( A ), &lda, ipiv,
336  reinterpret_cast<double*>( B ), &ldb, reinterpret_cast<double*>( work ), &lwork, info );
337 }
338 //*************************************************************************************************
339 
340 
341 //*************************************************************************************************
399 template< typename MT // Type of the system matrix
400  , bool SO // Storage order of the system matrix
401  , typename VT // Type of the right-hand side vector
402  , bool TF > // Transpose flag of the right-hand side vector
403 inline void sysv( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, char uplo, int* ipiv )
404 {
405  using boost::numeric_cast;
406 
414 
415  typedef typename MT::ElementType ET;
416 
417  if( !isSquare( ~A ) ) {
418  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
419  }
420 
421  if( uplo != 'L' && uplo != 'U' ) {
422  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
423  }
424 
425  int n ( numeric_cast<int>( (~A).rows() ) );
426  int nrhs( 1 );
427  int lda ( numeric_cast<int>( (~A).spacing() ) );
428  int ldb ( numeric_cast<int>( (~b).size() ) );
429  int info( 0 );
430 
431  if( n == 0 ) {
432  return;
433  }
434 
436  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
437  }
438 
439  int lwork( n*lda );
440  const UniqueArray<ET> work( new ET[lwork] );
441 
442  sysv( uplo, n, nrhs, (~A).data(), lda, ipiv, (~b).data(), ldb, work.get(), lwork, &info );
443 
444  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid function argument" );
445 
446  if( info > 0 ) {
447  BLAZE_THROW_INVALID_ARGUMENT( "Inversion of singular matrix failed" );
448  }
449 }
450 //*************************************************************************************************
451 
452 
453 //*************************************************************************************************
515 template< typename MT1 // Type of the system matrix
516  , bool SO1 // Storage order of the system matrix
517  , typename MT2 // Type of the right-hand side matrix
518  , bool SO2 > // Storage order of the right-hand side matrix
519 inline void sysv( DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, char uplo, int* ipiv )
520 {
521  using boost::numeric_cast;
522 
531 
532  typedef typename MT1::ElementType ET;
533 
534  if( !isSquare( ~A ) ) {
535  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
536  }
537 
538  if( uplo != 'L' && uplo != 'U' ) {
539  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
540  }
541 
542  int n ( numeric_cast<int>( (~A).rows() ) );
543  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
544  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
545  int lda ( numeric_cast<int>( (~A).spacing() ) );
546  int ldb ( numeric_cast<int>( (~B).spacing() ) );
547  int info( 0 );
548 
549  if( n != mrhs ) {
550  BLAZE_THROW_INVALID_ARGUMENT( "Matrix sizes do not match" );
551  }
552 
553  if( n == 0 ) {
554  return;
555  }
556 
558  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
559  }
560 
561  int lwork( n*lda );
562  const UniqueArray<ET> work( new ET[lwork] );
563 
564  sysv( uplo, n, nrhs, (~A).data(), lda, ipiv, (~B).data(), ldb, work.get(), lwork, &info );
565 
566  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid function argument" );
567 
568  if( info > 0 ) {
569  BLAZE_THROW_INVALID_ARGUMENT( "Inversion of singular matrix failed" );
570  }
571 }
572 //*************************************************************************************************
573 
574 } // namespace blaze
575 
576 #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.
Data type constraint.
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
BLAZE_ALWAYS_INLINE size_t size(const Vector< VT, TF > &vector)
Returns the current size/dimension of the vector.
Definition: Vector.h:252
#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
Header file for the DenseVector base class.
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
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.
Base class for N-dimensional dense vectors.The DenseVector class is a base class for all arbitrarily ...
Definition: DenseVector.h:70
#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:89
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.
#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
BLAZE_ALWAYS_INLINE size_t columns(const Matrix< MT, SO > &matrix)
Returns the current number of columns of the matrix.
Definition: Matrix.h:324
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
void sysv(char uplo, int n, int nrhs, float *A, int lda, int *ipiv, float *B, int ldb, float *work, int lwork, int *info)
LAPACK kernel for solving a symmetric indefinite single precision linear system of equations ( )...
Definition: sysv.h:159
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