Enum PointKind 

pub enum PointKind {
    Barycentric,
    Centroid,
    Root,
    Third,
    Fifth,
}

Enumerates the different kinds of points considered by the system

• Barycentric (critical points): points defining a barycentric coordinate for the facet

Variants

Barycentric

the topology of a 2-simplex naturally defines a maximum of three barycentric coordinates which are used to define the three critical points of the network

Centroid

the centroid is the geometric center of the triad, defined as the average of the three vertices

Root

the root (tonic) of the facet

Third

the middle vertex (note) of the facet

Fifth

the final vertex (note) of the facet

Implementations

impl PointKind

pub const fn is_barycentric(&self) -> bool

Returns true if the enum is PointKind::Barycentric otherwise false

pub const fn is_centroid(&self) -> bool

Returns true if the enum is PointKind::Centroid otherwise false

pub const fn is_root(&self) -> bool

Returns true if the enum is PointKind::Root otherwise false

pub const fn is_third(&self) -> bool

Returns true if the enum is PointKind::Third otherwise false

pub const fn is_fifth(&self) -> bool

Returns true if the enum is PointKind::Fifth otherwise false

impl PointKind

pub fn default_coordinates<T>(&self) -> [T; 3]

where T: Float + FromPrimitive,

Get default barycentric coordinates for this kind

Trait Implementations

impl AsRef<str> for PointKind

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PointKind

fn clone(&self) -> PointKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PointKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PointKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PointKind

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

Formats the value using the given formatter.

impl EnumCount for PointKind

const COUNT: usize = 5usize

impl FromStr for PointKind

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<PointKind, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for PointKind

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 IntoEnumIterator for PointKind

type Iterator = PointKindIter

fn iter() -> PointKindIter

impl Ord for PointKind

fn cmp(&self, other: &PointKind) -> 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 PartialEq for PointKind

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

fn partial_cmp(&self, other: &PointKind) -> 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 Serialize for PointKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for PointKind

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<PointKind, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl VariantArray for PointKind

const VARIANTS: &'static [Self]

impl VariantNames for PointKind

const VARIANTS: &'static [&'static str]

Names of the variants of this enum

impl Copy for PointKind

impl Eq for PointKind

impl StructuralPartialEq for PointKind