Struct ParamProjection 

pub struct ParamProjection { /* private fields */ }

Validated projection from one parameter layout into another.

The target layout owns the values produced by Self::project, while the source layout owns the values accepted by it. Only free parameters are projected: fixed target parameters retain their configured values, and a target free parameter must also be free in the source layout.

Implementations

impl ParamProjection

pub fn project(&self, source: &ParamValues) -> ParamResult<ParamValues>

Projects values from the source layout into the target layout.

Errors

Returns ParamError::UnknownName when the supplied values do not contain a required target parameter.

pub fn scatter_add(&self, target: &[f64], source: &mut [f64]) -> ParamResult<()>

Scatters a target-layout free gradient into a source-layout gradient.

Values are added to source, allowing several projections to contribute to one gradient. Both dimensions are validated against the layouts captured by this artifact.

Errors

Returns ParamError::FreeLengthMismatch when either slice has an incompatible free-parameter dimension.

Trait Implementations

impl Clone for ParamProjection

fn clone(&self) -> ParamProjection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamProjection

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

Formats the value using the given formatter.