AbstractLinAlgPack::SparseElement< T_Index, T_Value > Class Template Reference

Sparse storage element type. More...

#include <AbstractLinAlgPack_SparseElement.hpp>

Classes
union	index_and_padding

Private Attributes
index_and_padding	idx_pad_
value_type	value_

Public Typedefs.
typedef T_Value	value_type
typedef T_Index	index_type

Constructors
	SparseElement ()
	Construct uninitialized (value() == 0.0#, index() == 0#). More...
	SparseElement (index_type index, value_type value)
	Construct with a value and index set. More...

Value and index access
value_type &	value ()
const value_type &	value () const
const index_type &	index () const
void	initialize (index_type index, value_type value)
	Initialize. More...
void	change_index (index_type index)
	Change the index. More...

Detailed Description

template<class T_Index, class T_Value>
class AbstractLinAlgPack::SparseElement< T_Index, T_Value >

Sparse storage element type.

This class abstracts a sparse element of a templated type. It is ment to be used in a sparse vector. Objects of this type are designed so that the size of the object is the same at least two value_type objects.

The default assignment operator and copy constructor are allowed.

Definition at line 60 of file AbstractLinAlgPack_SparseElement.hpp.

Member Typedef Documentation

template<class T_Index , class T_Value >

typedef T_Value AbstractLinAlgPack::SparseElement< T_Index, T_Value >::value_type

Definition at line 66 of file AbstractLinAlgPack_SparseElement.hpp.

template<class T_Index , class T_Value >

typedef T_Index AbstractLinAlgPack::SparseElement< T_Index, T_Value >::index_type

Definition at line 68 of file AbstractLinAlgPack_SparseElement.hpp.

Constructor & Destructor Documentation

template<class T_Index , class T_Value >

AbstractLinAlgPack::SparseElement< T_Index, T_Value >::SparseElement ( )

inline

Construct uninitialized (value() == 0.0#, index() == 0#).

Definition at line 76 of file AbstractLinAlgPack_SparseElement.hpp.

template<class T_Index , class T_Value >

AbstractLinAlgPack::SparseElement< T_Index, T_Value >::SparseElement ( index_type  index, value_type  value  )

inline

Construct with a value and index set.

Definition at line 83 of file AbstractLinAlgPack_SparseElement.hpp.

Member Function Documentation

template<class T_Index , class T_Value >

value_type& AbstractLinAlgPack::SparseElement< T_Index, T_Value >::value ( )

inline

Definition at line 95 of file AbstractLinAlgPack_SparseElement.hpp.

template<class T_Index , class T_Value >

const value_type& AbstractLinAlgPack::SparseElement< T_Index, T_Value >::value ( ) const

inline

Definition at line 100 of file AbstractLinAlgPack_SparseElement.hpp.

template<class T_Index , class T_Value >

const index_type& AbstractLinAlgPack::SparseElement< T_Index, T_Value >::index ( ) const

inline

Definition at line 105 of file AbstractLinAlgPack_SparseElement.hpp.

template<class T_Index , class T_Value >

void AbstractLinAlgPack::SparseElement< T_Index, T_Value >::initialize ( index_type  index, value_type  value  )

inline

Initialize.

Definition at line 110 of file AbstractLinAlgPack_SparseElement.hpp.

template<class T_Index , class T_Value >

void AbstractLinAlgPack::SparseElement< T_Index, T_Value >::change_index ( index_type  index )

inline

Change the index.

Definition at line 115 of file AbstractLinAlgPack_SparseElement.hpp.

Member Data Documentation

template<class T_Index , class T_Value >

index_and_padding AbstractLinAlgPack::SparseElement< T_Index, T_Value >::idx_pad_

private

Definition at line 127 of file AbstractLinAlgPack_SparseElement.hpp.

template<class T_Index , class T_Value >

value_type AbstractLinAlgPack::SparseElement< T_Index, T_Value >::value_

private

Definition at line 128 of file AbstractLinAlgPack_SparseElement.hpp.

---

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

• AbstractLinAlgPack_SparseElement.hpp