Struct CanonicalVector 

pub struct CanonicalVector { /* private fields */ }

A validated, dimension-checked vector of f32 values in canonical form.

Stored as authoritative entity state. Dimension is fixed at construction and matches the contract-declared VectorDimension.

Canonical form

Every construction path (constructor and canonical decoder) enforces one canonical form: all components are finite, and negative zero is canonicalized to positive zero. Within that domain IEEE f32 equality, bitwise comparison, and bitwise hashing all agree, so the derived PartialEq, the bitwise Hash/Ord below, and the durable canonical digest are mutually consistent (a == b implies digest(a) == digest(b)). This discipline is what makes vectors a safe exception to the no-business-floats rule in this crate.

Implementations

impl CanonicalVector

pub fn new(components: Vec<f32>) -> Result<Self, CanonicalVectorError>

Creates a vector from components, enforcing canonical form.

Rejects an empty or over-MAX_VECTOR_DIMENSION component list and any NaN or infinite component as typed errors; canonicalizes -0.0 to +0.0.

pub fn dimension(&self) -> u32

The number of components (the dimension).

pub fn components(&self) -> &[f32]

The raw f32 components.

pub fn into_components(self) -> Vec<f32>

Consumes self and returns the owned components.

pub fn byte_size(&self) -> usize

Byte size for budget accounting (4 bytes per f32 component).

Trait Implementations

impl Clone for CanonicalVector

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanonicalVector

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

Formats the value using the given formatter.

impl Eq for CanonicalVector

impl Hash for CanonicalVector

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 CanonicalVector

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for CanonicalVector

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CanonicalVector

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for CanonicalVector