Skip to main content

ParameterRange

Struct ParameterRange 

Source
pub struct ParameterRange {
    pub kind: ParameterKind,
    pub min: f64,
    pub max: f64,
    pub step: Option<f64>,
    pub default: f64,
}
Expand description

A continuous or discrete range for a single tunable parameter.

When step is Some, the parameter is treated as discrete: values are quantized to the nearest grid point anchored at min. When step is None the parameter is treated as continuous and generators fall back to an internal default step count (typically 20 divisions).

§Examples

use zeph_experiments::{ParameterRange, ParameterKind};

let range = ParameterRange {
    kind: ParameterKind::Temperature,
    min: 0.0,
    max: 1.0,
    step: Some(0.1),
    default: 0.7,
};

assert!(range.is_valid());
assert_eq!(range.step_count(), Some(11));
assert!((range.clamp(2.0) - 1.0).abs() < f64::EPSILON);
assert!((range.quantize(0.73) - 0.7).abs() < 1e-10);

Fields§

§kind: ParameterKind

The parameter this range applies to.

§min: f64

Minimum value (inclusive).

§max: f64

Maximum value (inclusive).

§step: Option<f64>

Discrete step size. None means continuous (generators use a default step count).

§default: f64

Default (baseline) value, typically read from the current agent config.

Implementations§

Source§

impl ParameterRange

Source

pub fn step_count(&self) -> Option<usize>

Number of discrete grid points in this range, or None if step is not set or ≤ 0.

The count is floor((max - min) / step) + 1.

§Examples
use zeph_experiments::{ParameterRange, ParameterKind};

let r = ParameterRange { kind: ParameterKind::Temperature, min: 0.0, max: 1.0, step: Some(0.5), default: 0.5 };
assert_eq!(r.step_count(), Some(3)); // 0.0, 0.5, 1.0

let r_continuous = ParameterRange { step: None, ..r };
assert_eq!(r_continuous.step_count(), None);
Source

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

Clamp value to [min, max].

§Examples
use zeph_experiments::{ParameterRange, ParameterKind};

let r = ParameterRange { kind: ParameterKind::TopP, min: 0.1, max: 1.0, step: Some(0.1), default: 0.9 };
assert!((r.clamp(2.0) - 1.0).abs() < f64::EPSILON);
assert!((r.clamp(-1.0) - 0.1).abs() < f64::EPSILON);
Source

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

Return true if value lies within [min, max] (inclusive).

§Examples
use zeph_experiments::{ParameterRange, ParameterKind};

let r = ParameterRange { kind: ParameterKind::Temperature, min: 0.0, max: 1.0, step: Some(0.1), default: 0.7 };
assert!(r.contains(0.5));
assert!(!r.contains(1.1));
Source

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

Quantize value to the nearest grid step anchored at min.

Formula: min + ((value - min) / step).round() * step, then clamped to [min, max]. Anchoring at min ensures grid points align to {min, min+step, min+2*step, ...}.

Source

pub fn is_valid(&self) -> bool

Return true if this range is internally consistent.

Returns false if min > max, any bound or default is non-finite, or step is present but non-positive or non-finite.

§Examples
use zeph_experiments::{ParameterRange, ParameterKind};

let valid = ParameterRange { kind: ParameterKind::Temperature, min: 0.0, max: 1.0, step: Some(0.1), default: 0.7 };
assert!(valid.is_valid());

let inverted = ParameterRange { min: 1.0, max: 0.0, ..valid };
assert!(!inverted.is_valid());

Trait Implementations§

Source§

impl Clone for ParameterRange

Source§

fn clone(&self) -> ParameterRange

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ParameterRange

Source§

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

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

impl<'de> Deserialize<'de> for ParameterRange

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ParameterRange

Source§

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

Serialize this value into the given Serde serializer. Read more

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,