mdds
|
#include <multi_type_matrix.hpp>
Classes | |
struct | element_block_node_type |
struct | size_pair_type |
Public Types | |
typedef matrix_trait::string_element_block | string_block_type |
typedef matrix_trait::integer_element_block | integer_block_type |
typedef string_block_type::value_type | string_type |
typedef integer_block_type::value_type | integer_type |
typedef size_t | size_type |
typedef store_type::position_type | position_type |
typedef store_type::const_position_type | const_position_type |
typedef store_type::element_block_type | element_block_type |
typedef mtv::boolean_element_block | boolean_block_type |
typedef mtv::numeric_element_block | numeric_block_type |
Public Member Functions | |
multi_type_matrix () | |
multi_type_matrix (size_type rows, size_type cols) | |
template<typename _T > | |
multi_type_matrix (size_type rows, size_type cols, const _T &value) | |
template<typename _T > | |
multi_type_matrix (size_type rows, size_type cols, const _T &it_begin, const _T &it_end) | |
multi_type_matrix (const multi_type_matrix &r) | |
~multi_type_matrix () | |
bool | operator== (const multi_type_matrix &other) const |
bool | operator!= (const multi_type_matrix &other) const |
multi_type_matrix & | operator= (const multi_type_matrix &r) |
position_type | position (size_type row, size_type col) |
position_type | position (const position_type &pos_hint, size_type row, size_type col) |
const_position_type | position (size_type row, size_type col) const |
const_position_type | position (const const_position_type &pos_hint, size_type row, size_type col) const |
size_pair_type | matrix_position (const const_position_type &pos) const |
position_type | end_position () |
const_position_type | end_position () const |
mtm::element_t | get_type (const const_position_type &pos) const |
mtm::element_t | get_type (size_type row, size_type col) const |
double | get_numeric (size_type row, size_type col) const |
double | get_numeric (const const_position_type &pos) const |
integer_type | get_integer (size_type row, size_type col) const |
integer_type | get_integer (const const_position_type &pos) const |
bool | get_boolean (size_type row, size_type col) const |
bool | get_boolean (const const_position_type &pos) const |
const string_type & | get_string (size_type row, size_type col) const |
const string_type & | get_string (const const_position_type &pos) const |
template<typename _T > | |
_T | get (size_type row, size_type col) const |
void | set_empty (size_type row, size_type col) |
void | set_empty (size_type row, size_type col, size_type length) |
position_type | set_empty (const position_type &pos) |
void | set_column_empty (size_type col) |
void | set_row_empty (size_type row) |
void | set (size_type row, size_type col, double val) |
position_type | set (const position_type &pos, double val) |
void | set (size_type row, size_type col, bool val) |
position_type | set (const position_type &pos, bool val) |
void | set (size_type row, size_type col, const string_type &str) |
position_type | set (const position_type &pos, const string_type &str) |
void | set (size_type row, size_type col, integer_type val) |
position_type | set (const position_type &pos, integer_type val) |
template<typename _T > | |
void | set (size_type row, size_type col, const _T &it_begin, const _T &it_end) |
template<typename _T > | |
position_type | set (const position_type &pos, const _T &it_begin, const _T &it_end) |
template<typename _T > | |
void | set_column (size_type col, const _T &it_begin, const _T &it_end) |
size_pair_type | size () const |
multi_type_matrix & | transpose () |
void | copy (const multi_type_matrix &src) |
template<typename _T > | |
void | copy (size_type rows, size_type cols, const _T &it_begin, const _T &it_end) |
void | resize (size_type rows, size_type cols) |
template<typename _T > | |
void | resize (size_type rows, size_type cols, const _T &value) |
void | clear () |
bool | numeric () const |
bool | empty () const |
void | swap (multi_type_matrix &r) |
template<typename _Func > | |
_Func | walk (_Func func) const |
template<typename _Func > | |
_Func | walk (_Func func, const size_pair_type &start, const size_pair_type &end) const |
template<typename _Func > | |
_Func | walk (_Func func, const multi_type_matrix &right) const |
template<typename _Func > | |
_Func | walk (_Func func, const multi_type_matrix &right, const size_pair_type &start, const size_pair_type &end) const |
Static Public Member Functions | |
static mtm::element_t | to_mtm_type (mdds::mtv::element_t mtv_type) |
static position_type | next_position (const position_type &pos) |
static const_position_type | next_position (const const_position_type &pos) |
Matrix that can store numeric, integer, boolean, empty and string types. The string and integer types can be specified in the matrix trait template parameter. To use std::string as the string type and int as the integer type, use mdds::mtm::std_string_trait.
mdds::multi_type_matrix< _MtxTrait >::multi_type_matrix | ( | ) |
Default constructor.
mdds::multi_type_matrix< _MtxTrait >::multi_type_matrix | ( | size_type | rows, |
size_type | cols | ||
) |
Construct a matrix of specified size.
rows | size of rows. |
cols | size of columns. |
mdds::multi_type_matrix< _MtxTrait >::multi_type_matrix | ( | size_type | rows, |
size_type | cols, | ||
const _T & | value | ||
) |
Construct a matrix of specified size and initialize all its elements with specified value.
rows | size of rows. |
cols | size of columns. |
value | value to initialize all its elements with. |
mdds::multi_type_matrix< _MtxTrait >::multi_type_matrix | ( | size_type | rows, |
size_type | cols, | ||
const _T & | it_begin, | ||
const _T & | it_end | ||
) |
Construct a matrix of specified size and initialize its elements with specified values.
rows | size of rows. |
cols | size of columns. |
it_begin | iterator that points to the value of the first element. |
it_end | iterator that points to the position after the last element value. |
mdds::multi_type_matrix< _MtxTrait >::multi_type_matrix | ( | const multi_type_matrix< _MtxTrait > & | r | ) |
Copy constructor.
mdds::multi_type_matrix< _MtxTrait >::~multi_type_matrix | ( | ) |
Destructor.
void mdds::multi_type_matrix< _MtxTrait >::clear | ( | ) |
Empty the matrix.
void mdds::multi_type_matrix< _MtxTrait >::copy | ( | const multi_type_matrix< _MtxTrait > & | src | ) |
Copy values from the passed matrix instance. If the size of the passed matrix is smaller, then the element values are copied by their positions, while the rest of the elements that fall outside the size of the passed matrix instance will remain unmodified. If the size of the passed matrix instance is larger, then only the elements within the size of this matrix instance will get copied.
src | passed matrix object to copy element values from. |
void mdds::multi_type_matrix< _MtxTrait >::copy | ( | size_type | rows, |
size_type | cols, | ||
const _T & | it_begin, | ||
const _T & | it_end | ||
) |
Copy values from an array or array-like container, to a specified sub-matrix range. The length of the array must match the number of elements in the destination range, else it will throw a mdds::size_error.
rows | row size of the destination range. |
cols | column size of the destination range. |
it_begin | iterator pointing to the beginning of the input array. |
it_end | iterator pointing to the end position of the input array. |
bool mdds::multi_type_matrix< _MtxTrait >::empty | ( | ) | const |
Check whether or not this matrix is empty.
position_type mdds::multi_type_matrix< _MtxTrait >::end_position | ( | ) |
Return a position type that represents an end position. This can be used to compare with another position object to see if it is past the last element position.
const_position_type mdds::multi_type_matrix< _MtxTrait >::end_position | ( | ) | const |
Return a position type that represents an end position. This can be used to compare with another position object to see if it is past the last element position.
_T mdds::multi_type_matrix< _MtxTrait >::get | ( | size_type | row, |
size_type | col | ||
) | const |
Get the value of element at specified position. The caller must explicitly specify the return type. If the element is not of the specified type, it throws an exception.
row | row position of the element. |
col | column position of the element. |
bool mdds::multi_type_matrix< _MtxTrait >::get_boolean | ( | size_type | row, |
size_type | col | ||
) | const |
Get a boolean representation of the element. If the element is of numeric type, true is returned if it's non-zero, otherwise false is returned. If it's of boolean type, its value is returned. If it's of empty or string type, false is returned.
row | row position of the element. |
col | column position of the element. |
bool mdds::multi_type_matrix< _MtxTrait >::get_boolean | ( | const const_position_type & | pos | ) | const |
Get a boolean representation of the element from a position object. If the element is of numeric type, true is returned if it's non-zero, otherwise false is returned. If it's of boolean type, its value is returned. If it's of empty or string type, false is returned.
pos | position object of an element |
integer_type mdds::multi_type_matrix< _MtxTrait >::get_integer | ( | size_type | row, |
size_type | col | ||
) | const |
Get an integer representation of the element. If the element is of integer type, its value is returned. If it's of boolean type, either 1 or 0 is returned depending on whether it's true or false. If it's of empty or string type, 0 is returned.
row | row position of the element. |
col | column position of the element. |
integer_type mdds::multi_type_matrix< _MtxTrait >::get_integer | ( | const const_position_type & | pos | ) | const |
Get an integer representation of the element. If the element is of integer type, its value is returned. If it's of boolean type, either 1 or 0 is returned depending on whether it's true or false. If it's of empty or string type, 0 is returned.
pos | position object of an element |
double mdds::multi_type_matrix< _MtxTrait >::get_numeric | ( | size_type | row, |
size_type | col | ||
) | const |
Get a numeric representation of the element. If the element is of numeric type, its value is returned. If it's of boolean type, either 1 or 0 is returned depending on whether it's true or false. If it's of empty or string type, 0 is returned.
row | row position of the element. |
col | column position of the element. |
double mdds::multi_type_matrix< _MtxTrait >::get_numeric | ( | const const_position_type & | pos | ) | const |
Get a numeric representation of the element from a position object. If the element is of numeric type, its value is returned. If it's of boolean type, either 1 or 0 is returned depending on whether it's true or false. If it's of empty or string type, 0 is returned.
pos | position object of an element |
const string_type& mdds::multi_type_matrix< _MtxTrait >::get_string | ( | size_type | row, |
size_type | col | ||
) | const |
Get the value of a string element. If the element is not of string type, it throws an exception.
row | row position of the element. |
col | column position of the element. |
const string_type& mdds::multi_type_matrix< _MtxTrait >::get_string | ( | const const_position_type & | pos | ) | const |
Get the value of a string element from a position object. If the element is not of string type, it throws an exception.
pos | position object of an element |
mtm::element_t mdds::multi_type_matrix< _MtxTrait >::get_type | ( | const const_position_type & | pos | ) | const |
Get the type of element from a position object. The type can be one of empty, string, numeric, or boolean.
pos | position object of an element |
mtm::element_t mdds::multi_type_matrix< _MtxTrait >::get_type | ( | size_type | row, |
size_type | col | ||
) | const |
Get the type of element specified by its position. The type can be one of empty, string, numeric, or boolean.
size_pair_type mdds::multi_type_matrix< _MtxTrait >::matrix_position | ( | const const_position_type & | pos | ) | const |
Get the row and column positions of the current element from a position object.
pos | position object. |
|
static |
Move to the next logical position. The movement is in the top-to-bottom then left-to-right direction.
pos | position object. |
|
static |
Move to the next logical position. The movement is in the top-to-bottom then left-to-right direction.
pos | position object. |
bool mdds::multi_type_matrix< _MtxTrait >::numeric | ( | ) | const |
Check whether or not this matrix is numeric. A numeric matrix contains only numeric or boolean elements. An empty matrix is not numeric.
position_type mdds::multi_type_matrix< _MtxTrait >::position | ( | size_type | row, |
size_type | col | ||
) |
Get a mutable reference of an element (position object) at specified position. The position object can then be passed to an additional method to get the type or value of the element it references, or set a new value to it.
row | row position of the referenced element. |
col | column position of the referenced element. |
position_type mdds::multi_type_matrix< _MtxTrait >::position | ( | const position_type & | pos_hint, |
size_type | row, | ||
size_type | col | ||
) |
Get a mutable reference of an element (position object) at specified position. The position object can then be passed to an additional method to get the type or value of the element it references, or set a new value to it.
pos_hint | position object to be used as a position hint for faster lookup. |
row | row position of the referenced element. |
col | column position of the referenced element. |
const_position_type mdds::multi_type_matrix< _MtxTrait >::position | ( | size_type | row, |
size_type | col | ||
) | const |
Get an immutable reference of an element (position object) at specified position. The position object can then be passed to an additional method to get the type or value of the element it references.
row | row position of the referenced element. |
col | column position of the referenced element. |
const_position_type mdds::multi_type_matrix< _MtxTrait >::position | ( | const const_position_type & | pos_hint, |
size_type | row, | ||
size_type | col | ||
) | const |
Get an immutable reference of an element (position object) at specified position. The position object can then be passed to an additional method to get the type or value of the element it references.
pos_hint | position object to be used as a position hint for faster lookup. |
row | row position of the referenced element. |
col | column position of the referenced element. |
void mdds::multi_type_matrix< _MtxTrait >::resize | ( | size_type | rows, |
size_type | cols | ||
) |
Resize the matrix to specified size. This method supports resizing to zero-sized matrix; however, either specifying the row or column size to zero will resize the matrix to 0 x 0. When resizing the matrix larger, empty elements will be inserted in the region where no existing elements exist.
rows | new row size |
cols | new column size |
void mdds::multi_type_matrix< _MtxTrait >::resize | ( | size_type | rows, |
size_type | cols, | ||
const _T & | value | ||
) |
Resize the matrix to specified size and initial value. The initial value will be applied to new elements created when the specified size is larger than the current one.
rows | new row size |
cols | new column size |
value | initial value for new elements |
void mdds::multi_type_matrix< _MtxTrait >::set | ( | size_type | row, |
size_type | col, | ||
double | val | ||
) |
Set a numeric value to an element at specified position.
row | row index of the element. |
col | column index of the element. |
val | new value to set. |
position_type mdds::multi_type_matrix< _MtxTrait >::set | ( | const position_type & | pos, |
double | val | ||
) |
Set a numeric value to an element at specified position.
pos | position of the element to update. |
val | new value to set. |
void mdds::multi_type_matrix< _MtxTrait >::set | ( | size_type | row, |
size_type | col, | ||
bool | val | ||
) |
Set a boolean value to an element at specified position.
row | row index of the element. |
col | column index of the element. |
val | new value to set. |
position_type mdds::multi_type_matrix< _MtxTrait >::set | ( | const position_type & | pos, |
bool | val | ||
) |
Set a boolean value to an element at specified position.
pos | position of the element to update. |
val | new value to set. |
void mdds::multi_type_matrix< _MtxTrait >::set | ( | size_type | row, |
size_type | col, | ||
const string_type & | str | ||
) |
Set a string value to an element at specified position.
row | row index of the element. |
col | column index of the element. |
val | new value to set. |
position_type mdds::multi_type_matrix< _MtxTrait >::set | ( | const position_type & | pos, |
const string_type & | str | ||
) |
Set a string value to an element at specified position.
pos | position of the element to update. |
val | new value to set. |
void mdds::multi_type_matrix< _MtxTrait >::set | ( | size_type | row, |
size_type | col, | ||
integer_type | val | ||
) |
Set an integer value to an element at specified position.
row | row index of the element. |
col | column index of the element. |
val | new value to set. |
position_type mdds::multi_type_matrix< _MtxTrait >::set | ( | const position_type & | pos, |
integer_type | val | ||
) |
Set an integer value to an element at specified position.
pos | position of the element to update. |
val | new value to set. |
void mdds::multi_type_matrix< _MtxTrait >::set | ( | size_type | row, |
size_type | col, | ||
const _T & | it_begin, | ||
const _T & | it_end | ||
) |
Set values of multiple elements at once, starting at specified element position following the direction of columns. When the new value series does not fit in the first column, it gets wrapped into the next column(s).
The method will throw an std::out_of_range
exception if the specified position is outside the current container range.
row | row position of the start element. |
col | column position of the start element. |
it_begin | iterator that points to the begin position of the values being set. |
it_end | iterator that points to the end position of the values being set. |
position_type mdds::multi_type_matrix< _MtxTrait >::set | ( | const position_type & | pos, |
const _T & | it_begin, | ||
const _T & | it_end | ||
) |
Set values of multiple elements at once, starting at specified element position following the direction of columns. When the new value series does not fit in the first column, it gets wrapped into the next column(s).
pos | position of the first element. |
it_begin | iterator that points to the begin position of the values being set. |
it_end | iterator that points to the end position of the values being set. |
void mdds::multi_type_matrix< _MtxTrait >::set_column | ( | size_type | col, |
const _T & | it_begin, | ||
const _T & | it_end | ||
) |
Set values of multiple elements at once in a single column. When the length of passed elements exceeds that of the column, it gets truncated to the column size.
col | column position |
it_begin | iterator that points to the begin position of the values being set. |
it_end | iterator that points to the end position of the values being set. |
void mdds::multi_type_matrix< _MtxTrait >::set_column_empty | ( | size_type | col | ) |
Set the entire column empty.
col | index of the column to empty. |
void mdds::multi_type_matrix< _MtxTrait >::set_empty | ( | size_type | row, |
size_type | col | ||
) |
Set specified element position empty.
row | row position of the element. |
col | column position of the element. |
void mdds::multi_type_matrix< _MtxTrait >::set_empty | ( | size_type | row, |
size_type | col, | ||
size_type | length | ||
) |
Set specified range of elements empty.
row | row position of the first element. |
col | column position of the first element. |
length | length of the range to set empty. |
position_type mdds::multi_type_matrix< _MtxTrait >::set_empty | ( | const position_type & | pos | ) |
Set element referenced by the position object empty.
pos | position object that references element. |
void mdds::multi_type_matrix< _MtxTrait >::set_row_empty | ( | size_type | row | ) |
Set the entire row empty.
row | index of the row to empty. |
size_pair_type mdds::multi_type_matrix< _MtxTrait >::size | ( | ) | const |
Return the size of matrix as a pair. The first value is the row size, while the second value is the column size.
void mdds::multi_type_matrix< _MtxTrait >::swap | ( | multi_type_matrix< _MtxTrait > & | r | ) |
Swap the content of the matrix with another instance.
multi_type_matrix& mdds::multi_type_matrix< _MtxTrait >::transpose | ( | ) |
Transpose the stored matrix data.
_Func mdds::multi_type_matrix< _MtxTrait >::walk | ( | _Func | func | ) | const |
Walk all element blocks that consist of the matrix.
func | function object whose operator() gets called on each element block. |
_Func mdds::multi_type_matrix< _MtxTrait >::walk | ( | _Func | func, |
const size_pair_type & | start, | ||
const size_pair_type & | end | ||
) | const |
Walk through the element blocks in a sub-matrix range defined by start and end positions passed to this method.
func | function object whose operator() gets called on the element block. |
start | the column/row position of the upper-left corner of the sub-matrix. |
end | the column/row position of the lower-right corner of the sub-matrix. Both column and row must be greater or equal to those of the start position. |
_Func mdds::multi_type_matrix< _MtxTrait >::walk | ( | _Func | func, |
const multi_type_matrix< _MtxTrait > & | right | ||
) | const |
Walk through all element blocks in parallel with another matrix instance. It stops at the block boundaries of both matrix instances during the walk.
func | function object whose operator() gets called on each element block. |
right | another matrix instance to parallel-walk with. |
_Func mdds::multi_type_matrix< _MtxTrait >::walk | ( | _Func | func, |
const multi_type_matrix< _MtxTrait > & | right, | ||
const size_pair_type & | start, | ||
const size_pair_type & | end | ||
) | const |
Walk through the element blocks in a sub-matrix range in parallel with another matrix instance. It stops at the block boundaries of both matrix instances during the walk. The sub-matrix range is defined by start and end positions passed to this method.
func | function object whose operator() gets called on each element block. |
right | another matrix instance to parallel-walk with. |
start | the column/row position of the upper-left corner of the sub-matrix. |
end | the column/row position of the lower-right corner of the sub-matrix. Both column and row must be greater or equal to those of the start position. |