Wavelets in two dimensions. More...

#include <wavelet2d.hpp>

Inheritance diagram for gsl::wavelet2d:

Collaboration diagram for gsl::wavelet2d:

Private Member Functions
	wavelet2d (type &T, size_t const k)
	The default constructor creates a new wavelet2d with n elements. More...

	wavelet2d (gsl_wavelet *v)
	Could construct from a gsl_wavelet. More...

	wavelet2d (wavelet2d const &v)
	The copy constructor. More...

wavelet2d &	operator= (wavelet2d const &v)
	The assignment operator. More...

	wavelet2d (wavelet2d &&v)
	Move constructor. More...

wavelet2d &	operator= (wavelet2d &&v)
	Move operator. More...

int	transform (double *data, size_t tda, size_t size1, size_t size2, gsl_wavelet_direction dir, wavelet::workspace &work) const
	C++ version of gsl_wavelet2d_transform(). More...

int	transform_forward (double *data, size_t tda, size_t size1, size_t size2, wavelet::workspace &work) const
	C++ version of gsl_wavelet2d_transform_forward(). More...

int	transform_inverse (double *data, size_t tda, size_t size1, size_t size2, wavelet::workspace &work) const
	C++ version of gsl_wavelet2d_transform_inverse(). More...

int	nstransform (double *data, size_t tda, size_t size1, size_t size2, gsl_wavelet_direction dir, wavelet::workspace work) const
	C++ version of gsl_wavelet2d_nstransform(). More...

int	nstransform_forward (double *data, size_t tda, size_t size1, size_t size2, wavelet::workspace &work) const
	C++ version of gsl_wavelet2d_nstransform_forward(). More...

int	nstransform_inverse (double *data, size_t tda, size_t size1, size_t size2, wavelet::workspace &work) const
	C++ version of gsl_wavelet2d_nstransform_inverse(). More...

int	transform_matrix (matrix &a, gsl_wavelet_direction dir, wavelet::workspace &work) const
	C++ version of gsl_wavelet2d_transform_matrix(). More...

int	transform_matrix_forward (matrix &a, wavelet::workspace &work) const
	C++ version of gsl_wavelet2d_transform_matrix_forward(). More...

int	transform_matrix_inverse (matrix &a, wavelet::workspace &work) const
	C++ version of gsl_wavelet2d_transform_matrix_inverse(). More...

int	nstransform_matrix (matrix &a, gsl_wavelet_direction dir, wavelet::workspace &work) const
	C++ version of gsl_wavelet2d_nstransform_matrix(). More...

int	nstransform_matrix_forward (matrix &a, wavelet::workspace &work) const
	C++ version of gsl_wavelet2d_nstransform_matrix_forward(). More...

int	nstransform_matrix_inverse (matrix &a, wavelet::workspace &work) const
	C++ version of gsl_wavelet2d_nstransform_matrix_inverse(). More...

Additional Inherited Members
Public Types inherited from gsl::wavelet
typedef gsl_wavelet_type const *	type
	Define gsl::wavelet::static type. More...

Public Member Functions inherited from gsl::wavelet
	wavelet ()
	The default constructor is only really useful for assigning to. More...

	wavelet (type T, size_t const k)
	The default constructor creates a new wavelet with n elements. More...

	wavelet (gsl_wavelet *v)
	Could construct from a gsl_wavelet. More...

	wavelet (wavelet const &v)
	The copy constructor. More...

wavelet &	operator= (wavelet const &v)
	The assignment operator. More...

	~wavelet ()
	The destructor only deletes the pointers if count reaches zero. More...

	wavelet (wavelet &&v)
	Move constructor. More...

wavelet &	operator= (wavelet &&v)
	Move operator. More...

bool	operator== (wavelet const &v) const
	Two wavelet are identically equal if their elements are identical. More...

bool	operator!= (wavelet const &v) const
	Two wavelet are different if their elements are not identical. More...

bool	operator< (wavelet const &v) const
	A container needs to define an ordering for sorting. More...

bool	operator> (wavelet const &v) const
	A container needs to define an ordering for sorting. More...

