Struct PartitionID

pub struct PartitionID(pub u32);

represents the hiearchical partition id scheme. The root id has ID 1 and children are shifted to the left by one and plus 0/1. The parent child relationship can thus be queried in constant time.

Tuple Fields

0: u32

Implementations

impl PartitionID

pub fn root() -> PartitionID

Returns the root id

pub fn parent(&self) -> PartitionID

Returns the parent of a given ID. Note that the parent of the root id is always 1

pub fn parent_at_level(&self, level: u32) -> PartitionID

pub fn children(&self) -> (PartitionID, PartitionID)

Returns a left-right ordered tuple of children for a given ID

pub fn left_child(&self) -> PartitionID

Returns the left child of a ID

pub fn right_child(&self) -> PartitionID

Returns the right child of a ID

pub fn make_leftmost_descendant(&mut self, k: usize)

Transform ID to its left-most descendant k levels down

pub fn make_rightmost_descendant(&mut self, k: usize)

Transform ID to its right-most descendant k levels down

pub fn make_left_child(&mut self)

Transform the ID into its left child

pub fn make_right_child(&mut self)

Transform the ID into its right child

pub fn new(id: u32) -> Self

Returns a new PartitionID from an u32

pub fn level(&self) -> u8

The level in this scheme is defined by the the number of leading zeroes.

pub fn is_left_child(&self) -> bool

Returns whether the ID id a left child

pub fn is_right_child(&self) -> bool

Returns whether the ID id a right child

pub fn lowest_common_ancestor(&self, other: &PartitionID) -> PartitionID

pub fn extract_bit(&self, index: usize) -> bool

Trait Implementations

impl Binary for PartitionID

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd for PartitionID

type Output = PartitionID

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr for PartitionID

type Output = PartitionID

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl<'__de, __Context> BorrowDecode<'__de, __Context> for PartitionID

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for PartitionID

fn clone(&self) -> PartitionID

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PartitionID

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for PartitionID

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl Display for PartitionID

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encode for PartitionID

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl From<PartitionID> for usize

fn from(s: PartitionID) -> usize

Converts to this type from the input type.

impl Hash for PartitionID

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PartitionID

fn cmp(&self, other: &PartitionID) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PartitionID

fn eq(&self, other: &PartitionID) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PartitionID

fn partial_cmp(&self, other: &PartitionID) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for PartitionID

impl Eq for PartitionID

impl StructuralPartialEq for PartitionID