Skip to main content

TernaryPoint

Struct TernaryPoint 

Source
pub struct TernaryPoint { /* private fields */ }
Expand description

A ternary composition in semantic A/B/C order.

TernaryPoint::new performs no validation or normalisation. Call TernaryPoint::validate before projecting a user-provided point.

Implementations§

Source§

impl TernaryPoint

Source

pub const fn new(a: f64, b: f64, c: f64) -> Self

Construct an unvalidated composition without normalising it.

use plotters_ternary::{Normalization, TernaryPoint, Tolerance};

let raw = TernaryPoint::new(0.2, 0.3, 0.5);
let point = raw.validate(Normalization::RequireUnitSum, Tolerance::default())?;
assert_eq!(point.component(plotters_ternary::Component::C), 0.5);
Source

pub const fn component(self, component: Component) -> f64

Return a component value selected by its semantic name.

Source

pub const fn sum(self) -> f64

Return the unvalidated arithmetic sum of the three components.

Source

pub const fn as_array(self) -> [f64; 3]

Return the components in stable A/B/C order.

Source

pub fn validate( self, normalization: Normalization, tolerance: Tolerance, ) -> Result<Self, Error>

Validate this composition under an explicit sum policy.

Tiny finite negatives in [-tolerance.absolute, 0.0) become exactly zero before the sum is evaluated. Larger negatives, non-finite values, and near-zero sums fail. Normalization::Normalize then scales the cleaned values to unit sum.

use plotters_ternary::{Normalization, TernaryPoint, Tolerance};

let point = TernaryPoint::new(2.0, 3.0, 5.0)
    .validate(Normalization::Normalize, Tolerance::default())?;
assert!((point.sum() - 1.0).abs() < 1.0e-12);

Trait Implementations§

Source§

impl Clone for TernaryPoint

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for TernaryPoint

Source§

impl Debug for TernaryPoint

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<(f64, f64, f64)> for TernaryPoint

Source§

fn from((a, b, c): (f64, f64, f64)) -> Self

Converts to this type from the input type.
Source§

impl From<TernaryPoint> for [f64; 3]

Source§

fn from(point: TernaryPoint) -> Self

Converts to this type from the input type.
Source§

impl From<TernaryPoint> for (f64, f64, f64)

Source§

fn from(point: TernaryPoint) -> Self

Converts to this type from the input type.
Source§

impl From<[f64; 3]> for TernaryPoint

Source§

fn from([a, b, c]: [f64; 3]) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for TernaryPoint

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TernaryPoint

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.