Struct PointN

pub struct PointN<T, const N: usize>(/* private fields */);

Point with dimensions of constant generic size N and of generic type T (Implemented as Newtype Pattern on an array see book or https://www.worthe-it.co.za/blog/2020-10-31-newtype-pattern-in-rust.html) This type only interacts with the library through the point trait, so you are free to use your own Point/Coord/Vec structures instead by implementing the (small) trait

Implementations

impl<T, const N: usize> PointN<T, N>

pub fn new(array: [T; N]) -> Self

Trait Implementations

impl<T, const N: usize> Add<T> for PointN<T, N>

where T: Add<Output = T> + Clone + Copy,

This is not required by the Point trait or library but convenient if you want to use the type externally

type Output = PointN<T, N>

The resulting type after applying the + operator.

fn add(self, _rhs: T) -> PointN<T, N>

Performs the + operation.

impl<T, const N: usize> Add for PointN<T, N>

where T: Add<Output = T> + Clone + Copy,

type Output = PointN<T, N>

The resulting type after applying the + operator.

fn add(self, other: PointN<T, N>) -> PointN<T, N>

Performs the + operation.

impl<T: Clone, const N: usize> Clone for PointN<T, N>

fn clone(&self) -> PointN<T, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const N: usize> Debug for PointN<T, N>

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

Formats the value using the given formatter.

impl<T: Default + Copy, const N: usize> Default for PointN<T, N>

Initialize with the Default value for the underlying type

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T, const N: usize> IntoIterator for &'a mut PointN<T, N>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterMut<'a, T>

Creates an iterator from a value.

impl<T, const N: usize> IntoIterator for PointN<T, N>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<<PointN<T, N> as IntoIterator>::Item, N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T, const N: usize, U> Mul<U> for PointN<T, N>

where T: Mul<U, Output = T> + Clone + Copy, U: Clone + Copy,

type Output = PointN<T, N>

The resulting type after applying the * operator.

fn mul(self, _rhs: U) -> PointN<T, N>

Performs the * operation.

impl<T, const N: usize> PartialEq for PointN<T, N>

where T: PartialOrd,

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

Tests for self and other values to be equal, and is used by ==.

const 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<T, const N: usize> Point for PointN<T, N>

where T: Float + Copy + Default + Add<T, Output = T> + Add<f64, Output = T> + Sub<T, Output = T> + Sub<f64, Output = T> + Mul<T, Output = T> + Mul<f64, Output = T> + Sum<f64> + From<f64> + Into<f64>,

const DIM: usize = { N }

type Scalar = f64

fn axis(&self, index: usize) -> Self::Scalar

Panics if index is greater than implementors dimension

fn squared_length(&self) -> Self::Scalar

impl<T, const N: usize> Sub<T> for PointN<T, N>

where T: Sub<Output = T> + Clone + Copy,

This is not required by the Point trait or library but convenient if you want to use the type externally

type Output = PointN<T, N>

The resulting type after applying the - operator.

fn sub(self, _rhs: T) -> PointN<T, N>

Performs the - operation.

impl<T, const N: usize> Sub for PointN<T, N>

where T: Sub<Output = T> + Clone + Copy,

type Output = PointN<T, N>

The resulting type after applying the - operator.

fn sub(self, other: PointN<T, N>) -> PointN<T, N>

Performs the - operation.

impl<T: Copy, const N: usize> Copy for PointN<T, N>