Struct dapol::Height

pub struct Height(/* private fields */);

Abstraction for the height of the tree.

Example:

use dapol::Height;
use std::str::FromStr;

let height = Height::default();
let height = Height::expect_from(8u8);
let height = Height::from_str("8");

Implementations

impl Height

pub fn expect_from(int: u8) -> Self

Create a Height object from int.

panics if int is greater than MAX_HEIGHT or less than MIN_HEIGHT.

Note that if we try to implement the From trait then we have a collision.

pub fn from_y_coord(y_coord: u8) -> Self

Return the height for the given y-coord.

Why the offset? y starts from 0 but height starts from 1. See [crate][binary_tree][Coordinate] for more details.

pub fn as_y_coord(&self) -> u8

Return the y-coord for the given height.

Why the offset? y starts from 0 but height starts from 1. See [crate][binary_tree][Coordinate] for more details.

pub fn as_u8(&self) -> u8

Return the underlying integer value.

pub fn as_usize(&self) -> usize

Return the underlying integer value as type usize.

pub fn as_u32(&self) -> u32

Return the underlying integer value as type u32.

pub fn as_u64(&self) -> u64

Return the underlying integer value as type u64.

pub fn as_f64(&self) -> f64

Return the underlying integer value as type f64.

pub fn max_bottom_layer_nodes(&self) -> u64

The maximum number of leaf nodes on the bottom layer of the binary tree.

$$\text{max} = 2^{\text{height}-1}$$

Trait Implementations

impl Clone for Height

fn clone(&self) -> Height

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Height

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

Formats the value using the given formatter.

impl Default for Height

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Height

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Height> for OsStr

fn from(height: Height) -> OsStr

Converts to this type from the input type.

impl FromStr for Height

fn from_str(s: &str) -> Result<Self, Self::Err>

Constructor that takes in a string slice. If the length of the str is greater than the max then Err is returned.

type Err = HeightError

The associated error which can be returned from parsing.

impl PartialEq for Height

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Height

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Height

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<u8> for Height

Create a Height object from int.

Returns an error if int is greater than MAX_HEIGHT or less than MIN_HEIGHT.

type Error = HeightError

The type returned in the event of a conversion error.

fn try_from(int: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Height

impl StructuralPartialEq for Height