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 <blaze/math/Aliases.h>
48 #include <blaze/math/Exception.h>
52 #include <blaze/util/Assert.h>
54 #include <blaze/util/NumericCast.h>
55 
56 
57 namespace blaze {
58 
59 //=================================================================================================
60 //
61 // LAPACK GENERAL LINEAR SYSTEM FUNCTIONS (GESV)
62 //
63 //=================================================================================================
64 
65 //*************************************************************************************************
68 template< typename MT, bool SO, typename VT, bool TF >
69 inline void gesv( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, int* ipiv );
70 
71 template< typename MT1, bool SO1, typename MT2, bool SO2 >
72 inline void gesv( DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, int* ipiv );
74 //*************************************************************************************************
75 
76 
77 //*************************************************************************************************
131 template< typename MT // Type of the system matrix
132  , bool SO // Storage order of the system matrix
133  , typename VT // Type of the right-hand side vector
134  , bool TF > // Transpose flag of the right-hand side vector
135 inline void gesv( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, int* ipiv )
136 {
144 
145  if( !isSquare( ~A ) ) {
146  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
147  }
148 
149  if( (~b).size() != (~A).rows() ) {
150  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side vector provided" );
151  }
152 
153  int n ( numeric_cast<int>( (~A).rows() ) );
154  int nrhs( 1 );
155  int lda ( numeric_cast<int>( (~A).spacing() ) );
156  int ldb ( numeric_cast<int>( (~b).size() ) );
157  int info( 0 );
158 
159  if( n == 0 ) {
160  return;
161  }
162 
163  gesv( n, nrhs, (~A).data(), lda, ipiv, (~b).data(), ldb, &info );
164 
165  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid function argument" );
166 
167  if( info > 0 ) {
168  BLAZE_THROW_LAPACK_ERROR( "Inversion of singular matrix failed" );
169  }
170 }
171 //*************************************************************************************************
172 
173 
174 //*************************************************************************************************
231 template< typename MT1 // Type of the system matrix
232  , bool SO1 // Storage order of the system matrix
233  , typename MT2 // Type of the right-hand side matrix
234  , bool SO2 > // Storage order of the right-hand side matrix
235 inline void gesv( DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, int* ipiv )
236 {
245 
246  if( !isSquare( ~A ) ) {
247  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
248  }
249 
250  int n ( numeric_cast<int>( (~A).rows() ) );
251  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
252  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
253  int lda ( numeric_cast<int>( (~A).spacing() ) );
254  int ldb ( numeric_cast<int>( (~B).spacing() ) );
255  int info( 0 );
256 
257  if( n != mrhs ) {
258  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side matrix provided" );
259  }
260 
261  if( n == 0 ) {
262  return;
263  }
264 
265  gesv( n, nrhs, (~A).data(), lda, ipiv, (~B).data(), ldb, &info );
266 
267  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid function argument" );
268 
269  if( info > 0 ) {
270  BLAZE_THROW_LAPACK_ERROR( "Inversion of singular matrix failed" );
271  }
272 }
273 //*************************************************************************************************
274 
275 } // namespace blaze
276 
277 #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
Header file for the CLAPACK gesv wrapper functions.
BLAZE_ALWAYS_INLINE size_t size(const Vector< VT, TF > &vector) noexcept
Returns the current size/dimension of the vector.
Definition: Vector.h:265
#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.
Constraint on the data type.
Cast operators for numeric types.
#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:78
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:136
BLAZE_ALWAYS_INLINE size_t spacing(const DenseMatrix< MT, SO > &dm) noexcept
Returns the spacing between the beginning of two rows/columns.
Definition: DenseMatrix.h:110
Constraint on the data type.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:57
Header file for the DenseMatrix base class.
typename T::ElementType ElementType_
Alias declaration for nested ElementType type definitions.The ElementType_ alias declaration provides...
Definition: Aliases.h:163
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:71
BLAZE_ALWAYS_INLINE size_t columns(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of columns of the matrix.
Definition: Matrix.h:340
Header file for the exception macros of the math module.
Constraint on the data type.
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:61
BLAZE_ALWAYS_INLINE size_t rows(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of rows of the matrix.
Definition: Matrix.h:324
#define BLAZE_THROW_LAPACK_ERROR(MESSAGE)
Macro for the emission of an exception on detection of a LAPACK error.This macro encapsulates the def...
Definition: Exception.h:146
BLAZE_ALWAYS_INLINE bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:742
#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