bool	operator<= (wavelet const &v) const
	A container needs to define an ordering for sorting. More...

bool	operator>= (wavelet const &v) const
	A container needs to define an ordering for sorting. More...

bool	empty () const
	Find if the wavelet is empty. More...

void	swap (wavelet &v)
	Swap two wavelet objects. More...

gsl_wavelet *	get () const
	Get the gsl_wavelet. More...

bool	unique () const
	Find if this is the only object sharing the gsl_wavelet. More...

size_t	use_count () const
	Find how many wavelet objects share this pointer. More...

	operator bool () const
	Allow conversion to bool. More...

std::string	name () const
	C++ version of gsl_wavelet_name(). More...

gsl_wavelet_direction	forward () const
	Access direction. More...

gsl_wavelet_direction	backward () const
	Access direction. More...

template<typename DATA >
int	transform (DATA &data, size_t stride, gsl_wavelet_direction dir, workspace &work) const
	C++ version of gsl_wavelet_transform(). More...

template<typename DATA >
int	transform_forward (DATA &data, size_t stride, workspace &work) const
	C++ version of gsl_wavelet_transform_forward(). More...

template<typename DATA >
int	transform_inverse (DATA &data, size_t stride, workspace &work) const
	C++ version of gsl_wavelet_transform_inverse(). More...

template<typename DATA >
int	transform (DATA &data, gsl_wavelet_direction dir, workspace &work) const
	C++ version of gsl_wavelet_transform(). More...

template<typename DATA >
int	transform_forward (DATA &data, workspace &work) const
	C++ version of gsl_wavelet_transform_forward(). More...

template<typename DATA >
int	transform_inverse (DATA &data, workspace &work) const
	C++ version of gsl_wavelet_transform_inverse(). More...

Static Public Member Functions inherited from gsl::wavelet
static type	daubechies ()
	Wavelet static type. More...

static type	daubechies_centered ()
	Wavelet static type. More...

static type	haar ()
	Wavelet static type. More...

static type	haar_centered ()
	Wavelet static type. More...

static type	bspline ()
	Wavelet static type. More...

static type	bspline_centered ()
	Wavelet static type. More...

Protected Attributes inherited from gsl::wavelet
gsl_wavelet *	ccgsl_pointer
	The shared pointer. More...

size_t *	count
	The shared reference count. More...

Detailed Description

Wavelets in two dimensions.

Definition at line 31 of file wavelet2d.hpp.

Constructor & Destructor Documentation

◆ wavelet2d() [1/4]

gsl::wavelet2d::wavelet2d	(	type &	T,
		size_t const	k
	)

inlineexplicitprivate

The default constructor creates a new wavelet2d with n elements.

Parameters

T	The type of the wavelet2d
k	Parameter to select specific member of wavelet2d family

Definition at line 39 of file wavelet2d.hpp.

Referenced by operator=().

◆ wavelet2d() [2/4]

gsl::wavelet2d::wavelet2d ( gsl_wavelet * v )

inlineexplicitprivate

Could construct from a gsl_wavelet.

This is not usually a good idea. In this case we should not use gsl_wavelet_free() to deallocate the memory.

Parameters

v	The wavelet

Definition at line 46 of file wavelet2d.hpp.

◆ wavelet2d() [3/4]

gsl::wavelet2d::wavelet2d ( wavelet2d const & v )

inlineprivate

The copy constructor.

This creates a new reference to the workspace.

Parameters

v	The wavelet2d to copy.

Definition at line 52 of file wavelet2d.hpp.

◆ wavelet2d() [4/4]

gsl::wavelet2d::wavelet2d ( wavelet2d && v )

inlineprivate

Move constructor.

Parameters

v	The wavelet2d to move.

Definition at line 71 of file wavelet2d.hpp.

References gsl::wavelet::ccgsl_pointer, and gsl::wavelet::count.

Member Function Documentation

◆ nstransform()

int gsl::wavelet2d::nstransform	(	double *	data,
		size_t	tda,
		size_t	size1,
		size_t	size2,
		gsl_wavelet_direction	dir,
		wavelet::workspace	work
	)		const

inlineprivate

