#include <permutation.hh>

Inheritance diagram for concepts::Permutation< F >:

Collaboration diagram for concepts::Permutation< F >:

Public Types
typedef Cmplxtype< F >::type	c_type
	Real type of data type.
typedef _Matrix_iterator< F, const F &, const F * >	const_iterator
typedef _Matrix_iterator< F, F &, F * >	iterator
typedef Realtype< F >::type	r_type
	Real type of data type.
typedef F	type
	Type of data, e.g. matrix entries.
typedef F	value_type
Public Member Functions
iterator	begin (uint r=0)
	Iterator over the elements, standing at position (r,0).
const_iterator	begin (uint r=0) const
	Constant iterator over the elements, standing at position (r,0)
void	composeRestr (const TrivExtendRestrict< F > &restr, Matrix< F > &dest) const
	Computes the composition of a `Permutation` and a `TrivExtendRestrict` and stores the result in `dest`.
void	convertToMatrix (Matrix< F > &dest) const
	Convertes this permutation to the matrix `dest`.
virtual const uint	dimX () const
	Returns the size of the image space of the operator (number of rows of the corresponding matrix)
virtual const uint	dimY () const
	Returns the size of the source space of the operator (number of columns of the corresponding matrix)
iterator	end ()
	Iterator, standing behind last element.
const_iterator	end () const
	Constant iterator, standing behind last element.
const uint	nofCols () const
	Number of columns.
const uint	nofRows () const
	Number of rows.
virtual void	operator() (const Function< r_type > &fncY, Function< F > &fncX)
	Computes `fncX` = A(`fncY`) where A is this matrix.
virtual F &	operator() (const uint i, const uint j)
	Returns and allows access to entry with indices `i` and `j`.
virtual void	operator() (const Function< c_type > &fncY, Function< c_type > &fncX)
	Application operator for complex function `fncY`.
virtual F	operator() (const uint i, const uint j) const
	Returns entry with indices `i` and `j`.
virtual bool	operator== (const Matrix< F > &otherMat) const
int	operator[] (const uint i) const
	Returns the permutation of index `i`.
	Permutation (const Permutation< F > &perm, bool transpose=false)
	Copy constructor.
template<class G >
	Permutation (const Space< G > &space, const Array< int > &perm, bool transpose=false)
	Constructor.
	Permutation (uint dim, const Array< int > &perm, bool transpose=false)
virtual void	transpMult (const Vector< c_type > &fncY, Vector< c_type > &fncX)
virtual void	transpMult (const Vector< r_type > &fncY, Vector< F > &fncX)
	Computes `fncX` = A^T `fncY` where A is this matrix.
Static Public Member Functions
template<class G >
static void	assembly (Matrix< F > &dest, const Space< G > &spc, BilinearForm< F, G > &bf, const Real threshold=0.0)
	Assembly operator for `dest` using the bilinear form `bf`.
template<class G >
static void	assembly (Matrix< F > &dest, BilinearForm< F, G > &bf, const ElementPairList< G > &pairs)
	Assembly operator for `dest` using the bilinear form `bf`.
template<class G >
static void	assembly (Matrix< F > &dest, const Space< G > &spcX, const Space< G > &spcY, BilinearForm< F, G > &bf, const Real threshold=0.0)
	Assembly operator for `dest` using the bilinear form `bf`.
Timing Interface
These functions are used to get timings from class internal computations. The values are stored in a user defined concepts::InOutParameters structure in different arrays (see `setTimings`). These arrays can be grouped into a table for easier postprocessing with concepts::ResultsTable table; table.addMap(concepts::ResultsTable::DOUBLE, "jacobian", output); table.addMap(concepts::ResultsTable::DOUBLE, "whole_sumfact", output); std::ofstream ofs("table.gnuplot"); ofs << std::setprecision(20); table.print<concepts::ResultsTable::GNUPLOT>(ofs);
static void	setTimings (InOutParameters *timings)
	Sets the class to store the timing values in.
static bool	timings ()
	Returns true if the class is able to do timings.
Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const
	Returns information in an output stream.
Protected Attributes
uint	dimX_
	Dimension of image space and the source space.
uint	dimY_
Private Attributes
Array< int >	p_
	Array defining the permutation.

Detailed Description

template<typename F>
class concepts::Permutation< F >

Permutation operator.

This operator permutes a vector according to a given permutation (given as an array of indices).

The forward permutation acts like x[i] = y[perm[i]] on the vectors. The inverse acts like x[perm[i]] = y[i].

Test:: test::MoreCompositionsTest

Author:: Philipp Frauenfelder, 2002

Definition at line 35 of file permutation.hh.

Member Typedef Documentation

template<typename F>

typedef Cmplxtype<F>::type concepts::Permutation< F >::c_type

Real type of data type.

Reimplemented from concepts::Matrix< F >.

Definition at line 40 of file permutation.hh.

template<class F>

