Struct UniqueThreeRiver 

pub struct UniqueThreeRiver { /* private fields */ }

Unique Three River (Bottom) — a 3-bar bullish reversal. A long black candle is followed by a smaller black candle whose body sits inside the first but whose long lower shadow probes a new low, then a small white candle that stays below the second body. The fresh low that fails to hold marks an exhausted decline.

bar1 long black: open1 − close1 >= 0.5 * (high1 − low1)
bar2 black, body inside bar1's body, with a new low (low2 < low1)
bar3 small white, contained below bar2's body (high3 <= close2)
small body: close3 − open3 <= 0.3 * (high3 − low3)

Output is +1.0 when the pattern completes and 0.0 otherwise. Unique Three River is a single-direction (bullish-only) reversal, so it never emits −1.0. The first two bars always return 0.0 because the three-bar window is not yet filled. Body thresholds follow the geometric house style rather than TA-Lib’s rolling averages. Pattern-shape check only — no trend filter is applied; combine with a trend indicator for actionable signals.

Signed ±1 encoding

This detector emits the uniform candlestick sign convention shared across the pattern family — +1.0 bullish, 0.0 no pattern — so it drops straight into a machine-learning feature matrix as a single dimension.

Example

use wickra_core::{Candle, Indicator, UniqueThreeRiver};

let mut indicator = UniqueThreeRiver::new();
indicator.update(Candle::new(15.0, 15.1, 10.0, 10.5, 1.0, 0).unwrap());
indicator.update(Candle::new(14.0, 14.1, 9.0, 11.0, 1.0, 1).unwrap());
let out = indicator
    .update(Candle::new(10.2, 10.9, 9.5, 10.4, 1.0, 2).unwrap());
assert_eq!(out, Some(1.0));

Implementations

impl UniqueThreeRiver

pub const fn new() -> Self

Construct a new Unique Three River detector.

Trait Implementations

impl Clone for UniqueThreeRiver

fn clone(&self) -> UniqueThreeRiver

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UniqueThreeRiver

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

Formats the value using the given formatter.

impl Default for UniqueThreeRiver

fn default() -> UniqueThreeRiver

Returns the “default value” for a type.

impl Indicator for UniqueThreeRiver

type Input = Candle

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, candle: Candle) -> 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.