ice::nindex Struct Reference

#include <ice/types/nindex.hxx>

Inheritance diagram for ice::nindex:

Public Types
using	base_type
using	base_signed_type
Public Types inherited from ice::nvalue
using	base_type = ice::detail::nvalue_base_utype
using	base_signed_type = ice::detail::nvalue_base_stype

Public Member Functions
constexpr auto	offset (this nindex self) noexcept -> ice::isize
constexpr	nindex () noexcept=default
constexpr	nindex (nvalue value) noexcept
constexpr	nindex (base_type value) noexcept
constexpr	nindex (base_type value, base_type width) noexcept
constexpr bool	operator== (this ncount self, nindex_invalid_t) noexcept
template<typename Self>
constexpr bool	operator== (this Self self, ice::concepts::NValueCompatibleType auto other) noexcept
Public Member Functions inherited from ice::nvalue
template<typename Self>
constexpr bool	is_valid (this Self self) noexcept
template<typename Self>
constexpr auto	value_or (this Self self, ice::concepts::NValueCompatibleType auto fallback) noexcept
template<typename Self>
constexpr auto	min_value_or (this Self self, ice::concepts::NValueCompatibleType auto other, ice::concepts::NValueCompatibleType auto fallback) noexcept
constexpr auto	native () const noexcept
constexpr auto	internal () const noexcept
constexpr auto	u8 () const noexcept
constexpr auto	u16 () const noexcept
constexpr auto	u32 () const noexcept
constexpr auto	u64 () const noexcept
constexpr	operator base_type (this nvalue self) noexcept
template<typename Self>
constexpr bool	operator== (this Self self, ice::concepts::NValueCompatibleType auto other) noexcept
template<typename Self>
constexpr auto	operator<=> (this Self self, ice::concepts::NValueCompatibleType auto other) noexcept -> std::strong_ordering
template<typename Self>
constexpr auto	operator++ (this Self &self) noexcept -> Self &
template<typename Self>
constexpr auto	operator++ (this Self &self, int) noexcept -> Self
template<typename Self>
constexpr auto	operator-- (this Self &self) noexcept -> Self &
template<typename Self>
constexpr auto	operator-- (this Self &self, int) noexcept -> Self
template<typename Self>
constexpr auto	operator+ (this Self self, ice::concepts::NValueCompatibleType auto other) noexcept -> Self
template<typename Self>
constexpr auto	operator- (this Self self, ice::concepts::NValueCompatibleType auto other) noexcept -> Self
template<typename Self>
constexpr auto	operator* (this Self self, ice::concepts::NValueCompatibleType auto other) noexcept -> Self
template<typename Self>
constexpr auto	operator/ (this Self self, ice::concepts::NValueCompatibleType auto other) noexcept -> Self
template<typename Self>
constexpr auto	operator+= (this Self &self, ice::concepts::NValueCompatibleType auto other) noexcept -> Self &
template<typename Self>
constexpr auto	operator-= (this Self &self, ice::concepts::NValueCompatibleType auto other) noexcept -> Self &
template<typename Self>
constexpr auto	operator*= (this Self &self, ice::concepts::NValueCompatibleType auto other) noexcept -> Self &
template<typename Self>
constexpr auto	operator/= (this Self &self, ice::concepts::NValueCompatibleType auto other) noexcept -> Self &

Additional Inherited Members
Public Attributes inherited from ice::nvalue
ice::detail::nvalue_base_utype _width	ICE_NVALUE_WIDTH_FIELD_BITS
ice::detail::nvalue_base_stype _value	ICE_NVALUE_VALUE_FIELD_BITS

Member Typedef Documentation

base_signed_type

using ice::nvalue::base_signed_type

base_type

using ice::nvalue::base_type

Constructor & Destructor Documentation

nindex() [1/4]

ice::nindex::nindex ( )

constexprdefaultnoexcept

nindex() [2/4]

ice::nindex::nindex ( nvalue value )

inlineconstexprnoexcept

nindex() [3/4]

ice::nindex::nindex ( base_type value )

inlineconstexprnoexcept

nindex() [4/4]

ice::nindex::nindex ( base_type value, base_type width )

inlineconstexprnoexcept

Member Function Documentation

offset()

auto ice::nindex::offset ( this nindex self ) -> ice::isize

inlineconstexprnoexcept

operator==() [1/2]

bool ice::nindex::operator== ( this ncount self, nindex_invalid_t  )

inlineconstexprnoexcept

operator==() [2/2]

template<typename Self>

bool ice::nvalue::operator== ( this Self self, ice::concepts::NValueCompatibleType auto other )

inlineconstexprnoexcept

---

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

• collections/public/ice/types/nindex.hxx