Class to store the sparse matrix row. More...

#include <inmost_sparse.h>

Collaboration diagram for INMOST::Sparse::Row:

Classes
struct	entry_s
	Entry of the sparse matrix row. More...

Public Types
typedef struct INMOST::Sparse::Row::entry_s	entry
	Entry of the sparse matrix row. More...

typedef Entries::iterator	iterator

typedef Entries::const_iterator	const_iterator

typedef Entries::reverse_iterator	reverse_iterator

typedef Entries::const_reverse_iterator	const_reverse_iterator

Public Member Functions
std::string	GetAnnotation ()

void	SetAnnotation (std::string input)

void	Report ()

void	SetMarker ()

void	RemMarker ()

bool	GetMarker ()

	Row ()

	Row (const Row &other)

	Row (entry pbegin, entry pend)

bool	HaveLock ()

void	Lock ()

void	Unlock ()

	~Row ()

Row &	operator= (Row const &other)

INMOST_DATA_REAL_TYPE &	operator[] (INMOST_DATA_ENUM_TYPE i)
	The operator [] used to fill the sparse matrix row, but not to access individual elements of the row. More...

INMOST_DATA_REAL_TYPE	operator[] (INMOST_DATA_ENUM_TYPE i) const
	The operator [] used to access individual elements of the row. More...

void	Clear ()
	Clear all data of the current row. More...

void	Swap (Row &other)

INMOST_DATA_ENUM_TYPE	Size () const
	The size of the sparse row, i.e. the total number of nonzero elements. More...

bool	Empty () const

INMOST_DATA_ENUM_TYPE &	GetIndex (INMOST_DATA_ENUM_TYPE k)

INMOST_DATA_REAL_TYPE &	GetValue (INMOST_DATA_ENUM_TYPE k)

INMOST_DATA_ENUM_TYPE	GetIndex (INMOST_DATA_ENUM_TYPE k) const

INMOST_DATA_REAL_TYPE	GetValue (INMOST_DATA_ENUM_TYPE k) const

iterator	Begin ()

iterator	End ()

const_iterator	Begin () const

const_iterator	End () const

reverse_iterator	rBegin ()

reverse_iterator	rEnd ()

const_reverse_iterator	rBegin () const

const_reverse_iterator	rEnd () const

INMOST_DATA_REAL_TYPE	RowVec (Vector &x) const
	Return the scalar product of the current sparse row by a dense Vector. More...

void	MoveRow (Row &new_pos)

void	Zero ()
	Set the vector entries by zeroes. More...

void	Push (INMOST_DATA_ENUM_TYPE ind, INMOST_DATA_REAL_TYPE val)

void	Resize (INMOST_DATA_ENUM_TYPE size)

void	Print ()

Static Public Member Functions
static __INLINE entry	make_entry (INMOST_DATA_ENUM_TYPE ind, INMOST_DATA_REAL_TYPE val)

Public Attributes
char	annotation [MTX_ANNOTATION_SIZE]

bool	modified_pattern

Detailed Description

Class to store the sparse matrix row.

Definition at line 90 of file inmost_sparse.h.

Member Typedef Documentation

typedef Entries::const_iterator INMOST::Sparse::Row::const_iterator

Definition at line 124 of file inmost_sparse.h.

typedef Entries::const_reverse_iterator INMOST::Sparse::Row::const_reverse_iterator

Definition at line 126 of file inmost_sparse.h.

typedef struct INMOST::Sparse::Row::entry_s INMOST::Sparse::Row::entry

Entry of the sparse matrix row.

typedef Entries::iterator INMOST::Sparse::Row::iterator

Definition at line 123 of file inmost_sparse.h.

typedef Entries::reverse_iterator INMOST::Sparse::Row::reverse_iterator

Definition at line 125 of file inmost_sparse.h.

Constructor & Destructor Documentation

INMOST::Sparse::Row::Row ( )

INMOST::Sparse::Row::Row ( const Row & other )

INMOST::Sparse::Row::Row	(	entry *	pbegin,
		entry *	pend
	)

INMOST::Sparse::Row::~Row ( )

Member Function Documentation

iterator INMOST::Sparse::Row::Begin ( )

inline

Definition at line 209 of file inmost_sparse.h.

Here is the call graph for this function:

Here is the caller graph for this function:

const_iterator INMOST::Sparse::Row::Begin ( ) const

inline

Definition at line 211 of file inmost_sparse.h.

Here is the call graph for this function:

void INMOST::Sparse::Row::Clear ( )

inline

Clear all data of the current row.

Definition at line 199 of file inmost_sparse.h.

Here is the call graph for this function:

Here is the caller graph for this function:

bool INMOST::Sparse::Row::Empty ( ) const

inline

Definition at line 203 of file inmost_sparse.h.

Here is the call graph for this function:

iterator INMOST::Sparse::Row::End ( )

inline

Definition at line 210 of file inmost_sparse.h.

Here is the call graph for this function:

Here is the caller graph for this function:

const_iterator INMOST::Sparse::Row::End ( ) const

inline

Definition at line 212 of file inmost_sparse.h.

Here is the call graph for this function:

std::string INMOST::Sparse::Row::GetAnnotation ( )

INMOST_DATA_ENUM_TYPE& INMOST::Sparse::Row::GetIndex ( INMOST_DATA_ENUM_TYPE k )

inline

