Public Types | Public Member Functions | Protected Types | Private Member Functions | Private Attributes | List of all members
Eigen::SparseLUTransposeView< Conjugate, SparseLUType > Class Template Reference

#include <SparseLU.h>

+ Inheritance diagram for Eigen::SparseLUTransposeView< Conjugate, SparseLUType >:

Public Types

enum  { ColsAtCompileTime = MatrixType::ColsAtCompileTime , MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime }
 
typedef SparseLUType::Scalar Scalar
 
typedef SparseLUType::StorageIndex StorageIndex
 
typedef SparseLUType::MatrixType MatrixType
 
typedef SparseLUType::OrderingType OrderingType
 

Public Member Functions

 SparseLUTransposeView ()
 
 SparseLUTransposeView (const SparseLUTransposeView &view)
 
void setIsInitialized (const bool isInitialized)
 
void setSparseLU (SparseLUType *sparseLU)
 
template<typename Rhs , typename Dest >
bool _solve_impl (const MatrixBase< Rhs > &B, MatrixBase< Dest > &X_base) const
 
Index rows () const
 
Index cols () const
 
- Public Member Functions inherited from Eigen::SparseSolverBase< SparseLUTransposeView< Conjugate, SparseLUType > >
 SparseSolverBase ()
 
 SparseSolverBase (SparseSolverBase &&other)
 
 ~SparseSolverBase ()
 
SparseLUTransposeView< Conjugate, SparseLUType > & derived ()
 
const SparseLUTransposeView< Conjugate, SparseLUType > & derived () const
 
const Solve< SparseLUTransposeView< Conjugate, SparseLUType >, Rhs > solve (const MatrixBase< Rhs > &b) const
 
const Solve< SparseLUTransposeView< Conjugate, SparseLUType >, Rhs > solve (const SparseMatrixBase< Rhs > &b) const
 
void _solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
 

Protected Types

typedef SparseSolverBase< SparseLUTransposeView< Conjugate, SparseLUType > > APIBase
 

Private Member Functions

SparseLUTransposeView & operator= (const SparseLUTransposeView &)
 

Private Attributes

SparseLUType * m_sparseLU
 

Additional Inherited Members

- Protected Attributes inherited from Eigen::SparseSolverBase< SparseLUTransposeView< Conjugate, SparseLUType > >
bool m_isInitialized
 

Member Typedef Documentation

◆ APIBase

template<bool Conjugate, class SparseLUType >
typedef SparseSolverBase<SparseLUTransposeView<Conjugate, SparseLUType> > Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::APIBase
protected

◆ MatrixType

template<bool Conjugate, class SparseLUType >
typedef SparseLUType::MatrixType Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::MatrixType

◆ OrderingType

template<bool Conjugate, class SparseLUType >
typedef SparseLUType::OrderingType Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::OrderingType

◆ Scalar

template<bool Conjugate, class SparseLUType >
typedef SparseLUType::Scalar Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::Scalar

◆ StorageIndex

template<bool Conjugate, class SparseLUType >
typedef SparseLUType::StorageIndex Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::StorageIndex

Member Enumeration Documentation

◆ anonymous enum

template<bool Conjugate, class SparseLUType >
anonymous enum
Enumerator
ColsAtCompileTime 
MaxColsAtCompileTime 
38 { ColsAtCompileTime = MatrixType::ColsAtCompileTime, MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime };
Eigen::SparseLUTransposeView::MaxColsAtCompileTime
@ MaxColsAtCompileTime
Definition: SparseLU.h:38
Eigen::SparseLUTransposeView::ColsAtCompileTime
@ ColsAtCompileTime
Definition: SparseLU.h:38

Constructor & Destructor Documentation

◆ SparseLUTransposeView() [1/2]

template<bool Conjugate, class SparseLUType >
Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::SparseLUTransposeView ( )
inline
40 : APIBase(), m_sparseLU(NULL) {}
Eigen::SparseLUTransposeView::m_sparseLU
SparseLUType * m_sparseLU
Definition: SparseLU.h:72
Eigen::SparseLUTransposeView::APIBase
SparseSolverBase< SparseLUTransposeView< Conjugate, SparseLUType > > APIBase
Definition: SparseLU.h:29

◆ SparseLUTransposeView() [2/2]

