Struct maria_linalg::Vector

pub struct Vector<const N: usize> { /* private fields */ }

Abstracts over a vector of arbitary dimension.

Implementations

impl<const N: usize> Vector<N>

Implements necessary behaviors of a vector.

pub fn zero() -> Self

Constructs a zero vector.

pub fn new(values: [f64; N]) -> Self

Constructs a vector of provided values.

pub fn basis() -> [Self; N]

Constructs an orthogonal basis of vectors.

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

Scales a vector by a provided scalar, returning the new vector.

pub fn dot(&self, other: Self) -> f64

Dots this vector with another vector.

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

Crosses this vector with another vector.

Note: this is only implemented for Vector<3>. Otherwise, this returns a zero vector.

pub fn norm(&self) -> f64

Takes the norm of a vector.

pub fn mult(&self, matrix: Matrix<N>) -> Self

Left-multiplies the provided matrix by the transpose of this vector, returning the result.

pub fn child(mother: &Self, father: &Self, stdev: f64) -> Self

Given two vectors, generate a “child” vector. This function is useful for genetic optimization algorithms.

pub fn check(&self, lower: [Option<f64>; N], upper: [Option<f64>; N]) -> bool

Determines if this vector is within the element-wise contraints.

Trait Implementations

impl<const N: usize> Add for Vector<N>

type Output = Vector<N>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<const N: usize> Display for Vector<N>

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

Formats the value using the given formatter.

impl<const N: usize> From<[f64; N]> for Vector<N>

fn from(values: [f64; N]) -> Self

Converts to this type from the input type.

impl<const N: usize> Index<usize> for Vector<N>

type Output = f64

The returned type after indexing.

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<const N: usize> IndexMut<usize> for Vector<N>

fn index_mut(&mut self, idx: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const N: usize> Sub for Vector<N>

type Output = Vector<N>

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

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

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