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
//! Series transforms: input bars in, a new
//! OHLC-like series out (Renko, Range Bars, Kagi, Point & Figure). The
//! built-in transforms are in [`crate::transform`].
use crateSeriesKind;
use InputBar;
/// One output element of a [`SeriesTransform`].
/// Elements one `push` or `peek` call may write.
pub const MAX_OUTPUT_PER_CALL: usize = 65_536;
/// Reused output buffer of a [`SeriesTransform`] call; clearing keeps the
/// capacity, so a warmed-up buffer does not allocate.
/// Turns input bars into a new series, with the peek/push model of
/// indicators: the output is the elements `push` wrote for every
/// input but the last (finished, never changed again) followed by what
/// `peek` writes for the last input (the elements it would finish and the
/// ones still forming). Gap bars are never passed in.
///
/// # Examples
///
/// ```
/// use ferrochart_core::frame::SeriesKind;
/// use ferrochart_core::plugin::{InputBar, SeriesTransform, TransformBar, TransformOutput};
///
/// /// One element per input whose close moved by at least 1 since the last one.
/// #[derive(Default)]
/// struct Steps {
/// last: Option<f64>,
/// }
///
/// impl Steps {
/// fn step(last: Option<f64>, bar: &InputBar) -> Option<TransformBar> {
/// let from = last?;
/// ((bar.close - from).abs() >= 1.0).then(|| TransformBar {
/// open: from,
/// high: from.max(bar.close),
/// low: from.min(bar.close),
/// close: bar.close,
/// volume: f64::NAN,
/// flag: 0,
/// })
/// }
/// }
///
/// impl SeriesTransform for Steps {
/// fn name(&self) -> &str {
/// "steps"
/// }
/// fn output_kind(&self) -> SeriesKind {
/// SeriesKind::Candlestick
/// }
/// fn push(&mut self, bar: InputBar, out: &mut TransformOutput) {
/// match Self::step(self.last, &bar) {
/// Some(b) => {
/// out.push(b);
/// self.last = Some(bar.close);
/// }
/// None if self.last.is_none() => self.last = Some(bar.close),
/// None => {}
/// }
/// }
/// fn peek(&self, bar: InputBar, out: &mut TransformOutput) {
/// if let Some(b) = Self::step(self.last, &bar) {
/// out.push(b);
/// }
/// }
/// fn reset(&mut self) {
/// self.last = None;
/// }
/// }
/// ```