Struct AroonOscillator 

pub struct AroonOscillator {
    pub period: usize,
    pub aroon_up: f64,
    pub aroon_down: f64,
    pub value: f64,
    pub count: usize,
    pub initialized: bool,
    /* private fields */
}

The Aroon Oscillator calculates the Aroon Up and Aroon Down indicators to determine if an instrument is trending, and the strength of the trend.

Fields

period: usize

aroon_up: f64

aroon_down: f64

value: f64

count: usize

initialized: bool

Implementations

impl AroonOscillator

pub fn new(period: usize) -> Self

Creates a new AroonOscillator instance.

Panics

Panics if period is not positive (> 0).

pub fn update_raw(&mut self, high: f64, low: f64)

impl AroonOscillator

pub fn py_new(period: usize) -> Self

The Aroon Oscillator calculates the Aroon Up and Aroon Down indicators to determine if an instrument is trending, and the strength of the trend.

Trait Implementations

impl Debug for AroonOscillator

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

Formats the value using the given formatter.

impl Display for AroonOscillator

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

Formats the value using the given formatter.

impl Indicator for AroonOscillator

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<'py> IntoPyObject<'py> for AroonOscillator

type Target = AroonOscillator

The Python output type

type Output = Bound<'py, <AroonOscillator as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for AroonOscillator

const NAME: &str = "AroonOscillator"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for AroonOscillator

const MODULE: Option<&str>

Module which the class will be associated with.

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)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// The Aroon Oscillator calculates the Aroon Up and Aroon Down indicators to /// determine if an instrument is trending, and the strength of the trend.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<AroonOscillator as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<AroonOscillator>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForAroonOscillator

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 lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for AroonOscillator

const TEXT_SIGNATURE: &'static str = "(period)"

impl PyStubType for AroonOscillator

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for AroonOscillator

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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

Returns the safe abstraction over the type object.

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

Checks if object is an instance of this type.

impl DerefToPyAny for AroonOscillator

impl ExtractPyClassWithClone for AroonOscillator