C++ version of gsl_wavelet2d_nstransform().

Parameters

data	Data array
tda	Physical row length
size1	Number of rows
size2	Number of columns
dir	Direction: gsl_wavelet-forward() or gsl_wavelet_backward()
work	Supply a workspace of appropriate (undocumented) size

Returns: Error code on failure

Definition at line 138 of file wavelet2d.hpp.

References gsl::wavelet::get(), and gsl::wavelet::workspace::get().

◆ nstransform_forward()

int gsl::wavelet2d::nstransform_forward	(	double *	data,
		size_t	tda,
		size_t	size1,
		size_t	size2,
		wavelet::workspace &	work
	)		const

inlineprivate

C++ version of gsl_wavelet2d_nstransform_forward().

Parameters

data	Data array
tda	Physical row length
size1	Number of rows
size2	Number of columns
work	Supply a workspace of appropriate (undocumented) size

Returns: Error code on failure

Definition at line 152 of file wavelet2d.hpp.

References gsl::wavelet::get(), and gsl::wavelet::workspace::get().

◆ nstransform_inverse()

int gsl::wavelet2d::nstransform_inverse	(	double *	data,
		size_t	tda,
		size_t	size1,
		size_t	size2,
		wavelet::workspace &	work
	)		const

inlineprivate

C++ version of gsl_wavelet2d_nstransform_inverse().

Parameters

data	Data array
tda	Physical row length
size1	Number of rows
size2	Number of columns
work	Supply a workspace of appropriate (undocumented) size

Returns: Error code on failure

Definition at line 165 of file wavelet2d.hpp.

References gsl::wavelet::get(), and gsl::wavelet::workspace::get().

◆ nstransform_matrix()

int gsl::wavelet2d::nstransform_matrix	(	matrix &	a,
		gsl_wavelet_direction	dir,
		wavelet::workspace &	work
	)		const

inlineprivate

C++ version of gsl_wavelet2d_nstransform_matrix().

Parameters

a	A matrix
dir	Direction: gsl_wavelet-forward() or gsl_wavelet_backward()
work	Supply a workspace of appropriate (undocumented) size

Returns: Error code on failure

Definition at line 205 of file wavelet2d.hpp.

References gsl::sf::mathieu::a(), gsl::wavelet::get(), and gsl::wavelet::workspace::get().

◆ nstransform_matrix_forward()

int gsl::wavelet2d::nstransform_matrix_forward	(	matrix &	a,
		wavelet::workspace &	work
	)		const

inlineprivate

C++ version of gsl_wavelet2d_nstransform_matrix_forward().

Parameters

a	A matrix
work	Supply a workspace of appropriate (undocumented) size

Returns: Error code on failure

Definition at line 215 of file wavelet2d.hpp.

References gsl::sf::mathieu::a(), gsl::wavelet::get(), and gsl::wavelet::workspace::get().

◆ nstransform_matrix_inverse()

int gsl::wavelet2d::nstransform_matrix_inverse	(	matrix &	a,
		wavelet::workspace &	work
	)		const

inlineprivate

C++ version of gsl_wavelet2d_nstransform_matrix_inverse().

Parameters

a	A matrix
work	Supply a workspace of appropriate (undocumented) size

Returns: Error code on failure

Definition at line 224 of file wavelet2d.hpp.

References gsl::sf::mathieu::a(), gsl::wavelet::get(), and gsl::wavelet::workspace::get().

◆ operator=() [1/2]

wavelet2d & gsl::wavelet2d::operator= ( wavelet2d && v )

inlineprivate

Move operator.

Parameters

v	The wavelet2d to move.

Returns: A reference to this.

Definition at line 82 of file wavelet2d.hpp.

References wavelet2d().

◆ operator=() [2/2]

wavelet2d & gsl::wavelet2d::operator= ( wavelet2d const & v )

inlineprivate

The assignment operator.

This copies elementwise.

Parameters

v	The wavelet2d to copy

Definition at line 58 of file wavelet2d.hpp.

References gsl::wavelet::ccgsl_pointer, and gsl::wavelet::count.

◆ transform()

