Struct TypeVector 

pub struct TypeVector { /* private fields */ }

Finite hyper-Catalan type vectors of the form [m2, m3, m4, ...].

Implementations

impl TypeVector

pub fn new(values: Vec<u64>) -> Result<Self, GeodeError>

Creates a validated finite type vector.

The vector must contain at least one component, and the total face count must still fit in u64 so face_count() remains exact.

Errors

Returns GeodeError::EmptyTypeVector when values is empty.

Returns GeodeError::InvalidInput when the total face count would no longer fit in u64.

Examples found in repository

examples/basic_usage.rs (line 4)

fn main() -> Result<(), use_geode::GeodeError> {
    let vector = TypeVector::new(vec![0, 1])?;

    assert_eq!(polygon_edge_count(&vector)?, 4);
    assert_eq!(hyper_catalan(&vector)?, 1);
    assert_eq!(geode_memoized(&vector)?, 3);

    Ok(())
}

pub fn values(&self) -> &[u64]

Returns the underlying component slice.

pub const fn dimension(&self) -> usize

Returns the current dimension of the finite type vector.

pub fn face_count(&self) -> u64

Returns the total face count.

pub fn is_zero(&self) -> bool

Returns whether all components are zero.

pub fn incremented(&self, index: usize) -> Result<Self, GeodeError>

Returns a copy with one checked increment at index.

Errors

Returns GeodeError::IndexOutOfBounds when index is not present.

Returns GeodeError::ArithmeticOverflow when incrementing the chosen component would overflow u64.

Returns GeodeError::InvalidInput when the resulting total face count no longer fits in u64.

pub fn decremented(&self, index: usize) -> Result<Option<Self>, GeodeError>

Returns a copy with one decrement at index, or None when already zero.

Errors

Returns GeodeError::IndexOutOfBounds when index is not present.

Returns GeodeError::InvalidInput when the resulting total face count no longer fits in u64.

pub fn trimmed(&self) -> Self

Removes trailing zeroes while keeping at least one component.

Trait Implementations

impl Clone for TypeVector

fn clone(&self) -> TypeVector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeVector

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

Formats the value using the given formatter.

impl Hash for TypeVector

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 PartialEq for TypeVector

fn eq(&self, other: &TypeVector) -> 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 Eq for TypeVector

impl StructuralPartialEq for TypeVector