Struct ParamLayout 

pub struct ParamLayout { /* private fields */ }

Validated parameter ordering and mapping between full and free values.

Implementations

impl ParamLayout

pub fn new<S>(specs: impl IntoIterator<Item = S>) -> ParamResult<Self>

where S: Into<Parameter>,

Validates parameter definitions and constructs a layout.

Errors

Returns ParamError when a definition has an empty or duplicate name, invalid bounds, invalid periodic metadata, an invalid scale, or an initial or fixed value outside its permitted domain.

pub fn specs(&self) -> &[Parameter]

Returns all parameter definitions in full-layout order.

pub fn len(&self) -> usize

Returns the total number of free and fixed parameters.

pub fn is_empty(&self) -> bool

Returns whether the layout contains no parameters.

pub fn n_free(&self) -> usize

Returns the number of free parameters.

pub fn id(&self, name: &str) -> Option<ParamId>

Looks up a full-layout identifier by parameter name.

pub fn name(&self, id: ParamId) -> ParamResult<&str>

Returns the name associated with a full-layout identifier.

Errors

Returns ParamError::InvalidParamId when id is outside this layout.

pub fn spec(&self, id: ParamId) -> ParamResult<&Parameter>

Returns the definition associated with a full-layout identifier.

Errors

Returns ParamError::InvalidParamId when id is outside this layout.

pub fn free_id(&self, id: ParamId) -> ParamResult<Option<FreeParamId>>

Maps a full-layout identifier to free-parameter order.

Fixed parameters return None.

Errors

Returns ParamError::InvalidParamId when id is outside this layout.

pub fn free_params(&self) -> &[ParamId]

Returns full-layout identifiers in free-parameter order.

pub fn default_values(&self) -> ParamValues

Creates a full value set using fixed and deterministic initial values.

pub fn initial_free_values(&self) -> Vec<f64>

Return deterministic initial values in free-parameter order.

Uniform initial ranges use their midpoint.

pub fn values(&self, free: &[f64]) -> ParamResult<ParamValues>

Expand a free-parameter slice while restoring fixed values from the layout.

Errors

Returns ParamError::FreeLengthMismatch when free does not contain exactly one value per free parameter.

pub fn free_values_with(&self, value: impl FnMut(&Parameter) -> f64) -> Vec<f64>

Generate one value per free parameter in layout order.

pub fn sample_initial(&self, seed: u64) -> Vec<f64>

Generate initial free values, invoking uniform only for uniform initial ranges.

pub fn validate_free_values(&self, free: &[f64]) -> ParamResult<()>

Validate free values against ordinary bounds and canonical periodic domains.

Errors

Returns ParamError::FreeLengthMismatch when free has the wrong length, or a value-related ParamError when a value lies outside its parameter’s bounds or canonical periodic domain.

pub fn wrap_periodic_free_values(&self, free: &[f64]) -> ParamResult<Vec<f64>>

Return free values with periodic parameters mapped into their canonical domains. Non-periodic values are unchanged; ordinary bounds are not clamped.

Errors

Returns ParamError::FreeLengthMismatch when free does not contain exactly one value per free parameter.

Trait Implementations

impl Clone for ParamLayout

fn clone(&self) -> ParamLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamLayout

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParamLayout

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ParamLayout

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

where __S: Serializer,

Serialize this value into the given Serde serializer.