23 releases
| 0.7.0 | Mar 7, 2024 |
|---|---|
| 0.6.2 | Oct 8, 2023 |
| 0.6.1 | Apr 8, 2022 |
| 0.6.0 | Feb 13, 2022 |
| 0.2.1 | Nov 5, 2020 |
#46 in Math
4,479 downloads per month
Used in algolotl-ta
450KB
10K
SLoC
YATA
Yet Another Technical Analysis library
YaTa implements most common technical analysis methods and indicators.
It also provides you an interface to create your own indicators.
[dependencies]
yata = "0.6"
Available moving averages:
- Simple moving average (SMA);
- Weighted moving average (WMA);
- Exponential moving average family: EMA, DMA, TMA, DEMA, TEMA;
- Simple moving median (SMM);
- Linear regression moving average (LSMA);
- Volume weighted moving average (VWMA);
- Symmetrically weighted moving average (SWMA);
- Hull moving average (HMA);
- Running Moving Average (RMA);
- Triangular Moving Average (TRIMA);
- Wilder’s Smoothing Average (WSMA);
- Kaufman Adaptive Moving Average (KAMA);
- Convolution Moving Average;
- Variable Index Dynamic Average (Vidya);
Timeseries conversion
Some commonly used methods:
- Accumulation-distribution index;
- Commodity channel index;
- Cross / CrossAbove / CrossUnder;
- Derivative (differential);
- Highest / Lowest / Highest-Lowest Delta;
- Highest Index / Lowest Index;
- Integral (sum);
- Mean absolute deviation;
- Median absolute deviation;
- Momentum;
- Past;
- Rate Of Change (ROC);
- Reversal points;
- Standard Deviation;
- True Range;
- True Strength Index;
- Volatility;
Some commonly used indicators:
- Average Directional Index;
- Awesome Oscillator;
- Bollinger Bands;
- Commodity Channel Index;
- Detrended Price Oscillator;
- Ease Of Movement;
- Elders Force Index;
- Envelopes;
- Fisher Transform;
- Ichimoku Cloud;
- Keltner Channels;
- Moving Average Convergence Divergence (MACD);
- Money Flow Index;
- Price Channel Strategy;
- Relative Strength Index (RSI);
- Stochastic Oscillator;
- Trix;
- Woodies CCI;
And many others. See all
Method usage example
use yata::prelude::*;
use yata::methods::EMA;
// EMA of length=3
let mut ema = EMA::new(3, &3.0).unwrap();
ema.next(&3.0);
ema.next(&6.0);
assert_eq!(ema.next(&9.0), 6.75);
assert_eq!(ema.next(&12.0), 9.375);
Indicator usage example
use yata::helpers::{RandomCandles, MA};
use yata::indicators::MACD;
use yata::prelude::*;
let mut candles = RandomCandles::new();
let mut macd = MACD::default();
macd.method1 = "sma-4".parse().unwrap(); // one way of defining methods inside indicators
macd.signal = MA::TEMA(5); // another way of defining methods inside indicators
let mut macd = macd.init(&candles.first()).unwrap();
for candle in candles.take(10) {
let result = macd.next(&candle);
println!("{:?}", result);
}
Benchmarks
Methods
- _w10 - method with window
length=10 - _w100 - method with window
length=100
test bench_adi_w10 ... bench: 7 ns/iter (+/- 0)
test bench_adi_w100 ... bench: 7 ns/iter (+/- 0)
test bench_cci_w10 ... bench: 16 ns/iter (+/- 0)
test bench_cci_w100 ... bench: 133 ns/iter (+/- 8)
test bench_conv_w10 ... bench: 23 ns/iter (+/- 2)
test bench_conv_w100 ... bench: 197 ns/iter (+/- 0)
test bench_cross ... bench: 5 ns/iter (+/- 0)
test bench_cross_above ... bench: 3 ns/iter (+/- 0)
test bench_cross_under ... bench: 3 ns/iter (+/- 0)
test bench_dema_w10 ... bench: 7 ns/iter (+/- 0)
test bench_dema_w100 ... bench: 6 ns/iter (+/- 0)
test bench_derivative_w10 ... bench: 4 ns/iter (+/- 0)
test bench_derivative_w100 ... bench: 3 ns/iter (+/- 0)
test bench_dma_w10 ... bench: 5 ns/iter (+/- 0)
test bench_dma_w100 ... bench: 5 ns/iter (+/- 0)
test bench_ema_w10 ... bench: 5 ns/iter (+/- 0)
test bench_ema_w100 ... bench: 5 ns/iter (+/- 0)
test bench_heikin_ashi ... bench: 4 ns/iter (+/- 0)
test bench_highest_index_w10 ... bench: 6 ns/iter (+/- 0)
test bench_highest_index_w100 ... bench: 6 ns/iter (+/- 0)
test bench_highest_lowest_delta_w10 ... bench: 10 ns/iter (+/- 0)
test bench_highest_lowest_delta_w100 ... bench: 10 ns/iter (+/- 0)
test bench_highest_w10 ... bench: 6 ns/iter (+/- 0)
test bench_highest_w100 ... bench: 7 ns/iter (+/- 0)
test bench_hma_w10 ... bench: 14 ns/iter (+/- 0)
test bench_hma_w100 ... bench: 15 ns/iter (+/- 0)
test bench_integral_w10 ... bench: 7 ns/iter (+/- 0)
test bench_integral_w100 ... bench: 7 ns/iter (+/- 0)
test bench_lin_reg_w10 ... bench: 8 ns/iter (+/- 1)
test bench_lin_reg_w100 ... bench: 8 ns/iter (+/- 0)
test bench_linear_volatility_w10 ... bench: 4 ns/iter (+/- 0)
test bench_linear_volatility_w100 ... bench: 4 ns/iter (+/- 0)
test bench_lowest_index_w10 ... bench: 6 ns/iter (+/- 0)
test bench_lowest_index_w100 ... bench: 7 ns/iter (+/- 0)
test bench_lowest_w10 ... bench: 6 ns/iter (+/- 0)
test bench_lowest_w100 ... bench: 6 ns/iter (+/- 0)
test bench_mean_abs_dev_w10 ... bench: 11 ns/iter (+/- 0)
test bench_mean_abs_dev_w100 ... bench: 123 ns/iter (+/- 4)
test bench_median_abs_dev_w10 ... bench: 31 ns/iter (+/- 7)
test bench_median_abs_dev_w100 ... bench: 190 ns/iter (+/- 8)
test bench_momentum_w10 ... bench: 3 ns/iter (+/- 0)
test bench_momentum_w100 ... bench: 3 ns/iter (+/- 0)
test bench_past_w10 ... bench: 3 ns/iter (+/- 0)
test bench_past_w100 ... bench: 3 ns/iter (+/- 0)
test bench_rate_of_change_w10 ... bench: 3 ns/iter (+/- 0)
test bench_rate_of_change_w100 ... bench: 3 ns/iter (+/- 0)
test bench_reverse_high_w10 ... bench: 5 ns/iter (+/- 0)
test bench_reverse_high_w100 ... bench: 5 ns/iter (+/- 0)
test bench_reverse_low_w10 ... bench: 5 ns/iter (+/- 0)
test bench_reverse_low_w100 ... bench: 5 ns/iter (+/- 0)
test bench_reverse_signal_w10 ... bench: 9 ns/iter (+/- 0)
test bench_reverse_signal_w100 ... bench: 9 ns/iter (+/- 0)
test bench_rma_w10 ... bench: 4 ns/iter (+/- 0)
test bench_rma_w100 ... bench: 4 ns/iter (+/- 0)
test bench_sma_w10 ... bench: 3 ns/iter (+/- 0)
test bench_sma_w100 ... bench: 3 ns/iter (+/- 0)
test bench_smm_w10 ... bench: 17 ns/iter (+/- 1)
test bench_smm_w100 ... bench: 35 ns/iter (+/- 2)
test bench_st_dev_w10 ... bench: 7 ns/iter (+/- 0)
test bench_st_dev_w100 ... bench: 7 ns/iter (+/- 0)
test bench_swma_w10 ... bench: 8 ns/iter (+/- 0)
test bench_swma_w100 ... bench: 8 ns/iter (+/- 0)
test bench_tema_w10 ... bench: 8 ns/iter (+/- 0)
test bench_tema_w100 ... bench: 7 ns/iter (+/- 0)
test bench_tma_w10 ... bench: 5 ns/iter (+/- 0)
test bench_tma_w100 ... bench: 5 ns/iter (+/- 1)
test bench_trima_w10 ... bench: 5 ns/iter (+/- 0)
test bench_trima_w100 ... bench: 5 ns/iter (+/- 1)
test bench_tsi_w10 ... bench: 9 ns/iter (+/- 0)
test bench_tsi_w100 ... bench: 10 ns/iter (+/- 0)
test bench_vidya_w10 ... bench: 8 ns/iter (+/- 1)
test bench_vidya_w100 ... bench: 8 ns/iter (+/- 0)
test bench_vwma_w10 ... bench: 5 ns/iter (+/- 0)
test bench_vwma_w100 ... bench: 5 ns/iter (+/- 0)
test bench_wma_w10 ... bench: 6 ns/iter (+/- 1)
test bench_wma_w100 ... bench: 6 ns/iter (+/- 0)
Indicators
test bench_awesome_oscillator ... bench: 36 ns/iter (+/- 0)
test bench_bollinger_bands ... bench: 53 ns/iter (+/- 2)
test bench_chaikin_money_flow ... bench: 22 ns/iter (+/- 0)
test bench_chaikin_oscillator ... bench: 23 ns/iter (+/- 0)
test bench_chande_kroll_stop ... bench: 58 ns/iter (+/- 0)
test bench_chande_momentum_oscillator ... bench: 25 ns/iter (+/- 0)
test bench_commodity_channel_index ... bench: 38 ns/iter (+/- 0)
test bench_coppock_curve ... bench: 38 ns/iter (+/- 2)
test bench_detrended_price_oscillator ... bench: 10 ns/iter (+/- 0)
test bench_ease_of_movement ... bench: 20 ns/iter (+/- 0)
test bench_elders_force_index ... bench: 17 ns/iter (+/- 1)
test bench_envelopes ... bench: 14 ns/iter (+/- 0)
test bench_fisher_transform ... bench: 125 ns/iter (+/- 13)
test bench_hull_moving_average ... bench: 28 ns/iter (+/- 0)
test bench_ichimoku_cloud ... bench: 65 ns/iter (+/- 7)
test bench_indicator_aroon ... bench: 46 ns/iter (+/- 12)
test bench_indicator_average_directional_index ... bench: 49 ns/iter (+/- 1)
test bench_kaufman ... bench: 34 ns/iter (+/- 3)
test bench_keltner_channel ... bench: 26 ns/iter (+/- 2)
test bench_klinger_volume_oscillator ... bench: 40 ns/iter (+/- 1)
test bench_know_sure_thing ... bench: 41 ns/iter (+/- 0)
test bench_macd ... bench: 23 ns/iter (+/- 0)
test bench_momentum_index ... bench: 13 ns/iter (+/- 0)
test bench_money_flow_index ... bench: 59 ns/iter (+/- 12)
test bench_parabolic_sar ... bench: 17 ns/iter (+/- 2)
test bench_pivot_reversal_strategy ... bench: 30 ns/iter (+/- 4)
test bench_relative_strength_index ... bench: 35 ns/iter (+/- 1)
test bench_relative_vigor_index ... bench: 59 ns/iter (+/- 0)
test bench_smi_ergodic_indicator ... bench: 30 ns/iter (+/- 2)
test bench_stochastic_oscillator ... bench: 48 ns/iter (+/- 4)
test bench_trend_strength_index ... bench: 46 ns/iter (+/- 2)
test bench_trix ... bench: 32 ns/iter (+/- 10)
test bench_true_strength_index ... bench: 38 ns/iter (+/- 16)
test bench_woodies_cci ... bench: 68 ns/iter (+/- 6)
Current unsafe status
By default, there is no unsafe code in the crate. But you can optionally enable unsafe_performance feature throw you Cargo.toml or by --feature flag in your CLI.
unsafe_performance enables some unsafe code blocks, most of them are unsafe access to a vector's elements. For some methods it may increase performance by ~5-10%.
Features
serde- enablesserdecrate support;period_type_u16- setsPeriodTypetou16;period_type_u32- setsPeriodTypetou32;period_type_u64- setsPeriodTypetou64;value_type_f32- setsValueTypetof32;unsafe_performance- enables optional unsafe code blocks, which may increase performance;
Rust version
YaTa library supports Rust stable except that you can't run benchmarks with it.
Suggestions
You are welcome to give any suggestions about implementing new indicators and methods.
Say thanks
If you like this library, and you want to say thanks, you can do it also by donating to bitcoin address 1P3gTnaTK9LKSYx2nETrKe2zjP4HMkdhvK
Dependencies
~0.3–1MB
~21K SLoC