kand 0.2.2

Kand: A Pure Rust technical analysis library inspired by TA-Lib.
Documentation
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
use crate::{TAFloat, error::KandError};

/// Calculates the lookback period required for T3 indicator
///
/// # Arguments
/// * `param_period` - Smoothing period (must be >= 2)
///
/// # Returns
/// * `Result<usize, KandError>` - Lookback period if successful
///
/// # Errors
/// * `KandError::InvalidParameter` - If `param_period` < 2
pub const fn lookback(param_period: usize) -> Result<usize, KandError> {
    #[cfg(feature = "check")]
    {
        // Parameter range check
        if param_period < 2 {
            return Err(KandError::InvalidParameter);
        }
    }
    Ok(6 * (param_period - 1))
}

/// Calculates T3 (Triple Exponential Moving Average) indicator for a price series
///
/// # Description
/// T3 is a sophisticated moving average developed by Tim Tillson that reduces lag while maintaining smoothness.
/// It combines six EMAs with optimized weightings to produce a responsive yet smooth indicator.
///
/// # Mathematical Formula
/// ```text
/// k = 2/(period + 1)
/// EMA1 = EMA(price, period)
/// EMA2 = EMA(EMA1, period)
/// EMA3 = EMA(EMA2, period)
/// EMA4 = EMA(EMA3, period)
/// EMA5 = EMA(EMA4, period)
/// EMA6 = EMA(EMA5, period)
///
/// Coefficients:
/// a = volume_factor
/// c1 = -a^3
/// c2 = 3*a^2 + 3*a^3
/// c3 = -6*a^2 - 3*a - 3*a^3
/// c4 = 1 + 3*a + a^3 + 3*a^2
///
/// T3 = c1*EMA6 + c2*EMA5 + c3*EMA4 + c4*EMA3
/// ```
///
/// # Arguments
/// * `input` - Price data array
/// * `param_period` - Smoothing period for EMAs (must be >= 2)
/// * `param_vfactor` - Volume factor controlling smoothing (typically 0-1)
/// * `output` - Array to store T3 values
/// * `output_ema1` - Array to store EMA1 values
/// * `output_ema2` - Array to store EMA2 values
/// * `output_ema3` - Array to store EMA3 values
/// * `output_ema4` - Array to store EMA4 values
/// * `output_ema5` - Array to store EMA5 values
/// * `output_ema6` - Array to store EMA6 values
///
/// # Returns
/// * `Result<(), KandError>` - Empty Ok if successful
///
/// # Errors
/// * `KandError::InvalidData` - If input array is empty
/// * `KandError::LengthMismatch` - If input/output array lengths don't match
/// * `KandError::InvalidParameter` - If `param_period` < 2
/// * `KandError::InsufficientData` - If input length <= lookback period
/// * `KandError::NaNDetected` - If NaN values found in input
///
/// # Example
/// ```
/// use kand::ohlcv::t3;
///
/// let input = vec![10.0, 12.0, 15.0, 14.0, 13.0, 11.0, 11.0];
/// let mut output = vec![0.0; input.len()];
/// let mut ema1 = vec![0.0; input.len()];
/// let mut ema2 = vec![0.0; input.len()];
/// let mut ema3 = vec![0.0; input.len()];
/// let mut ema4 = vec![0.0; input.len()];
/// let mut ema5 = vec![0.0; input.len()];
/// let mut ema6 = vec![0.0; input.len()];
///
/// t3::t3(
///     &input,
///     2,
///     0.7,
///     &mut output,
///     &mut ema1,
///     &mut ema2,
///     &mut ema3,
///     &mut ema4,
///     &mut ema5,
///     &mut ema6,
/// )
/// .unwrap();
/// ```
pub fn t3(
    input: &[TAFloat],
    param_period: usize,
    param_vfactor: TAFloat,
    output: &mut [TAFloat],
    output_ema1: &mut [TAFloat],
    output_ema2: &mut [TAFloat],
    output_ema3: &mut [TAFloat],
    output_ema4: &mut [TAFloat],
    output_ema5: &mut [TAFloat],
    output_ema6: &mut [TAFloat],
) -> Result<(), KandError> {
    let len = input.len();
    let lookback = lookback(param_period)?;

    #[cfg(feature = "check")]
    {
        // Empty data check
        if len == 0 {
            return Err(KandError::InvalidData);
        }

        // Data sufficiency check
        if len <= lookback {
            return Err(KandError::InsufficientData);
        }

        // Length consistency check
        if len != output.len()
            || len != output_ema1.len()
            || len != output_ema2.len()
            || len != output_ema3.len()
            || len != output_ema4.len()
            || len != output_ema5.len()
            || len != output_ema6.len()
        {
            return Err(KandError::LengthMismatch);
        }

        // Parameter range check
        if param_period < 2 {
            return Err(KandError::InvalidParameter);
        }
    }

    #[cfg(feature = "deep-check")]
    {
        for value in input.iter().take(len) {
            if value.is_nan() {
                return Err(KandError::NaNDetected);
            }
        }
    }

    let a = param_vfactor as TAFloat;
    let a2 = a * a;
    let a3 = a2 * a;

    // Calculate coefficients consistent with TA-Lib
    let c1 = -a3;
    let c2 = 3.0 * (a2 + a3);
    let c3 = 3.0f64.mul_add(-a3, (-6.0f64).mul_add(a2, -(3.0 * a)));
    let c4 = 3.0f64.mul_add(a2, 3.0f64.mul_add(a, 1.0) + a3);

    let k = crate::helper::period_to_k(param_period)?;
    let one_minus_k = 1.0 - k;

    // Sequential initialization mimicking TA-Lib's warm-up process.
    // "today" will serve as our pointer into the input array.
    let mut today = 0;

    // Initialize EMA1 with a simple moving average (SMA) of the first 'param_period' values.
    let mut temp = 0.0;
    for _ in 0..param_period {
        temp += input[today];
        today += 1;
    }
    let mut e1 = temp / (param_period as TAFloat);

    // Initialize EMA2 using the next (param_period - 1) values.
    temp = e1;
    for _ in 1..param_period {
        e1 = k.mul_add(input[today], one_minus_k * e1);
        temp += e1;
        today += 1;
    }
    let mut e2 = temp / (param_period as TAFloat);

    // Initialize EMA3.
    temp = e2;
    for _ in 1..param_period {
        e1 = k.mul_add(input[today], one_minus_k * e1);
        e2 = k.mul_add(e1, one_minus_k * e2);
        temp += e2;
        today += 1;
    }
    let mut e3 = temp / (param_period as TAFloat);

    // Initialize EMA4.
    temp = e3;
    for _ in 1..param_period {
        e1 = k.mul_add(input[today], one_minus_k * e1);
        e2 = k.mul_add(e1, one_minus_k * e2);
        e3 = k.mul_add(e2, one_minus_k * e3);
        temp += e3;
        today += 1;
    }
    let mut e4 = temp / (param_period as TAFloat);

    // Initialize EMA5.
    temp = e4;
    for _ in 1..param_period {
        e1 = k.mul_add(input[today], one_minus_k * e1);
        e2 = k.mul_add(e1, one_minus_k * e2);
        e3 = k.mul_add(e2, one_minus_k * e3);
        e4 = k.mul_add(e3, one_minus_k * e4);
        temp += e4;
        today += 1;
    }
    let mut e5 = temp / (param_period as TAFloat);

    // Initialize EMA6.
    temp = e5;
    for _ in 1..param_period {
        e1 = k.mul_add(input[today], one_minus_k * e1);
        e2 = k.mul_add(e1, one_minus_k * e2);
        e3 = k.mul_add(e2, one_minus_k * e3);
        e4 = k.mul_add(e3, one_minus_k * e4);
        e5 = k.mul_add(e4, one_minus_k * e5);
        temp += e5;
        today += 1;
    }
    let mut e6 = temp / (param_period as TAFloat);

    // Skip the remainder of the unstable period (if any).
    while today <= lookback {
        e1 = k.mul_add(input[today], one_minus_k * e1);
        e2 = k.mul_add(e1, one_minus_k * e2);
        e3 = k.mul_add(e2, one_minus_k * e3);
        e4 = k.mul_add(e3, one_minus_k * e4);
        e5 = k.mul_add(e4, one_minus_k * e5);
        e6 = k.mul_add(e5, one_minus_k * e6);
        today += 1;
    }

    // Write the first valid output at index = lookback.
    output[lookback] = c4.mul_add(e3, c3.mul_add(e4, c1.mul_add(e6, c2 * e5)));
    output_ema1[lookback] = e1;
    output_ema2[lookback] = e2;
    output_ema3[lookback] = e3;
    output_ema4[lookback] = e4;
    output_ema5[lookback] = e5;
    output_ema6[lookback] = e6;

    // Process the remaining data points.
    while today < len {
        e1 = k.mul_add(input[today], one_minus_k * e1);
        e2 = k.mul_add(e1, one_minus_k * e2);
        e3 = k.mul_add(e2, one_minus_k * e3);
        e4 = k.mul_add(e3, one_minus_k * e4);
        e5 = k.mul_add(e4, one_minus_k * e5);
        e6 = k.mul_add(e5, one_minus_k * e6);

        output[today] = c4.mul_add(e3, c3.mul_add(e4, c1.mul_add(e6, c2 * e5)));
        output_ema1[today] = e1;
        output_ema2[today] = e2;
        output_ema3[today] = e3;
        output_ema4[today] = e4;
        output_ema5[today] = e5;
        output_ema6[today] = e6;
        today += 1;
    }

    // Mark the unstable period indices with NaN.
    for i in 0..lookback {
        output[i] = TAFloat::NAN;
        output_ema1[i] = TAFloat::NAN;
        output_ema2[i] = TAFloat::NAN;
        output_ema3[i] = TAFloat::NAN;
        output_ema4[i] = TAFloat::NAN;
        output_ema5[i] = TAFloat::NAN;
        output_ema6[i] = TAFloat::NAN;
    }

    Ok(())
}

