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

use num_enum::{IntoPrimitive, TryFromPrimitive};

/// Moving Average types for technical analysis.
///
/// The integer representation of this enum is determined by the enabled features:
/// - With feature "i64": Uses i64 representation (extended precision)
/// - With feature "i32": Uses i32 representation (standard precision)
/// - With no features enabled: Defaults to i32
///
/// # Variants
///
/// * `DEMA` - Double Exponential Moving Average
/// * `EMA` - Exponential Moving Average
/// * `KAMA` - Kaufman Adaptive Moving Average
/// * `MAMA` - MESA Adaptive Moving Average
/// * `RMA` - Wilder's Smoothed Moving Average
/// * `SMA` - Simple Moving Average
/// * `T3` - Triple Exponential Moving Average (T3)
/// * `TEMA` - Triple Exponential Moving Average
/// * `TRIMA` - Triangular Moving Average
/// * `WMA` - Weighted Moving Average
#[derive(Debug, Clone, Copy, PartialEq, Eq, IntoPrimitive, TryFromPrimitive)]
#[cfg(feature = "i64")]
#[repr(i64)]
pub enum MAType {
    DEMA  = 0,
    EMA   = 1,
    KAMA  = 2,
    MAMA  = 3,
    RMA   = 4,
    SMA   = 5,
    T3    = 6,
    TEMA  = 7,
    TRIMA = 8,
    WMA   = 9,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, IntoPrimitive, TryFromPrimitive)]
#[cfg(not(feature = "i64"))]
#[repr(i32)]
pub enum MAType {
    DEMA  = 0,
    EMA   = 1,
    KAMA  = 2,
    MAMA  = 3,
    RMA   = 4,
    SMA   = 5,
    T3    = 6,
    TEMA  = 7,
    TRIMA = 8,
    WMA   = 9,
}

impl Default for MAType {
    /// Returns the default Moving Average type (SMA).
    ///
    /// # Returns
    ///
    /// * [`MAType::SMA`] - Simple Moving Average, chosen for its:
    ///     - Widespread use and familiarity
    ///     - Computational simplicity
    ///     - Reliable baseline performance
    fn default() -> Self {
        Self::SMA
    }
}

/// Standard signal values for technical indicators.
///
/// The integer representation of this enum is determined by the enabled features:
/// - With feature "i64": Uses i64 representation (extended precision)
/// - With feature "i32": Uses i32 representation (standard precision)
/// - With no features enabled: Defaults to i32
///
/// Signal values are designed to be consistent across precision modes:
/// * `Bullish` (+100): Strong upward potential
/// * `Balance` (+50): Moderate upward bias
/// * `Bearish` (-100): Strong downward potential
/// * `Neutral` (0): No clear directional bias
/// * `Pattern` (+1): Technical pattern detected
/// * `Invalid` (-1): Invalid or error state
#[derive(Debug, Clone, Copy, PartialEq, Eq, IntoPrimitive, TryFromPrimitive)]
#[cfg(feature = "i64")]
#[repr(i64)]
pub enum Signal {
    Bullish = 100,
    Balance = 50,
    Bearish = -100,
    Neutral = 0,
    Pattern = 1,
    Invalid = -1,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, IntoPrimitive, TryFromPrimitive)]
#[cfg(not(feature = "i64"))]
#[repr(i32)]
pub enum Signal {
    Bullish = 100,
    Balance = 50,
    Bearish = -100,
    Neutral = 0,
    Pattern = 1,
    Invalid = -1,
}

impl Default for Signal {
    /// Returns the default signal value (Neutral).
    ///
    /// # Returns
    /// * [`Signal::Neutral`] - Represents no directional bias (0)
    fn default() -> Self {
        Self::Neutral
    }
}