Enum BoxSizeMethod 

pub enum BoxSizeMethod {
    Fixed,
    Atr {
        period: usize,
        multiplier: f64,
    },
    Percentage(f64),
}

How a price-based chart obtains its size in price units. Resolve from the loaded history when selecting the method, then keep the result while bars stream in. Reapply the parameters to explicitly recalculate from newer history.

Variants

Fixed

Use the chart type’s explicit size in price units.

Atr

Wilder’s average true range, seeded with the mean of the first period true ranges, then smoothed through the remaining history and multiplied by multiplier.

Fields

period: usize

Number of true ranges in the seed and smoothing period; at least 1.

multiplier: f64

Positive, finite multiple of ATR.

Percentage(f64)

A percentage of the absolute latest close; 1 means 1%.

Implementations

impl BoxSizeMethod

pub fn resolve(self, fixed: f64, bars: &[Bar]) -> Option<f64>

Resolve a positive finite size, or None for invalid inputs or insufficient history. The first bar’s true range is its high minus low. Later true ranges are the largest of high minus low, absolute high minus previous close, and absolute low minus previous close.

Trait Implementations

impl Clone for BoxSizeMethod

fn clone(&self) -> BoxSizeMethod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BoxSizeMethod

impl Debug for BoxSizeMethod

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

Formats the value using the given formatter.

impl Default for BoxSizeMethod

fn default() -> BoxSizeMethod

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BoxSizeMethod

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BoxSizeMethod

fn eq(&self, other: &BoxSizeMethod) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for BoxSizeMethod

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BoxSizeMethod