MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
AbstractLinAlgPack::MatrixWithOpConcreteEncap< M > Class Template Reference

This template class defines the storage for a concrete matrix class that operations are based on. More...

#include <AbstractLinAlgPack_MatrixWithOpConcreteEncap.hpp>

Inheritance diagram for AbstractLinAlgPack::MatrixWithOpConcreteEncap< M >:
Inheritance graph
[legend]

Public Member Functions

size_type rows () const
 
size_type cols () const
 
MatrixOpoperator= (const MatrixOp &m)
 
- Public Member Functions inherited from AbstractLinAlgPack::MatrixOp
virtual void zero_out ()
 M_lhs = 0 : Zero out the matrix. More...
 
virtual void Mt_S (value_type alpha)
 M_lhs *= alpha : Multiply a matrix by a scalar. More...
 
virtual mat_mut_ptr_t clone ()
 Clone the non-const matrix object (if supported). More...
 
virtual mat_ptr_t clone () const
 Clone the const matrix object (if supported). More...
 
virtual std::ostream & output (std::ostream &out) const
 Virtual output function. More...
 
const MatNorm calc_norm (EMatNormType requested_norm_type=MAT_NORM_1, bool allow_replacement=false) const
 Compute a norm of this matrix. More...
 
virtual mat_ptr_t sub_view (const Range1D &row_rng, const Range1D &col_rng) const
 Create a transient constant sub-matrix view of this matrix (if supported). More...
 
mat_ptr_t sub_view (const index_type &rl, const index_type &ru, const index_type &cl, const index_type &cu) const
 Inlined implementation calls this->sub_view(Range1D(rl,ru),Range1D(cl,cu)). More...
 
virtual mat_ptr_t perm_view (const Permutation *P_row, const index_type row_part[], int num_row_part, const Permutation *P_col, const index_type col_part[], int num_col_part) const
 Create a permuted view: M_perm = P_row' * M * P_col. More...
 
virtual mat_ptr_t perm_view_update (const Permutation *P_row, const index_type row_part[], int num_row_part, const Permutation *P_col, const index_type col_part[], int num_col_part, const mat_ptr_t &perm_view) const
 Reinitialize a permuted view: M_perm = P_row' * M * P_col. More...
 
- Public Member Functions inherited from AbstractLinAlgPack::MatrixBase
virtual ~MatrixBase ()
 Virtual destructor. More...
 
virtual const VectorSpacespace_cols () const =0
 Vector space for vectors that are compatible with the columns of the matrix. More...
 
virtual const VectorSpacespace_rows () const =0
 Vector space for vectors that are compatible with the rows of the matrix. More...
 
virtual size_type nz () const
 Return the number of nonzero elements in the matrix. More...
 

Private Attributes

M m_
 

Representation access

 MatrixWithOpConcreteEncap ()
 The compiler did not generate this default constructor. More...
 
 MatrixWithOpConcreteEncap (const M &m)
 This constructor will have to be overridden. More...
 
Mm ()
 Get the underlying M object. More...
 
const Mm () const
 

Detailed Description

template<class M>
class AbstractLinAlgPack::MatrixWithOpConcreteEncap< M >

This template class defines the storage for a concrete matrix class that operations are based on.

The default copy constructor and assignment operator are allowed.

Definition at line 55 of file AbstractLinAlgPack_MatrixWithOpConcreteEncap.hpp.

Constructor & Destructor Documentation

The compiler did not generate this default constructor.

Definition at line 64 of file AbstractLinAlgPack_MatrixWithOpConcreteEncap.hpp.

template<class M>
AbstractLinAlgPack::MatrixWithOpConcreteEncap< M >::MatrixWithOpConcreteEncap ( const M m)
inline

This constructor will have to be overridden.

Definition at line 68 of file AbstractLinAlgPack_MatrixWithOpConcreteEncap.hpp.

Member Function Documentation

template<class M>
M& AbstractLinAlgPack::MatrixWithOpConcreteEncap< M >::m ( )
inline

Get the underlying M object.

Definition at line 72 of file AbstractLinAlgPack_MatrixWithOpConcreteEncap.hpp.

template<class M>
const M& AbstractLinAlgPack::MatrixWithOpConcreteEncap< M >::m ( ) const
inline
template<class M >
size_type MatrixWithOpConcreteEncap::rows ( ) const
virtual
template<class M >
size_type MatrixWithOpConcreteEncap::cols ( ) const
virtual
template<class M >
MatrixOp & MatrixWithOpConcreteEncap::operator= ( const MatrixOp m)
virtual

Member Data Documentation

template<class M>
M AbstractLinAlgPack::MatrixWithOpConcreteEncap< M >::m_
private

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