Struct rustitude_core::amplitude::Amplitude

pub struct Amplitude {
    pub name: String,
    pub node: Arc<RwLock<Box<dyn Node>>>,
    pub active: bool,
    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.

This is mostly used interally as an intermediate step to an AmpOp.

Fields

name: String

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

node: Arc<RwLock<Box<dyn Node>>>

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

active: bool

cache_position: usize

parameter_index_start: usize

Implementations

impl Amplitude

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

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

Trait Implementations

impl Clone for Amplitude

fn clone(&self) -> Amplitude

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Amplitude

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

Formats the value using the given formatter.

impl Display for Amplitude

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

Formats the value using the given formatter.

impl From<Amplitude> for AmpOp

fn from(amp: Amplitude) -> Self

Converts to this type from the input type.

impl From<Amplitude> for PyAmpOp

fn from(amp: Amplitude) -> Self

Converts to this type from the input type.

impl HasPyGilRef for Amplitude

type AsRefTarget = PyCell<Amplitude>

Utility type to make Py::as_ref work.

impl IntoPy<Py<PyAny>> for Amplitude

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl Node for Amplitude

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

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

fn calculate( &self, parameters: &[f64], event: &Event ) -> Result<Complex64, NodeError>

A method which runs every time the amplitude is evaluated and produces a Complex64.

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

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

impl PyClass for Amplitude

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Amplitude

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Amplitude>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a Amplitude

type Holder = Option<PyRef<'py, Amplitude>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut Amplitude

type Holder = Option<PyRefMut<'py, Amplitude>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder ) -> PyResult<Self>

impl PyMethods<Amplitude> for PyClassImplCollector<Amplitude>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Amplitude

const NAME: &'static str = "Amplitude"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

👎Deprecated since 0.21.0: PyTypeInfo::type_object will be replaced by PyTypeInfo::type_object_bound in a future PyO3 version

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_type_of will be replaced by PyTypeInfo::is_type_of_bound in a future PyO3 version

Checks if object is an instance of this type or a subclass of this type.

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_exact_type_of will be replaced by PyTypeInfo::is_exact_type_of_bound in a future PyO3 version

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for Amplitude