ufo::TreeIndex Struct Reference

Public Types
using	offset_type = std::uint32_t
using	pos_type = std::uint32_t

Public Member Functions
constexpr	TreeIndex (pos_type pos, offset_type offset) noexcept
constexpr bool	operator!= (TreeIndex rhs) const
constexpr bool	operator== (TreeIndex rhs) const
constexpr TreeIndex	sibling (offset_type offset) const
constexpr bool	valid () const

Public Attributes
offset_type	offset {0}
pos_type	pos {NULL_POS}

Static Public Attributes
static constexpr pos_type const	INVALID_POS = NULL_POS - 2
static constexpr pos_type const	MAX_VALID_POS = INVALID_POS - 1
static constexpr pos_type const	NULL_POS = std::numeric_limits<pos_type>::max()
static constexpr pos_type const	PROCESSING_POS = NULL_POS - 1
static constexpr pos_type const	TYPE_BIT

Friends
void	swap (TreeIndex &lhs, TreeIndex &rhs) noexcept

Detailed Description

Definition at line 54 of file index.hpp.

Member Typedef Documentation

offset_type

using ufo::TreeIndex::offset_type = std::uint32_t

Definition at line 64 of file index.hpp.

pos_type

using ufo::TreeIndex::pos_type = std::uint32_t

Definition at line 63 of file index.hpp.

Constructor & Destructor Documentation

TreeIndex()

constexpr ufo::TreeIndex::TreeIndex ( pos_type  pos, offset_type  offset  )

inlineconstexprnoexcept

Definition at line 78 of file index.hpp.

Member Function Documentation

operator!=()

constexpr bool ufo::TreeIndex::operator!= ( TreeIndex  rhs ) const

inlineconstexpr

Definition at line 94 of file index.hpp.

operator==()

constexpr bool ufo::TreeIndex::operator== ( TreeIndex  rhs ) const

inlineconstexpr

Definition at line 89 of file index.hpp.

sibling()

constexpr TreeIndex ufo::TreeIndex::sibling ( offset_type  offset ) const

inlineconstexpr

Definition at line 96 of file index.hpp.

valid()

constexpr bool ufo::TreeIndex::valid ( ) const

inlineconstexpr

Definition at line 101 of file index.hpp.

Friends And Related Symbol Documentation

swap

void swap ( TreeIndex &  lhs, TreeIndex &  rhs  )

friend

Definition at line 83 of file index.hpp.

Member Data Documentation

INVALID_POS

constexpr pos_type const ufo::TreeIndex::INVALID_POS = NULL_POS - 2

staticconstexpr

Definition at line 70 of file index.hpp.

MAX_VALID_POS

constexpr pos_type const ufo::TreeIndex::MAX_VALID_POS = INVALID_POS - 1

staticconstexpr

Definition at line 71 of file index.hpp.

NULL_POS

constexpr pos_type const ufo::TreeIndex::NULL_POS = std::numeric_limits<pos_type>::max()

staticconstexpr

Definition at line 68 of file index.hpp.

offset

offset_type ufo::TreeIndex::offset {0}

Definition at line 74 of file index.hpp.

pos

pos_type ufo::TreeIndex::pos {NULL_POS}

Definition at line 73 of file index.hpp.

PROCESSING_POS

constexpr pos_type const ufo::TreeIndex::PROCESSING_POS = NULL_POS - 1

staticconstexpr

Definition at line 69 of file index.hpp.

TYPE_BIT

constexpr pos_type const ufo::TreeIndex::TYPE_BIT

staticconstexpr

Initial value:

=
        pos_type(1) << (std::numeric_limits<pos_type>::digits - 1)

Definition at line 66 of file index.hpp.

---

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

• lib/container/include/ufo/container/tree/index.hpp