Struct Hyperplane 

pub struct Hyperplane { /* private fields */ }

An n-dimensional hyperplane represented by coefficients.dot(point) + offset = 0.

Implementations

impl Hyperplane

pub fn try_new( coefficients: Vec<f64>, offset: f64, ) -> Result<Hyperplane, GeometryError>

Creates a validated hyperplane from finite coefficients and finite offset.

Errors

Returns a GeometryError when coefficients are empty, non-finite, all zero, or when the offset is non-finite.

pub fn dimension(&self) -> usize

Returns the hyperplane dimension.

pub fn coefficients(&self) -> &[f64]

Returns the coefficient vector.

pub const fn offset(&self) -> f64

Returns the offset.

pub fn evaluate(&self, point: &[f64]) -> Option<f64>

Evaluates the hyperplane equation at point when dimensions match.

Trait Implementations

impl Clone for Hyperplane

fn clone(&self) -> Hyperplane

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hyperplane

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

Formats the value using the given formatter.

impl PartialEq for Hyperplane

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