int gsl::wavelet2d::transform	(	double *	data,
		size_t	tda,
		size_t	size1,
		size_t	size2,
		gsl_wavelet_direction	dir,
		wavelet::workspace &	work
	)		const

inlineprivate

C++ version of gsl_wavelet2d_transform().

Parameters

data	Data array
tda	Physical row length
size1	Number of rows
size2	Number of columns
dir	Direction: gsl_wavelet-forward() or gsl_wavelet_backward()
work	Supply a workspace of appropriate (undocumented) size

Returns: Error code on failure

Definition at line 98 of file wavelet2d.hpp.

References gsl::wavelet::get(), and gsl::wavelet::workspace::get().

◆ transform_forward()

int gsl::wavelet2d::transform_forward	(	double *	data,
		size_t	tda,
		size_t	size1,
		size_t	size2,
		wavelet::workspace &	work
	)		const

inlineprivate

C++ version of gsl_wavelet2d_transform_forward().

Parameters

data	Data array
tda	Physical row length
size1	Number of rows
size2	Number of columns
work	Supply a workspace of appropriate (undocumented) size

Returns: Error code on failure

Definition at line 111 of file wavelet2d.hpp.

References gsl::wavelet::get(), and gsl::wavelet::workspace::get().

◆ transform_inverse()

int gsl::wavelet2d::transform_inverse	(	double *	data,
		size_t	tda,
		size_t	size1,
		size_t	size2,
		wavelet::workspace &	work
	)		const

inlineprivate

C++ version of gsl_wavelet2d_transform_inverse().

Parameters

data	Data array
tda	Physical row length
size1	Number of rows
size2	Number of columns
work	Supply a workspace of appropriate (undocumented) size

Returns: Error code on failure

Definition at line 124 of file wavelet2d.hpp.

References gsl::wavelet::get(), and gsl::wavelet::workspace::get().

◆ transform_matrix()

int gsl::wavelet2d::transform_matrix	(	matrix &	a,
		gsl_wavelet_direction	dir,
		wavelet::workspace &	work
	)		const

inlineprivate

C++ version of gsl_wavelet2d_transform_matrix().

Parameters

a	A matrix
dir	Direction: gsl_wavelet-forward() or gsl_wavelet_backward()
work	Supply a workspace of appropriate (undocumented) size

Returns: Error code on failure

Definition at line 176 of file wavelet2d.hpp.

References gsl::sf::mathieu::a(), gsl::wavelet::get(), and gsl::wavelet::workspace::get().

◆ transform_matrix_forward()

int gsl::wavelet2d::transform_matrix_forward	(	matrix &	a,
		wavelet::workspace &	work
	)		const

inlineprivate

C++ version of gsl_wavelet2d_transform_matrix_forward().

Parameters

a	A matrix
work	Supply a workspace of appropriate (undocumented) size

Returns: Error code on failure

Definition at line 186 of file wavelet2d.hpp.

References gsl::sf::mathieu::a(), gsl::wavelet::get(), and gsl::wavelet::workspace::get().

◆ transform_matrix_inverse()

int gsl::wavelet2d::transform_matrix_inverse	(	matrix &	a,
		wavelet::workspace &	work
	)		const

inlineprivate

C++ version of gsl_wavelet2d_transform_matrix_inverse().

Parameters

a	A matrix
work	Supply a workspace of appropriate (undocumented) size

Returns: Error code on failure

Definition at line 195 of file wavelet2d.hpp.

References gsl::sf::mathieu::a(), gsl::wavelet::get(), and gsl::wavelet::workspace::get().

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

wavelet2d.hpp

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ wavelet2d() [1/4]

◆ wavelet2d() [2/4]

◆ wavelet2d() [3/4]

◆ wavelet2d() [4/4]

Member Function Documentation

◆ nstransform()

◆ nstransform_forward()

◆ nstransform_inverse()

◆ nstransform_matrix()

◆ nstransform_matrix_forward()

◆ nstransform_matrix_inverse()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ transform()

◆ transform_forward()

◆ transform_inverse()

◆ transform_matrix()

◆ transform_matrix_forward()

◆ transform_matrix_inverse()