tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions > Struct Template Reference

#include <vertex_handle.h>

Inheritance diagram for tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >:

Collaboration diagram for tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >:

Public Member Functions
constexpr	vertex_handle (integral auto const ... is)
template<integral Int>
constexpr	vertex_handle (std::array< Int, num_dimensions()> const &is, std::size_t const plain_index)
constexpr	vertex_handle (std::array< std::size_t, num_dimensions()> const &is, std::size_t const plain_index)
constexpr auto	indices () const -> auto const &
constexpr auto	indices () -> auto &
constexpr auto	index (std::size_t const i) const -> auto const &
constexpr auto	index (std::size_t const i) -> auto &
constexpr auto	plain_index () const -> auto const &
constexpr auto	plain_index () -> auto &
constexpr auto	operator== (vertex_handle const &other) const
constexpr auto	operator!= (vertex_handle const &other) const
constexpr auto	operator< (vertex_handle const &other) const -> bool
constexpr auto	operator<= (vertex_handle const &other) const -> bool
constexpr auto	operator> (vertex_handle const &other) const -> bool
constexpr auto	operator>= (vertex_handle const &other) const -> bool

Static Public Member Functions
static constexpr std::size_t	num_dimensions ()

Private Attributes
std::array< std::size_t, NumDimensions >	m_indices
std::size_t	m_plain_index

Constructor & Destructor Documentation

vertex_handle() [1/3]

template<std::size_t NumDimensions>

constexpr tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::vertex_handle ( integral auto const ...  is )

inlineconstexpr

vertex_handle() [2/3]

template<std::size_t NumDimensions>

template<integral Int>

constexpr tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::vertex_handle ( std::array< Int, num_dimensions()> const &  is, std::size_t const  plain_index  )

inlineconstexpr

vertex_handle() [3/3]

template<std::size_t NumDimensions>

constexpr tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::vertex_handle ( std::array< std::size_t, num_dimensions()> const &  is, std::size_t const  plain_index  )

inlineconstexpr

Member Function Documentation

index() [1/2]

template<std::size_t NumDimensions>

constexpr auto tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::index ( std::size_t const  i ) -> auto&

inlineconstexpr

index() [2/2]

template<std::size_t NumDimensions>

constexpr auto tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::index ( std::size_t const  i ) const -> auto const&

inlineconstexpr

indices() [1/2]

template<std::size_t NumDimensions>

constexpr auto tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::indices ( ) -> auto&

inlineconstexpr

indices() [2/2]

template<std::size_t NumDimensions>

constexpr auto tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::indices ( ) const -> auto const&

inlineconstexpr

num_dimensions()

template<std::size_t NumDimensions>

static constexpr std::size_t tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::num_dimensions ( )

inlinestaticconstexpr

operator!=()

template<std::size_t NumDimensions>

constexpr auto tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::operator!= ( vertex_handle< NumDimensions > const &  other ) const

inlineconstexpr

operator<()

template<std::size_t NumDimensions>

constexpr auto tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::operator< ( vertex_handle< NumDimensions > const &  other ) const -> bool

inlineconstexpr

operator<=()

template<std::size_t NumDimensions>

constexpr auto tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::operator<= ( vertex_handle< NumDimensions > const &  other ) const -> bool

inlineconstexpr

operator==()

template<std::size_t NumDimensions>

constexpr auto tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::operator== ( vertex_handle< NumDimensions > const &  other ) const

inlineconstexpr

operator>()

template<std::size_t NumDimensions>

constexpr auto tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::operator> ( vertex_handle< NumDimensions > const &  other ) const -> bool

inlineconstexpr

operator>=()

template<std::size_t NumDimensions>

constexpr auto tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::operator>= ( vertex_handle< NumDimensions > const &  other ) const -> bool

inlineconstexpr

plain_index() [1/2]

template<std::size_t NumDimensions>

constexpr auto tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::plain_index ( ) -> auto&

inlineconstexpr

plain_index() [2/2]

template<std::size_t NumDimensions>

constexpr auto tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::plain_index ( ) const -> auto const&

inlineconstexpr

Member Data Documentation

m_indices

template<std::size_t NumDimensions>

std::array<std::size_t, NumDimensions> tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::m_indices

private

m_plain_index

template<std::size_t NumDimensions>

std::size_t tatooine::detail::rectilinear_grid::vertex_handle< NumDimensions >::m_plain_index

private

---

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

• /mnt/data/home/ci/builds/Bicifxyn/0/libs/tatooine2/geometry/include/tatooine/detail/rectilinear_grid/vertex_handle.h