Struct Bounds 

pub struct Bounds {
    pub min: f64,
    pub max: f64,
}

Bounds for a single dimension

Fields

min: f64

Lower bound (inclusive)

max: f64

Upper bound (inclusive)

Implementations

impl Bounds

pub fn new(min: f64, max: f64) -> Self

Create new bounds.

A degenerate (min == max) bound is allowed and represents a dimension pinned to a single constant value; see normalize and denormalize for how such bounds behave.

Panics

Panics if min > max. Use try_new for a fallible constructor that returns a GenomeError instead of panicking.

pub fn try_new(min: f64, max: f64) -> Result<Self, GenomeError>

Fallibly create new bounds, rejecting min > max.

Returns Err(GenomeError::InvalidStructure) when min > max. A degenerate (min == max) bound is permitted.

pub fn symmetric(half_width: f64) -> Self

Create symmetric bounds centered at 0

pub fn unit() -> Self

Create unit bounds [0, 1]

pub fn range(&self) -> f64

Get the range (max - min)

pub fn center(&self) -> f64

Get the center point

pub fn contains(&self, value: f64) -> bool

Check if a value is within bounds

pub fn clamp(&self, value: f64) -> f64

Clamp a value to be within bounds

pub fn normalize(&self, value: f64) -> f64

Normalize a value from bounds to [0, 1].

For a degenerate (min == max) bound the range is zero, so there is no meaningful position within [0, 1]; this returns 0.5 (the midpoint) rather than dividing by zero and producing NaN/±inf.

pub fn denormalize(&self, value: f64) -> f64

Denormalize a value from [0, 1] to bounds.

For a degenerate (min == max) bound the range is zero, so every input maps to the single legal value min.

Trait Implementations

impl Clone for Bounds

fn clone(&self) -> Bounds

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Bounds

impl Debug for Bounds

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

Formats the value using the given formatter.

impl Default for Bounds

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Bounds

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<(f64, f64)> for Bounds

fn from((min, max): (f64, f64)) -> Self

Converts to this type from the input type.

impl FromIterator<Bounds> for MultiBounds

fn from_iter<I: IntoIterator<Item = Bounds>>(iter: I) -> Self

Creates a value from an iterator.

impl PartialEq for Bounds

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Bounds

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Bounds