Rmedian workspace. More...

#include <filter.hpp>

Collaboration diagram for gsl::filter::rmedian_workspace:

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

	rmedian_workspace (size_t const K)

	rmedian_workspace (gsl_filter_rmedian_workspace *v)
	Could construct from a gsl_filter_rmedian_workspace. More...

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

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

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

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

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

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

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

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

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

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

bool	operator>= (rmedian_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 (rmedian_workspace &v)
	Swap two workspace objects. More...

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

bool	unique () const
	Find if this is the only object sharing the gsl_filter_median_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_filter_rmedian_workspace *	ccgsl_pointer
	The shared pointer. More...

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

Detailed Description

Rmedian workspace.

Definition at line 477 of file filter.hpp.

Constructor & Destructor Documentation

◆ rmedian_workspace() [1/5]

gsl::filter::rmedian_workspace::rmedian_workspace ( )

inline

The default constructor is only really useful for assigning to.

Definition at line 482 of file filter.hpp.

References ccgsl_pointer, and count.

Referenced by operator=().

◆ rmedian_workspace() [2/5]

gsl::filter::rmedian_workspace::rmedian_workspace ( size_t const K )

inlineexplicit

Parameters

K	Kernel size

Definition at line 491 of file filter.hpp.

References ccgsl_pointer, and count.

◆ rmedian_workspace() [3/5]

gsl::filter::rmedian_workspace::rmedian_workspace ( gsl_filter_rmedian_workspace * v )

inlineexplicit

Could construct from a gsl_filter_rmedian_workspace.

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

Parameters

v	The gsl_rmedian_workspace

Definition at line 507 of file filter.hpp.

References ccgsl_pointer, and count.

◆ rmedian_workspace() [4/5]

gsl::filter::rmedian_workspace::rmedian_workspace ( rmedian_workspace const & v )

inline

The copy constructor.

This creates a new reference to the workspace.

Parameters

v	The workspace to copy.

Definition at line 518 of file filter.hpp.

References ccgsl_pointer, and count.

◆ ~rmedian_workspace()

gsl::filter::rmedian_workspace::~rmedian_workspace ( )

inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 538 of file filter.hpp.

References ccgsl_pointer, and count.

◆ rmedian_workspace() [5/5]

gsl::filter::rmedian_workspace::rmedian_workspace ( rmedian_workspace && v )

inline

Move constructor.

Parameters

v	The workspace to move.

Definition at line 550 of file filter.hpp.

References count.

Member Function Documentation

◆ empty()

bool gsl::filter::rmedian_workspace::empty ( ) const

inline

Find if the workspace is empty.

Returns: true if has size zero; otherwise false

Definition at line 633 of file filter.hpp.

References ccgsl_pointer.

◆ get()

gsl_filter_rmedian_workspace * gsl::filter::rmedian_workspace::get ( ) const

inline

Get the gsl_filter_rmedian_workspace.

Returns: the gsl_filter_median_workspace

Definition at line 659 of file filter.hpp.

References ccgsl_pointer.

Referenced by gsl::filter::rmedian().

◆ operator bool()

gsl::filter::rmedian_workspace::operator bool ( ) const

inlineexplicit

Allow conversion to bool.

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

Definition at line 679 of file filter.hpp.

References ccgsl_pointer.

◆ operator!=()

bool gsl::filter::rmedian_workspace::operator!= ( rmedian_workspace const & v ) const

inline

Two workspace are different if their elements are not identical.

Parameters

v	The workspace to be compared with `this`

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

Definition at line 582 of file filter.hpp.

References operator==().

◆ operator<()

bool gsl::filter::rmedian_workspace::operator< ( rmedian_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

v	The workspace to be compared with `this`

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

Definition at line 594 of file filter.hpp.

References ccgsl_pointer.

◆ operator<=()

bool gsl::filter::rmedian_workspace::operator<= ( rmedian_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

v	The workspace to be compared with `this`

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

Definition at line 616 of file filter.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

rmedian_workspace & gsl::filter::rmedian_workspace::operator= ( rmedian_workspace && v )

inline

Move operator.

Parameters

v	The workspace to move.

Returns: A reference to this.

Definition at line 560 of file filter.hpp.

References rmedian_workspace().

◆ operator=() [2/2]

rmedian_workspace & gsl::filter::rmedian_workspace::operator= ( rmedian_workspace const & v )

inline

The assignment operator.

This copies elementwise.

Parameters

v	The workspace to copy

Definition at line 525 of file filter.hpp.

References ccgsl_pointer, and count.

◆ operator==()

bool gsl::filter::rmedian_workspace::operator== ( rmedian_workspace const & v ) const

inline

Two workspace are identically equal if their elements are identical.

Parameters

v	The workspace to be compared with `this`

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

Definition at line 573 of file filter.hpp.

References ccgsl_pointer.

Referenced by operator!=().

◆ operator>()

bool gsl::filter::rmedian_workspace::operator> ( rmedian_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

v	The workspace to be compared with `this`

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

Definition at line 605 of file filter.hpp.

References ccgsl_pointer.

◆ operator>=()

bool gsl::filter::rmedian_workspace::operator>= ( rmedian_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

v	The workspace to be compared with `this`

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

Definition at line 627 of file filter.hpp.

References ccgsl_pointer.

◆ swap()

void gsl::filter::rmedian_workspace::swap ( rmedian_workspace & v )

inline

Swap two workspace objects.

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

Parameters

v	The workspace to swap with `this`.

Definition at line 640 of file filter.hpp.

References ccgsl_pointer, and count.

◆ unique()

bool gsl::filter::rmedian_workspace::unique ( ) const

inline

Find if this is the only object sharing the gsl_filter_median_workspace.

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

Definition at line 665 of file filter.hpp.

References count.

◆ use_count()

size_t gsl::filter::rmedian_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 670 of file filter.hpp.

References count.

Member Data Documentation

◆ ccgsl_pointer

gsl_filter_rmedian_workspace* gsl::filter::rmedian_workspace::ccgsl_pointer

private

The shared pointer.

Definition at line 648 of file filter.hpp.

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

◆ count

size_t* gsl::filter::rmedian_workspace::count

private

The shared reference count.

Definition at line 652 of file filter.hpp.

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

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

filter.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ rmedian_workspace() [1/5]

◆ rmedian_workspace() [2/5]

◆ rmedian_workspace() [3/5]

◆ rmedian_workspace() [4/5]

◆ ~rmedian_workspace()

◆ rmedian_workspace() [5/5]

Member Function Documentation

◆ 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