lib.rs

#![allow(
    clippy::too_many_arguments,
    clippy::let_and_return,
    clippy::from_over_into,
    clippy::upper_case_acronyms,
    clippy::new_ret_no_self,
    clippy::wrong_self_convention,
    clippy::new_without_default,
    clippy::float_cmp,
    clippy::assign_op_pattern,
    clippy::absurd_extreme_comparisons,
    clippy::collapsible_else_if,
)]

//! ta is a Rust library for technical analysis. It provides number of technical indicators
//! that can be used to build trading strategies for stock markets, futures, forex, cryptocurrencies, etc.
//!
//! Every indicator is implemented as a data structure with fields, that define parameters and
//! state.
//!
//! Every indicator implements [Next<T>](trait.Next.html) and [Reset](trait.Reset.html) traits,
//! which are the core concept of the library.
//!
//! Since `Next<T>` is a generic trait, most of the indicators can work with both input types: `f64` and more complex
//! structures like [DataItem](struct.DataItem.html).

//
// # Example
// ```
// use core::indicators::ExponentialMovingAverage;
// use core::Next;
//
// // it can return an error, when an invalid length is passed (e.g. 0)
// let mut ema = ExponentialMovingAverage::new(3).unwrap();
//
// assert_eq!(ema.next(2.0), 2.0);
// assert_eq!(ema.next(5.0), 3.5);
// assert_eq!(ema.next(1.0), 2.25);
// assert_eq!(ema.next(6.25), 4.25);
// ```
//
// # List of indicators
//
// * Trend
//   * [Exponential Moving Average (EMA)](indicators/struct.ExponentialMovingAverage.html)
//   * [Simple Moving Average (SMA)](indicators/struct.SimpleMovingAverage.html)
// * Oscillators
//   * [Relative Strength Index (RSI)](indicators/struct.RelativeStrengthIndex.html)
//   * [Fast Stochastic](indicators/struct.FastStochastic.html)
//   * [Slow Stochastic](indicators/struct.SlowStochastic.html)
//   * [Moving Average Convergence Divergence (MACD)](indicators/struct.MovingAverageConvergenceDivergence.html)
//   * [Money Flow Index (MFI)](indicators/struct.MoneyFlowIndex.html)
// * Other
//   * [Standard Deviation (SD)](indicators/struct.StandardDeviation.html)
//   * [Bollinger Bands (BB)](indicators/struct.BollingerBands.html)
//   * [Maximum](indicators/struct.Maximum.html)
//   * [Minimum](indicators/struct.Minimum.html)
//   * [True Range](indicators/struct.TrueRange.html)
//   * [Average True Range (ATR)](indicators/struct.AverageTrueRange.html)
//   * [Efficiency Ratio (ER)](indicators/struct.EfficiencyRatio.html)
//   * [Rate of Change (ROC)](indicators/struct.RateOfChange.html)
//   * [On Balance Volume (OBV)](indicators/struct.OnBalanceVolume.html)
//

mod utils;

#[macro_use]
extern crate error_chain;

#[cfg(test)]
#[macro_use]
mod test_helper;

mod helpers;

pub mod errors;
pub mod indicators;

mod traits;
pub use crate::traits::*;

mod indicator;
pub use crate::indicator::*;

mod data_item;
pub use crate::data_item::DataItem;

#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
        assert_eq!(2 + 2, 4);
    }
}