Workspace for real symmetric matrices (eigenvectors and eigenvalues) More...

#include <eigen_symm.hpp>

Collaboration diagram for gsl::eigen::symmv_workspace:

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

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

	symmv_workspace (gsl_eigen_symmv_workspace *v)
	Could construct from a gsl_eigen_symmv_workspace. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

size_t	size () const
	The size of the workspace. More...

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

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

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

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

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

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

Detailed Description

Workspace for real symmetric matrices (eigenvectors and eigenvalues)

Definition at line 256 of file eigen_symm.hpp.

Constructor & Destructor Documentation

◆ symmv_workspace() [1/5]

gsl::eigen::symmv_workspace::symmv_workspace ( )

inline

The default constructor is only really useful for assigning to.

Definition at line 261 of file eigen_symm.hpp.

References ccgsl_pointer, and count.

Referenced by operator=().

◆ symmv_workspace() [2/5]

gsl::eigen::symmv_workspace::symmv_workspace ( size_t const n )

inlineexplicit

The default constructor creates a new symmv_workspace with n elements.

Parameters

n	The number of elements in the symmv_workspace

Definition at line 271 of file eigen_symm.hpp.

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

◆ symmv_workspace() [3/5]

gsl::eigen::symmv_workspace::symmv_workspace ( gsl_eigen_symmv_workspace * v )

inlineexplicit

Could construct from a gsl_eigen_symmv_workspace.

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

Parameters

v	The symmv_workspace

Definition at line 286 of file eigen_symm.hpp.

References ccgsl_pointer, and count.

◆ symmv_workspace() [4/5]

gsl::eigen::symmv_workspace::symmv_workspace ( symmv_workspace const & v )

inline

The copy constructor.

This creates a new reference to the workspace.

Parameters

v	The symmv_workspace to copy.

Definition at line 297 of file eigen_symm.hpp.

References ccgsl_pointer, and count.

◆ ~symmv_workspace()

gsl::eigen::symmv_workspace::~symmv_workspace ( )

inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 316 of file eigen_symm.hpp.

References ccgsl_pointer, and count.

◆ symmv_workspace() [5/5]

gsl::eigen::symmv_workspace::symmv_workspace ( symmv_workspace && v )

inline

Move constructor.

Parameters

v	The symmv_workspace to move.

Definition at line 328 of file eigen_symm.hpp.

References count.

Member Function Documentation

◆ empty()

bool gsl::eigen::symmv_workspace::empty ( ) const

inline

Find if the symmv_workspace is empty.

Returns: true if has size zero; otherwise false

Definition at line 405 of file eigen_symm.hpp.

References ccgsl_pointer.

◆ get()

gsl_eigen_symmv_workspace * gsl::eigen::symmv_workspace::get ( ) const

inline

Get the gsl_eigen_symmv_workspace.

Returns: the gsl_eigen_symmv_workspace

Definition at line 436 of file eigen_symm.hpp.

References ccgsl_pointer.

Referenced by gsl::eigen::symmv().

◆ operator bool()

gsl::eigen::symmv_workspace::operator bool ( ) const

inlineexplicit

Allow conversion to bool.

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

Definition at line 456 of file eigen_symm.hpp.

References ccgsl_pointer.

◆ operator!=()

bool gsl::eigen::symmv_workspace::operator!= ( symmv_workspace const & v ) const

inline

Two symmv_workspace are different equal if their elements are not identical.

Parameters

v	The symmv_workspace to be compared with `this`

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

Definition at line 358 of file eigen_symm.hpp.

References operator==().

◆ operator<()

bool gsl::eigen::symmv_workspace::operator< ( symmv_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 symmv_workspace is nonnegative.

Parameters

v	The symmv_workspace to be compared with `this`

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

Definition at line 370 of file eigen_symm.hpp.

References ccgsl_pointer.

◆ operator<=()

bool gsl::eigen::symmv_workspace::operator<= ( symmv_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 symmv_workspace is nonnegative.

Parameters

v	The symmv_workspace to be compared with `this`

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

Definition at line 390 of file eigen_symm.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

symmv_workspace & gsl::eigen::symmv_workspace::operator= ( symmv_workspace && v )

inline

Move operator.

Parameters

v	The symmv_workspace to move.

Returns: A reference to this.

Definition at line 337 of file eigen_symm.hpp.

References symmv_workspace().

◆ operator=() [2/2]

symmv_workspace & gsl::eigen::symmv_workspace::operator= ( symmv_workspace const & v )

inline

The assignment operator.

This copies elementwise.

Parameters

v	The symmv_workspace to copy

Definition at line 304 of file eigen_symm.hpp.

References ccgsl_pointer, and count.

◆ operator==()

bool gsl::eigen::symmv_workspace::operator== ( symmv_workspace const & v ) const

inline

Two symmv_workspace are identically equal if their elements are identical.

Parameters

v	The symmv_workspace to be compared with `this`

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

Definition at line 350 of file eigen_symm.hpp.

References ccgsl_pointer.

Referenced by operator!=().

◆ operator>()

bool gsl::eigen::symmv_workspace::operator> ( symmv_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 symmv_workspace is nonnegative.

Parameters

v	The symmv_workspace to be compared with `this`

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

Definition at line 380 of file eigen_symm.hpp.

References ccgsl_pointer.

◆ operator>=()

bool gsl::eigen::symmv_workspace::operator>= ( symmv_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 symmv_workspace is nonnegative.

Parameters

v	The symmv_workspace to be compared with `this`

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

Definition at line 400 of file eigen_symm.hpp.

References ccgsl_pointer.

◆ size()

size_t gsl::eigen::symmv_workspace::size ( ) const

inline

The size of the workspace.

Returns: The size of the workspace

Definition at line 420 of file eigen_symm.hpp.

References ccgsl_pointer.

◆ swap()

void gsl::eigen::symmv_workspace::swap ( symmv_workspace & v )

inline

Swap two symmv_workspace.

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

Parameters

v	The symmv_workspace to swap with `this`.

Definition at line 412 of file eigen_symm.hpp.

References ccgsl_pointer, and count.

◆ unique()

bool gsl::eigen::symmv_workspace::unique ( ) const

inline

Find if this is the only object sharing the gsl_eigen_symmv_workspace.

Returns: true or falses according as this is the only symmv_workspace object sharing the gsl_eigen_symmv_workspace

Definition at line 442 of file eigen_symm.hpp.

References count.

◆ use_count()

size_t gsl::eigen::symmv_workspace::use_count ( ) const

inline

Find how many symmv_workspace objects share this pointer.

Returns: the number of symmv_workspace objects that share this pointer

Definition at line 447 of file eigen_symm.hpp.

References count.

Member Data Documentation

◆ ccgsl_pointer

gsl_eigen_symmv_workspace* gsl::eigen::symmv_workspace::ccgsl_pointer

private

The shared pointer.

Definition at line 425 of file eigen_symm.hpp.

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

◆ count

size_t* gsl::eigen::symmv_workspace::count

private

The shared reference count.

Definition at line 429 of file eigen_symm.hpp.

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

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

eigen_symm.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ symmv_workspace() [1/5]

◆ symmv_workspace() [2/5]

◆ symmv_workspace() [3/5]

◆ symmv_workspace() [4/5]

◆ ~symmv_workspace()

◆ symmv_workspace() [5/5]

Member Function Documentation

◆ empty()

◆ get()

◆ operator bool()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>()

◆ operator>=()

◆ size()

◆ swap()

◆ unique()

◆ use_count()

Member Data Documentation

◆ ccgsl_pointer

◆ count