Struct PyTolerance 

pub struct PyTolerance {
    pub(crate) inner: Tolerance,
}

How hard a ladder solver tries: a residual in the instrument’s units, a Newton step on the parameter, and the iteration, backtrack and sweep budgets — the core’s defaults unless overridden.

Fields

inner: Tolerance

Implementations

impl PyTolerance

pub(crate) fn __repr__(&self) -> String

pub(crate) fn new( residual: Option<f64>, step: Option<f64>, max_iterations: Option<usize>, max_backtracks: Option<usize>, max_sweeps: Option<usize>, ) -> Self

pub(crate) fn residual(&self) -> f64

Residual below which a pillar is solved, in the instrument’s units.

pub(crate) fn step(&self) -> f64

Newton step below which the parameter is taken as converged.

pub(crate) fn max_iterations(&self) -> usize

Iterations allowed per pillar.

pub(crate) fn max_backtracks(&self) -> usize

Halvings allowed of one Newton step.

pub(crate) fn max_sweeps(&self) -> usize

Full-curve sweeps allowed after the sequential pass.

Trait Implementations

impl Clone for PyTolerance

fn clone(&self) -> PyTolerance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PyTolerance

impl DerefToPyAny for PyTolerance

impl IntoPy<Py<PyAny>> for PyTolerance

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

Performs the conversion.

impl PyClass for PyTolerance

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for PyTolerance

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

This handles following two situations:

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

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 PyClassNewTextSignature<PyTolerance> for PyClassImplCollector<PyTolerance>

fn new_text_signature(self) -> Option<&'static str>

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

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

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

impl PyMethods<PyTolerance> for PyClassImplCollector<PyTolerance>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyTolerance

const NAME: &'static str = "Tolerance"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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

Returns the safe abstraction over the type object.

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_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.