Struct Clip

pub struct Clip {
    pub maximum: f64,
    pub minimum: f64,
    pub value: f64,
}

Clips the value to a minimum and maximum range

Alternative

https://doc.rust-lang.org/std/primitive.f64.html#method.clamp

Examples

use com_croftsoft_core::math::math_lib::*;
assert_eq!(
  Clip {
    maximum:  1.0,
    minimum: -1.0,
    value:    0.0,
  }.calculate().unwrap(),
  0.0);
assert_eq!(
  Clip {
    maximum:  1.0,
    minimum: -1.0,
    value:   -2.0,
  }.calculate().unwrap(),
  -1.0);
assert_eq!(
  Clip {
    maximum:  1.0,
    minimum: -1.0,
    value:    2.0,
  }.calculate().unwrap(),
  1.0);
assert_eq!(
  Clip {
    maximum:  f64::NAN,
    minimum: -1.0,
    value:    0.0,
  }.calculate().unwrap_err(),
  ClipError::MaximumIsNotANumber);
assert_eq!(
  Clip {
    maximum:  f64::INFINITY,
    minimum: -1.0,
    value:    0.0,
  }.calculate().unwrap_err(),
  ClipError::MaximumIsInfinite(f64::INFINITY));
assert_eq!(
  Clip {
    maximum:  f64::NEG_INFINITY,
    minimum: -1.0,
    value:    0.0,
  }.calculate().unwrap_err(),
  ClipError::MaximumIsInfinite(f64::NEG_INFINITY));
assert_eq!(
  Clip {
    maximum: -1.0,
    minimum:  1.0,
    value:    0.0,
  }.calculate().unwrap_err(),
  ClipError::MinimumIsGreaterThanMaximum);
assert_eq!(
  Clip {
    maximum:  1.0,
    minimum:  f64::INFINITY,
    value:    0.0,
  }.calculate().unwrap_err(),
  ClipError::MinimumIsInfinite(f64::INFINITY));
assert_eq!(
  Clip {
    maximum:  1.0,
    minimum:  f64::NEG_INFINITY,
    value:    0.0,
  }.calculate().unwrap_err(),
  ClipError::MinimumIsInfinite(f64::NEG_INFINITY));
assert_eq!(
  Clip {
    maximum:  1.0,
    minimum:  f64::NAN,
    value:    0.0,
  }.calculate().unwrap_err(),
  ClipError::MinimumIsNotANumber);
assert_eq!(
  Clip {
    maximum:  1.0,
    minimum: -1.0,
    value:    f64::INFINITY,
  }.calculate().unwrap_err(),
  ClipError::ValueIsInfinite(f64::INFINITY));
assert_eq!(
  Clip {
    maximum:  1.0,
    minimum: -1.0,
    value:    f64::NEG_INFINITY,
  }.calculate().unwrap_err(),
  ClipError::ValueIsInfinite(f64::NEG_INFINITY));
assert_eq!(
  Clip {
    maximum:  1.0,
    minimum: -1.0,
    value:    f64::NAN,
  }.calculate().unwrap_err(),
  ClipError::ValueIsNotANumber);

Fields

maximum: f64

minimum: f64

value: f64

Implementations

impl Clip

pub fn calculate(&self) -> Result<f64, ClipError>

Trait Implementations

impl Clone for Clip

fn clone(&self) -> Clip

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Clip

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

Formats the value using the given formatter.

impl PartialEq for Clip

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

Tests for self and other values to be equal, and is used by ==.

const 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 Clip