finance-query 2.5.1

A Rust library for querying financial data
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

//! Elder Ray Index indicator.

pub use super::bull_bear_power::BullBearPowerResult as ElderRayResult;
use super::{Result, bull_bear_power::bull_bear_power};

/// Calculate Elder Ray Index.
///
/// Similar to Bull Bear Power; uses EMA of the given period.
///
/// # Arguments
///
/// * `highs` - High prices
/// * `lows` - Low prices
/// * `closes` - Close prices
/// * `period` - EMA period (default: 13)
///
/// # Example
///
/// ```
/// use finance_query::indicators::elder_ray;
///
/// let highs = vec![10.0; 20];
/// let lows = vec![8.0; 20];
/// let closes = vec![9.0; 20];
/// let result = elder_ray(&highs, &lows, &closes, 13).unwrap();
/// ```
pub fn elder_ray(
    highs: &[f64],
    lows: &[f64],
    closes: &[f64],
    period: usize,
) -> Result<ElderRayResult> {
    bull_bear_power(highs, lows, closes, period)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_elder_ray_default_period() {
        let highs = vec![10.0; 20];
        let lows = vec![8.0; 20];
        let closes = vec![9.0; 20];
        let result = elder_ray(&highs, &lows, &closes, 13).unwrap();

        assert_eq!(result.bull_power.len(), 20);
        assert!(result.bull_power[11].is_none());
        assert!(result.bull_power[12].is_some());
    }

    #[test]
    fn test_elder_ray_custom_period() {
        let highs = vec![10.0; 20];
        let lows = vec![8.0; 20];
        let closes = vec![9.0; 20];
        let result = elder_ray(&highs, &lows, &closes, 5).unwrap();
        assert!(result.bull_power[3].is_none());
        assert!(result.bull_power[4].is_some());
    }
}