Struct PolarComplexScalar

pub struct PolarComplexScalar;

A Node for computing a single complex value from two input parameters in polar form.

This struct implements Node to generate a complex value from two input parameters called mag and phi.

Parameters:

• mag: The magnitude of the complex scalar.
• phi: The phase of the complex scalar.

Trait Implementations

impl Clone for PolarComplexScalar

fn clone(&self) -> PolarComplexScalar

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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 Complex.

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

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

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 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.