/// Calculates the latest T3 value incrementally using previous EMA values
///
/// # Description
/// Provides an efficient way to update T3 values in real-time by using previously calculated EMA values.
/// This avoids recalculating the entire series when only the latest value is needed.
///
/// # Arguments
/// * `input_price` - Latest price value to calculate T3 from
/// * `prev_ema1` - Previous EMA1 value
/// * `prev_ema2` - Previous EMA2 value
/// * `prev_ema3` - Previous EMA3 value
/// * `prev_ema4` - Previous EMA4 value
/// * `prev_ema5` - Previous EMA5 value
/// * `prev_ema6` - Previous EMA6 value
/// * `param_period` - Smoothing period for EMAs (must be >= 2)
/// * `param_vfactor` - Volume factor (typically 0-1)
///
/// # Returns
/// * `Result<(TAFloat, TAFloat, TAFloat, TAFloat, TAFloat, TAFloat, TAFloat), KandError>` - Tuple containing:
///   - Latest T3 value
///   - Updated EMA1 value
///   - Updated EMA2 value
///   - Updated EMA3 value
///   - Updated EMA4 value
///   - Updated EMA5 value
///   - Updated EMA6 value
///
/// # Errors
/// * `KandError::InvalidParameter` - If `param_period` < 2
/// * `KandError::NaNDetected` - If any input value is NaN
///
/// # Example
/// ```
/// use kand::ohlcv::t3;
///
/// let (t3_value, ema1, ema2, ema3, ema4, ema5, ema6) = t3::t3_inc(
///     100.0, // New price
///     95.0,  // Previous EMA1
///     94.0,  // Previous EMA2
///     93.0,  // Previous EMA3
///     92.0,  // Previous EMA4
///     91.0,  // Previous EMA5
///     90.0,  // Previous EMA6
///     5,     // Period
///     0.7,   // Volume factor
/// )
/// .unwrap();
/// ```
#[allow(clippy::too_many_arguments, clippy::type_complexity)]
pub fn t3_inc(
    input_price: TAFloat,
    prev_ema1: TAFloat,
    prev_ema2: TAFloat,
    prev_ema3: TAFloat,
    prev_ema4: TAFloat,
    prev_ema5: TAFloat,
    prev_ema6: TAFloat,
    param_period: usize,
    param_vfactor: TAFloat,
) -> Result<
    (
        TAFloat,
        TAFloat,
        TAFloat,
        TAFloat,
        TAFloat,
        TAFloat,
        TAFloat,
    ),
    KandError,
