ccgsl 2.7.2
C++wrappersforGnuScientificLibrary
Public Member Functions | Private Attributes | List of all members
gsl::wavelet::workspace Class Reference

Workspace for wavelets. More...

#include <wavelet.hpp>

Collaboration diagram for gsl::wavelet::workspace:
Collaboration graph

Public Member Functions

 workspace ()
 The default constructor is only really useful for assigning to. More...
 
 workspace (size_t const n)
 The default constructor creates a new workspace with n elements. More...
 
 workspace (gsl_wavelet_workspace *v)
 Could construct from a gsl_wavelet_workspace. More...
 
 workspace (workspace const &v)
 The copy constructor. More...
 
workspace & operator= (workspace const &v)
 The assignment operator. More...
 
 ~workspace ()
 The destructor only deletes the pointers if count reaches zero. More...
 
 workspace (workspace &&v)
 Move constructor. More...
 
workspace & operator= (workspace &&v)
 Move operator. More...
 
bool operator== (workspace const &v) const
 Two workspace are identically equal if their elements are identical. More...
 
bool operator!= (workspace const &v) const
 Two workspace are different if their elements are not identical. More...
 
bool operator< (workspace const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator> (workspace const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator<= (workspace const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator>= (workspace const &v) const
 A container needs to define an ordering for sorting. More...
 
bool empty () const
 Find if the workspace is empty. More...
 
void swap (workspace &v)
 Swap two workspace objects. More...
 
gsl_wavelet_workspace * get () const
 Get the gsl_wavelet_workspace. More...
 
bool unique () const
 Find if this is the only object sharing the gsl_wavelet_workspace. 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_wavelet_workspace * ccgsl_pointer
 The shared pointer. More...
 
size_t * count
 The shared reference count. More...
 

Detailed Description

Workspace for wavelets.

Definition at line 271 of file wavelet.hpp.

Constructor & Destructor Documentation

◆ workspace() [1/5]

gsl::wavelet::workspace::workspace ( )
inline

The default constructor is only really useful for assigning to.

Definition at line 276 of file wavelet.hpp.

References ccgsl_pointer, and count.

Referenced by operator=().

◆ workspace() [2/5]

gsl::wavelet::workspace::workspace ( size_t const  n)
inlineexplicit

The default constructor creates a new workspace with n elements.

Parameters
nThe number of elements in the workspace

Definition at line 286 of file wavelet.hpp.

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

◆ workspace() [3/5]

gsl::wavelet::workspace::workspace ( gsl_wavelet_workspace *  v)
inlineexplicit

Could construct from a gsl_wavelet_workspace.

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

Parameters
vThe workspace

Definition at line 302 of file wavelet.hpp.

References ccgsl_pointer, and count.

◆ workspace() [4/5]

gsl::wavelet::workspace::workspace ( workspace const &  v)
inline

The copy constructor.

This creates a new reference to the workspace.

Parameters
vThe workspace to copy.

Definition at line 313 of file wavelet.hpp.

References ccgsl_pointer, and count.

◆ ~workspace()

gsl::wavelet::workspace::~workspace ( )
inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 332 of file wavelet.hpp.

References ccgsl_pointer, and count.

◆ workspace() [5/5]

gsl::wavelet::workspace::workspace ( workspace &&  v)
inline

Move constructor.

Parameters
vThe workspace to move.

Definition at line 344 of file wavelet.hpp.

References count.

Member Function Documentation

◆ empty()

bool gsl::wavelet::workspace::empty ( ) const
inline

Find if the workspace is empty.

Returns
true if has size zero; otherwise false

Definition at line 421 of file wavelet.hpp.

References ccgsl_pointer.

◆ get()

gsl_wavelet_workspace * gsl::wavelet::workspace::get ( ) const
inline

Get the gsl_wavelet_workspace.

Returns
the gsl_wavelet_workspace

Definition at line 447 of file wavelet.hpp.

References ccgsl_pointer.

Referenced by gsl::wavelet2d::nstransform(), gsl::wavelet2d::nstransform_forward(), gsl::wavelet2d::nstransform_inverse(), gsl::wavelet2d::nstransform_matrix(), gsl::wavelet2d::nstransform_matrix_forward(), gsl::wavelet2d::nstransform_matrix_inverse(), gsl::wavelet::transform(), gsl::wavelet2d::transform(), gsl::wavelet::transform_forward(), gsl::wavelet2d::transform_forward(), gsl::wavelet::transform_inverse(), gsl::wavelet2d::transform_inverse(), gsl::wavelet2d::transform_matrix(), gsl::wavelet2d::transform_matrix_forward(), and gsl::wavelet2d::transform_matrix_inverse().

◆ operator bool()

gsl::wavelet::workspace::operator bool ( ) const
inlineexplicit

Allow conversion to bool.

Returns
true or false according as this contains a pointer to a gsl_wavelet_workspace.

Definition at line 467 of file wavelet.hpp.

References ccgsl_pointer.

◆ operator!=()

bool gsl::wavelet::workspace::operator!= ( workspace const &  v) const
inline

Two workspace are different if their elements are not identical.

Parameters
vThe workspace to be compared with this
Returns
false or true according as this and v have identical elements or not

Definition at line 374 of file wavelet.hpp.

References operator==().

◆ operator<()

bool gsl::wavelet::workspace::operator< ( workspace const &  v) const
inline

A container needs to define an ordering for sorting.

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

Parameters
vThe workspace to be compared with this
Returns
false or true according as this is less than v lexicographically

Definition at line 386 of file wavelet.hpp.

References ccgsl_pointer.

◆ operator<=()

bool gsl::wavelet::workspace::operator<= ( workspace const &  v) const
inline

A container needs to define an ordering for sorting.

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

Parameters
vThe workspace to be compared with this
Returns
false or true according as this is less than or equal to v lexicographically

Definition at line 406 of file wavelet.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

workspace & gsl::wavelet::workspace::operator= ( workspace &&  v)
inline

Move operator.

Parameters
vThe workspace to move.
Returns
A reference to this.

Definition at line 353 of file wavelet.hpp.

References workspace().

◆ operator=() [2/2]

workspace & gsl::wavelet::workspace::operator= ( workspace const &  v)
inline

The assignment operator.

This copies elementwise.

Parameters
vThe workspace to copy

Definition at line 320 of file wavelet.hpp.

References ccgsl_pointer, and count.

◆ operator==()

bool gsl::wavelet::workspace::operator== ( workspace const &  v) const
inline

Two workspace are identically equal if their elements are identical.

Parameters
vThe workspace to be compared with this
Returns
true or false according as this and v have identical elements or not

Definition at line 366 of file wavelet.hpp.

References ccgsl_pointer.

Referenced by operator!=().

◆ operator>()

bool gsl::wavelet::workspace::operator> ( workspace const &  v) const
inline

A container needs to define an ordering for sorting.

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

Parameters
vThe workspace to be compared with this
Returns
false or true according as this is greater than v lexicographically

Definition at line 396 of file wavelet.hpp.

References ccgsl_pointer.

◆ operator>=()

bool gsl::wavelet::workspace::operator>= ( workspace const &  v) const
inline

A container needs to define an ordering for sorting.

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

Parameters
vThe workspace to be compared with this
Returns
false or true according as this is no less than v lexicographically

Definition at line 416 of file wavelet.hpp.

References ccgsl_pointer.

◆ swap()

void gsl::wavelet::workspace::swap ( workspace &  v)
inline

Swap two workspace objects.

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

Parameters
vThe workspace to swap with this.

Definition at line 428 of file wavelet.hpp.

References ccgsl_pointer, and count.

◆ unique()

bool gsl::wavelet::workspace::unique ( ) const
inline

Find if this is the only object sharing the gsl_wavelet_workspace.

Returns
true or falses according as this is the only workspace object sharing the gsl_wavelet_workspace.

Definition at line 453 of file wavelet.hpp.

References count.

◆ use_count()

size_t gsl::wavelet::workspace::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 458 of file wavelet.hpp.

References count.

Member Data Documentation

◆ ccgsl_pointer

gsl_wavelet_workspace* gsl::wavelet::workspace::ccgsl_pointer
private

The shared pointer.

Definition at line 436 of file wavelet.hpp.

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

◆ count

size_t* gsl::wavelet::workspace::count
private

The shared reference count.

Definition at line 440 of file wavelet.hpp.

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

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