Struct Evaluator 

pub struct Evaluator {
    pub amplitudes: Vec<Box<dyn Amplitude>>,
    pub resources: Arc<RwLock<Resources>>,
    pub dataset: Arc<Dataset>,
    pub expression: ExpressionNode,
    /* private fields */
}

Evaluator for Expression that mirrors the existing evaluator behavior.

Fields

amplitudes: Vec<Box<dyn Amplitude>>

resources: Arc<RwLock<Resources>>

dataset: Arc<Dataset>

expression: ExpressionNode

Implementations

impl Evaluator

pub fn parameters(&self) -> Vec<String>

Get the list of parameter names in the order they appear in the Evaluator::evaluate method.

pub fn free_parameters(&self) -> Vec<String>

Get the list of free parameter names.

pub fn fixed_parameters(&self) -> Vec<String>

Get the list of fixed parameter names.

pub fn n_free(&self) -> usize

Number of free parameters.

pub fn n_fixed(&self) -> usize

Number of fixed parameters.

pub fn n_parameters(&self) -> usize

Total number of parameters.

pub fn fix(&self, name: &str, value: f64) -> LadduResult<Self>

Return a new Evaluator with the given parameter fixed to a value.

pub fn free(&self, name: &str) -> LadduResult<Self>

Return a new Evaluator with the given parameter freed.

pub fn rename_parameter(&self, old: &str, new: &str) -> LadduResult<Self>

Return a new Evaluator with a single parameter renamed.

pub fn rename_parameters( &self, mapping: &HashMap<String, String>, ) -> LadduResult<Self>

Return a new Evaluator with several parameters renamed.

pub fn activate<T: AsRef<str>>(&self, name: T)

Activate an Amplitude by name, skipping missing entries.

pub fn activate_strict<T: AsRef<str>>(&self, name: T) -> LadduResult<()>

Activate an Amplitude by name and return an error if it is missing.

pub fn activate_many<T: AsRef<str>>(&self, names: &[T])

Activate several Amplitudes by name, skipping missing entries.

pub fn activate_many_strict<T: AsRef<str>>( &self, names: &[T], ) -> LadduResult<()>

Activate several Amplitudes by name and return an error if any are missing.

pub fn activate_all(&self)

Activate all registered Amplitudes.

pub fn deactivate<T: AsRef<str>>(&self, name: T)

Dectivate an Amplitude by name, skipping missing entries.

pub fn deactivate_strict<T: AsRef<str>>(&self, name: T) -> LadduResult<()>

Dectivate an Amplitude by name and return an error if it is missing.

pub fn deactivate_many<T: AsRef<str>>(&self, names: &[T])

Deactivate several Amplitudes by name, skipping missing entries.

pub fn deactivate_many_strict<T: AsRef<str>>( &self, names: &[T], ) -> LadduResult<()>

Dectivate several Amplitudes by name and return an error if any are missing.

pub fn deactivate_all(&self)

Deactivate all registered Amplitudes.

pub fn isolate<T: AsRef<str>>(&self, name: T)

Isolate an Amplitude by name (deactivate the rest), skipping missing entries.

pub fn isolate_strict<T: AsRef<str>>(&self, name: T) -> LadduResult<()>

Isolate an Amplitude by name (deactivate the rest) and return an error if it is missing.

pub fn isolate_many<T: AsRef<str>>(&self, names: &[T])

Isolate several Amplitudes by name (deactivate the rest), skipping missing entries.

pub fn isolate_many_strict<T: AsRef<str>>(&self, names: &[T]) -> LadduResult<()>

Isolate several Amplitudes by name (deactivate the rest) and return an error if any are missing.

pub fn evaluate_local(&self, parameters: &[f64]) -> Vec<Complex64>

Evaluate the stored Expression over the events in the Dataset stored by the Evaluator with the given values for free parameters (non-MPI version).

Notes

This method is not intended to be called in analyses but rather in writing methods that have mpi-feature-gated versions. Most users will want to call Evaluator::evaluate instead.

pub fn evaluate(&self, parameters: &[f64]) -> Vec<Complex64>

Evaluate the stored Expression over the events in the Dataset stored by the Evaluator with the given values for free parameters.

pub fn evaluate_batch_local( &self, parameters: &[f64], indices: &[usize], ) -> Vec<Complex64>

See Evaluator::evaluate_local. This method evaluates over a subset of events rather than all events in the total dataset.

pub fn evaluate_batch( &self, parameters: &[f64], indices: &[usize], ) -> Vec<Complex64>

Evaluate the stored Expression over a subset of events in the Dataset stored by the Evaluator with the given values for free parameters. See also [Expression::evaluate].

pub fn evaluate_gradient_local( &self, parameters: &[f64], ) -> Vec<DVector<Complex64>>

Evaluate the gradient of the stored Expression over the events in the Dataset stored by the Evaluator with the given values for free parameters (non-MPI version).

Notes

This method is not intended to be called in analyses but rather in writing methods that have mpi-feature-gated versions. Most users will want to call Evaluator::evaluate_gradient instead.

pub fn evaluate_gradient(&self, parameters: &[f64]) -> Vec<DVector<Complex64>>

Evaluate the gradient of the stored Expression over the events in the Dataset stored by the Evaluator with the given values for free parameters.

pub fn evaluate_gradient_batch_local( &self, parameters: &[f64], indices: &[usize], ) -> Vec<DVector<Complex64>>

See Evaluator::evaluate_gradient_local. This method evaluates over a subset of events rather than all events in the total dataset.

pub fn evaluate_gradient_batch( &self, parameters: &[f64], indices: &[usize], ) -> Vec<DVector<Complex64>>

Evaluate the gradient of the stored Expression over a subset of the events in the Dataset stored by the Evaluator with the given values for free parameters. See also [Expression::evaluate_gradient].

Trait Implementations

impl Clone for Evaluator

fn clone(&self) -> Evaluator

Returns a duplicate of the value.

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

Performs copy-assignment from source.