Struct Point

pub struct Point<const D: usize, T: ExtendedNumOps> {
    pub vec: [T; D],
}

The basic input type for constructing and simplifying a polyline. It can have any number of components, and will work with components that implement the ExtendedNumOps type. Dimensionality must be determined at compile time.

This also implements some basic math operations between points, like:

• addition
• subtraction
• component-wise multiplication
• scalar multiplication

Example

use simplify_polyline::*;

let point2d: Point<2, i32> = Point { vec: [1, 1] };
let another_point2d: Point<2, i32> = Point { vec: [2, 2] };

assert_eq!(point2d + another_point2d, Point { vec: [3, 3] });
assert_eq!(point2d - another_point2d, Point { vec: [-1, -1] });
assert_eq!(point2d * another_point2d, Point { vec: [2, 2] });
assert_eq!(point2d * 7, Point { vec: [7, 7] });

Fields

vec: [T; D]

The components of the point.

Implementations

impl<const D: usize, T: ExtendedNumOps> Point<D, T>

pub fn sq_dist(&self, other: &Point<D, T>) -> T

Computes the squared distance between two points.

pub fn sq_dist_origin(&self) -> T

Computes the squared distance between this point, and the origin.

pub fn value_sum(&self) -> T

Computes the sum of each value of the point.

pub fn is_origin(&self) -> bool

Checks if the point is the origin point (all values at zero).

Trait Implementations

impl<'a, 'b, const D: usize, T: ExtendedNumOps> Add<&'b Point<D, T>> for &'a Point<D, T>

type Output = Point<D, T>

The resulting type after applying the + operator.

fn add(self, other: &'b Point<D, T>) -> Self::Output

Performs the + operation.

impl<'b, const D: usize, T: ExtendedNumOps> Add<&'b Point<D, T>> for Point<D, T>

type Output = Point<D, T>

The resulting type after applying the + operator.

fn add(self, other: &'b Point<D, T>) -> Self::Output

Performs the + operation.

impl<'a, const D: usize, T: ExtendedNumOps> Add<Point<D, T>> for &'a Point<D, T>

type Output = Point<D, T>

The resulting type after applying the + operator.

fn add(self, other: Point<D, T>) -> Self::Output

Performs the + operation.

impl<const D: usize, T: ExtendedNumOps> Add for Point<D, T>

type Output = Point<D, T>

The resulting type after applying the + operator.

fn add(self, rhs: Point<D, T>) -> Self::Output

Performs the + operation.

impl<const D: usize, T: Clone + ExtendedNumOps> Clone for Point<D, T>

fn clone(&self) -> Point<D, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const D: usize, T: Debug + ExtendedNumOps> Debug for Point<D, T>

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

Formats the value using the given formatter.

impl<'a, 'b, const D: usize, T: ExtendedNumOps> Mul<&'b Point<D, T>> for &'a Point<D, T>

type Output = Point<D, T>

The resulting type after applying the * operator.

fn mul(self, other: &'b Point<D, T>) -> Self::Output

Performs the * operation.

impl<'b, const D: usize, T: ExtendedNumOps> Mul<&'b Point<D, T>> for Point<D, T>

type Output = Point<D, T>

The resulting type after applying the * operator.

fn mul(self, other: &'b Point<D, T>) -> Self::Output

Performs the * operation.

impl<'a, 'b, const D: usize, T: ExtendedNumOps> Mul<&'b T> for &'a Point<D, T>

type Output = Point<D, T>

The resulting type after applying the * operator.

fn mul(self, other: &'b T) -> Self::Output

Performs the * operation.

impl<'b, const D: usize, T: ExtendedNumOps> Mul<&'b T> for Point<D, T>

type Output = Point<D, T>

The resulting type after applying the * operator.

fn mul(self, other: &'b T) -> Self::Output

Performs the * operation.

impl<'a, const D: usize, T: ExtendedNumOps> Mul<Point<D, T>> for &'a Point<D, T>

type Output = Point<D, T>

The resulting type after applying the * operator.

fn mul(self, other: Point<D, T>) -> Self::Output

Performs the * operation.

impl<'a, const D: usize, T: ExtendedNumOps> Mul<T> for &'a Point<D, T>

type Output = Point<D, T>

The resulting type after applying the * operator.

fn mul(self, other: T) -> Self::Output

Performs the * operation.

impl<const D: usize, T: ExtendedNumOps> Mul<T> for Point<D, T>

type Output = Point<D, T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<const D: usize, T: ExtendedNumOps> Mul for Point<D, T>

type Output = Point<D, T>

The resulting type after applying the * operator.

fn mul(self, rhs: Point<D, T>) -> Self::Output

Performs the * operation.

impl<const D: usize, T: PartialEq + ExtendedNumOps> PartialEq for Point<D, T>

fn eq(&self, other: &Point<D, T>) -> 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<'a, 'b, const D: usize, T: ExtendedNumOps> Sub<&'b Point<D, T>> for &'a Point<D, T>

type Output = Point<D, T>

The resulting type after applying the - operator.

fn sub(self, other: &'b Point<D, T>) -> Self::Output

Performs the - operation.

impl<'b, const D: usize, T: ExtendedNumOps> Sub<&'b Point<D, T>> for Point<D, T>

type Output = Point<D, T>

The resulting type after applying the - operator.

fn sub(self, other: &'b Point<D, T>) -> Self::Output

Performs the - operation.

impl<'a, const D: usize, T: ExtendedNumOps> Sub<Point<D, T>> for &'a Point<D, T>

type Output = Point<D, T>

The resulting type after applying the - operator.

fn sub(self, other: Point<D, T>) -> Self::Output

Performs the - operation.

impl<const D: usize, T: ExtendedNumOps> Sub for Point<D, T>

type Output = Point<D, T>

The resulting type after applying the - operator.

fn sub(self, rhs: Point<D, T>) -> Self::Output

Performs the - operation.

impl<const D: usize, T: Copy + ExtendedNumOps> Copy for Point<D, T>

impl<const D: usize, T: Eq + ExtendedNumOps> Eq for Point<D, T>

impl<const D: usize, T: ExtendedNumOps> StructuralPartialEq for Point<D, T>