Struct Trin 

pub struct Trin { /* private fields */ }

TRIN (Arms Index) — (advancers / decliners) / (advancing volume / declining volume).

The TRIN compares the breadth of a move in issues to the breadth of the move in volume. A value near 1.0 means advancing issues and advancing volume are in balance; a value below 1.0 is bullish (volume is concentrated in advancing issues relative to their count); a value above 1.0 is bearish (declining issues are absorbing disproportionate volume).

To stay finite on degenerate ticks the decliner count is floored to one and both volume sums are floored to 1.0, so a tick with no declining issues or no volume on one side still yields a defined reading instead of a division by zero.

Input = CrossSection, Output = f64, warmup_period == 1.

Example

use wickra_core::{CrossSection, Indicator, Member, Trin};

let mut trin = Trin::new();
// 3 advancers / 1 decliner = 3; adv vol 150 / dec vol 50 = 3; TRIN = 1.0.
let tick = CrossSection::new(
    vec![
        Member::new(1.0, 50.0, false, false),
        Member::new(1.0, 50.0, false, false),
        Member::new(1.0, 50.0, false, false),
        Member::new(-1.0, 50.0, false, false),
    ],
    0,
)
.unwrap();
assert_eq!(trin.update(tick), Some(1.0));

Implementations

impl Trin

pub const fn new() -> Self

Construct a new TRIN / Arms Index indicator.

Trait Implementations

impl Clone for Trin

fn clone(&self) -> Trin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Trin

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

Formats the value using the given formatter.

impl Default for Trin

fn default() -> Trin

Returns the “default value” for a type.

impl Indicator for Trin

type Input = CrossSection

Type of one input data point (typically f64 for a price, or Candle / Tick).

type Output = f64

Type of one output value.

fn update(&mut self, section: CrossSection) -> Option<f64>

Feed one new data point into the indicator and return the freshly computed output, or None if the indicator is still warming up.

fn reset(&mut self)

Reset all internal state, leaving the indicator equivalent to a freshly constructed instance with the same parameters.

fn warmup_period(&self) -> usize

Number of inputs required before the first non-None output can be produced.

fn is_ready(&self) -> bool

Whether the indicator has emitted at least one value since the last reset.

fn name(&self) -> &'static str

Stable, human-readable indicator name. Used by chaining and diagnostics.