gesv.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_GESV_H_
36 #define _BLAZE_MATH_LAPACK_GESV_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 sgesv_( int* n, int* nrhs, float* A, int* lda, int* ipiv, float* b, int* ldb, int* info );
70 void dgesv_( int* n, int* nrhs, double* A, int* lda, int* ipiv, double* b, int* ldb, int* info );
71 void cgesv_( int* n, int* nrhs, float* A, int* lda, int* ipiv, float* b, int* ldb, int* info );
72 void zgesv_( int* n, int* nrhs, double* A, int* lda, int* ipiv, double* b, int* ldb, int* info );
73 
74 }
76 //*************************************************************************************************
77 
78 
79 
80 
81 //=================================================================================================
82 //
83 // LAPACK GENERAL LINEAR SYSTEM FUNCTIONS (GESV)
84 //
85 //=================================================================================================
86 
87 //*************************************************************************************************
90 inline void gesv( int n, int nrhs, float* A, int lda, int* ipiv, float* B, int ldb, int* info );
91 
92 inline void gesv( int n, int nrhs, double* A, int lda, int* ipiv, double* B, int ldb, int* info );
93 
94 inline void gesv( int n, int nrhs, complex<float>* A, int lda, int* ipiv, complex<float>* B, int ldb, int* info );
95 
96 inline void gesv( int n, int nrhs, complex<double>* A, int lda, int* ipiv, complex<double>* B, int ldb, int* info );
97 
98 template< typename MT, bool SO, typename VT, bool TF >
99 inline void gesv( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, int* ipiv );
100 
101 template< typename MT1, bool SO1, typename MT2, bool SO2 >
102 inline void gesv( DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, int* ipiv );
104 //*************************************************************************************************
105 
106 
107 //*************************************************************************************************
149 inline void gesv( int n, int nrhs, float* A, int lda, int* ipiv, float* B, int ldb, int* info )
150 {
151  sgesv_( &n, &nrhs, A, &lda, ipiv, B, &ldb, info );
152 }
153 //*************************************************************************************************
154 
155 
156 //*************************************************************************************************
198 inline void gesv( int n, int nrhs, double* A, int lda, int* ipiv, double* B, int ldb, int* info )
199 {
200  dgesv_( &n, &nrhs, A, &lda, ipiv, B, &ldb, info );
201 }
202 //*************************************************************************************************
203 
204 
205 //*************************************************************************************************
247 inline void gesv( int n, int nrhs, complex<float>* A, int lda, int* ipiv, complex<float>* B, int ldb, int* info )
248 {
249  BLAZE_STATIC_ASSERT( sizeof( complex<float> ) == 2UL*sizeof( float ) );
250 
251  cgesv_( &n, &nrhs, reinterpret_cast<float*>( A ), &lda, ipiv,
252  reinterpret_cast<float*>( B ), &ldb, info );
253 }
254 //*************************************************************************************************
255 
256 
257 //*************************************************************************************************
299 inline void gesv( int n, int nrhs, complex<double>* A, int lda, int* ipiv, complex<double>* B, int ldb, int* info )
300 {
301  BLAZE_STATIC_ASSERT( sizeof( complex<double> ) == 2UL*sizeof( double ) );
302 
303  zgesv_( &n, &nrhs, reinterpret_cast<double*>( A ), &lda, ipiv,
304  reinterpret_cast<double*>( B ), &ldb, info );
305 }
306 //*************************************************************************************************
307 
308 
309 //*************************************************************************************************
360 template< typename MT // Type of the system matrix
361  , bool SO // Storage order of the system matrix
362  , typename VT // Type of the right-hand side vector
363  , bool TF > // Transpose flag of the right-hand side vector
364 inline void gesv( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, int* ipiv )
365 {
366  using boost::numeric_cast;
367 
375 
376  if( !isSquare( ~A ) ) {
377  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
378  }
379 
380  int n ( numeric_cast<int>( (~A).rows() ) );
381  int nrhs( 1 );
382  int lda ( numeric_cast<int>( (~A).spacing() ) );
383  int ldb ( numeric_cast<int>( (~b).size() ) );
384  int info( 0 );
385 
386  if( n == 0 ) {
387  return;
388  }
389 
390  gesv( n, nrhs, (~A).data(), lda, ipiv, (~b).data(), ldb, &info );
391 
392  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid function argument" );
393 
394  if( info > 0 ) {
395  BLAZE_THROW_INVALID_ARGUMENT( "Inversion of singular matrix failed" );
396  }
397 }
398 //*************************************************************************************************
399 
400 
401 //*************************************************************************************************
457 template< typename MT1 // Type of the system matrix
458  , bool SO1 // Storage order of the system matrix
459  , typename MT2 // Type of the right-hand side matrix
460  , bool SO2 > // Storage order of the right-hand side matrix
461 inline void gesv( DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, int* ipiv )
462 {
463  using boost::numeric_cast;
464 
473 
474  if( !isSquare( ~A ) ) {
475  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
476  }
477 
478  int n ( numeric_cast<int>( (~A).rows() ) );
479  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
480  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
481  int lda ( numeric_cast<int>( (~A).spacing() ) );
482  int ldb ( numeric_cast<int>( (~B).spacing() ) );
483  int info( 0 );
484 
485  if( n != mrhs ) {
486  BLAZE_THROW_INVALID_ARGUMENT( "Matrix sizes do not match" );
487  }
488 
489  if( n == 0 ) {
490  return;
491  }
492 
493  gesv( n, nrhs, (~A).data(), lda, ipiv, (~B).data(), ldb, &info );
494 
495  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid function argument" );
496 
497  if( info > 0 ) {
498  BLAZE_THROW_INVALID_ARGUMENT( "Inversion of singular matrix failed" );
499  }
500 }
501 //*************************************************************************************************
502 
503 } // namespace blaze
504 
505 #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
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
void gesv(int n, int nrhs, float *A, int lda, int *ipiv, float *B, int ldb, int *info)
LAPACK kernel for solving a general single precision linear system of equations ( )...
Definition: gesv.h:149
Namespace of the Blaze C++ math library.
Definition: Blaze.h:57
Compile time assertion.
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
#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