typedef _Matrix_iterator<F, const F&, const F*> concepts::Matrix< F >::const_iterator [inherited]

Reimplemented in concepts::SparseMatrix< F >, concepts::SubMatrixN< F >, concepts::SparseMatrix< concepts::Real >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< T >, concepts::SparseMatrix< Cmplx >, and concepts::SparseMatrix< Real >.

Definition at line 42 of file matrix.hh.

template<class F>

typedef _Matrix_iterator<F, F&, F*> concepts::Matrix< F >::iterator [inherited]

Reimplemented in concepts::SparseMatrix< F >, concepts::SubMatrixN< F >, concepts::SparseMatrix< concepts::Real >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< T >, concepts::SparseMatrix< Cmplx >, and concepts::SparseMatrix< Real >.

Definition at line 41 of file matrix.hh.

template<typename F>

typedef Realtype<F>::type concepts::Permutation< F >::r_type

Real type of data type.

Reimplemented from concepts::Matrix< F >.

Definition at line 38 of file permutation.hh.

template<class F>

typedef F concepts::Operator< F >::type [inherited]

Type of data, e.g. matrix entries.

Reimplemented in concepts::AfterIteration< F >, and concepts::SubMatrixN< F >.

Definition at line 43 of file compositions.hh.

template<class F>

typedef F concepts::Matrix< F >::value_type [inherited]

Definition at line 35 of file matrix.hh.

Constructor & Destructor Documentation

template<typename F>

template<class G >

concepts::Permutation< F >::Permutation	(	const Space< G > &	space,
		const Array< int > &	perm,
		bool	transpose = `false`
	)

Constructor.

Parameters:

space	Source and image space
perm	Array defining the permutation
transpose	Applies the permutation (`false`) or its transpose (ie. its inverse, `true`)

template<typename F>

concepts::Permutation< F >::Permutation	(	uint	dim,
		const Array< int > &	perm,
		bool	transpose = `false`
	)

template<typename F>

concepts::Permutation< F >::Permutation	(	const Permutation< F > &	perm,
		bool	transpose = `false`
	)

Copy constructor.

Parameters:

perm	Permutation
transpose	Transposes the permutation while copying

Member Function Documentation

template<class F>

template<class G >

static void concepts::Matrix< F >::assembly	(	Matrix< F > &	dest,
		const Space< G > &	spc,
		BilinearForm< F, G > &	bf,
		const Real	threshold = `0.0`
	)		`[static, inherited]`

Assembly operator for dest using the bilinear form bf.

This assembly operator does not compute element matrices for two different elements. The elements are taken from the space spc.

Examples:: linearDG1d.cc.

template<class F>

template<class G >

static void concepts::Matrix< F >::assembly	(	Matrix< F > &	dest,
		const Space< G > &	spcX,
		const Space< G > &	spcY,
		BilinearForm< F, G > &	bf,
		const Real	threshold = `0.0`
	)		`[static, inherited]`

Assembly operator for dest using the bilinear form bf.

This assembly operator computes also the element matrices for two different elements (coming from spcX and spcY).

template<class F>

template<class G >

static void concepts::Matrix< F >::assembly	(	Matrix< F > &	dest,
		BilinearForm< F, G > &	bf,
		const ElementPairList< G > &	pairs
	)		`[static, inherited]`

Assembly operator for dest using the bilinear form bf.

This assembly operator uses the element pairs taken from pairs. For every two elements found in a ElementPair in pairs, the bilinear form is evaluated and the result assembled into dest.

template<class F>

iterator concepts::Matrix< F >::begin ( uint r = 0 ) [inline, inherited]

Iterator over the elements, standing at position (r,0).

Might be implemented differently for derived classes.

Reimplemented in concepts::SparseMatrix< F >, concepts::SubMatrixN< F >, concepts::SparseMatrix< concepts::Real >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< T >, concepts::SparseMatrix< Cmplx >, and concepts::SparseMatrix< Real >.

Definition at line 55 of file matrix.hh.

template<class F>

const_iterator concepts::Matrix< F >::begin ( uint r = 0 ) const [inline, inherited]

Constant iterator over the elements, standing at position (r,0)

Might be implemented differently for derived classes.

Reimplemented in concepts::SparseMatrix< F >, concepts::SubMatrixN< F >, concepts::SparseMatrix< concepts::Real >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< T >, concepts::SparseMatrix< Cmplx >, and concepts::SparseMatrix< Real >.

Definition at line 62 of file matrix.hh.

template<typename F>

void concepts::Permutation< F >::composeRestr	(	const TrivExtendRestrict< F > &	restr,
		Matrix< F > &	dest
	)		const

Computes the composition of a Permutation and a TrivExtendRestrict and stores the result in dest.

template<typename F>

void concepts::Permutation< F >::convertToMatrix ( Matrix< F > & dest ) const

Convertes this permutation to the matrix dest.

