Workspace for integration. More...

#include <integration.hpp>

Collaboration diagram for gsl::integration::romberg_workspace:

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

	romberg_workspace (size_t const n)
	The default constructor creates a new romberg_workspace with n elements. More...

	romberg_workspace (gsl_integration_romberg_workspace *v)
	Could construct from a gsl_integration_romberg_workspace. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

Workspace for integration.

Definition at line 2302 of file integration.hpp.

Constructor & Destructor Documentation

◆ romberg_workspace() [1/5]

gsl::integration::romberg_workspace::romberg_workspace ( )

inline

The default constructor is only really useful for assigning to.

Definition at line 2307 of file integration.hpp.

References ccgsl_pointer, and count.

Referenced by operator=().

◆ romberg_workspace() [2/5]

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

inlineexplicit

The default constructor creates a new romberg_workspace with n elements.

Parameters

n	The number of double-precision intervals in the romberg_workspace

Definition at line 2317 of file integration.hpp.

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

◆ romberg_workspace() [3/5]

gsl::integration::romberg_workspace::romberg_workspace ( gsl_integration_romberg_workspace * v )

inlineexplicit

Could construct from a gsl_integration_romberg_workspace.

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

Parameters

v	The romberg_workspace

Definition at line 2333 of file integration.hpp.

References ccgsl_pointer, and count.

◆ romberg_workspace() [4/5]

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

inline

The copy constructor.

This creates a new reference to the romberg_workspace.

Parameters

v	The integration_romberg_workspace to copy.

Definition at line 2344 of file integration.hpp.

References ccgsl_pointer, and count.

◆ ~romberg_workspace()

gsl::integration::romberg_workspace::~romberg_workspace ( )

inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 2363 of file integration.hpp.

References ccgsl_pointer, and count.

◆ romberg_workspace() [5/5]

gsl::integration::romberg_workspace::romberg_workspace ( romberg_workspace && v )

inline

Move constructor.

Parameters

v	The romberg_workspace to move.

Definition at line 2375 of file integration.hpp.

References count.

Member Function Documentation

◆ empty()

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

inline

Find if the romberg_workspace is empty.

Returns: true if has size zero; otherwise false

Definition at line 2452 of file integration.hpp.

References ccgsl_pointer.

◆ get()

gsl_integration_romberg_workspace * gsl::integration::romberg_workspace::get ( ) const

inline

Get the gsl_integration_romberg_workspace.

Returns: the gsl_integration_romberg_workspace

Definition at line 2478 of file integration.hpp.

References ccgsl_pointer.

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

◆ operator bool()

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

inlineexplicit

Allow conversion to bool.

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

Definition at line 2498 of file integration.hpp.

References ccgsl_pointer.

◆ operator!=()

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

inline

Two romberg_workspace are different if their elements are not identical.

Parameters

v	The romberg_workspace to be compared with `this`

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

Definition at line 2405 of file integration.hpp.

References operator==().

◆ operator<()

bool gsl::integration::romberg_workspace::operator< ( romberg_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 romberg_workspace is nonnegative.

Parameters

v	The romberg_workspace to be compared with `this`

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

Definition at line 2417 of file integration.hpp.

References ccgsl_pointer.

◆ operator<=()

bool gsl::integration::romberg_workspace::operator<= ( romberg_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 romberg_workspace is nonnegative.

Parameters

v	The romberg_workspace to be compared with `this`

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

Definition at line 2437 of file integration.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

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

inline

Move operator.

Parameters

v	The romberg_workspace to move.

Returns: A reference to this.

Definition at line 2384 of file integration.hpp.

References romberg_workspace().

◆ operator=() [2/2]

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

inline

The assignment operator.

This copies elementwise.

Parameters

v	The romberg_workspace to copy

Definition at line 2351 of file integration.hpp.

References ccgsl_pointer, and count.

◆ operator==()

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

inline

Two romberg_workspace are identically equal if their elements are identical.

Parameters

v	The romberg_workspace to be compared with `this`

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

Definition at line 2397 of file integration.hpp.

References ccgsl_pointer.

Referenced by operator!=().

◆ operator>()

bool gsl::integration::romberg_workspace::operator> ( romberg_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 romberg_workspace is nonnegative.

Parameters

v	The romberg_workspace to be compared with `this`

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

Definition at line 2427 of file integration.hpp.

References ccgsl_pointer.

◆ operator>=()

bool gsl::integration::romberg_workspace::operator>= ( romberg_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 romberg_workspace is nonnegative.

Parameters

v	The romberg_workspace to be compared with `this`

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

Definition at line 2447 of file integration.hpp.

References ccgsl_pointer.

◆ swap()

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

inline

Swap two romberg_workspace.

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

Parameters

v	The romberg_workspace to swap with `this`.

Definition at line 2459 of file integration.hpp.

References ccgsl_pointer, and count.

◆ unique()

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

inline

Find if this is the only object sharing the gsl_integration_romberg_workspace.

Returns: true or falses according as this is the only romberg_workspace object sharing the gsl_integration_romberg_workspace

Definition at line 2484 of file integration.hpp.

References count.

◆ use_count()

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

inline

Find how many romberg_workspace objects share this pointer.

Returns: the number of romberg_workspace objects that share this pointer

Definition at line 2489 of file integration.hpp.

References count.

Member Data Documentation

◆ ccgsl_pointer

gsl_integration_romberg_workspace* gsl::integration::romberg_workspace::ccgsl_pointer

private

The shared pointer.

Definition at line 2467 of file integration.hpp.

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

◆ count

size_t* gsl::integration::romberg_workspace::count

private

The shared reference count.

Definition at line 2471 of file integration.hpp.

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

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

integration.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ romberg_workspace() [1/5]

◆ romberg_workspace() [2/5]

◆ romberg_workspace() [3/5]

◆ romberg_workspace() [4/5]

◆ ~romberg_workspace()

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