DGtal  0.9.4beta
Public Types | Public Member Functions | Data Fields | Protected Member Functions
DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out > Class Template Reference

#include <DGtal/dec/LinearOperator.h>

Public Types

typedef TCalculus Calculus
 
typedef Calculus::SparseMatrix Container
 
typedef Calculus::Scalar Scalar
 
typedef KForm< Calculus, order_in, duality_in > InputKForm
 
typedef KForm< Calculus, order_out, duality_out > OutputKForm
 
typedef LinearOperator< Calculus, order_out, duality_out, order_in, duality_in > TransposedLinearOperator
 

Public Member Functions

 BOOST_STATIC_ASSERT ((order_in >=0))
 
 BOOST_STATIC_ASSERT ((order_in<=Calculus::dimensionEmbedded))
 
 BOOST_STATIC_ASSERT ((order_out >=0))
 
 BOOST_STATIC_ASSERT ((order_out<=Calculus::dimensionEmbedded))
 
 LinearOperator (ConstAlias< Calculus > calculus)
 
 LinearOperator (ConstAlias< Calculus > calculus, const Container &container)
 
LinearOperatoroperator= (const LinearOperator &other)
 
void selfDisplay (std::ostream &out) const
 
TransposedLinearOperator transpose () const
 
void clear ()
 
bool isValid () const
 

Data Fields

Container myContainer
 
const CalculusmyCalculus
 

Protected Member Functions

 LinearOperator ()
 

Detailed Description

template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
class DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >

Aim: LinearOperator represents discrete linear operator between discrete kforms in the DEC package.

Description of template class 'LinearOperator'

Template Parameters
TCalculusshould be DiscreteExteriorCalculus.
order_inis the input order of the linear operator.
duality_inis the input duality of the linear operator.
order_outis the output order of the linear operator.
duality_outis the output duality of the linear operator.
Examples:
dec/exampleDiscreteExteriorCalculusSolve.cpp.

Definition at line 68 of file LinearOperator.h.

Member Typedef Documentation

template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
typedef TCalculus DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::Calculus

Definition at line 72 of file LinearOperator.h.

template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
typedef Calculus::SparseMatrix DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::Container

Container typr.

Definition at line 80 of file LinearOperator.h.

template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
typedef KForm<Calculus, order_in, duality_in> DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::InputKForm

Input KForm type.

Definition at line 84 of file LinearOperator.h.

template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
typedef KForm<Calculus, order_out, duality_out> DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::OutputKForm

Output KForm type.

Definition at line 86 of file LinearOperator.h.

template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
typedef Calculus::Scalar DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::Scalar

Calculus scalar type.

Definition at line 82 of file LinearOperator.h.

template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
typedef LinearOperator<Calculus, order_out, duality_out, order_in, duality_in> DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::TransposedLinearOperator

Transposed operator type.

Definition at line 88 of file LinearOperator.h.

Constructor & Destructor Documentation

template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::LinearOperator ( ConstAlias< Calculus calculus)

Constructor.

Parameters
calculusthe discrete exterior calculus to use.
template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::LinearOperator ( ConstAlias< Calculus calculus,
const Container container 
)

Constructor.

Parameters
calculusthe discrete exterior calculus to use.
containerthe container to copy.
template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::LinearOperator ( )
protected

Constructor. Forbidden by default (protected to avoid g++ warnings).

Member Function Documentation

template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::BOOST_STATIC_ASSERT ( (order_in >=0)  )
template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::BOOST_STATIC_ASSERT ( (order_in<=Calculus::dimensionEmbedded)  )
template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::BOOST_STATIC_ASSERT ( (order_out >=0)  )
template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::BOOST_STATIC_ASSERT ( (order_out<=Calculus::dimensionEmbedded)  )
template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
void DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::clear ( )

Clear current linear operator.

template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
bool DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::isValid ( ) const

Checks the validity/consistency of the object.

Returns
'true' if the object is valid, 'false' otherwise.
template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
LinearOperator& DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::operator= ( const LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out > &  other)

Assignment.

Parameters
otherthe object to copy.
Returns
a reference on 'this'.
template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
void DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::selfDisplay ( std::ostream &  out) const

Writes/Displays the object on an output stream.

Parameters
outthe output stream where the object is written.
template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
TransposedLinearOperator DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::transpose ( ) const

Transpose operator.

Field Documentation

template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
const Calculus* DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::myCalculus

Pointer to const calculus.

Definition at line 122 of file LinearOperator.h.

template<typename TCalculus, Order order_in, Duality duality_in, Order order_out, Duality duality_out>
Container DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality_out >::myContainer

Container used to actually hold the kform data.

Definition at line 117 of file LinearOperator.h.


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