> {
    #[cfg(feature = "check")]
    {
        if param_period < 2 {
            return Err(KandError::InvalidParameter);
        }
    }

    #[cfg(feature = "deep-check")]
    {
        if input_price.is_nan()
            || prev_ema1.is_nan()
            || prev_ema2.is_nan()
            || prev_ema3.is_nan()
            || prev_ema4.is_nan()
            || prev_ema5.is_nan()
            || prev_ema6.is_nan()
        {
            return Err(KandError::NaNDetected);
        }
    }

    let k = crate::helper::period_to_k(param_period)?;
    let one_minus_k = 1.0 - k;

    // Calculate new EMA values
    let ema1 = input_price.mul_add(k, prev_ema1 * one_minus_k);
    let ema2 = ema1.mul_add(k, prev_ema2 * one_minus_k);
    let ema3 = ema2.mul_add(k, prev_ema3 * one_minus_k);
    let ema4 = ema3.mul_add(k, prev_ema4 * one_minus_k);
    let ema5 = ema4.mul_add(k, prev_ema5 * one_minus_k);
    let ema6 = ema5.mul_add(k, prev_ema6 * one_minus_k);

    // Calculate coefficients
    let a = param_vfactor as TAFloat;
    let a2 = a * a;
    let a3 = a2 * a;

    let c1 = -a3;
    let c2 = 3.0 * (a2 + a3);
    let c3 = 3.0f64.mul_add(-a3, (-6.0f64).mul_add(a2, -(3.0 * a)));
    let c4 = 3.0f64.mul_add(a2, 3.0f64.mul_add(a, 1.0) + a3);

    // Calculate T3
    let t3 = c4.mul_add(ema3, c3.mul_add(ema4, c1.mul_add(ema6, c2 * ema5)));

    Ok((t3, ema1, ema2, ema3, ema4, ema5, ema6))
}

