FrameTL::FrameIndex< IBASIS, DIM_d, DIM_m > Class Template Reference

#include <frame_index.h>

List of all members.

Public Types
typedef MultiIndex< int, DIM_d >	type_type
	The index type.
typedef MultiIndex< int, DIM_d >	translation_type
	The translation index type.
Public Member Functions
	FrameIndex (const AggregatedFrame< IBASIS, DIM_d, DIM_m > *frame=0)
	FrameIndex (const FrameIndex &)
	FrameIndex (const FrameIndex *)
	FrameIndex (const AggregatedFrame< IBASIS, DIM_d, DIM_m > *frame, const CubeIndex< IBASIS, DIM_d > &, const int patch)
	FrameIndex (const AggregatedFrame< IBASIS, DIM_d, DIM_m > *frame, const int j, const type_type &e, const unsigned int patch, const translation_type &k)
	FrameIndex (const int num, const AggregatedFrame< IBASIS, DIM_d, DIM_m > *frame)
bool	operator== (const FrameIndex &lambda) const
	Check for equality.
bool	operator!= (const FrameIndex &lambda) const
	Check for non-equality.
FrameIndex &	operator++ ()
	Preincrement.
FrameIndex &	operator= (const FrameIndex &)
	Assignment.
bool	operator< (const FrameIndex &lambda) const
	Lexicographic order < .
bool	operator<= (const FrameIndex &lambda) const
	Lexicographic order <= .
const int	j () const
	Scale j.
const type_type &	e () const
	Type e.
const translation_type &	k () const
	Translation index k.
const int	p () const
	Access to patchnumber.
const int	number () const
const AggregatedFrame< IBASIS, DIM_d, DIM_m > *	frame () const
	Access to underlying frame.
void	set_number ()
Protected Attributes
const AggregatedFrame< IBASIS, DIM_d, DIM_m > *	frame_
int	j_
	Scale.
type_type	e_
	Type.
int	p_
translation_type	k_
	Translation index.
int	num_
	Number of this index.

---

Detailed Description

template<class IBASIS, unsigned int DIM_d, unsigned int DIM_m = DIM_d>
class FrameTL::FrameIndex< IBASIS, DIM_d, DIM_m >

This class represents tensor product multilevel aggregated wavelet frame indices. A FrameIndex mainly encodes level, type, patchnumber and shift parameter of an aggregated wavelet frame element.

---

Constructor & Destructor Documentation

template<class IBASIS , unsigned int DIM_d, unsigned int DIM_m>

FrameTL::FrameIndex< IBASIS, DIM_d, DIM_m >::FrameIndex

(

const AggregatedFrame< IBASIS, DIM_d, DIM_m > *

frame = 0

)

[inline]

Default constructor.

template<class IBASIS , unsigned int DIM_d, unsigned int DIM_m>

FrameTL::FrameIndex< IBASIS, DIM_d, DIM_m >::FrameIndex

(

const FrameIndex< IBASIS, DIM_d, DIM_m > &

ind

)

[inline]

Copy constructor.

template<class IBASIS , unsigned int DIM_d, unsigned int DIM_m>

FrameTL::FrameIndex< IBASIS, DIM_d, DIM_m >::FrameIndex

(

const FrameIndex< IBASIS, DIM_d, DIM_m > *

ind

)

[inline]

Constructor. Clone index from a given const pointer to another FrameIndex.

template<class IBASIS , unsigned int DIM_d, unsigned int DIM_m>

FrameTL::FrameIndex< IBASIS, DIM_d, DIM_m >::FrameIndex	(	const AggregatedFrame< IBASIS, DIM_d, DIM_m > *	frame,
		const CubeIndex< IBASIS, DIM_d > &	c,
		const int	patch
	)			[inline]

Constructor. Creates the FrameIndex from a given wavelet index of a wavelet on the unit cube. Also the integer number (according to the canonical lexicographical ordering "level, type, patch, shift parameter") of this FrameIndex is calculated.

template<class IBASIS , unsigned int DIM_d, unsigned int DIM_m>

FrameTL::FrameIndex< IBASIS, DIM_d, DIM_m >::FrameIndex	(	const AggregatedFrame< IBASIS, DIM_d, DIM_m > *	frame,
		const int	j,
		const type_type &	e,
		const unsigned int	patch,
		const translation_type &	k
	)			[inline]

Constructor. Create a FrameIndex from the given level, type patchnumber and shift parameter. Also the integer number (according to the canonical lexicographical ordering "level, type, patch, shift parameter") of this FrameIndex is calculated.

template<class IBASIS , unsigned int DIM_d, unsigned int DIM_m>

FrameTL::FrameIndex< IBASIS, DIM_d, DIM_m >::FrameIndex	(	const int	num,
		const AggregatedFrame< IBASIS, DIM_d, DIM_m > *	frame
	)			[inline]

Constructor. From the given integer number (according to the canonical lexicographical ordering "level, type, patch, shift parameter") the a FrameIndex is reconstructed, i.e., level, type, patchnumber, and shift parameter are determined.

---

Member Function Documentation

template<class IBASIS , unsigned int DIM_d, unsigned int DIM_m>

void FrameTL::FrameIndex< IBASIS, DIM_d, DIM_m >::set_number

(

)

[inline]

The integer number (according to the canonical lexicographical ordering "level, type, patch, shift parameter") of this FrameIndex is calculated and set.

---

Member Data Documentation

template<class IBASIS , unsigned int DIM_d, unsigned int DIM_m = DIM_d>

const AggregatedFrame<IBASIS,DIM_d,DIM_m>* FrameTL::FrameIndex< IBASIS, DIM_d, DIM_m >::frame_ [protected]

Pointer to corresponding frame.

template<class IBASIS , unsigned int DIM_d, unsigned int DIM_m = DIM_d>

int FrameTL::FrameIndex< IBASIS, DIM_d, DIM_m >::p_ [protected]

Patchnumber.

---

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

• /home/werner/PROMOTION/source/FrameTL/frame_index.h
• /home/werner/PROMOTION/source/FrameTL/frame_index.cpp