Defines the requirements of a matrix (e.g. score matrices, trace matrices).
More...
#include <seqan3/alignment/matrix/detail/matrix_concept.hpp>
|
(Note that these are not member functions.)
|
|
You can expect these members on all types that implement seqan3::detail::matrix.
|
typedef IMPLEMENTATION_DEFINED | value_type |
| The type of an entry in the matrix.
|
|
typedef IMPLEMENTATION_DEFINED | reference |
| The type of a reference to an entry in the matrix.
|
|
typedef IMPLEMENTATION_DEFINED | size_type |
| The size type of the matrix.
|
|
size_type | cols () const noexcept |
| The number of columns in the matrix. More...
|
|
size_type | rows () const noexcept |
| The number of rows in the matrix. More...
|
|
reference | at (matrix_coordinate coordinate) noexcept |
| A reference to the entry of the matrix at the given coordinate.
|
|
|
template<matrix matrix1_t, matrix matrix2_t> |
bool | operator== (matrix1_t const &lhs, matrix2_t const &rhs) noexcept |
| Whether two alignment matrices are equal. More...
|
|
template<matrix matrix1_t, matrix matrix2_t> |
bool | operator!= (matrix1_t const &lhs, matrix2_t const &rhs) noexcept |
| Whether two alignment matrices are equal. More...
|
|
Defines the requirements of a matrix (e.g. score matrices, trace matrices).
- Template Parameters
-
matrix_t | The type the concept check is performed on (the putative matrix). |
◆ cols()
◆ operator!=()
bool operator!= |
( |
matrix1_t const & |
lhs, |
|
|
matrix2_t const & |
rhs |
|
) |
| |
|
related |
Whether two alignment matrices are equal.
- Template Parameters
-
matrix1_t | The type of the left hand side matrix. |
matrix2_t | The type of the right hand side matrix. |
- Parameters
-
[in] | lhs | Compare the left hand side matrix |
[in] | rhs | with the right hand side matrix. |
◆ operator==()
bool operator== |
( |
matrix1_t const & |
lhs, |
|
|
matrix2_t const & |
rhs |
|
) |
| |
|
related |
Whether two alignment matrices are equal.
- Template Parameters
-
matrix1_t | The type of the left hand side matrix. |
matrix2_t | The type of the right hand side matrix. |
- Parameters
-
[in] | lhs | Compare the left hand side matrix |
[in] | rhs | with the right hand side matrix. |
◆ rows()
The documentation for this interface was generated from the following file: