A two-dimensional matrix. Similar to std::vector, but uses a binary operator(,) for element access. More...
#include <OpenMS/DATASTRUCTURES/Matrix.h>
 
  
 | 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< Size, Size > const &size_pair, value_type value=value_type()) | 
| SizeType | rows () const | 
| Number of rows.  More... | |
| SizeType | cols () const | 
| Number of columns.  More... | |
| std::pair< Size, Size > | 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.  More... | |
| std::pair< Size, Size > const | indexPair (Size 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.  More... | |
| 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.  More... | |
| 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.  More... | |
| bool | operator== (Matrix const &rhs) const | 
| Equality comparator.  More... | |
| bool | operator< (Matrix const &rhs) const | 
| Less-than comparator. Comparison is done lexicographically: first by row, then by column.  More... | |
| template<int ROWS, int COLS> | |
| void | setMatrix (const ValueType matrix[ROWS][COLS]) | 
| set matrix to 2D arrays values  More... | |
| gsl_matrix * | toGslMatrix () | 
| create gsl_matrix*  More... | |
| Constructors, assignment, and destructor | |
| Matrix () | |
| Matrix (const SizeType rows, const 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) | 
| container_type | row (size_type const i) const | 
| Return the i-th row of the matrix as a vector.  More... | |
| container_type | col (size_type const i) const | 
| Return the i-th column of the matrix as a vector.  More... | |
| Protected Types | |
| typedef std::vector< Value > | Base | 
| Protected Attributes | |
| Data members | |
| SizeType | rows_ | 
| Number of rows (height of a column)  More... | |
| SizeType | cols_ | 
| Number of columns (width of a row)  More... | |
|  Protected Attributes inherited from vector< T > | |
| T | elements | 
| STL member.  More... | |
| 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.  More... | |
A two-dimensional matrix. Similar to std::vector, but uses a binary operator(,) for element access.
Think of it as a random access container. You can also generate gray scale images. This data structure is not designed to be used for linear algebra, but rather a simple two-dimensional array.
The following member functions of the base class std::vector<ValueType> can also be used:
| typedef Base::allocator_type allocator_type | 
| typedef allocator_type AllocatorType | 
| 
 | protected | 
| typedef Base::const_iterator const_iterator | 
| typedef Base::const_reference const_reference | 
| typedef Base::const_reverse_iterator const_reverse_iterator | 
| typedef const_iterator ConstIterator | 
| typedef const_reference ConstReference | 
| typedef Base container_type | 
| typedef Base ContainerType | 
| typedef Base::difference_type difference_type | 
| typedef difference_type DifferenceType | 
| typedef Base::iterator iterator | 
| typedef Base::pointer pointer | 
| typedef Base::reference reference | 
| typedef Base::reverse_iterator reverse_iterator | 
| typedef reverse_iterator ReverseIterator | 
| typedef Base::size_type size_type | 
| typedef Base::value_type value_type | 
| typedef value_type ValueType | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
Return the i-th column of the matrix as a vector.
Referenced by Matrix< unsigned int >::index().
Calculate the column from an index into the underlying vector. Note that Matrix uses the (row,column) lexicographic ordering for indexing.
| 
 | inline | 
Number of columns.
Referenced by BilinearInterpolation< Key, Value >::addValue(), BilinearInterpolation< Key, Value >::supportMax_1(), and BilinearInterpolation< Key, Value >::value().
| 
 | inline | 
Referenced by Matrix< unsigned int >::operator()().
Calculate the index into the underlying vector from row and column. Note that Matrix uses the (row,column) lexicographic ordering for indexing.
Referenced by Matrix< unsigned int >::col(), Matrix< unsigned int >::getValue(), Matrix< unsigned int >::row(), and Matrix< unsigned int >::setValue().
Calculate the row and column from an index into the underlying vector. Note that Matrix uses the (row,column) lexicographic ordering for indexing.
| 
 | inline | 
| 
 | 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.
| 
 | inline | 
Equality comparator.
If matrices have different row or colmn numbers, throws a precondition exception.
| 
 | inline | 
Referenced by Matrix< unsigned int >::setMatrix().
| 
 | inline | 
| 
 | inline | 
Return the i-th row of the matrix as a vector.
Calculate the row from an index into the underlying vector. Note that Matrix uses the (row,column) lexicographic ordering for indexing.
| 
 | inline | 
Number of rows.
Referenced by BilinearInterpolation< Key, Value >::addValue(), BilinearInterpolation< Key, Value >::supportMax_0(), and BilinearInterpolation< Key, Value >::value().
| 
 | inline | 
set matrix to 2D arrays values
| 
 | inline | 
Referenced by Matrix< unsigned int >::setMatrix().
| 
 | inline | 
create gsl_matrix*
allocate and return an equivalent GSL matrix
| 
 | related | 
Print the contents to a stream.
| 
 | protected | 
Number of columns (width of a row)
Referenced by Matrix< unsigned int >::clear(), Matrix< unsigned int >::col(), Matrix< unsigned int >::colIndex(), Matrix< unsigned int >::cols(), Matrix< unsigned int >::index(), Matrix< unsigned int >::indexPair(), Matrix< unsigned int >::operator<(), Matrix< unsigned int >::operator=(), Matrix< unsigned int >::operator==(), Matrix< unsigned int >::resize(), Matrix< unsigned int >::row(), Matrix< unsigned int >::rowIndex(), Matrix< unsigned int >::setMatrix(), Matrix< unsigned int >::sizePair(), and Matrix< unsigned int >::toGslMatrix().
| 
 | protected | 
Number of rows (height of a column)
Referenced by Matrix< unsigned int >::clear(), Matrix< unsigned int >::col(), Matrix< unsigned int >::index(), Matrix< unsigned int >::operator<(), Matrix< unsigned int >::operator=(), Matrix< unsigned int >::operator==(), Matrix< unsigned int >::resize(), Matrix< unsigned int >::row(), Matrix< unsigned int >::rows(), Matrix< unsigned int >::setMatrix(), Matrix< unsigned int >::sizePair(), and Matrix< unsigned int >::toGslMatrix().
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:29 using doxygen 1.8.5 |