Skip to main content

Vector

Struct Vector 

Source
pub struct Vector<const D: usize> { /* private fields */ }
Expand description

Finite fixed-size vector of length D, stored inline.

Public construction rejects NaN and infinity through try_new, and the storage field is private, so a Vector value carries the invariant that every stored entry is finite. Algorithms therefore do not re-scan stored entries at every use; user-visible non-finite errors come from construction boundaries or from values computed during arithmetic, such as overflowed accumulators.

Direct field construction is intentionally unavailable to downstream callers:

use la_stack::Vector;

let _ = Vector::<2> {
    data: [1.0, f64::NAN],
};

Implementations§

Source§

impl<const D: usize> Vector<D>

Source

pub const fn try_new(data: [f64; D]) -> Result<Self, LaError>

Try to create a finite vector from a backing array.

This is the public raw-storage boundary for vectors. Successful construction makes the returned Vector a finite-storage proof.

§Examples
use la_stack::prelude::*;

let v = Vector::<3>::try_new([1.0, 2.0, 3.0])?;
assert_eq!(v.into_array(), [1.0, 2.0, 3.0]);
§Errors

Returns LaError::NonFinite with the first offending entry index when data contains NaN or infinity.

Source

pub const fn zero() -> Self

All-zeros finite vector.

§Examples
use la_stack::prelude::*;

let z = Vector::<2>::zero();
assert_eq!(z.into_array(), [0.0, 0.0]);
Source

pub const fn as_array(&self) -> &[f64; D]

Borrow the finite backing array.

§Examples
use la_stack::prelude::*;

let v = Vector::<2>::try_new([1.0, -2.0])?;
assert_eq!(v.as_array(), &[1.0, -2.0]);
Source

pub const fn into_array(self) -> [f64; D]

Consume and return the finite backing array.

§Examples
use la_stack::prelude::*;

let v = Vector::<2>::try_new([1.0, 2.0])?;
let a = v.into_array();
assert_eq!(a, [1.0, 2.0]);
Source

pub const fn dot(self, other: Self) -> Result<f64, LaError>

Dot product.

Terms are accumulated in f64 using f64::mul_add at each index. Intermediate rounding occurs, and this method does not provide a certified absolute rounding bound for the returned dot product. Raw Vector values are finite by construction, so this method only checks whether the accumulation overflows to NaN or infinity.

§Examples
use la_stack::prelude::*;

let a = Vector::<3>::try_new([1.0, 2.0, 3.0])?;
let b = Vector::<3>::try_new([-2.0, 0.5, 4.0])?;
assert!((a.dot(b)? - 11.0).abs() <= 1e-12);
§Errors

Returns LaError::NonFinite when the accumulated dot product overflows to NaN or infinity.

Source

pub const fn norm2_sq(self) -> Result<f64, LaError>

Squared Euclidean norm.

This is computed as dot(self, self), so norm2_sq has the same f64 mul_add accumulation behavior as dot. Intermediate rounding occurs, and this method does not provide a certified absolute rounding bound for the returned squared norm. Vector values are finite by construction, so this method only checks whether the accumulation overflows to NaN or infinity.

§Examples
use la_stack::prelude::*;

let v = Vector::<3>::try_new([1.0, 2.0, 3.0])?;
assert!((v.norm2_sq()? - 14.0).abs() <= 1e-12);
§Errors

Returns LaError::NonFinite when the accumulated norm overflows to NaN or infinity.

Trait Implementations§

Source§

impl<const D: usize> Clone for Vector<D>

Source§

fn clone(&self) -> Vector<D>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<const D: usize> Copy for Vector<D>

Source§

impl<const D: usize> Debug for Vector<D>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<const D: usize> Default for Vector<D>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<const D: usize> PartialEq for Vector<D>

Source§

fn eq(&self, other: &Vector<D>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl<const D: usize> StructuralPartialEq for Vector<D>

Auto Trait Implementations§

§

impl<const D: usize> Freeze for Vector<D>

§

impl<const D: usize> RefUnwindSafe for Vector<D>

§

impl<const D: usize> Send for Vector<D>

§

impl<const D: usize> Sync for Vector<D>

§

impl<const D: usize> Unpin for Vector<D>

§

impl<const D: usize> UnsafeUnpin for Vector<D>

§

impl<const D: usize> UnwindSafe for Vector<D>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.