template<bool Conjugate, class SparseLUType >
Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::SparseLUTransposeView ( const SparseLUTransposeView< Conjugate, SparseLUType > &  view)
inline
41  : APIBase() {
42  this->m_sparseLU = view.m_sparseLU;
43  this->m_isInitialized = view.m_isInitialized;
44  }

References Eigen::SparseSolverBase< Derived >::m_isInitialized, Eigen::SparseSolverBase< SparseLUTransposeView< Conjugate, SparseLUType > >::m_isInitialized, and Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::m_sparseLU.

Member Function Documentation

◆ _solve_impl()

template<bool Conjugate, class SparseLUType >
template<typename Rhs , typename Dest >
bool Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::_solve_impl ( const MatrixBase< Rhs > &  B,
MatrixBase< Dest > &  X_base 
) const
inline
49  {
50  Dest& X(X_base.derived());
51  eigen_assert(m_sparseLU->info() == Success && "The matrix should be factorized first");
52  EIGEN_STATIC_ASSERT((Dest::Flags & RowMajorBit) == 0, THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES);
53 
54  // this ugly const_cast_derived() helps to detect aliasing when applying the permutations
55  for (Index j = 0; j < B.cols(); ++j) {
56  X.col(j) = m_sparseLU->colsPermutation() * B.const_cast_derived().col(j);
57  }
58  // Forward substitution with transposed or adjoint of U
59  m_sparseLU->matrixU().template solveTransposedInPlace<Conjugate>(X);
60 
61  // Backward substitution with transposed or adjoint of L
62  m_sparseLU->matrixL().template solveTransposedInPlace<Conjugate>(X);
63 
64  // Permute back the solution
65  for (Index j = 0; j < B.cols(); ++j) X.col(j) = m_sparseLU->rowsPermutation().transpose() * X.col(j);
66  return true;
67  }
eigen_assert
#define eigen_assert(x)
Definition: Macros.h:910
EIGEN_STATIC_ASSERT
#define EIGEN_STATIC_ASSERT(X, MSG)
Definition: StaticAssert.h:26
oomph::Matrix
Definition: matrices.h:74
Eigen::Success
@ Success
Definition: Constants.h:440
Eigen::RowMajorBit
const unsigned int RowMajorBit
Definition: Constants.h:70
X
#define X
Definition: icosphere.cpp:20
Eigen::Index
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:83
j
std::ptrdiff_t j
Definition: tut_arithmetic_redux_minmax.cpp:2

References eigen_assert, EIGEN_STATIC_ASSERT, j, Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::m_sparseLU, Eigen::RowMajorBit, Eigen::Success, and X.

◆ cols()

template<bool Conjugate, class SparseLUType >
Index Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::cols ( ) const
inline
69 { return m_sparseLU->cols(); }

References Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::m_sparseLU.

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

◆ operator=()

template<bool Conjugate, class SparseLUType >
SparseLUTransposeView& Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::operator= ( const SparseLUTransposeView< Conjugate, SparseLUType > &  )
private

◆ rows()

template<bool Conjugate, class SparseLUType >
Index Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::rows ( ) const
inline
68 { return m_sparseLU->rows(); }

References Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::m_sparseLU.

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

◆ setIsInitialized()

template<bool Conjugate, class SparseLUType >
void Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::setIsInitialized ( const bool  isInitialized)
inline
45 { this->m_isInitialized = isInitialized; }

References Eigen::SparseSolverBase< SparseLUTransposeView< Conjugate, SparseLUType > >::m_isInitialized.

Referenced by Eigen::SparseLU< MatrixType_, OrderingType_ >::adjoint(), and Eigen::SparseLU< MatrixType_, OrderingType_ >::transpose().

◆ setSparseLU()

template<bool Conjugate, class SparseLUType >
void Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::setSparseLU ( SparseLUType *  sparseLU)
inline
46 { m_sparseLU = sparseLU; }

References Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::m_sparseLU.

Referenced by Eigen::SparseLU< MatrixType_, OrderingType_ >::adjoint(), and Eigen::SparseLU< MatrixType_, OrderingType_ >::transpose().

Member Data Documentation

◆ m_sparseLU

template<bool Conjugate, class SparseLUType >
SparseLUType* Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::m_sparseLU
private

Referenced by Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::_solve_impl(), Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::cols(), Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::rows(), Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::setSparseLU(), and Eigen::SparseLUTransposeView< Conjugate, SparseLUType >::SparseLUTransposeView().

The documentation for this class was generated from the following file: