#include <OpenMS/DATASTRUCTURES/Matrix.h>
Think of it as a random access container. You can also generate gray scale images. This is not designed to be used for linear algebra.
The following member functions of the base class std::vector<ValueType> can also be used:
Public Types | |
STL compliance type definitions | |
typedef Base | container_type |
typedef Base::difference_type | difference_type |
typedef Base::size_type | size_type |
typedef Base::const_iterator | const_iterator |
typedef Base::const_reverse_iterator | const_reverse_iterator |
typedef Base::iterator | iterator |
typedef Base::reverse_iterator | reverse_iterator |
typedef Base::const_reference | const_reference |
typedef Base::pointer | pointer |
typedef Base::reference | reference |
typedef Base::value_type | value_type |
typedef Base::allocator_type | allocator_type |
OpenMS compliance type definitions | |
typedef Base | ContainerType |
typedef difference_type | DifferenceType |
typedef size_type | SizeType |
typedef const_iterator | ConstIterator |
typedef const_reverse_iterator | ConstReverseIterator |
typedef iterator | Iterator |
typedef reverse_iterator | ReverseIterator |
typedef const_reference | ConstReference |
typedef pointer | Pointer |
typedef reference | Reference |
typedef value_type | ValueType |
typedef allocator_type | AllocatorType |
Public Member Functions | |
void | clear () |
void | resize (size_type i, size_type j, value_type value=value_type()) |
void | resize (std::pair< UInt, UInt > const &size_pair, value_type value=value_type()) |
SizeType | rows () const throw () |
Number of rows. | |
SizeType | cols () const throw () |
Number of columns. | |
std::pair< UInt, UInt > | sizePair () const |
SizeType const | index (SizeType row, SizeType col) const |
Calculate the index into the underlying vector from row and column. Note that Matrix uses the (row,column) lexicographic ordering for indexing. | |
std::pair< UInt, UInt > const | indexPair (UInt index) const |
Calculate the row and column from an index into the underlying vector. Note that Matrix uses the (row,column) lexicographic ordering for indexing. | |
SizeType | colIndex (SizeType index) const |
Calculate the column from an index into the underlying vector. Note that Matrix uses the (row,column) lexicographic ordering for indexing. | |
SizeType | rowIndex (SizeType index) const |
Calculate the row from an index into the underlying vector. Note that Matrix uses the (row,column) lexicographic ordering for indexing. | |
bool | operator== (Matrix const &rhs) const throw (Exception::Precondition) |
Equality comparator. | |
bool | operator< (Matrix const &rhs) const throw (Exception::Precondition) |
Less-than comparator. Comparison is done lexicographically: first by row, then by column. | |
Constructors, assignment, and destructor | |
Matrix () | |
Matrix (SizeType rows, SizeType cols, ValueType value=ValueType()) | |
Matrix (const Matrix &source) | |
Matrix & | operator= (const Matrix &rhs) |
~Matrix () | |
Accessors | |
const_reference | operator() (size_type const i, size_type const j) const |
reference | operator() (size_type const i, size_type const j) |
const_reference | getValue (size_type const i, size_type const j) const |
reference | getValue (size_type const i, size_type const j) |
void | setValue (size_type const i, size_type const j, value_type value) |
Protected Types | |
typedef std::vector< Value > | Base |
Protected Attributes | |
Data members | |
SizeType | rows_ |
Number of rows (height of a column). | |
SizeType | cols_ |
Number of columns (width of a row). | |
Related Functions | |
(Note that these are not member functions.) | |
template<typename Value> | |
std::ostream & | operator<< (std::ostream &os, const Matrix< Value > &matrix) |
Print the contents to a stream. |
typedef std::vector< Value > Base [protected] |
typedef Base container_type |
typedef Base::difference_type difference_type |
typedef Base::size_type size_type |
typedef Base::const_iterator const_iterator |
typedef Base::const_reverse_iterator const_reverse_iterator |
typedef Base::iterator iterator |
typedef Base::reverse_iterator reverse_iterator |
typedef Base::const_reference const_reference |
typedef Base::pointer pointer |
typedef Base::reference reference |
typedef Base::value_type value_type |
typedef Base::allocator_type allocator_type |
typedef Base ContainerType |
typedef difference_type DifferenceType |
typedef const_iterator ConstIterator |
typedef reverse_iterator ReverseIterator |
typedef const_reference ConstReference |
typedef value_type ValueType |
typedef allocator_type AllocatorType |
Matrix | ( | ) | [inline] |
~Matrix | ( | ) | [inline] |
const_reference operator() | ( | size_type const | i, | |
size_type const | j | |||
) | const [inline] |
const_reference getValue | ( | size_type const | i, | |
size_type const | j | |||
) | const [inline] |
void setValue | ( | size_type const | i, | |
size_type const | j, | |||
value_type | value | |||
) | [inline] |
void clear | ( | ) | [inline] |
void resize | ( | size_type | i, | |
size_type | j, | |||
value_type | value = value_type() | |||
) | [inline] |
void resize | ( | std::pair< UInt, UInt > const & | size_pair, | |
value_type | value = value_type() | |||
) | [inline] |
SizeType rows | ( | ) | const throw () [inline] |
Number of rows.
SizeType cols | ( | ) | const throw () [inline] |
Number of columns.
Calculate the index into the underlying vector from row and column. Note that Matrix uses the (row,column) lexicographic ordering for indexing.
Calculate the row and column from an index into the underlying vector. Note that Matrix uses the (row,column) lexicographic ordering for indexing.
Calculate the column from an index into the underlying vector. Note that Matrix uses the (row,column) lexicographic ordering for indexing.
Calculate the row from an index into the underlying vector. Note that Matrix uses the (row,column) lexicographic ordering for indexing.
bool operator== | ( | Matrix< Value > const & | rhs | ) | const throw (Exception::Precondition) [inline] |
Equality comparator.
If matrices have different row or colmn numbers, throws a precondition exception.
bool operator< | ( | Matrix< Value > const & | rhs | ) | const throw (Exception::Precondition) [inline] |
Less-than comparator. Comparison is done lexicographically: first by row, then by column.
If matrices have different row or column numbers, throws a precondition exception.
std::ostream & operator<< | ( | std::ostream & | os, | |
const Matrix< Value > & | matrix | |||
) | [related] |
Print the contents to a stream.
Generated Tue Apr 1 15:36:43 2008 -- using doxygen 1.5.4 | OpenMS / TOPP 1.1 |