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>
49 #include <blaze/math/Exception.h>
53 #include <blaze/util/Assert.h>
55 #include <blaze/util/NumericCast.h>
56 
57 
58 namespace blaze {
59 
60 //=================================================================================================
61 //
62 // LAPACK GENERAL LINEAR SYSTEM FUNCTIONS (GESV)
63 //
64 //=================================================================================================
65 
66 //*************************************************************************************************
69 template< typename MT, bool SO, typename VT, bool TF >
70 inline void gesv( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, int* ipiv );
71 
72 template< typename MT1, bool SO1, typename MT2, bool SO2 >
73 inline void gesv( DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, int* ipiv );
75 //*************************************************************************************************
76 
77 
78 //*************************************************************************************************
132 template< typename MT // Type of the system matrix
133  , bool SO // Storage order of the system matrix
134  , typename VT // Type of the right-hand side vector
135  , bool TF > // Transpose flag of the right-hand side vector
136 inline void gesv( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& b, int* ipiv )
137 {
143 
148 
149  if( !isSquare( ~A ) ) {
150  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
151  }
152 
153  if( (~b).size() != (~A).rows() ) {
154  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side vector provided" );
155  }
156 
157  int n ( numeric_cast<int>( (~A).rows() ) );
158  int nrhs( 1 );
159  int lda ( numeric_cast<int>( (~A).spacing() ) );
160  int ldb ( numeric_cast<int>( (~b).size() ) );
161  int info( 0 );
162 
163  if( n == 0 ) {
164  return;
165  }
166 
167  gesv( n, nrhs, (~A).data(), lda, ipiv, (~b).data(), ldb, &info );
168 
169  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid function argument" );
170 
171  if( info > 0 ) {
172  BLAZE_THROW_LAPACK_ERROR( "Inversion of singular matrix failed" );
173  }
174 }
175 //*************************************************************************************************
176 
177 
178 //*************************************************************************************************
235 template< typename MT1 // Type of the system matrix
236  , bool SO1 // Storage order of the system matrix
237  , typename MT2 // Type of the right-hand side matrix
238  , bool SO2 > // Storage order of the right-hand side matrix
239 inline void gesv( DenseMatrix<MT1,SO1>& A, DenseMatrix<MT2,SO2>& B, int* ipiv )
240 {
246 
252 
253  if( !isSquare( ~A ) ) {
254  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
255  }
256 
257  int n ( numeric_cast<int>( (~A).rows() ) );
258  int mrhs( numeric_cast<int>( SO2 ? (~B).rows() : (~B).columns() ) );
259  int nrhs( numeric_cast<int>( SO2 ? (~B).columns() : (~B).rows() ) );
260  int lda ( numeric_cast<int>( (~A).spacing() ) );
261  int ldb ( numeric_cast<int>( (~B).spacing() ) );
262  int info( 0 );
263 
264  if( n != mrhs ) {
265  BLAZE_THROW_INVALID_ARGUMENT( "Invalid right-hand side matrix provided" );
266  }
267 
268  if( n == 0 ) {
269  return;
270  }
271 
272  gesv( n, nrhs, (~A).data(), lda, ipiv, (~B).data(), ldb, &info );
273 
274  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid function argument" );
275 
276  if( info > 0 ) {
277  BLAZE_THROW_LAPACK_ERROR( "Inversion of singular matrix failed" );
278  }
279 }
280 //*************************************************************************************************
281 
282 } // namespace blaze
283 
284 #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
MT::ElementType * data(DenseMatrix< MT, SO > &dm) noexcept
Low-level data access to the dense matrix elements.
Definition: DenseMatrix.h:169
Header file for the CLAPACK gesv wrapper functions.
#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.
Constraint on the data type.
Cast operators for numeric types.
constexpr size_t columns(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of columns of the matrix.
Definition: Matrix.h:514
#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:80
typename T::ElementType ElementType_t
Alias declaration for nested ElementType type definitions.The ElementType_t alias declaration provide...
Definition: Aliases.h:170
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
size_t spacing(const DenseMatrix< MT, SO > &dm) noexcept
Returns the spacing between the beginning of two rows/columns.
Definition: DenseMatrix.h:252
Constraint on the data type.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:58
#define BLAZE_CONSTRAINT_MUST_BE_CONTIGUOUS_TYPE(T)
Constraint on the data type.In case the given data type T is not an array-like data type with contigu...
Definition: Contiguous.h:61
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:76
#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
Header file for the exception macros of the math module.
Constraint on the data type.
Header file for run time assertion macros.
constexpr size_t size(const Matrix< MT, SO > &matrix) noexcept
Returns the total number of elements of the matrix.
Definition: Matrix.h:530
#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
constexpr size_t rows(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of rows of the matrix.
Definition: Matrix.h:498
#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
bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:951
#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