Struct EfficiencyRatio

#[repr(C)]
pub struct EfficiencyRatio {
    pub period: usize,
    pub price_type: PriceType,
    pub value: f64,
    pub inputs: Vec<f64>,
    pub initialized: bool,
    /* private fields */
}

An indicator which calculates the efficiency ratio across a rolling window.

The Kaufman Efficiency measures the ratio of the relative market speed in relation to the volatility, this could be thought of as a proxy for noise.

Fields

period: usize

The rolling window period for the indicator (>= 2).

price_type: PriceType

value: f64

inputs: Vec<f64>

initialized: bool

Implementations

impl EfficiencyRatio

pub fn new(period: usize, price_type: Option<PriceType>) -> Self

Creates a new EfficiencyRatio instance.

pub fn update_raw(&mut self, value: f64)

Trait Implementations

impl Debug for EfficiencyRatio

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

Formats the value using the given formatter.

impl Display for EfficiencyRatio

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

Formats the value using the given formatter.

impl Indicator for EfficiencyRatio

fn name(&self) -> String

fn has_inputs(&self) -> bool

fn initialized(&self) -> bool

fn handle_quote(&mut self, quote: &QuoteTick)

fn handle_trade(&mut self, trade: &TradeTick)

fn handle_bar(&mut self, bar: &Bar)

fn reset(&mut self)

fn handle_delta(&mut self, delta: &OrderBookDelta)

fn handle_deltas(&mut self, deltas: &OrderBookDeltas)

fn handle_depth(&mut self, depth: &OrderBookDepth10)

fn handle_book(&mut self, book: &OrderBook)

impl IntoPy<Py<PyAny>> for EfficiencyRatio

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

Performs the conversion.

impl PyClass for EfficiencyRatio

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for EfficiencyRatio

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

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

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

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

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

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

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

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

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

impl PyMethods<EfficiencyRatio> for PyClassImplCollector<EfficiencyRatio>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for EfficiencyRatio

const NAME: &'static str = "EfficiencyRatio"

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.

impl DerefToPyAny for EfficiencyRatio