1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
//! On-Neck candlestick pattern.
use crate::ohlcv::Candle;
use crate::traits::Indicator;
/// On-Neck — a 2-bar bearish continuation. In a decline a long black candle is
/// followed by a white candle that opens below the black bar's low yet rallies
/// only as far as the black bar's *low* (the "neckline"). The feeble bounce shows
/// sellers remain in control.
///
/// ```text
/// long body = |close − open| >= 0.5 * (high − low)
/// bar1 black & long
/// bar2 white, opens below bar1's low (open2 < low1)
/// bar2 closes at bar1's low (the neckline) (|close2 − low1| <= 0.05 · range1)
/// ```
///
/// Output is `−1.0` when the pattern completes and `0.0` otherwise. On-Neck is a
/// single-direction (bearish-only) continuation, so it never emits `+1.0`. The
/// first bar always returns `0.0` because the two-bar window is not yet filled.
/// Body and neckline 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` bearish, `0.0` no pattern — so it drops straight into
/// a machine-learning feature matrix as a single dimension.
///
/// # Example
///
/// ```
/// use wickra_core::{Candle, Indicator, OnNeck};
///
/// let mut indicator = OnNeck::new();
/// indicator.update(Candle::new(15.0, 15.1, 9.0, 10.0, 1.0, 0).unwrap());
/// let out = indicator
/// .update(Candle::new(7.0, 9.1, 6.9, 9.0, 1.0, 1).unwrap());
/// assert_eq!(out, Some(-1.0));
/// ```
#[derive(Debug, Clone, Default)]
pub struct OnNeck {
prev: Option<Candle>,
has_emitted: bool,
}
impl OnNeck {
/// Construct a new On-Neck detector.
pub const fn new() -> Self {
Self {
prev: None,
has_emitted: false,
}
}
}
impl Indicator for OnNeck {
type Input = Candle;
type Output = f64;
fn update(&mut self, candle: Candle) -> Option<f64> {
self.has_emitted = true;
let prev = self.prev;
self.prev = Some(candle);
let Some(bar1) = prev else {
return Some(0.0);
};
let range1 = bar1.high - bar1.low;
if range1 <= 0.0 {
return Some(0.0);
}
if bar1.close < bar1.open
&& (bar1.open - bar1.close) >= 0.5 * range1
&& candle.close > candle.open
&& candle.open < bar1.low
&& (candle.close - bar1.low).abs() <= 0.05 * range1
{
return Some(-1.0);
}
Some(0.0)
}
fn reset(&mut self) {
self.prev = None;
self.has_emitted = false;
}
fn warmup_period(&self) -> usize {
2
}
fn is_ready(&self) -> bool {
self.has_emitted
}
fn name(&self) -> &'static str {
"OnNeck"
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::traits::BatchExt;
fn c(open: f64, high: f64, low: f64, close: f64, ts: i64) -> Candle {
Candle::new(open, high, low, close, 1.0, ts).unwrap()
}
#[test]
fn accessors_and_metadata() {
let t = OnNeck::new();
assert_eq!(t.name(), "OnNeck");
assert_eq!(t.warmup_period(), 2);
assert!(!t.is_ready());
}
#[test]
fn on_neck_is_minus_one() {
let mut t = OnNeck::new();
assert_eq!(t.update(c(15.0, 15.1, 9.0, 10.0, 0)), Some(0.0));
assert_eq!(t.update(c(7.0, 9.1, 6.9, 9.0, 1)), Some(-1.0));
}
#[test]
fn close_into_body_yields_zero() {
let mut t = OnNeck::new();
t.update(c(15.0, 15.1, 9.0, 10.0, 0));
// Closes at the prior close, not the low -> in-neck, not on-neck.
assert_eq!(t.update(c(7.0, 10.2, 6.9, 10.1, 1)), Some(0.0));
}
#[test]
fn second_bar_black_yields_zero() {
let mut t = OnNeck::new();
t.update(c(15.0, 15.1, 9.0, 10.0, 0));
assert_eq!(t.update(c(9.5, 9.6, 6.9, 9.0, 1)), Some(0.0));
}
#[test]
fn opens_above_low_yields_zero() {
let mut t = OnNeck::new();
t.update(c(15.0, 15.1, 9.0, 10.0, 0));
// Opens above bar1's low.
assert_eq!(t.update(c(9.5, 10.1, 9.4, 10.0, 1)), Some(0.0));
}
#[test]
fn first_bar_returns_zero() {
let mut t = OnNeck::new();
assert_eq!(t.update(c(15.0, 15.1, 9.0, 10.0, 0)), Some(0.0));
}
#[test]
fn batch_equals_streaming() {
let candles: Vec<Candle> = (0..40)
.map(|i| {
let base = 100.0 + i as f64;
c(base + 5.0, base + 5.1, base - 1.0, base, i)
})
.collect();
let mut a = OnNeck::new();
let mut b = OnNeck::new();
assert_eq!(
a.batch(&candles),
candles.iter().map(|x| b.update(*x)).collect::<Vec<_>>()
);
}
#[test]
fn reset_clears_state() {
let mut t = OnNeck::new();
t.update(c(15.0, 15.1, 9.0, 10.0, 0));
t.update(c(7.0, 9.1, 6.9, 9.0, 1));
assert!(t.is_ready());
t.reset();
assert!(!t.is_ready());
assert_eq!(t.update(c(15.0, 15.1, 9.0, 10.0, 0)), Some(0.0));
}
#[test]
fn zero_range_first_bar_yields_zero() {
let mut t = OnNeck::new();
// Flat first bar (range1 == 0) -> rejected.
t.update(c(10.0, 10.0, 10.0, 10.0, 0));
assert_eq!(t.update(c(9.0, 10.0, 8.0, 9.5, 1)), Some(0.0));
}
}