C++ version of gsl_fft_complex_wavetable functions. More...

#include <fft_complex.hpp>

Collaboration diagram for gsl::fft::complex::wavetable:

Public Member Functions
	wavetable ()
	The default constructor is only really useful for assigning to. More...

	wavetable (size_t const n)
	The default constructor creates a new workspace of size n. More...

	wavetable (gsl_fft_complex_wavetable *v)
	Could construct from a gsl_fft_complex_wavetable. More...

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

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

wavetable	clone () const
	The clone function. More...

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

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

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

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

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

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

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

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

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

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

void	swap (wavetable &v)
	Swap two wavetable. More...

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

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

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

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

Private Attributes
gsl_fft_complex_wavetable *	ccgsl_pointer
	The shared pointer. More...

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

Detailed Description

C++ version of gsl_fft_complex_wavetable functions.

Definition at line 425 of file fft_complex.hpp.

Constructor & Destructor Documentation

◆ wavetable() [1/5]

gsl::fft::complex::wavetable::wavetable ( )

inline

The default constructor is only really useful for assigning to.

Definition at line 430 of file fft_complex.hpp.

References ccgsl_pointer, and count.

Referenced by operator=().

◆ wavetable() [2/5]

gsl::fft::complex::wavetable::wavetable ( size_t const n )

inlineexplicit

The default constructor creates a new workspace of size n.

Parameters

n	The size of the workspace.

Definition at line 440 of file fft_complex.hpp.

References ccgsl_pointer, count, and gsl::rstat::n().

◆ wavetable() [3/5]

gsl::fft::complex::wavetable::wavetable ( gsl_fft_complex_wavetable * v )

inlineexplicit

Could construct from a gsl_fft_complex_wavetable.

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

Parameters

v	The wavetable

Definition at line 456 of file fft_complex.hpp.

References ccgsl_pointer, and count.

◆ wavetable() [4/5]

gsl::fft::complex::wavetable::wavetable ( wavetable const & v )

inline

The copy constructor.

This creates a new reference to the workspace.

Parameters

v	The wavetable to copy.

Definition at line 467 of file fft_complex.hpp.

References ccgsl_pointer, and count.

◆ ~wavetable()

gsl::fft::complex::wavetable::~wavetable ( )

inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 501 of file fft_complex.hpp.

References ccgsl_pointer, and count.

◆ wavetable() [5/5]

gsl::fft::complex::wavetable::wavetable ( wavetable && v )

inline

Move constructor.

Parameters

v	The wavetable to move.

Definition at line 513 of file fft_complex.hpp.

References count.

Member Function Documentation

◆ clone()

wavetable gsl::fft::complex::wavetable::clone ( ) const

inline

The clone function.

Use this if you want a copy of the wavetable that does not share the underlying data.

Returns: a new copy of this.

Definition at line 488 of file fft_complex.hpp.

References ccgsl_pointer.

◆ empty()

bool gsl::fft::complex::wavetable::empty ( ) const

inline

Find if the wavetable is empty.

Returns: true if has size zero; otherwise false

Definition at line 590 of file fft_complex.hpp.

References ccgsl_pointer.

◆ get()

gsl_fft_complex_wavetable * gsl::fft::complex::wavetable::get ( ) const

inline

Get the gsl_fft_complex_wavetable.

Returns: the gsl_fft_complex_wavetable

Definition at line 616 of file fft_complex.hpp.

References ccgsl_pointer.

Referenced by gsl::fft::complex::backward(), gsl::fft::complex::forward(), gsl::fft::complex::inverse(), and gsl::fft::complex::transform().

◆ operator bool()

gsl::fft::complex::wavetable::operator bool ( ) const

inlineexplicit

Allow conversion to bool.

Returns: true or false according as this contains a pointer to a gsl_fft_complex_wavetable

Definition at line 636 of file fft_complex.hpp.

References ccgsl_pointer.

◆ operator!=()

bool gsl::fft::complex::wavetable::operator!= ( wavetable const & v ) const

inline

Two wavetable are different equal if their elements are not identical.

Parameters

v	The wavetable to be compared with `this`

Returns: false or true according as this and v have identical elements or not

Definition at line 543 of file fft_complex.hpp.

References operator==().

◆ operator<()

bool gsl::fft::complex::wavetable::operator< ( wavetable const & v ) const

inline

A container needs to define an ordering for sorting.

This uses standard lexicographical ordering and so is not useful, for eaxmple, for checking, that a wavetable is nonnegative.

