Struct Point 

pub struct Point { /* private fields */ }

A point in dimensional space

Implementations

impl Point

pub fn new(dims: Vec<f32>) -> Self

Create a new point from a vector of dimensions

Example

use arms::Point;
let p = Point::new(vec![1.0, 2.0, 3.0]);
assert_eq!(p.dimensionality(), 3);

pub fn origin(dims: usize) -> Self

Create an origin point (all zeros) of given dimensionality

Example

use arms::Point;
let origin = Point::origin(768);
assert_eq!(origin.dimensionality(), 768);
assert!(origin.dims().iter().all(|&x| x == 0.0));

pub fn dimensionality(&self) -> usize

Get the dimensionality of this point

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

Access the dimensions as a slice

pub fn dims_mut(&mut self) -> &mut [f32]

Mutable access to dimensions

pub fn magnitude(&self) -> f32

Calculate the magnitude (L2 norm) of this point

Example

use arms::Point;
let p = Point::new(vec![3.0, 4.0]);
assert!((p.magnitude() - 5.0).abs() < 0.0001);

pub fn is_normalized(&self) -> bool

Check if this point is normalized (magnitude ≈ 1.0)

pub fn normalize(&self) -> Self

Return a normalized copy of this point

If magnitude is zero, returns a clone of self.

Example

use arms::Point;
let p = Point::new(vec![3.0, 4.0]);
let normalized = p.normalize();
assert!(normalized.is_normalized());

pub fn add(&self, other: &Point) -> Self

Add another point to this one (element-wise)

pub fn scale(&self, scalar: f32) -> Self

Scale this point by a scalar

Trait Implementations

impl Clone for Point

fn clone(&self) -> Point

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Point

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

Formats the value using the given formatter.

impl PartialEq for Point

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