seqan3::detail::column_index_type< index_type > Struct Template Reference

A strong type for designated initialisation of the column index of a matrix. More...

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

Inheritance diagram for seqan3::detail::column_index_type< index_type >:

Related Symbols
(Note that these are not member symbols.)
Type deduction guides
template<std::signed_integral index_type>
	column_index_type (index_type) -> column_index_type< std::ptrdiff_t >
	Deduces an signed integral type to std::ptrdiff_t.
template<std::unsigned_integral index_type>
	column_index_type (index_type) -> column_index_type< size_t >
	Deduces an unsigned integral type to size_t.
template<simd_index index_type>
	column_index_type (index_type) -> column_index_type< index_type >
	Deduces the template argument from a simd vector index type.

Additional Inherited Members
Public Types inherited from seqan3::detail::strong_type< index_type, column_index_type< index_type > >
using	value_type = index_type
	The underlying value type.
Public Member Functions inherited from seqan3::detail::strong_type< index_type, column_index_type< index_type > >
constexpr	strong_type () noexcept=default
	Defaulted.
constexpr	strong_type (strong_type const &) noexcept=default
	Defaulted.
constexpr	strong_type (strong_type &&) noexcept=default
	Defaulted.
constexpr	strong_type (index_type _value)
	Construction from underlying value type.
constexpr strong_type &	operator= (strong_type const &) noexcept=default
	Defaulted.
constexpr strong_type &	operator= (strong_type &&) noexcept=default
	Defaulted.
	~strong_type () noexcept=default
	Defaulted.
constexpr index_type &	get () &noexcept
	Returns the underlying value.
constexpr index_type const &	get () const &noexcept
	Returns the underlying value.
constexpr index_type &&	get () &&noexcept
	Returns the underlying value as rvalue.
constexpr index_type const &&	get () const &&noexcept
	Returns the underlying value as rvalue.
constexpr column_index_type< index_type >	operator+ (strong_type const &other)
	Adds addition operator to the strong type.
constexpr column_index_type< index_type >	operator- (strong_type const &other)
	Adds subtraction operator to the strong type.
constexpr column_index_type< index_type >	operator* (strong_type const &other)
	Adds multiplication operator to the strong type.
constexpr column_index_type< index_type >	operator/ (strong_type const &other)
	Adds division operator to the strong type.
constexpr column_index_type< index_type >	operator% (strong_type const &other)
	Adds modulo operator to the strong type.
constexpr column_index_type< index_type >	operator& (strong_type const &other)
	Adds bitwise and operator to the strong type.
constexpr column_index_type< index_type >	operator| (strong_type const &other)
	Adds bitwise or operator to the strong type.
constexpr column_index_type< index_type >	operator^ (strong_type const &other)
	Adds bitwise xor operator to the strong type.
constexpr column_index_type< index_type >	operator~ ()
	Adds bitwise not operator to the strong type.
constexpr column_index_type< index_type >	operator<< (strong_type const &other)
	Adds bitwise left shift operator to the strong type.
constexpr column_index_type< index_type >	operator<< (integral_t const shift)
	Adds bitwise left shift operator to the strong type.
constexpr column_index_type< index_type >	operator>> (strong_type const &other)
	Adds bitwise right shift operator to the strong type.
constexpr column_index_type< index_type >	operator>> (integral_t const shift)
	Adds bitwise right shift operator to the strong type.
constexpr bool	operator&& (strong_type const &other)
	Adds logical and operator to the strong type.
constexpr bool	operator|| (strong_type const &other)
	Adds logical or operator to the strong type.
constexpr bool	operator! ()
	Adds logical not operator to the strong type.
constexpr column_index_type< index_type > &	operator++ ()
	Adds pre-increment operator to the strong type.
constexpr column_index_type< index_type >	operator++ (int)
	Adds post-increment operator to the strong type.
constexpr column_index_type< index_type > &	operator-- ()
	Adds pre-decrement operator to the strong type.
constexpr column_index_type< index_type >	operator-- (int)
	Adds post-decrement operator to the strong type.
constexpr bool	operator== (strong_type const &rhs) const
	Return whether this instance is equal to rhs.
constexpr bool	operator!= (strong_type const &rhs) const
	Return whether this instance is not equal to rhs.
constexpr	operator index_type () const
	Adds explicit conversion to it's underlying type.
Static Public Attributes inherited from seqan3::detail::strong_type< index_type, column_index_type< index_type > >
static constexpr strong_type_skill	skills
	The selected skills for this type.

Detailed Description

template<typename index_type>
requires (std::integral<index_type> || simd_index<index_type>)
struct seqan3::detail::column_index_type< index_type >

A strong type for designated initialisation of the column index of a matrix.

Template Parameters

index_type

The type of the index to store; must model seqan3::arithmetic or seqan3::simd::simd_index.

---

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

• matrix_coordinate.hpp