Trait vector_space::InnerSpace

pub trait InnerSpace: VectorSpace {
    // Required method
    fn scalar(self, other: Self) -> Self::Scalar;

    // Provided methods
    fn magnitude2(self) -> Self::Scalar { ... }
    fn magnitude(self) -> Self::Scalar { ... }
    fn normalize(self) -> Self { ... }
    fn angle(self, other: Self) -> Self::Scalar { ... }
    fn with_magnitude(self, magnitude: Self::Scalar) -> Self { ... }
    fn with_direction(self, dir: Self) -> Self { ... }
    fn query_axis(self, dir: Self) -> Self::Scalar { ... }
    fn normalized_project(self, dir: Self) -> Self { ... }
    fn project(self, dir: Self) -> Self { ... }
    fn normalized_reject(self, dir: Self) -> Self { ... }
    fn reject(self, dir: Self) -> Self { ... }
    fn normalized_reflect(self, dir: Self) -> Self { ... }
    fn reflect(self, dir: Self) -> Self { ... }
}

This trait defines the scalar product and adds commom vector operations.

Required Methods

fn scalar(self, other: Self) -> Self::Scalar

The scalar product.

Provided Methods

fn magnitude2(self) -> Self::Scalar

The squared magnitude.

This is more efficient than calculating the magnitude. Useful if you need the squared magnitude anyway.

fn magnitude(self) -> Self::Scalar

The magnitude of a vector.

fn normalize(self) -> Self

The normalized vector.

fn angle(self, other: Self) -> Self::Scalar

The angle between two vectors.

fn with_magnitude(self, magnitude: Self::Scalar) -> Self

Sets the magnitude of a vector.

fn with_direction(self, dir: Self) -> Self

Sets the direction of a vector.

fn query_axis(self, dir: Self) -> Self::Scalar

The value of the vector along the specified axis.

fn normalized_project(self, dir: Self) -> Self

Projects a vector onto an already normalized direction vector.

fn project(self, dir: Self) -> Self

Projects a vector onto an arbitraty direction vector.

fn normalized_reject(self, dir: Self) -> Self

Rejects a vector from an already normalized direction vector.

fn reject(self, dir: Self) -> Self

Rejects a vector from an arbitraty direction vector.

fn normalized_reflect(self, dir: Self) -> Self

Reflects a vector from an already normalized direction vector.

fn reflect(self, dir: Self) -> Self

Reflects a vector from an arbitraty direction vector.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl InnerSpace for f32

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

impl InnerSpace for f64

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

Implementors