Struct Point 

pub struct Point<T = f32> { /* private fields */ }

Critical point within the surface of a triadic space

Implementations

impl<T> Point<T>

pub fn new(u: T, v: T, modulus: Octave<isize>, kind: PointKind) -> Self

where T: Copy + PartialOrd + Num,

pub fn from_triad(kind: PointKind, triad: &Triad) -> Self

where T: Float + FromPrimitive,

Create a new critical point with coordinates adjusted for the triad class

pub const fn coordinates(&self) -> &[T; 3]

returns an immutable reference to the coordinates of the critical point

pub fn coordinates_mut(&mut self) -> &mut [T; 3]

returns an mutable reference to the coordinates of the critical point

pub const fn modulus(&self) -> &Octave

returns an immutable reference to the critical points octave

pub fn modulus_mut(&mut self) -> &mut Octave

returns a mutable reference to the critical points octave

pub fn kind(&self) -> PointKind

returns the name of the critical point

pub const fn weight(&self) -> &T

returns an immutable reference to the weight of the critical point

pub fn weight_mut(&mut self) -> &mut T

returns a mutable reference to the weight of the critical point

pub fn set_coordinates(&mut self, u: T, v: T)

where T: Copy + PartialOrd + Num,

set the coordinates of the critical point

pub fn set_kind(&mut self, kind: PointKind)

set the name of the critical point

pub fn set_weight(&mut self, weight: T)

set the weight of the critical point

pub fn with_coordinates(self, u: T, v: T) -> Self

where T: Copy + PartialOrd + NumOps<T> + One,

consumes the current instance to create another with the given coordinates

pub fn with_kind(self, kind: PointKind) -> Self

consumes the current instance to create another with the given name

pub fn with_modulus(self, modulus: Octave) -> Self

consumes the current instance to create another with the given modulus

pub fn with_weight(self, weight: T) -> Self

consumes the current instance to create another with the given weight

pub fn validate(&self) -> bool

where T: Float,

returns true if the critical point is valid

Trait Implementations

impl<T: Clone> Clone for Point<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Point<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Point<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Hash> Hash for Point<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Index<usize> for Point<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for Point<T>

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

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

impl<T: Ord> Ord for Point<T>

fn cmp(&self, other: &Point<T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Point<T>

fn eq(&self, other: &Point<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<T: PartialOrd> PartialOrd for Point<T>

fn partial_cmp(&self, other: &Point<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for Point<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy> Copy for Point<T>

impl<T: Eq> Eq for Point<T>

impl<T> StructuralPartialEq for Point<T>