#[cfg(test)]
mod tests {
    use approx::assert_relative_eq;

    use super::*;

    #[test]
    fn test_t3_calculation() {
        let input = vec![
            35216.1, 35221.4, 35190.7, 35170.0, 35181.5, 35254.6, 35202.8, 35251.9, 35197.6,
            35184.7, 35175.1, 35229.9, 35212.5, 35160.7, 35090.3, 35041.2, 34999.3, 35013.4,
            35069.0, 35024.6, 34939.5, 34952.6, 35000.0, 35041.8, 35080.0, 35114.5, 35097.2,
            35092.0, 35073.2, 35139.3, 35092.0, 35126.7, 35106.3, 35124.8, 35170.1,
        ];

        let param_period = 5;
        let param_vfactor = 0.7;
        let mut output = vec![0.0; input.len()];
        let mut output_ema1 = vec![0.0; input.len()];
        let mut output_ema2 = vec![0.0; input.len()];
        let mut output_ema3 = vec![0.0; input.len()];
        let mut output_ema4 = vec![0.0; input.len()];
        let mut output_ema5 = vec![0.0; input.len()];
        let mut output_ema6 = vec![0.0; input.len()];

        // Calculate T3 for the full series
        t3(
            &input,
            param_period,
            param_vfactor,
            &mut output,
            &mut output_ema1,
            &mut output_ema2,
            &mut output_ema3,
            &mut output_ema4,
            &mut output_ema5,
            &mut output_ema6,
        )
        .unwrap();

        // First 24 values should be NaN (lookback = 6 * (period - 1) = 24)
        for value in output.iter().take(24) {
            assert!(value.is_nan());
        }

        // Compare with known values
        let expected_values = [
            34_990.330_892_685_28,
            35_014.010_406_572_81,
            35_039.640_085_147_26,
            35_061.489_687_430_236,
            35_075.563_406_161_85,
            35_090.473_558_789_85,
            35_100.366_627_049_894,
            35_109.086_698_426_225,
            35_114.435_788_643_98,
            35_118.848_638_076_015,
            35_127.887_566_614_78,
        ];

        for (i, expected) in expected_values.iter().enumerate() {
            assert_relative_eq!(output[i + 24], *expected, epsilon = 0.0001);
        }

        // Test incremental calculation
        let mut prev_ema1: TAFloat = output_ema1[24];
        let mut prev_ema2: TAFloat = output_ema2[24];
        let mut prev_ema3: TAFloat = output_ema3[24];
        let mut prev_ema4: TAFloat = output_ema4[24];
        let mut prev_ema5: TAFloat = output_ema5[24];
        let mut prev_ema6: TAFloat = output_ema6[24];

        // Test each incremental step matches the full calculation
        for i in 25..input.len() {
            let (t3, ema1, ema2, ema3, ema4, ema5, ema6) = t3_inc(
                input[i],
                prev_ema1,
                prev_ema2,
                prev_ema3,
                prev_ema4,
                prev_ema5,
                prev_ema6,
                param_period,
                param_vfactor,
            )
            .unwrap();

            assert_relative_eq!(t3, output[i], epsilon = 0.0001);
            assert_relative_eq!(ema1, output_ema1[i], epsilon = 0.0001);
            assert_relative_eq!(ema2, output_ema2[i], epsilon = 0.0001);
            assert_relative_eq!(ema3, output_ema3[i], epsilon = 0.0001);
            assert_relative_eq!(ema4, output_ema4[i], epsilon = 0.0001);
            assert_relative_eq!(ema5, output_ema5[i], epsilon = 0.0001);
            assert_relative_eq!(ema6, output_ema6[i], epsilon = 0.0001);

            prev_ema1 = ema1;
            prev_ema2 = ema2;
            prev_ema3 = ema3;
            prev_ema4 = ema4;
            prev_ema5 = ema5;
            prev_ema6 = ema6;
        }
    }
}