Struct rustitude_core::manager::Parameter

pub struct Parameter { /* private fields */ }

A struct which specifies if a given parameter is fixed or free and gives the corresponding value and input index as well as information about the parameter’s position in sums, groups, and amplitudes.

This struct is mostly used internally by the Manager struct. The index usize corresponds to the index this parameter should be sourced from in the input vector. Parameters will have input indices larger than the number of free parameters in the system, and parameter indices will automatically be incremented and decremented when new parameters are added, fixed, or constrained.

See also: Manager::fix, Manager::free, Manager::constrain

Implementations

impl Parameter

pub fn new( sum: &str, group: &str, amplitude: &str, name: &str, index: usize ) -> Self

pub fn get_sum(&self) -> String

pub fn get_group(&self) -> String

pub fn get_amplitude(&self) -> String

pub fn get_name(&self) -> String

pub fn increment(&mut self)

Increments the index by 1.

pub fn decrement(&mut self)

Decrements the index by 1.

pub fn set_index(&mut self, index: usize)

Sets the index to a given value.

pub fn get_index(&self) -> usize

Getter method for the index.

pub fn fix(&mut self, index: usize, value: f64)

Converts the Parameter from free to fixed with the given index and value.

pub fn free(&mut self, index: usize, initial_value: f64)

Converts the Parameter from fixed to free with a given index and initial value.

pub fn is_fixed(&self) -> bool

Checks if the Parameter is fixed.

pub fn fixed(&self) -> Option<f64>

Getter method for fixed.

pub fn set_bounds(&mut self, lower_bound: f64, upper_bound: f64)

pub fn set_initial(&mut self, initial_value: f64)

pub fn get_bounds(&self) -> (f64, f64)

pub fn get_initial(&self) -> f64

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl Display for Parameter

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

Formats the value using the given formatter.

impl HasPyGilRef for Parameter

type AsRefTarget = PyCell<Parameter>

Utility type to make Py::as_ref work.

impl IntoPy<Py<PyAny>> for Parameter

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

Performs the conversion.

impl PartialEq for Parameter

fn eq(&self, other: &Parameter) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Parameter

fn partial_cmp(&self, other: &Parameter) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PyClass for Parameter

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Parameter

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

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 Parameter

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

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

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

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

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

impl PyTypeInfo for Parameter

const NAME: &'static str = "Parameter"

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 Parameter

impl StructuralPartialEq for Parameter