Workspace for robust linear least squares with p parameters and n observations. More...

#include <multifit.hpp>

Collaboration diagram for gsl::multifit::robust_workspace:

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

	robust_workspace (robust_type &T, size_t const n, size_t const p)
	The default constructor creates a new robust_workspace with n elements. More...

	robust_workspace (gsl_multifit_robust_workspace *v)
	Could construct from a gsl_multifit_robust_workspace. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

Workspace for robust linear least squares with p parameters and n observations.

Definition at line 455 of file multifit.hpp.

Constructor & Destructor Documentation

◆ robust_workspace() [1/5]

gsl::multifit::robust_workspace::robust_workspace ( )

inline

The default constructor is only really useful for assigning to.

Definition at line 460 of file multifit.hpp.

References ccgsl_pointer, and count.

Referenced by operator=().

◆ robust_workspace() [2/5]

gsl::multifit::robust_workspace::robust_workspace	(	robust_type &	T,
		size_t const	n,
		size_t const	p
	)

inlineexplicit

The default constructor creates a new robust_workspace with n elements.

Parameters

T	The type of workspace.
n	The number of observations in the robust_workspace
p	The number of parameters in the robust_workspace

Definition at line 472 of file multifit.hpp.

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

◆ robust_workspace() [3/5]

gsl::multifit::robust_workspace::robust_workspace ( gsl_multifit_robust_workspace * v )

inlineexplicit

Could construct from a gsl_multifit_robust_workspace.

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

Parameters

v	The robust_workspace

Definition at line 488 of file multifit.hpp.

References ccgsl_pointer, and count.

◆ robust_workspace() [4/5]

gsl::multifit::robust_workspace::robust_workspace ( robust_workspace const & v )

inline

The copy constructor.

This creates a new reference to the workspace.

Parameters

v	The robust_workspace to copy.

Definition at line 499 of file multifit.hpp.

References ccgsl_pointer, and count.

◆ ~robust_workspace()

gsl::multifit::robust_workspace::~robust_workspace ( )

inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 518 of file multifit.hpp.

References ccgsl_pointer, and count.

◆ robust_workspace() [5/5]

gsl::multifit::robust_workspace::robust_workspace ( robust_workspace && v )

inline

Move constructor.

Parameters

v	The robust_workspace to move.

Definition at line 530 of file multifit.hpp.

References count.

Member Function Documentation

◆ empty()

bool gsl::multifit::robust_workspace::empty ( ) const

inline

Find if the robust_workspace is empty.

Returns: true if has size zero; otherwise false

Definition at line 608 of file multifit.hpp.

References ccgsl_pointer.

◆ get()

gsl_multifit_robust_workspace * gsl::multifit::robust_workspace::get ( ) const

inline

Get the gsl_multifit_robust_workspace.

Returns: the gsl_multifit_robust_workspace

Definition at line 634 of file multifit.hpp.

References ccgsl_pointer.

Referenced by gsl::multifit::robust(), gsl::multifit::robust_maxiter(), gsl::multifit::robust_name(), gsl::multifit::robust_residuals(), gsl::multifit::robust_statistics(), gsl::multifit::robust_tune(), and gsl::multifit::robust_weights().

◆ operator bool()

gsl::multifit::robust_workspace::operator bool ( ) const

inlineexplicit

Allow conversion to bool.

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

Definition at line 654 of file multifit.hpp.

References ccgsl_pointer.

◆ operator!=()

bool gsl::multifit::robust_workspace::operator!= ( robust_workspace const & v ) const

inline

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

Parameters

v	The robust_workspace to be compared with `this`

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

Definition at line 561 of file multifit.hpp.

References operator==().

◆ operator<()

bool gsl::multifit::robust_workspace::operator< ( robust_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 robust_workspace is nonnegative.

Parameters

v	The robust_workspace to be compared with `this`

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

Definition at line 573 of file multifit.hpp.

References ccgsl_pointer.

◆ operator<=()

bool gsl::multifit::robust_workspace::operator<= ( robust_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 robust_workspace is nonnegative.

Parameters

v	The robust_workspace to be compared with `this`

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

Definition at line 593 of file multifit.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

robust_workspace & gsl::multifit::robust_workspace::operator= ( robust_workspace && v )

inline

Move operator.

Parameters

v	The robust_workspace to move.

Returns: A reference to this.

Definition at line 540 of file multifit.hpp.

References robust_workspace().

◆ operator=() [2/2]

robust_workspace & gsl::multifit::robust_workspace::operator= ( robust_workspace const & v )

inline

The assignment operator.

This copies elementwise.

Parameters

v	The robust_workspace to copy

Definition at line 506 of file multifit.hpp.

References ccgsl_pointer, and count.

◆ operator==()

bool gsl::multifit::robust_workspace::operator== ( robust_workspace const & v ) const

inline

Two robust_workspace are identically equal if their elements are identical.

Parameters

v	The robust_workspace to be compared with `this`

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

Definition at line 553 of file multifit.hpp.

References ccgsl_pointer.

Referenced by operator!=().

◆ operator>()

bool gsl::multifit::robust_workspace::operator> ( robust_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 robust_workspace is nonnegative.

Parameters

v	The robust_workspace to be compared with `this`

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

Definition at line 583 of file multifit.hpp.

References ccgsl_pointer.

◆ operator>=()

bool gsl::multifit::robust_workspace::operator>= ( robust_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 robust_workspace is nonnegative.

Parameters

v	The robust_workspace to be compared with `this`

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

Definition at line 603 of file multifit.hpp.

References ccgsl_pointer.

◆ swap()

void gsl::multifit::robust_workspace::swap ( robust_workspace & v )

inline

Swap two robust_workspace.

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

Parameters

v	The robust_workspace to swap with `this`.

Definition at line 615 of file multifit.hpp.

References ccgsl_pointer, and count.

◆ unique()

bool gsl::multifit::robust_workspace::unique ( ) const

inline

Find if this is the only object sharing the gsl_multifit_robust_workspace.

Returns: true or falses according as this is the only robust_workspace object sharing the gsl_multifit_robust_workspace

Definition at line 640 of file multifit.hpp.

References count.

◆ use_count()

size_t gsl::multifit::robust_workspace::use_count ( ) const

inline

Find how many robust_workspace objects share this pointer.

Returns: the number of robust_workspace objects that share this pointer

Definition at line 645 of file multifit.hpp.

References count.

Member Data Documentation

◆ ccgsl_pointer

gsl_multifit_robust_workspace* gsl::multifit::robust_workspace::ccgsl_pointer

private

The shared pointer.

Definition at line 623 of file multifit.hpp.

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

◆ count

size_t* gsl::multifit::robust_workspace::count

private

The shared reference count.

Definition at line 627 of file multifit.hpp.

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

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

multifit.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ robust_workspace() [1/5]

◆ robust_workspace() [2/5]

◆ robust_workspace() [3/5]

◆ robust_workspace() [4/5]

◆ ~robust_workspace()

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