ccgsl 2.7.2
C++wrappersforGnuScientificLibrary
Public Member Functions | Private Attributes | List of all members
gsl::multifit::linear_workspace Class Reference

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

#include <multifit.hpp>

Collaboration diagram for gsl::multifit::linear_workspace:
Collaboration graph

Public Member Functions

 linear_workspace ()
 The default constructor is only really useful for assigning to. More...
 
 linear_workspace (size_t const n, size_t const p)
 The default constructor creates a new linear_workspace with n elements. More...
 
 linear_workspace (gsl_multifit_linear_workspace *v)
 Could construct from a gsl_multifit_linear_workspace. More...
 
 linear_workspace (linear_workspace const &v)
 The copy constructor. More...
 
linear_workspace & operator= (linear_workspace const &v)
 The assignment operator. More...
 
 ~linear_workspace ()
 The destructor only deletes the pointers if count reaches zero. More...
 
 linear_workspace (linear_workspace &&v)
 Move constructor. More...
 
linear_workspace & operator= (linear_workspace &&v)
 Move operator. More...
 
bool operator== (linear_workspace const &v) const
 Two linear_workspace are identically equal if their elements are identical. More...
 
bool operator!= (linear_workspace const &v) const
 Two linear_workspace are different equal if their elements are not identical. More...
 
