Struct PyPredictedPnl 

pub struct PyPredictedPnl {
    pub(crate) inner: PredictedPnl,
}

The predicted explain: first order from risk plus one directional second-order pass.

Fields

inner: PredictedPnl

Implementations

impl PyPredictedPnl

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

pub(crate) fn rows(&self) -> PyRecords

Each market input’s contribution, (input, risk × move).

pub(crate) fn by_axis(&self) -> PyRecords

The rows summed by axis, (axis, contribution); None for an input on no axis.

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

The sum of the first-order rows.

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

The one-pass second-order term along the move.

pub(crate) fn own_gamma(&self) -> PyRecords

The quadratic’s own-gamma terms, (axis, value) per axis group that moved, an empty axis for the inputs on no axis: ½ d_aᵀ H d_a from one second-order pass along the move restricted to the group.

pub(crate) fn cross_gamma(&self) -> PyRecords

The quadratic’s cross-gamma terms, (axis, other, value) per pair of moved groups, one symmetric number each: d_aᵀ H d_b, by the polarisation identity from the passes along each group and along both.

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

quadratic less the own and cross terms: round-off, reported as a health check of the split.

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

The reset step: the exact revaluation from each new print’s forecast to the print, for the prints after holds and before does not; zero when there are none. resets + first_order + quadratic + residual is actual.

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

The value before the move.

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

The value after the move.

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

after − before.

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

What first and second order together leave unexplained.

Trait Implementations

impl Clone for PyPredictedPnl

fn clone(&self) -> PyPredictedPnl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DerefToPyAny for PyPredictedPnl

impl IntoPy<Py<PyAny>> for PyPredictedPnl

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

Performs the conversion.

impl PyClass for PyPredictedPnl

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for PyPredictedPnl

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

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<'a, 'py> PyFunctionArgument<'a, 'py> for &'a PyPredictedPnl

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

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

impl PyMethods<PyPredictedPnl> for PyClassImplCollector<PyPredictedPnl>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyPredictedPnl

const NAME: &'static str = "PredictedPnl"

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.