seqan3::detail::matrix< matrix_t > Interface Template Reference

Defines the requirements of a matrix (e.g. score matrices, trace matrices). More...

#include <seqan3/alignment/matrix/detail/matrix_concept.hpp>

Inheritance diagram for seqan3::detail::matrix< matrix_t >:

Related Symbols
(Note that these are not member symbols.)
Requirements for seqan3::detail::matrix
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.
size_type	rows () const noexcept
	The number of rows in the matrix.
reference	at (matrix_coordinate coordinate) noexcept
	A reference to the entry of the matrix at the given coordinate.
Comparison operators
template<matrix matrix1_t, matrix matrix2_t>
bool	operator== (matrix1_t const &lhs, matrix2_t const &rhs) noexcept
	Whether two alignment matrices are equal.
template<matrix matrix1_t, matrix matrix2_t>
bool	operator!= (matrix1_t const &lhs, matrix2_t const &rhs) noexcept
	Whether two alignment matrices are equal.

Detailed Description

template<typename matrix_t>
interface seqan3::detail::matrix< matrix_t >

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).

Friends And Related Symbol Documentation

cols()

template<typename matrix_t >

size_type cols ( ) const

related

The number of columns in the matrix.

Implemented in seqan3::detail::debug_matrix< matrix_t, first_sequence_t, second_sequence_t >.

operator!=()

template<matrix matrix1_t, matrix matrix2_t>

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==()

template<matrix matrix1_t, matrix matrix2_t>

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()

template<typename matrix_t >

size_type rows ( ) const

related

The number of rows in the matrix.

Implemented in seqan3::detail::debug_matrix< matrix_t, first_sequence_t, second_sequence_t >.

---

The documentation for this interface was generated from the following file:

• matrix_concept.hpp