bool operator< (linear_workspace const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator> (linear_workspace const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator<= (linear_workspace const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator>= (linear_workspace const &v) const
 A container needs to define an ordering for sorting. More...
 
bool empty () const
 Find if the linear_workspace is empty. More...
 
void swap (linear_workspace &v)
 Swap two linear_workspace. More...
 
gsl_multifit_linear_workspace * get () const
 Get the gsl_multifit_linear_workspace. More...
 
bool unique () const
 Find if this is the only object sharing the gsl_multifit_linear_workspace. More...
 
size_t use_count () const
 Find how many linear_workspace objects share this pointer. More...
 
 operator bool () const
 Allow conversion to bool. More...
 

Private Attributes

gsl_multifit_linear_workspace * ccgsl_pointer
 The shared pointer. More...
 
size_t * count
 The shared reference count. More...
 

Detailed Description

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

Definition at line 37 of file multifit.hpp.

Constructor & Destructor Documentation

◆ linear_workspace() [1/5]

gsl::multifit::linear_workspace::linear_workspace ( )
inline

The default constructor is only really useful for assigning to.

Definition at line 42 of file multifit.hpp.

References ccgsl_pointer, and count.

Referenced by operator=().

◆ linear_workspace() [2/5]

gsl::multifit::linear_workspace::linear_workspace ( size_t const  n,
size_t const  p 
)
inlineexplicit

The default constructor creates a new linear_workspace with n elements.

Parameters
nThe number of observations in the linear_workspace
pThe number of parameters in the linear_workspace

Definition at line 53 of file multifit.hpp.

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

◆ linear_workspace() [3/5]

gsl::multifit::linear_workspace::linear_workspace ( gsl_multifit_linear_workspace *  v)
inlineexplicit

Could construct from a gsl_multifit_linear_workspace.

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

Parameters
vThe linear_workspace

Definition at line 69 of file multifit.hpp.

References ccgsl_pointer, and count.

◆ linear_workspace() [4/5]

gsl::multifit::linear_workspace::linear_workspace ( linear_workspace const &  v)
inline

The copy constructor.

This creates a new reference to the workspace.

Parameters
vThe linear_workspace to copy.

Definition at line 80 of file multifit.hpp.

References ccgsl_pointer, and count.

◆ ~linear_workspace()

gsl::multifit::linear_workspace::~linear_workspace ( )
inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 99 of file multifit.hpp.

References ccgsl_pointer, and count.

◆ linear_workspace() [5/5]

gsl::multifit::linear_workspace::linear_workspace ( linear_workspace &&  v)
inline

Move constructor.

Parameters
vThe linear_workspace to move.

Definition at line 111 of file multifit.hpp.

References count.

Member Function Documentation

◆ empty()

bool gsl::multifit::linear_workspace::empty ( ) const
inline

Find if the linear_workspace is empty.

Returns
true if has size zero; otherwise false

Definition at line 189 of file multifit.hpp.

References ccgsl_pointer.

◆ get()

gsl_multifit_linear_workspace * gsl::multifit::linear_workspace::get ( ) const
inline

Get the gsl_multifit_linear_workspace.

Returns
the gsl_multifit_linear_workspace

Definition at line 215 of file multifit.hpp.

References ccgsl_pointer.

Referenced by gsl::multifit::linear(), gsl::multifit::linear_bsvd(), gsl::multifit::linear_gcv(), gsl::multifit::linear_gcv_calc(), gsl::multifit::linear_gcv_curve(), gsl::multifit::linear_gcv_init(), gsl::multifit::linear_gcv_min(), gsl::multifit::linear_genform1(), gsl::multifit::linear_genform2(), gsl::multifit::linear_lcurvature(), gsl::multifit::linear_lcurve(), gsl::multifit::linear_Lsobolev(), gsl::multifit::linear_rank(), gsl::multifit::linear_rcond(), gsl::multifit::linear_solve(), gsl::multifit::linear_stdform1(), gsl::multifit::linear_stdform2(), gsl::multifit::linear_svd(), gsl::multifit::linear_wgenform2(), gsl::multifit::linear_wstdform1(), gsl::multifit::linear_wstdform2(), gsl::multifit::wlinear(), gsl::multifit::wlinear_svd(), gsl::multifit::wlinear_tsvd(), and gsl::multifit::wlinear_usvd().

◆ operator bool()

gsl::multifit::linear_workspace::operator bool ( ) const
inlineexplicit

Allow conversion to bool.

Returns
true or false according as this contains a pointer to a gsl_multifit_linear_workspace

Definition at line 235 of file multifit.hpp.

References ccgsl_pointer.

◆ operator!=()

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

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

Parameters
vThe linear_workspace to be compared with this
Returns
false or true according as this and v have identical elements or not

Definition at line 142 of file multifit.hpp.

References operator==().

◆ operator<()

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

Parameters
vThe linear_workspace to be compared with this
Returns
false or true according as this is less than v lexicographically

Definition at line 154 of file multifit.hpp.

References ccgsl_pointer.

◆ operator<=()

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

Parameters
vThe linear_workspace to be compared with this
Returns
false or true according as this is less than or equal to v lexicographically

Definition at line 174 of file multifit.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

linear_workspace & gsl::multifit::linear_workspace::operator= ( linear_workspace &&  v)
inline

Move operator.

Parameters
vThe linear_workspace to move.
Returns
A reference to this.

Definition at line 121 of file multifit.hpp.

References linear_workspace().

◆ operator=() [2/2]

linear_workspace & gsl::multifit::linear_workspace::operator= ( linear_workspace const &  v)
inline

The assignment operator.

This copies elementwise.

Parameters
vThe linear_workspace to copy

Definition at line 87 of file multifit.hpp.

References ccgsl_pointer, and count.

◆ operator==()

bool gsl::multifit::linear_workspace::operator== ( linear_workspace const &  v) const
inline

Two linear_workspace are identically equal if their elements are identical.

Parameters
vThe linear_workspace to be compared with this
Returns
true or false according as this and v have identical elements or not

Definition at line 134 of file multifit.hpp.

References ccgsl_pointer.

Referenced by operator!=().

◆ operator>()

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

Parameters
vThe linear_workspace to be compared with this
Returns
false or true according as this is greater than v lexicographically

Definition at line 164 of file multifit.hpp.

References ccgsl_pointer.

◆ operator>=()

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

Parameters
vThe linear_workspace to be compared with this
Returns
false or true according as this is no less than v lexicographically

Definition at line 184 of file multifit.hpp.

References ccgsl_pointer.

◆ swap()

void gsl::multifit::linear_workspace::swap ( linear_workspace &  v)
inline

Swap two linear_workspace.

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

Parameters
vThe linear_workspace to swap with this.

Definition at line 196 of file multifit.hpp.

References ccgsl_pointer, and count.

◆ unique()

bool gsl::multifit::linear_workspace::unique ( ) const
inline

Find if this is the only object sharing the gsl_multifit_linear_workspace.

Returns
true or falses according as this is the only linear_workspace object sharing the gsl_multifit_linear_workspace

Definition at line 221 of file multifit.hpp.

References count.

◆ use_count()

size_t gsl::multifit::linear_workspace::use_count ( ) const
inline

Find how many linear_workspace objects share this pointer.

Returns
the number of linear_workspace objects that share this pointer

Definition at line 226 of file multifit.hpp.

References count.

Member Data Documentation

◆ ccgsl_pointer

gsl_multifit_linear_workspace* gsl::multifit::linear_workspace::ccgsl_pointer
private

The shared pointer.

Definition at line 204 of file multifit.hpp.

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

◆ count

size_t* gsl::multifit::linear_workspace::count
private

The shared reference count.

Definition at line 208 of file multifit.hpp.

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

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