DGtal: DGtal::LinearOperator< TCalculus, order_in, duality_in, order_out, duality

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

#include <DGtal/dec/LinearOperator.h>

Public Types
typedef TCalculus	Calculus

typedef Calculus::SparseMatrix	Container
	Container typr. More...

typedef Calculus::Scalar	Scalar
	Calculus scalar type. More...

typedef KForm< Calculus, order_in, duality_in >	InputKForm
	Input KForm type. More...

typedef KForm< Calculus, order_out, duality_out >	OutputKForm
	Output KForm type. More...

typedef LinearOperator< Calculus, order_out, duality_out, order_in, duality_in >	TransposedLinearOperator
	Transposed operator type. More...

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)

LinearOperator &	operator= (const LinearOperator &other)

void	selfDisplay (std::ostream &out) const

TransposedLinearOperator	transpose () const

void	clear ()

bool	isValid () const

Data Fields
Container	myContainer

const Calculus *	myCalculus

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

TCalculus	should be DiscreteExteriorCalculus.
order_in	is the input order of the linear operator.
duality_in	is the input duality of the linear operator.
order_out	is the output order of the linear operator.
duality_out	is the output duality of the linear operator.

Definition at line 68 of file LinearOperator.h.

Member Typedef Documentation

◆ Calculus

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.

◆ Container

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.

◆ InputKForm

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.

◆ OutputKForm

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.

◆ Scalar

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.

◆ TransposedLinearOperator

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

◆ LinearOperator() [1/3]

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

calculus the discrete exterior calculus to use.

◆ LinearOperator() [2/3]

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

calculus	the discrete exterior calculus to use.
container	the container to copy.

◆ LinearOperator() [3/3]

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

◆ BOOST_STATIC_ASSERT() [1/4]

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) )

◆ BOOST_STATIC_ASSERT() [2/4]

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) )

◆ BOOST_STATIC_ASSERT() [3/4]

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) )

◆ BOOST_STATIC_ASSERT() [4/4]

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) )

◆ clear()

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.

◆ isValid()

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.

◆ operator=()

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

other the object to copy.

Returns: a reference on 'this'.

◆ selfDisplay()

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

out	the output stream where the object is written.

◆ transpose()

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.

Referenced by DGtal::ATSolver2D< TKSpace, TLinearAlgebra >::solveOneAlternateStep().

Field Documentation

◆ myCalculus

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.

◆ myContainer

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.

Referenced by DGtal::ATSolver2D< TKSpace, TLinearAlgebra >::initOperators().

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

LinearOperator.h

Public Types

Public Member Functions

Data Fields

Protected Member Functions

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 >

Member Typedef Documentation

◆ Calculus

◆ Container

◆ InputKForm

◆ OutputKForm

◆ Scalar

◆ TransposedLinearOperator

Constructor & Destructor Documentation

◆ LinearOperator() [1/3]

◆ LinearOperator() [2/3]

◆ LinearOperator() [3/3]

Member Function Documentation

◆ BOOST_STATIC_ASSERT() [1/4]

◆ BOOST_STATIC_ASSERT() [2/4]

◆ BOOST_STATIC_ASSERT() [3/4]

◆ BOOST_STATIC_ASSERT() [4/4]

◆ clear()

◆ isValid()

◆ operator=()

◆ selfDisplay()

◆ transpose()

Field Documentation

◆ myCalculus

◆ myContainer

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 >