Struct ParameterSensitivityResult 

pub struct ParameterSensitivityResult<S: Scalar> {
    pub output: S,
    pub sensitivities: Vec<ParameterSensitivity<S>>,
}

Result of parameter-importance analysis on a scalar pure function.

Distinct from the ODE forward-sensitivity result type numra_ode::SensitivityResult. See ParameterSensitivity for the distinction.

Fields

output: S

Output value at nominal parameters

sensitivities: Vec<ParameterSensitivity<S>>

Sensitivities for each parameter

Implementations

impl<S: Scalar> ParameterSensitivityResult<S>

pub fn new(output: S, sensitivities: Vec<ParameterSensitivity<S>>) -> Self

Create a new sensitivity result.

pub fn most_sensitive(&self) -> Option<&ParameterSensitivity<S>>

Find the most sensitive parameter.

pub fn propagate_uncertainty(&self, param_variances: &[S]) -> S

Propagate uncertainty from parameter uncertainties. Returns the output uncertainty (variance).

Trait Implementations

impl<S: Clone + Scalar> Clone for ParameterSensitivityResult<S>

fn clone(&self) -> ParameterSensitivityResult<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + Scalar> Debug for ParameterSensitivityResult<S>

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

Formats the value using the given formatter.