Workspace for glfixed_table: used for Gauss–Legendre integration. More...

#include <integration.hpp>

Collaboration diagram for gsl::integration::glfixed_table:

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

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

	glfixed_table (gsl_integration_glfixed_table *v)
	Could construct from a gsl_integration_glfixed_table. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

Workspace for glfixed_table: used for Gauss–Legendre integration.

Definition at line 1804 of file integration.hpp.

Constructor & Destructor Documentation

◆ glfixed_table() [1/5]

gsl::integration::glfixed_table::glfixed_table ( )

inline

The default constructor is only really useful for assigning to.

Definition at line 1809 of file integration.hpp.

References ccgsl_pointer, and count.

Referenced by operator=().

◆ glfixed_table() [2/5]

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

inlineexplicit

The default constructor creates a new glfixed_table with n elements.

Parameters

n	The number of points in the table. The n-point Gauss–Legendre rule is exact for polynomials of order \(2n-1\) or less.

Definition at line 1820 of file integration.hpp.

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

◆ glfixed_table() [3/5]

gsl::integration::glfixed_table::glfixed_table ( gsl_integration_glfixed_table * v )

inlineexplicit

Could construct from a gsl_integration_glfixed_table.

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

Parameters

v	The glfixed_table

Definition at line 1836 of file integration.hpp.

References ccgsl_pointer, and count.

◆ glfixed_table() [4/5]

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

inline

The copy constructor.

This creates a new reference to the workspace.

Parameters

v	The glfixed_table to copy.

Definition at line 1847 of file integration.hpp.

References ccgsl_pointer, and count.

◆ ~glfixed_table()

gsl::integration::glfixed_table::~glfixed_table ( )

inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 1866 of file integration.hpp.

References ccgsl_pointer, and count.

◆ glfixed_table() [5/5]

gsl::integration::glfixed_table::glfixed_table ( glfixed_table && v )

inline

Move constructor.

Parameters

v	The glfixed_table to move.

Definition at line 1878 of file integration.hpp.

References count.

Member Function Documentation

◆ empty()

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

inline

Find if the glfixed_table is empty.

Returns: true if has size zero; otherwise false

Definition at line 1955 of file integration.hpp.

References ccgsl_pointer.

◆ get()

gsl_integration_glfixed_table * gsl::integration::glfixed_table::get ( ) const

inline

Get the gsl_integration_glfixed_table.

Returns: the gsl_integration_glfixed_table

Definition at line 1981 of file integration.hpp.

References ccgsl_pointer.

Referenced by gsl::integration::glfixed(), and gsl::integration::glfixed_point().

◆ operator bool()

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

inlineexplicit

Allow conversion to bool.

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

Definition at line 2001 of file integration.hpp.

References ccgsl_pointer.

◆ operator!=()

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

inline

Two glfixed_table are different if their elements are not identical.

Parameters

v	The glfixed_table to be compared with `this`

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

Definition at line 1908 of file integration.hpp.

References operator==().

◆ operator<()

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

Parameters

v	The glfixed_table to be compared with `this`

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

Definition at line 1920 of file integration.hpp.

References ccgsl_pointer.

◆ operator<=()

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

Parameters

v	The glfixed_table to be compared with `this`

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

Definition at line 1940 of file integration.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

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

inline

Move operator.

Parameters

v	The glfixed_table to move.

Returns: A reference to this.

Definition at line 1887 of file integration.hpp.

References glfixed_table().

◆ operator=() [2/2]

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

inline

The assignment operator.

This copies elementwise.

Parameters

v	The glfixed_table to copy

Definition at line 1854 of file integration.hpp.

References ccgsl_pointer, and count.

◆ operator==()

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

inline

Two glfixed_table are identically equal if their elements are identical.

Parameters

v	The glfixed_table to be compared with `this`

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

Definition at line 1900 of file integration.hpp.

References ccgsl_pointer.

Referenced by operator!=().

◆ operator>()

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

Parameters

v	The glfixed_table to be compared with `this`

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

Definition at line 1930 of file integration.hpp.

References ccgsl_pointer.

◆ operator>=()

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

Parameters

v	The glfixed_table to be compared with `this`

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

Definition at line 1950 of file integration.hpp.

References ccgsl_pointer.

◆ swap()

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

inline

Swap two glfixed_table.

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

Parameters

v	The glfixed_table to swap with `this`.

Definition at line 1962 of file integration.hpp.

References ccgsl_pointer, and count.

◆ unique()

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

inline

Find if this is the only object sharing the gsl_integration_glfixed_table.

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

Definition at line 1987 of file integration.hpp.

References count.

◆ use_count()

size_t gsl::integration::glfixed_table::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 1992 of file integration.hpp.

References count.

Member Data Documentation

◆ ccgsl_pointer

gsl_integration_glfixed_table* gsl::integration::glfixed_table::ccgsl_pointer

private

The shared pointer.

Definition at line 1970 of file integration.hpp.

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

◆ count

size_t* gsl::integration::glfixed_table::count

private

The shared reference count.

Definition at line 1974 of file integration.hpp.

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

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

integration.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ glfixed_table() [1/5]

◆ glfixed_table() [2/5]

◆ glfixed_table() [3/5]

◆ glfixed_table() [4/5]

◆ ~glfixed_table()

◆ glfixed_table() [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