Parameters

v	The wavetable to be compared with `this`

Returns: false or true according as this is less than v lexicographically

Definition at line 555 of file fft_complex.hpp.

References ccgsl_pointer.

◆ operator<=()

bool gsl::fft::complex::wavetable::operator<= ( wavetable const & v ) const

inline

A container needs to define an ordering for sorting.

This uses standard lexicographical ordering and so is not useful, for eaxmple, for checking, that a wavetable is nonnegative.

Parameters

v	The wavetable to be compared with `this`

Returns: false or true according as this is less than or equal to v lexicographically

Definition at line 575 of file fft_complex.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

wavetable & gsl::fft::complex::wavetable::operator= ( wavetable && v )

inline

Move operator.

Parameters

v	The wavetable to move.

Returns: A reference to this.

Definition at line 522 of file fft_complex.hpp.

References wavetable().

◆ operator=() [2/2]

wavetable & gsl::fft::complex::wavetable::operator= ( wavetable const & v )

inline

The assignment operator.

This copies elementwise.

Parameters

v	The wavetable to copy

Definition at line 474 of file fft_complex.hpp.

References ccgsl_pointer, and count.

◆ operator==()

bool gsl::fft::complex::wavetable::operator== ( wavetable const & v ) const

inline

Two wavetable are identically equal if their elements are identical.

Parameters

v	The wavetable to be compared with `this`

Returns: true or false according as this and v have identical elements or not

Definition at line 535 of file fft_complex.hpp.

References ccgsl_pointer.

Referenced by operator!=().

◆ operator>()

bool gsl::fft::complex::wavetable::operator> ( wavetable const & v ) const

inline

A container needs to define an ordering for sorting.

This uses standard lexicographical ordering and so is not useful, for eaxmple, for checking, that a wavetable is nonnegative.

Parameters

v	The wavetable to be compared with `this`

Returns: false or true according as this is greater than v lexicographically

Definition at line 565 of file fft_complex.hpp.

References ccgsl_pointer.

◆ operator>=()

bool gsl::fft::complex::wavetable::operator>= ( wavetable const & v ) const

inline

A container needs to define an ordering for sorting.

This uses standard lexicographical ordering and so is not useful, for eaxmple, for checking, that a wavetable is nonnegative.

Parameters

v	The wavetable to be compared with `this`

Returns: false or true according as this is no less than v lexicographically

Definition at line 585 of file fft_complex.hpp.

References ccgsl_pointer.

◆ swap()

void gsl::fft::complex::wavetable::swap ( wavetable & v )

inline

Swap two wavetable.

This works even if the wavetable have different sizes because it swaps pointers.

Parameters

v	The wavetable to swap with `this`.

Definition at line 597 of file fft_complex.hpp.

References ccgsl_pointer, and count.

◆ unique()

bool gsl::fft::complex::wavetable::unique ( ) const

inline

Find if this is the only object sharing the gsl_fft_complex_wavetable.

Returns: true or falses according as this is the only workspace object sharing the gsl_fft_complex_wavetable

Definition at line 622 of file fft_complex.hpp.

References count.

◆ use_count()

size_t gsl::fft::complex::wavetable::use_count ( ) const

inline

Find how many workspace objects share this pointer.

Returns: the number of workspace objects that share this pointer

Definition at line 627 of file fft_complex.hpp.

References count.

Member Data Documentation

◆ ccgsl_pointer

gsl_fft_complex_wavetable* gsl::fft::complex::wavetable::ccgsl_pointer

private

The shared pointer.

Definition at line 605 of file fft_complex.hpp.

Referenced by clone(), empty(), get(), operator bool(), operator<(), operator<=(), operator=(), operator==(), operator>(), operator>=(), swap(), wavetable(), and ~wavetable().

◆ count

size_t* gsl::fft::complex::wavetable::count

private

The shared reference count.

Definition at line 609 of file fft_complex.hpp.

Referenced by operator=(), swap(), unique(), use_count(), wavetable(), and ~wavetable().

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

fft_complex.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ wavetable() [1/5]

◆ wavetable() [2/5]

◆ wavetable() [3/5]

◆ wavetable() [4/5]

◆ ~wavetable()

◆ wavetable() [5/5]

Member Function Documentation

◆ clone()

◆ empty()

◆ get()

◆ operator bool()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>()

◆ operator>=()

◆ swap()

◆ unique()

◆ use_count()

Member Data Documentation

◆ ccgsl_pointer

◆ count