Precondition:: dest is empty

template<class F>

virtual const uint concepts::Operator< F >::dimX ( ) const [inline, virtual, inherited]

Returns the size of the image space of the operator (number of rows of the corresponding matrix)

Definition at line 87 of file compositions.hh.

template<class F>

virtual const uint concepts::Operator< F >::dimY ( ) const [inline, virtual, inherited]

Returns the size of the source space of the operator (number of columns of the corresponding matrix)

Definition at line 92 of file compositions.hh.

template<class F>

const_iterator concepts::Matrix< F >::end ( ) const [inline, inherited]

Constant iterator, standing behind last element.

Reimplemented in concepts::SparseMatrix< F >, concepts::SubMatrixN< F >, concepts::SparseMatrix< concepts::Real >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< T >, concepts::SparseMatrix< Cmplx >, and concepts::SparseMatrix< Real >.

Definition at line 64 of file matrix.hh.

template<class F>

iterator concepts::Matrix< F >::end ( ) [inline, inherited]

Iterator, standing behind last element.

Definition at line 57 of file matrix.hh.

template<typename F>

virtual std::ostream& concepts::Permutation< F >::info ( std::ostream & os ) const [protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::Operator< F >.

template<class F>

const uint concepts::Matrix< F >::nofCols ( ) const [inline, inherited]

Number of columns.

Definition at line 49 of file matrix.hh.

template<class F>

const uint concepts::Matrix< F >::nofRows ( ) const [inline, inherited]

Number of rows.

Definition at line 47 of file matrix.hh.

template<typename F>

virtual F concepts::Permutation< F >::operator()	(	const uint	i,
		const uint	j
	)		const `[virtual]`

Returns entry with indices i and j.

Implements concepts::Matrix< F >.

template<typename F>

virtual void concepts::Permutation< F >::operator()	(	const Function< c_type > &	fncY,
		Function< c_type > &	fncX
	)		`[virtual]`

Application operator for complex function fncY.

Computes fncX = A(fncY) where A is this operator. fncX becomes complex.

In derived classes its enough to implement the operator() for complex Operator's. If a real counterpart is not implemented, the function fncY is splitted into real and imaginary part and the application operator for real functions is called for each. Then the result is combined.

If in a derived class the operator() for complex Operator's is not implemented, a exception is thrown from here.

Implements concepts::Matrix< F >.

template<typename F>

virtual F& concepts::Permutation< F >::operator()	(	const uint	i,
		const uint	j
	)		`[virtual]`

Returns and allows access to entry with indices i and j.

Implements concepts::Matrix< F >.

template<typename F>

virtual void concepts::Permutation< F >::operator()	(	const Function< r_type > &	fncY,
		Function< F > &	fncX
	)		`[virtual]`

Computes fncX = A(fncY) where A is this matrix.

Implements concepts::Matrix< F >.

template<class F>

virtual bool concepts::Matrix< F >::operator== ( const Matrix< F > & otherMat ) const [inline, virtual, inherited]

Definition at line 103 of file matrix.hh.

template<typename F>

int concepts::Permutation< F >::operator[] ( const uint i ) const [inline]

Returns the permutation of index i.

Definition at line 65 of file permutation.hh.

template<class F>

static void concepts::Matrix< F >::setTimings ( InOutParameters * timings ) [static, inherited]

Sets the class to store the timing values in.

Additionally, the timeCntr_ is reset to 0. This counter is used to fill in the values into the arrays listed below in subsequent calls. The following timings are taken and stored in timings:

evaluation of bilinear form in bilinear_form
application of T matrix in tmatrix_apply
assembling into global matrix in global_assembly

template<class F>

static bool concepts::Matrix< F >::timings ( ) [static, inherited]

Returns true if the class is able to do timings.

The ability to do timings depends on a compiler switch in matrix.cc file.

template<typename F>

virtual void concepts::Permutation< F >::transpMult	(	const Vector< c_type > &	fncY,
		Vector< c_type > &	fncX
	)		`[virtual]`

Implements concepts::Matrix< F >.

template<typename F>

virtual void concepts::Permutation< F >::transpMult	(	const Vector< r_type > &	fncY,
		Vector< F > &	fncX
	)		`[virtual]`

Computes fncX = A^T fncY where A is this matrix.

Implements concepts::Matrix< F >.

Member Data Documentation

template<class F>

uint concepts::Operator< F >::dimX_ [protected, inherited]

Dimension of image space and the source space.

Definition at line 96 of file compositions.hh.

template<class F>

uint concepts::Operator< F >::dimY_ [protected, inherited]

Definition at line 96 of file compositions.hh.

template<typename F>

Array<int> concepts::Permutation< F >::p_ [private]

Array defining the permutation.

Definition at line 89 of file permutation.hh.

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

operator/permutation.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

template<typename F> class concepts::Permutation< F >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename F>
class concepts::Permutation< F >