Struct Evaluator

pub struct Evaluator {
    pub amplitudes: Vec<Box<dyn Amplitude>>,
    pub resources: Arc<RwLock<Resources>>,
    pub dataset: Arc<Dataset>,
    pub expression: Expression,
}

A structure which can be used to evaluate the stored Expression built on registered Amplitudes. This contains a Resources struct which already contains cached values for precomputed Amplitudes and any relevant free parameters and constants.

Fields

amplitudes: Vec<Box<dyn Amplitude>>

A list of Amplitudes which were registered with the Manager used to create the internal Expression. This includes but is not limited to those which are actually used in the Expression.

resources: Arc<RwLock<Resources>>

The internal Resources where precalculated values are stored

dataset: Arc<Dataset>

The internal Dataset

expression: Expression

The internal Expression

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 activate<T: AsRef<str>>(&self, name: T) -> Result<(), LadduError>

Activate an Amplitude by name.

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

Activate several Amplitudes by name.

pub fn activate_all(&self)

Activate all registered Amplitudes.

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

Dectivate an Amplitude by name.

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

Deactivate several Amplitudes by name.

pub fn deactivate_all(&self)

Deactivate all registered Amplitudes.

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

Isolate an Amplitude by name (deactivate the rest).

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

Isolate several Amplitudes by name (deactivate the rest).

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

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: &[Float]) -> Vec<Complex<Float>>

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

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

Evaluate 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: &[Float], ) -> Vec<DVector<Complex<Float>>>

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

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.