Workspace for CQUAD quadrature routine. More...

#include <integration.hpp>

Collaboration diagram for gsl::integration::cquad_workspace:

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

	cquad_workspace (size_t const n)
	The default constructor creates a new cquad_workspace with space for n intervals. More...

	cquad_workspace (gsl_integration_cquad_workspace *v)
	Could construct from a gsl_integration_cquad_workspace. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

Workspace for CQUAD quadrature routine.

Definition at line 2062 of file integration.hpp.

Constructor & Destructor Documentation

◆ cquad_workspace() [1/5]

gsl::integration::cquad_workspace::cquad_workspace ( )

inline

The default constructor is only really useful for assigning to.

Definition at line 2067 of file integration.hpp.

References ccgsl_pointer, and count.

Referenced by operator=().

◆ cquad_workspace() [2/5]

gsl::integration::cquad_workspace::cquad_workspace ( size_t const n )

inlineexplicit

The default constructor creates a new cquad_workspace with space for n intervals.

Parameters

n	The number of intervals in the cquad_workspace

Definition at line 2077 of file integration.hpp.

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

◆ cquad_workspace() [3/5]

gsl::integration::cquad_workspace::cquad_workspace ( gsl_integration_cquad_workspace * v )

inlineexplicit

Could construct from a gsl_integration_cquad_workspace.

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

Parameters

v	The cquad_workspace

Definition at line 2093 of file integration.hpp.

References ccgsl_pointer, and count.

◆ cquad_workspace() [4/5]

gsl::integration::cquad_workspace::cquad_workspace ( cquad_workspace const & v )

inline

The copy constructor.

This creates a new reference to the workspace.

Parameters

v	The cquad_workspace to copy.

Definition at line 2104 of file integration.hpp.

References ccgsl_pointer, and count.

◆ ~cquad_workspace()

gsl::integration::cquad_workspace::~cquad_workspace ( )

inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 2123 of file integration.hpp.

References ccgsl_pointer, and count.

◆ cquad_workspace() [5/5]

gsl::integration::cquad_workspace::cquad_workspace ( cquad_workspace && v )

inline

Move constructor.

Parameters

v	The cquad_workspace to move.

Definition at line 2135 of file integration.hpp.

References count.

Member Function Documentation

◆ empty()

bool gsl::integration::cquad_workspace::empty ( ) const

inline

Find if the cquad_workspace is empty.

Returns: true if has size zero; otherwise false

Definition at line 2212 of file integration.hpp.

References ccgsl_pointer.

◆ get()

gsl_integration_cquad_workspace * gsl::integration::cquad_workspace::get ( ) const

inline

Get the gsl_integration_cquad_workspace.

Returns: the gsl_integration_cquad_workspace

Definition at line 2238 of file integration.hpp.

References ccgsl_pointer.

Referenced by gsl::integration::cquad().

◆ operator bool()

gsl::integration::cquad_workspace::operator bool ( ) const

inlineexplicit

Allow conversion to bool.

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

Definition at line 2258 of file integration.hpp.

References ccgsl_pointer.

◆ operator!=()

bool gsl::integration::cquad_workspace::operator!= ( cquad_workspace const & v ) const

inline

Two cquad_workspace are different if their elements are not identical.

Parameters

v	The cquad_workspace to be compared with `this`

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

Definition at line 2165 of file integration.hpp.

References operator==().

◆ operator<()

bool gsl::integration::cquad_workspace::operator< ( cquad_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 eaxmple, for checking, that a cquad_workspace is nonnegative.

Parameters

v	The cquad_workspace to be compared with `this`

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

Definition at line 2177 of file integration.hpp.

References ccgsl_pointer.

◆ operator<=()

bool gsl::integration::cquad_workspace::operator<= ( cquad_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 eaxmple, for checking, that a cquad_workspace is nonnegative.

Parameters

v	The cquad_workspace to be compared with `this`

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

Definition at line 2197 of file integration.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

cquad_workspace & gsl::integration::cquad_workspace::operator= ( cquad_workspace && v )

inline

Move operator.

Parameters

v	The cquad_workspace to move.

Returns: A reference to this.

Definition at line 2144 of file integration.hpp.

References cquad_workspace().

◆ operator=() [2/2]

cquad_workspace & gsl::integration::cquad_workspace::operator= ( cquad_workspace const & v )

inline

The assignment operator.

This copies elementwise.

Parameters

v	The cquad_workspace to copy

Definition at line 2111 of file integration.hpp.

References ccgsl_pointer, and count.

◆ operator==()

bool gsl::integration::cquad_workspace::operator== ( cquad_workspace const & v ) const

inline

Two cquad_workspace are identically equal if their elements are identical.

Parameters

v	The cquad_workspace to be compared with `this`

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

Definition at line 2157 of file integration.hpp.

References ccgsl_pointer.

Referenced by operator!=().

◆ operator>()

bool gsl::integration::cquad_workspace::operator> ( cquad_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 eaxmple, for checking, that a cquad_workspace is nonnegative.

Parameters

v	The cquad_workspace to be compared with `this`

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

Definition at line 2187 of file integration.hpp.

References ccgsl_pointer.

◆ operator>=()

bool gsl::integration::cquad_workspace::operator>= ( cquad_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 eaxmple, for checking, that a cquad_workspace is nonnegative.

Parameters

v	The cquad_workspace to be compared with `this`

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

Definition at line 2207 of file integration.hpp.

References ccgsl_pointer.

◆ swap()

void gsl::integration::cquad_workspace::swap ( cquad_workspace & v )

inline

Swap two cquad_workspace.

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

Parameters

v	The cquad_workspace to swap with `this`.

Definition at line 2219 of file integration.hpp.

References ccgsl_pointer, and count.

◆ unique()

bool gsl::integration::cquad_workspace::unique ( ) const

inline

Find if this is the only object sharing the gsl_integration_cquad_workspace.

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

Definition at line 2244 of file integration.hpp.

References count.

◆ use_count()

size_t gsl::integration::cquad_workspace::use_count ( ) const

inline

Find how many cquad_workspace objects share this pointer.

Returns: the number of workspace objects that share this pointer

Definition at line 2249 of file integration.hpp.

References count.

Member Data Documentation

◆ ccgsl_pointer

gsl_integration_cquad_workspace* gsl::integration::cquad_workspace::ccgsl_pointer

private

The shared pointer.

Definition at line 2227 of file integration.hpp.

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

◆ count

size_t* gsl::integration::cquad_workspace::count

private

The shared reference count.

Definition at line 2231 of file integration.hpp.

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

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

integration.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ cquad_workspace() [1/5]

◆ cquad_workspace() [2/5]

◆ cquad_workspace() [3/5]

◆ cquad_workspace() [4/5]

◆ ~cquad_workspace()

◆ cquad_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