ccgsl 2.7.2
C++wrappersforGnuScientificLibrary
Public Member Functions | Private Attributes | List of all members
gsl::multilarge::linear::workspace Class Reference

Workspace for solving systems. More...

#include <multilarge.hpp>

Collaboration diagram for gsl::multilarge::linear::workspace:
Collaboration graph

Public Member Functions

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

Private Attributes

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

Detailed Description

Workspace for solving systems.

Definition at line 54 of file multilarge.hpp.

Constructor & Destructor Documentation

◆ workspace() [1/5]

gsl::multilarge::linear::workspace::workspace ( )
inline

The default constructor is only really useful for assigning to.

Definition at line 59 of file multilarge.hpp.

References ccgsl_pointer, and count.

Referenced by operator=().

◆ workspace() [2/5]

gsl::multilarge::linear::workspace::workspace ( type const *  T,
size_t const  p 
)
inlineexplicit

The default constructor creates a new workspace with window length K.

Parameters
TThe type
pThe number of columns

Definition at line 68 of file multilarge.hpp.

References ccgsl_pointer, and count.

◆ workspace() [3/5]

gsl::multilarge::linear::workspace::workspace ( gsl_multilarge_linear_workspace *  v)
inlineexplicit

Could construct from a gsl_multilarge_linear_workspace*.

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

Parameters
vThe workspace

Definition at line 84 of file multilarge.hpp.

References ccgsl_pointer, and count.

◆ workspace() [4/5]

gsl::multilarge::linear::workspace::workspace ( workspace const &  v)
inline

The copy constructor.

This creates a new reference to the workspace.

Parameters
vThe workspace to copy.

Definition at line 95 of file multilarge.hpp.

References ccgsl_pointer, and count.

◆ ~workspace()

gsl::multilarge::linear::workspace::~workspace ( )
inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 115 of file multilarge.hpp.

References ccgsl_pointer, and count.

◆ workspace() [5/5]

gsl::multilarge::linear::workspace::workspace ( workspace &&  v)
inline

Move constructor.

Parameters
vThe workspace to move.

Definition at line 127 of file multilarge.hpp.

References count.

Member Function Documentation

◆ empty()

bool gsl::multilarge::linear::workspace::empty ( ) const
inline

Find if the workspace is empty.

Returns
true if has size zero; otherwise false

Definition at line 204 of file multilarge.hpp.

References ccgsl_pointer.

◆ get()

gsl_multilarge_linear_workspace * gsl::multilarge::linear::workspace::get ( ) const
inline

Get the gsl_multilarge_linear_workspace.

Returns
the gsl_multilarge_linear_workspace

Definition at line 230 of file multilarge.hpp.

References ccgsl_pointer.

Referenced by gsl::multilarge::linear::accumulate(), gsl::multilarge::linear::genform1(), gsl::multilarge::linear::genform2(), gsl::multilarge::linear::lcurve(), gsl::multilarge::linear::matrix_ptr(), name(), gsl::multilarge::linear::name(), gsl::multilarge::linear::rcond(), reset(), gsl::multilarge::linear::reset(), gsl::multilarge::linear::rhs_ptr(), gsl::multilarge::linear::solve(), gsl::multilarge::linear::stdform1(), gsl::multilarge::linear::stdform2(), gsl::multilarge::linear::wstdform1(), and gsl::multilarge::linear::wstdform2().

◆ name()

char const * gsl::multilarge::linear::workspace::name ( ) const
inline
Returns
The name of the solver

Definition at line 255 of file multilarge.hpp.

References get().

◆ operator bool()

gsl::multilarge::linear::workspace::operator bool ( ) const
inlineexplicit

Allow conversion to bool.

Returns
true or false according as this contains a pointer to a gsl_multilarge_linear_workspace.

Definition at line 250 of file multilarge.hpp.

References ccgsl_pointer.

◆ operator!=()

bool gsl::multilarge::linear::workspace::operator!= ( workspace const &  v) const
inline

Two workspace are different if their elements are not identical.

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

Definition at line 157 of file multilarge.hpp.

References operator==().

◆ operator<()

bool gsl::multilarge::linear::workspace::operator< ( 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 example, for checking, that a workspace is nonnegative.

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

Definition at line 169 of file multilarge.hpp.

References ccgsl_pointer.

◆ operator<=()

bool gsl::multilarge::linear::workspace::operator<= ( 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 example, for checking, that a workspace is nonnegative.

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

Definition at line 189 of file multilarge.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

workspace & gsl::multilarge::linear::workspace::operator= ( workspace &&  v)
inline

Move operator.

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

Definition at line 136 of file multilarge.hpp.

References workspace().

◆ operator=() [2/2]

workspace & gsl::multilarge::linear::workspace::operator= ( workspace const &  v)
inline

The assignment operator.

This copies elementwise.

Parameters
vThe workspace to copy

Definition at line 102 of file multilarge.hpp.

References ccgsl_pointer, and count.

◆ operator==()

bool gsl::multilarge::linear::workspace::operator== ( workspace const &  v) const
inline

Two workspace are identically equal if their elements are identical.

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

Definition at line 149 of file multilarge.hpp.

References ccgsl_pointer.

Referenced by operator!=().

◆ operator>()

bool gsl::multilarge::linear::workspace::operator> ( 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 example, for checking, that a workspace is nonnegative.

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

Definition at line 179 of file multilarge.hpp.

References ccgsl_pointer.

◆ operator>=()

bool gsl::multilarge::linear::workspace::operator>= ( 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 example, for checking, that a workspace is nonnegative.

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

Definition at line 199 of file multilarge.hpp.

References ccgsl_pointer.

◆ reset()

int gsl::multilarge::linear::workspace::reset ( )
inline

C++ version of gsl_multilarge_linear_reset().

Returns
Error code on failure

Definition at line 260 of file multilarge.hpp.

References get().

◆ swap()

void gsl::multilarge::linear::workspace::swap ( workspace &  v)
inline

Swap two workspace objects.

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

Parameters
vThe workspace to swap with this.

Definition at line 211 of file multilarge.hpp.

References ccgsl_pointer, and count.

◆ unique()

bool gsl::multilarge::linear::workspace::unique ( ) const
inline

Find if this is the only object sharing the gsl_multilarge_linear_workspace.

Returns
true or falses according as this is the only workspace object sharing the gsl_multilarge_linear_workspace.

Definition at line 236 of file multilarge.hpp.

References count.

◆ use_count()

size_t gsl::multilarge::linear::workspace::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 241 of file multilarge.hpp.

References count.

Member Data Documentation

◆ ccgsl_pointer

gsl_multilarge_linear_workspace* gsl::multilarge::linear::workspace::ccgsl_pointer
private

The shared pointer.

Definition at line 219 of file multilarge.hpp.

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

◆ count

size_t* gsl::multilarge::linear::workspace::count
private

The shared reference count.

Definition at line 223 of file multilarge.hpp.

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

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