Struct rustitude_core::amplitude::Amplitude

pub struct Amplitude<F: Field> {
    pub name: String,
    pub node: Box<dyn Node<F>>,
    pub active: bool,
    pub parameters: Vec<String>,
    pub cache_position: usize,
    pub parameter_index_start: usize,
}

A struct which stores a named Node.

The Amplitude struct turns a Node trait into a concrete type and also stores a name associated with the Node. This allows us to distinguish multiple uses of the same Node in an analysis, and makes each Node’s parameters unique.

Fields

name: String

A name which uniquely identifies an Amplitude within a sum and group.

node: Box<dyn Node<F>>

A Node which contains all of the operations needed to compute a [ComplexField] from an Event in a Dataset, a Vec<Field> of parameter values, and possibly some precomputed values.

active: bool

Indicates whether the amplitude should be included in calculations or skipped.

parameters: Vec<String>

Contains the parameter names associated with this amplitude.

cache_position: usize

Indicates the reserved position in the cache for shortcutting computation with a precomputed cache.

parameter_index_start: usize

Indicates the position in the final parameter vector that coincides with the starting index for parameters in this Amplitude

Implementations

impl<F: Field> Amplitude<F>

pub fn new(name: &str, node: impl Node<F> + 'static) -> Self

Creates a new Amplitude from a name and a Node-implementing struct.

pub fn register( &mut self, cache_position: usize, parameter_index_start: usize, dataset: &Dataset<F>, ) -> Result<(), RustitudeError>

Set the Amplitude::cache_position and Amplitude::parameter_index_start and runs Amplitude::precalculate over the given Dataset.

Errors

This function will raise a RustitudeError if the precalculation step fails.

Trait Implementations

impl<F: Field> Add<&Amplitude<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Add>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Amplitude<F>> for &Imag<F>

type Output = <Imag<F> as Add<Amplitude<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Amplitude<F>> for &Product<F>

type Output = <Product<F> as Add<Amplitude<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Amplitude<F>> for &Real<F>

type Output = <Real<F> as Add<Amplitude<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Amplitude<F>> for &Sum<F>

type Output = <Sum<F> as Add<Amplitude<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Amplitude<F>> for Amplitude<F>

type Output = <Amplitude<F> as Add>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Amplitude<F>> for Imag<F>

type Output = <Imag<F> as Add<Amplitude<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Amplitude<F>> for Product<F>

type Output = <Product<F> as Add<Amplitude<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Amplitude<F>> for Real<F>

type Output = <Real<F> as Add<Amplitude<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Amplitude<F>> for Sum<F>

type Output = <Sum<F> as Add<Amplitude<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Imag<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Add<Imag<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Imag<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Imag<F>> for Amplitude<F>

type Output = <Amplitude<F> as Add<Imag<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Imag<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Product<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Add<Product<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Product<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Product<F>> for Amplitude<F>

type Output = <Amplitude<F> as Add<Product<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Product<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Real<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Add<Real<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Real<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Real<F>> for Amplitude<F>

type Output = <Amplitude<F> as Add<Real<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Real<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Sum<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Add<Sum<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Sum<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<&Sum<F>> for Amplitude<F>

type Output = <Amplitude<F> as Add<Sum<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Sum<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Amplitude<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Add>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Amplitude<F>> for &Imag<F>

type Output = <Imag<F> as Add<Amplitude<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Amplitude<F>> for &Product<F>

type Output = <Product<F> as Add<Amplitude<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Amplitude<F>> for &Real<F>

type Output = <Real<F> as Add<Amplitude<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Amplitude<F>> for &Sum<F>

type Output = <Sum<F> as Add<Amplitude<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Amplitude<F>> for Box<dyn AmpLike<F>>

type Output = Sum<F>

The resulting type after applying the + operator.

fn add(self, rhs: Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Amplitude<F>> for Imag<F>

type Output = Sum<F>

The resulting type after applying the + operator.

fn add(self, rhs: Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Amplitude<F>> for Product<F>

type Output = Sum<F>

The resulting type after applying the + operator.

fn add(self, rhs: Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Amplitude<F>> for Real<F>

type Output = Sum<F>

The resulting type after applying the + operator.

fn add(self, rhs: Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Amplitude<F>> for Sum<F>

type Output = Sum<F>

The resulting type after applying the + operator.

fn add(self, rhs: Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Box<dyn AmpLike<F>>> for Amplitude<F>

type Output = Sum<F>

The resulting type after applying the + operator.

fn add(self, rhs: Box<dyn AmpLike<F>>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Imag<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Add<Imag<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Imag<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Imag<F>> for Amplitude<F>

type Output = Sum<F>

The resulting type after applying the + operator.

fn add(self, rhs: Imag<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Product<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Add<Product<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Product<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Product<F>> for Amplitude<F>

type Output = Sum<F>

The resulting type after applying the + operator.

fn add(self, rhs: Product<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Real<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Add<Real<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Real<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Real<F>> for Amplitude<F>

type Output = Sum<F>

The resulting type after applying the + operator.

fn add(self, rhs: Real<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Sum<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Add<Sum<F>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Sum<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add<Sum<F>> for Amplitude<F>

type Output = Sum<F>

The resulting type after applying the + operator.

fn add(self, rhs: Sum<F>) -> Self::Output

Performs the + operation.

impl<F: Field> Add for Amplitude<F>

type Output = Sum<F>

The resulting type after applying the + operator.

fn add(self, rhs: Amplitude<F>) -> Self::Output

Performs the + operation.

impl<F: Field> AmpLike<F> for Amplitude<F>

fn walk(&self) -> Vec<Self>

This method walks through an AmpLike struct and recursively amalgamates a list of Amplitudes contained within. Note that these Amplitudes are owned clones of the interior structures.

fn walk_mut(&mut self) -> Vec<&mut Self>

This method is similar to AmpLike::walk, but returns mutable references rather than clones.

fn compute(&self, cache: &[Option<Complex<F>>]) -> Option<Complex<F>>

Given a cache of complex values calculated from a list of amplitudes, this method will calculate the desired mathematical structure given by the AmpLike and any AmpLikes it contains.

fn get_cloned_terms(&self) -> Option<Vec<Box<dyn AmpLike<F>>>>

This method returns clones of any AmpLikes wrapped by the given AmpLike.

fn real(&self) -> Real<F>

where Self: Sized + 'static,

Take the real part of an Amplitude or Amplitude-like struct.

fn imag(&self) -> Imag<F>

where Self: Sized + 'static,

Take the imaginary part of an Amplitude or Amplitude-like struct.

fn prod(als: &Vec<Box<dyn AmpLike<F>>>) -> Product<F>

where Self: Sized + 'static,

Take the product of a Vec of Amplitude-like structs.

fn sum(als: &Vec<Box<dyn AmpLike<F>>>) -> Sum<F>

where Self: Sized + 'static,

Take the sum of a Vec of Amplitude-like structs.

impl<F: Field> AsTree for Amplitude<F>

fn _get_tree(&self, _bits: &mut Vec<bool>) -> String

Prints the tree of an AsTree-implementor starting with a particular indentation structure defined by bits. A true bit will print a vertical line, while a false bit will not.

fn get_tree(&self) -> String

Returns a string representing the node and its children with tree formatting.

fn _get_indent(&self, bits: Vec<bool>) -> String

Returns a string with the proper indents for a given entry in AsTree::get_tree. A true bit will yield a vertical line, while a false bit will not.

fn _get_intermediate(&self) -> String

Returns a string with the intermediate branch symbol for a given entry in AsTree::get_tree.

fn _get_end(&self) -> String

Prints the a final branch for a given entry in AsTree::get_tree.

impl<F: Clone + Field> Clone for Amplitude<F>

fn clone(&self) -> Amplitude<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Field> Debug for Amplitude<F>

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

Formats the value using the given formatter.

impl<F: Field> Display for Amplitude<F>

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

Formats the value using the given formatter.

impl<F: Field> Mul<&Amplitude<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Mul>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Amplitude<F>> for &Imag<F>

type Output = <Imag<F> as Mul<Amplitude<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Amplitude<F>> for &Product<F>

type Output = <Product<F> as Mul<Amplitude<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Amplitude<F>> for &Real<F>

type Output = <Real<F> as Mul<Amplitude<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Amplitude<F>> for &Sum<F>

type Output = <Sum<F> as Mul<Amplitude<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Amplitude<F>> for Amplitude<F>

type Output = <Amplitude<F> as Mul>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Amplitude<F>> for Imag<F>

type Output = <Imag<F> as Mul<Amplitude<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Amplitude<F>> for Product<F>

type Output = <Product<F> as Mul<Amplitude<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Amplitude<F>> for Real<F>

type Output = <Real<F> as Mul<Amplitude<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Amplitude<F>> for Sum<F>

type Output = <Sum<F> as Mul<Amplitude<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Imag<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Mul<Imag<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Imag<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Imag<F>> for Amplitude<F>

type Output = <Amplitude<F> as Mul<Imag<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Imag<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Product<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Mul<Product<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Product<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Product<F>> for Amplitude<F>

type Output = <Amplitude<F> as Mul<Product<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Product<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Real<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Mul<Real<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Real<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Real<F>> for Amplitude<F>

type Output = <Amplitude<F> as Mul<Real<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Real<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Sum<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Mul<Sum<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Sum<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<&Sum<F>> for Amplitude<F>

type Output = <Amplitude<F> as Mul<Sum<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &Sum<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Amplitude<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Mul>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Amplitude<F>> for &Imag<F>

type Output = <Imag<F> as Mul<Amplitude<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Amplitude<F>> for &Product<F>

type Output = <Product<F> as Mul<Amplitude<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Amplitude<F>> for &Real<F>

type Output = <Real<F> as Mul<Amplitude<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Amplitude<F>> for &Sum<F>

type Output = <Sum<F> as Mul<Amplitude<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Amplitude<F>> for Box<dyn AmpLike<F>>

type Output = Product<F>

The resulting type after applying the * operator.

fn mul(self, rhs: Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Amplitude<F>> for Imag<F>

type Output = Product<F>

The resulting type after applying the * operator.

fn mul(self, rhs: Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Amplitude<F>> for Product<F>

type Output = Product<F>

The resulting type after applying the * operator.

fn mul(self, rhs: Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Amplitude<F>> for Real<F>

type Output = Product<F>

The resulting type after applying the * operator.

fn mul(self, rhs: Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Amplitude<F>> for Sum<F>

type Output = Sum<F>

The resulting type after applying the * operator.

fn mul(self, rhs: Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Box<dyn AmpLike<F>>> for Amplitude<F>

type Output = Product<F>

The resulting type after applying the * operator.

fn mul(self, rhs: Box<dyn AmpLike<F>>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Imag<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Mul<Imag<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Imag<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Imag<F>> for Amplitude<F>

type Output = Product<F>

The resulting type after applying the * operator.

fn mul(self, rhs: Imag<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Product<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Mul<Product<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Product<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Product<F>> for Amplitude<F>

type Output = Product<F>

The resulting type after applying the * operator.

fn mul(self, rhs: Product<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Real<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Mul<Real<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Real<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Real<F>> for Amplitude<F>

type Output = Product<F>

The resulting type after applying the * operator.

fn mul(self, rhs: Real<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Sum<F>> for &Amplitude<F>

type Output = <Amplitude<F> as Mul<Sum<F>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Sum<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul<Sum<F>> for Amplitude<F>

type Output = Sum<F>

The resulting type after applying the * operator.

fn mul(self, rhs: Sum<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Mul for Amplitude<F>

type Output = Product<F>

The resulting type after applying the * operator.

fn mul(self, rhs: Amplitude<F>) -> Self::Output

Performs the * operation.

impl<F: Field> Node<F> for Amplitude<F>

fn precalculate(&mut self, dataset: &Dataset<F>) -> Result<(), RustitudeError>

A method that is run once and stores some precalculated values given a Dataset input.

fn calculate( &self, parameters: &[F], event: &Event<F>, ) -> Result<Complex<F>, RustitudeError>

A method which runs every time the amplitude is evaluated and produces a [ComplexField].

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

A method which specifies the number and order of parameters used by the Node.

fn into_amplitude(self, name: &str) -> Amplitude<F>

where Self: Sized + 'static,

A convenience method for turning Nodes into Amplitudes.

fn named(self, name: &str) -> Amplitude<F>

where Self: Sized + 'static,

A convenience method for turning Nodes into Amplitudes. This method has a shorter name than Node::into_amplitude, which it calls.

fn is_python_node(&self) -> bool

A flag which says if the Node was written in Python. This matters because the GIL cannot currently play nice with rayon multithreading. You will probably never need to set this, as the only object which returns True is in the py_rustitude crate which binds this crate to Python.