Struct FloatingPointRange 

pub struct FloatingPointRange {
    pub min: f64,
    pub max: f64,
    pub step: f64,
}

Floating point range constraints for parameters

Fields

min: f64

Minimum allowed value (inclusive)

max: f64

Maximum allowed value (inclusive)

step: f64

Step size for value changes (0 = any step allowed)

Implementations

impl FloatingPointRange

pub const fn new(min: f64, max: f64, step: f64) -> FloatingPointRange

Create a new floating point range

pub fn is_valid(&self) -> bool

A range is well-formed when min <= max and step >= 0 (0 = no step).

Upstream refuses to DECLARE with an ill-formed range (DeclarationError::InvalidRange); a negative step here would also go on the wire as a huge u64 in DescribeParameters (issue 1150).

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

Check if a value is within this range.

Issue 1150: step is ENFORCED, mirroring rclrs range.rs. A value is in range iff min <= v <= max and, when step != 0, v lies on the lattice min + k*step within floating tolerance. Either endpoint is always accepted, exactly as upstream (the upper bound need not be on the lattice). The tolerance is upstream’s: 100 ULP, relative to the magnitude of the two operands.

Trait Implementations

impl Clone for FloatingPointRange

fn clone(&self) -> FloatingPointRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FloatingPointRange

impl Debug for FloatingPointRange

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

Formats the value using the given formatter.

impl Default for FloatingPointRange

fn default() -> FloatingPointRange

Returns the “default value” for a type.