Definition at line 204 of file inmost_sparse.h.

Here is the call graph for this function:

INMOST_DATA_ENUM_TYPE INMOST::Sparse::Row::GetIndex ( INMOST_DATA_ENUM_TYPE k ) const

inline

Definition at line 206 of file inmost_sparse.h.

Here is the call graph for this function:

bool INMOST::Sparse::Row::GetMarker ( )

inline

Definition at line 142 of file inmost_sparse.h.

INMOST_DATA_REAL_TYPE& INMOST::Sparse::Row::GetValue ( INMOST_DATA_ENUM_TYPE k )

inline

Definition at line 205 of file inmost_sparse.h.

Here is the call graph for this function:

INMOST_DATA_REAL_TYPE INMOST::Sparse::Row::GetValue ( INMOST_DATA_ENUM_TYPE k ) const

inline

Definition at line 207 of file inmost_sparse.h.

Here is the call graph for this function:

bool INMOST::Sparse::Row::HaveLock ( )

inline

Definition at line 146 of file inmost_sparse.h.

void INMOST::Sparse::Row::Lock ( )

inline

Definition at line 154 of file inmost_sparse.h.

static __INLINE entry INMOST::Sparse::Row::make_entry	(	INMOST_DATA_ENUM_TYPE	ind,
		INMOST_DATA_REAL_TYPE	val
	)

inlinestatic

Definition at line 107 of file inmost_sparse.h.

Here is the caller graph for this function:

void INMOST::Sparse::Row::MoveRow ( Row & new_pos )

inline

Definition at line 219 of file inmost_sparse.h.

Row& INMOST::Sparse::Row::operator= ( Row const & other )

INMOST_DATA_REAL_TYPE& INMOST::Sparse::Row::operator[] ( INMOST_DATA_ENUM_TYPE i )

inline

The operator [] used to fill the sparse matrix row, but not to access individual elements of the row.

Definition at line 169 of file inmost_sparse.h.

Here is the call graph for this function:

INMOST_DATA_REAL_TYPE INMOST::Sparse::Row::operator[] ( INMOST_DATA_ENUM_TYPE i ) const

inline

The operator [] used to access individual elements of the row.

Definition at line 186 of file inmost_sparse.h.

Here is the call graph for this function:

void INMOST::Sparse::Row::Print ( )

inline

Definition at line 231 of file inmost_sparse.h.

Here is the call graph for this function:

void INMOST::Sparse::Row::Push	(	INMOST_DATA_ENUM_TYPE	ind,
		INMOST_DATA_REAL_TYPE	val
	)

inline

Push specified element into sparse row. This function should be used only if the index is not repeated in the row.

Definition at line 224 of file inmost_sparse.h.

Here is the call graph for this function:

Here is the caller graph for this function:

reverse_iterator INMOST::Sparse::Row::rBegin ( )

inline

Definition at line 213 of file inmost_sparse.h.

Here is the call graph for this function:

const_reverse_iterator INMOST::Sparse::Row::rBegin ( ) const

inline

Definition at line 215 of file inmost_sparse.h.

Here is the call graph for this function:

void INMOST::Sparse::Row::RemMarker ( )

inline

Definition at line 141 of file inmost_sparse.h.

reverse_iterator INMOST::Sparse::Row::rEnd ( )

inline

Definition at line 214 of file inmost_sparse.h.

Here is the call graph for this function:

const_reverse_iterator INMOST::Sparse::Row::rEnd ( ) const

inline

Definition at line 216 of file inmost_sparse.h.

Here is the call graph for this function:

void INMOST::Sparse::Row::Report ( )

inline

Definition at line 139 of file inmost_sparse.h.

Here is the call graph for this function:

void INMOST::Sparse::Row::Resize ( INMOST_DATA_ENUM_TYPE size )

inline

Resize row to specified size. It is intended to be used together with non-const Row::GetIndex and Row::GetValue that allow for the modification of individual entries.

Parameters

size	New size of the row.

Definition at line 229 of file inmost_sparse.h.

Here is the call graph for this function:

INMOST_DATA_REAL_TYPE INMOST::Sparse::Row::RowVec ( Vector & x ) const

Return the scalar product of the current sparse row by a dense Vector.

void INMOST::Sparse::Row::SetAnnotation ( std::string input )

void INMOST::Sparse::Row::SetMarker ( )

inline

Definition at line 140 of file inmost_sparse.h.

INMOST_DATA_ENUM_TYPE INMOST::Sparse::Row::Size ( ) const

inline

The size of the sparse row, i.e. the total number of nonzero elements.

Definition at line 202 of file inmost_sparse.h.

Here is the call graph for this function:

void INMOST::Sparse::Row::Swap ( Row & other )

Here is the caller graph for this function:

void INMOST::Sparse::Row::Unlock ( )

inline

Definition at line 160 of file inmost_sparse.h.

void INMOST::Sparse::Row::Zero ( )

inline

Set the vector entries by zeroes.

Definition at line 221 of file inmost_sparse.h.

Here is the call graph for this function:

Member Data Documentation

char INMOST::Sparse::Row::annotation[MTX_ANNOTATION_SIZE]

Definition at line 94 of file inmost_sparse.h.

bool INMOST::Sparse::Row::modified_pattern

Definition at line 128 of file inmost_sparse.h.

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

INMOST.lib/Source/Headers/inmost_sparse.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation