Struct IchimokuCloud 

pub struct IchimokuCloud {

    pub tenkan_period: usize,
    pub kijun_period: usize,
    pub senkou_period: usize,
    pub displacement: usize,
    pub tenkan_sen: f64,
    pub kijun_sen: f64,
    pub senkou_span_a: f64,
    pub senkou_span_b: f64,
    pub chikou_span: f64,
    pub has_tenkan: bool,
    pub has_kijun: bool,
    pub has_senkou_a: bool,
    pub has_senkou_b: bool,
    pub has_chikou: bool,
    pub count: usize,
    pub initialized: bool,
    /* private fields */
}

Ichimoku Kinko Hyo: the five-line cloud chart.

tenkan_sen    = midpoint(high, low over tenkan_period)
kijun_sen     = midpoint(high, low over kijun_period)
senkou_span_a = (tenkan_sen + kijun_sen) / 2      as computed `displacement - 1` bars ago
senkou_span_b = midpoint(high, low over senkou_period) as computed `displacement - 1` bars ago
chikou_span   = close from `displacement - 1` bars ago

The two Senkou spans form the Kumo (cloud). Charts draw them displacement bars ahead and the Chikou span displacement bars behind; streaming in chronological order, the values visible at bar n are the ones buffered displacement updates ago, that is bar n - displacement + 1.

Each line becomes available at its own bar: tenkan_sen after tenkan_period bars, kijun_sen after kijun_period, chikou_span after displacement, senkou_span_a after kijun_period + displacement - 1, and senkou_span_b after senkou_period + displacement - 1 (77 bars at the classic (9, 26, 52, 26)). The matching has_* flag reports whether each field holds a value, and initialized gates on all five.

Fields

tenkan_period: usize

kijun_period: usize

senkou_period: usize

displacement: usize

tenkan_sen: f64

kijun_sen: f64

senkou_span_a: f64

senkou_span_b: f64

chikou_span: f64

has_tenkan: bool

has_kijun: bool

has_senkou_a: bool

has_senkou_b: bool

has_chikou: bool

count: usize

initialized: bool

Implementations

impl IchimokuCloud

pub fn new( tenkan_period: usize, kijun_period: usize, senkou_period: usize, displacement: usize, ) -> Self

Creates a new IchimokuCloud instance.

Panics

Panics if:

• any of tenkan_period, kijun_period, senkou_period or displacement is zero or exceeds 16,777,216.
• the periods are not non-decreasing (tenkan_period <= kijun_period <= senkou_period).

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

Updates the indicator with the given high, low and close.

Trait Implementations

impl Debug for IchimokuCloud

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

Formats the value using the given formatter.

impl DerefToPyAny for IchimokuCloud

impl Display for IchimokuCloud

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

Formats the value using the given formatter.

impl ExtractPyClassWithClone for IchimokuCloud

impl Indicator for IchimokuCloud

fn name(&self) -> String

fn has_inputs(&self) -> bool

fn initialized(&self) -> bool

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: &OrderBookDepth)

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

fn handle_quote(&mut self, quote: &QuoteTick) -> Result<()>

Updates the indicator with the given quote tick.

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

impl<'py> IntoPyObject<'py> for IchimokuCloud

type Target = IchimokuCloud

The Python output type

type Output = Bound<'py, <IchimokuCloud 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 IchimokuCloud

const NAME: &str = "IchimokuCloud"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for IchimokuCloud

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 = /// Ichimoku Kinko Hyo: the five-line cloud chart. /// /// ```text /// tenkan_sen = midpoint(high, low over tenkan_period) /// kijun_sen = midpoint(high, low over kijun_period) /// senkou_span_a = (tenkan_sen + kijun_sen) / 2 as computed `displacement - 1` bars ago /// senkou_span_b = midpoint(high, low over senkou_period) as computed `displacement - 1` bars ago /// chikou_span = close from `displacement - 1` bars ago /// ``` /// /// The two Senkou spans form the Kumo (cloud). Charts draw them `displacement` /// bars ahead and the Chikou span `displacement` bars behind; streaming in /// chronological order, the values visible at bar `n` are the ones buffered /// `displacement` updates ago, that is bar `n - displacement + 1`. /// /// Each line becomes available at its own bar: `tenkan_sen` after `tenkan_period` /// bars, `kijun_sen` after `kijun_period`, `chikou_span` after `displacement`, /// `senkou_span_a` after `kijun_period + displacement - 1`, and `senkou_span_b` /// after `senkou_period + displacement - 1` (77 bars at the classic /// `(9, 26, 52, 26)`). The matching `has_*` flag reports whether each field /// holds a value, and `initialized` gates on all five.

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 = <<IchimokuCloud as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<IchimokuCloud>

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 = Pyo3MethodsInventoryForIchimokuCloud

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 IchimokuCloud

const TEXT_SIGNATURE: &'static str = "(tenkan_period=9, kijun_period=26, senkou_period=52, displacement=26)"

impl PyStubType for IchimokuCloud

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 IchimokuCloud

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.