yata 0.7.0

Yet another Technical Analysis library. For rust now.
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

use std::str::FromStr;

use super::{Error, Method, PeriodType, ValueType};

/// Marker trait for any moving average
///
/// Moving average is a [`Method`] which has parameters of single [`PeriodType`], input is single [`ValueType`] and output is single [`ValueType`].
///
/// # See also
///
/// [Default moving averages methods list](crate::helpers::MA)
///
/// [`Method`]: crate::core::Method
/// [`ValueType`]: crate::core::ValueType
/// [`PeriodType`]: crate::core::PeriodType
pub trait MovingAverage: Method<Input = ValueType, Output = ValueType> {}

/// Trait for dynamically creation of moving average instances based on it's type and period
///
/// This trait plays the same role for moving averages as [`IndicatorConfig`] plays for indicators.
///
/// [`IndicatorConfig`]: crate::core::IndicatorConfig
pub trait MovingAverageConstructor: Clone + FromStr {
	/// Used for comparing MA types
	type Type: Eq;

	/// `MovingAverage` Instance type
	type Instance: MovingAverage;

	/// Creates moving average instance with the `initial_value`
	fn init(&self, initial_value: ValueType) -> Result<Self::Instance, Error>;

	/// Returns period length of
	fn ma_period(&self) -> PeriodType;

	/// Returns moving average type
	fn ma_type(&self) -> Self::Type;

	/// Checks two moving average constructors for the same moving average type
	fn is_similar_to(&self, other: &Self) -> bool {
		self.ma_type() == other.ma_type()
	}
}