Struct Halfspace 

pub struct Halfspace { /* private fields */ }

Representation of a halfspace: a·x ≤ b

Implementations

impl Halfspace

pub fn new(normal: Array1<f64>, offset: f64) -> Self

Create a new halfspace with normal vector and offset

Arguments

• normal - Normal vector (a₁, a₂, …, aₐ)
• offset - Offset value b

Returns

• A new Halfspace instance

Examples

use scirs2_spatial::halfspace::Halfspace;
use scirs2_core::ndarray::array;

// Halfspace x + y ≤ 1
let hs = Halfspace::new(array![1.0, 1.0], 1.0);

pub fn normal(&self) -> &Array1<f64>

Get the normal vector

pub fn offset(&self) -> f64

Get the offset

pub fn dim(&self) -> usize

Get the dimension of the halfspace

pub fn contains(&self, point: &ArrayView1<'_, f64>) -> bool

Check if a point satisfies the halfspace constraint

Arguments

• point - Point to test

Returns

• true if point satisfies a·x ≤ b, false otherwise

pub fn distance(&self, point: &ArrayView1<'_, f64>) -> SpatialResult<f64>

Get the distance from a point to the halfspace boundary

Arguments

• point - Point to measure distance from

Returns

• Signed distance (negative if inside halfspace, positive if outside)

pub fn normalize(&self) -> SpatialResult<Self>

Normalize the halfspace so that the normal vector has unit length

Returns

• A new normalized Halfspace

Trait Implementations

impl Clone for Halfspace

fn clone(&self) -> Halfspace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Halfspace

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

Formats the value using the given formatter.

impl PartialEq for Halfspace

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