Storm 1.13.0.1
A Modern Probabilistic Model Checker
Loading...
Searching...
No Matches
storm::storage::MatrixEntry< IndexType, ValueType > Class Template Reference

#include <SparseMatrix.h>

Public Types

typedef IndexType index_type
typedef ValueType value_type

Public Member Functions

 MatrixEntry (index_type column, value_type value)
 Constructs a matrix entry with the given column and value.
 MatrixEntry (std::pair< index_type, value_type > &&pair)
 Move-constructs the matrix entry fro the given column-value pair.
 MatrixEntry ()=default
 MatrixEntry (MatrixEntry const &other)=default
MatrixEntryoperator= (MatrixEntry const &other)=default
 MatrixEntry (MatrixEntry &&other)=default
MatrixEntryoperator= (MatrixEntry &&other)=default
index_type const & getColumn () const
 Retrieves the column of the matrix entry.
void setColumn (index_type const &column)
 Sets the column of the current entry.
value_type const & getValue () const
 Retrieves the value of the matrix entry.
void setValue (value_type const &value)
 Sets the value of the entry in the matrix.
std::pair< index_type, value_type > const & getColumnValuePair () const
 Retrieves a pair of column and value that characterizes this entry.
MatrixEntry operator* (value_type factor) const
 Multiplies the entry with the given factor and returns the result.
bool operator== (MatrixEntry const &other) const
bool operator!= (MatrixEntry const &other) const

Friends

template<typename IndexTypePrime, typename ValueTypePrime>
std::ostream & operator<< (std::ostream &out, MatrixEntry< IndexTypePrime, ValueTypePrime > const &entry)

Detailed Description

template<typename IndexType, typename ValueType>
class storm::storage::MatrixEntry< IndexType, ValueType >

Definition at line 40 of file SparseMatrix.h.

Member Typedef Documentation

◆ index_type

template<typename IndexType, typename ValueType>
typedef IndexType storm::storage::MatrixEntry< IndexType, ValueType >::index_type

Definition at line 42 of file SparseMatrix.h.

◆ value_type

template<typename IndexType, typename ValueType>
typedef ValueType storm::storage::MatrixEntry< IndexType, ValueType >::value_type

Definition at line 43 of file SparseMatrix.h.

Constructor & Destructor Documentation

◆ MatrixEntry() [1/5]

template<typename IndexType, typename ValueType>
storm::storage::MatrixEntry< IndexType, ValueType >::MatrixEntry ( index_type column,
value_type value )

Constructs a matrix entry with the given column and value.

Parameters
columnThe column of the matrix entry.
valueThe value of the matrix entry.

Definition at line 25 of file SparseMatrix.cpp.

◆ MatrixEntry() [2/5]

template<typename IndexType, typename ValueType>
storm::storage::MatrixEntry< IndexType, ValueType >::MatrixEntry ( std::pair< index_type, value_type > && pair)

Move-constructs the matrix entry fro the given column-value pair.

Parameters
pairThe column-value pair from which to move-construct the matrix entry.

Definition at line 30 of file SparseMatrix.cpp.

◆ MatrixEntry() [3/5]

template<typename IndexType, typename ValueType>
storm::storage::MatrixEntry< IndexType, ValueType >::MatrixEntry ( )
default

◆ MatrixEntry() [4/5]

template<typename IndexType, typename ValueType>
storm::storage::MatrixEntry< IndexType, ValueType >::MatrixEntry ( MatrixEntry< IndexType, ValueType > const & other)
default

◆ MatrixEntry() [5/5]

template<typename IndexType, typename ValueType>
storm::storage::MatrixEntry< IndexType, ValueType >::MatrixEntry ( MatrixEntry< IndexType, ValueType > && other)
default

Member Function Documentation

◆ getColumn()

template<typename IndexType, typename ValueType>
IndexType const & storm::storage::MatrixEntry< IndexType, ValueType >::getColumn ( ) const

Retrieves the column of the matrix entry.

Returns
The column of the matrix entry.

Definition at line 35 of file SparseMatrix.cpp.

◆ getColumnValuePair()

template<typename IndexType, typename ValueType>
std::pair< IndexType, ValueType > const & storm::storage::MatrixEntry< IndexType, ValueType >::getColumnValuePair ( ) const

Retrieves a pair of column and value that characterizes this entry.

Returns
A column-value pair that characterizes this entry.

Definition at line 55 of file SparseMatrix.cpp.

◆ getValue()

template<typename IndexType, typename ValueType>
ValueType const & storm::storage::MatrixEntry< IndexType, ValueType >::getValue ( ) const

Retrieves the value of the matrix entry.

Returns
The value of the matrix entry.

Definition at line 45 of file SparseMatrix.cpp.

◆ operator!=()

template<typename IndexType, typename ValueType>
bool storm::storage::MatrixEntry< IndexType, ValueType >::operator!= ( MatrixEntry< IndexType, ValueType > const & other) const

Definition at line 70 of file SparseMatrix.cpp.

◆ operator*()

template<typename IndexType, typename ValueType>
MatrixEntry< IndexType, ValueType > storm::storage::MatrixEntry< IndexType, ValueType >::operator* ( value_type factor) const

Multiplies the entry with the given factor and returns the result.

Parameters
factorThe factor with which to multiply the entry.

Definition at line 60 of file SparseMatrix.cpp.

◆ operator=() [1/2]

template<typename IndexType, typename ValueType>
MatrixEntry & storm::storage::MatrixEntry< IndexType, ValueType >::operator= ( MatrixEntry< IndexType, ValueType > && other)
default

◆ operator=() [2/2]

template<typename IndexType, typename ValueType>
MatrixEntry & storm::storage::MatrixEntry< IndexType, ValueType >::operator= ( MatrixEntry< IndexType, ValueType > const & other)
default

◆ operator==()

template<typename IndexType, typename ValueType>
bool storm::storage::MatrixEntry< IndexType, ValueType >::operator== ( MatrixEntry< IndexType, ValueType > const & other) const

Definition at line 65 of file SparseMatrix.cpp.

◆ setColumn()

template<typename IndexType, typename ValueType>
void storm::storage::MatrixEntry< IndexType, ValueType >::setColumn ( index_type const & column)

Sets the column of the current entry.

Parameters
columnThe column to set for this entry.

Definition at line 40 of file SparseMatrix.cpp.

◆ setValue()

template<typename IndexType, typename ValueType>
void storm::storage::MatrixEntry< IndexType, ValueType >::setValue ( value_type const & value)

Sets the value of the entry in the matrix.

Parameters
valueThe value that is to be set for this entry.

Definition at line 50 of file SparseMatrix.cpp.

◆ operator<<

template<typename IndexType, typename ValueType>
template<typename IndexTypePrime, typename ValueTypePrime>
std::ostream & operator<< ( std::ostream & out,
MatrixEntry< IndexTypePrime, ValueTypePrime > const & entry )
friend

Definition at line 75 of file SparseMatrix.cpp.


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