Struct yata::indicators::Kaufman

source ·
pub struct Kaufman {
    pub period1: PeriodType,
    pub period2: PeriodType,
    pub period3: PeriodType,
    pub filter_period: PeriodType,
    pub square_smooth: bool,
    pub k: ValueType,
    pub source: Source,
}
Expand description

Kaufman Adaptive Moving Average (KAMA)

§1 value

  • KAMA value

Range of KAMA values is the same as the range of the source values.

§1 signal

  • if filter_period is less or equal than 0, then returns signal when KAMA crosses source value. When source crosses KAMA upwards, returns full buy signal. When source crosses KAMA downwards, returns full sell signal. Otherwise returns no signal.

  • if filter_period is greater than 1, it uses same cross between source and KAMA, but with additional filtering using standard deviation.

Fields§

§period1: PeriodType

Volatility calculation period. Default is 10.

Range in [1; PeriodType::MAX).

§period2: PeriodType

Fast period. Default is 2.

Range in [1; period3).

§period3: PeriodType

Slow period. Default is 30.

Range in (period2; PeriodType::MAX).

§filter_period: PeriodType

Filter period. Default is 10.

Range in [0; PeriodType::MAX)

§square_smooth: bool

Apply double smoothing. Default is true.

§k: ValueType

Standard deviation multiplier. Default is 0.3.

Range in (0.0; +inf)

§source: Source

Source type. Default is Close

Trait Implementations§

source§

impl Clone for Kaufman

source§

fn clone(&self) -> Kaufman

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Kaufman

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for Kaufman

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for Kaufman

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl IndicatorConfig for Kaufman

§

type Instance = KaufmanInstance

Type of State
source§

const NAME: &'static str = "Kaufman"

Name of an indicator
source§

fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

Initializes the State based on current Configuration
source§

fn validate(&self) -> bool

Validates if Configuration is OK
source§

fn set(&mut self, name: &str, value: String) -> Result<(), Error>

Dynamically sets Configuration parameters
source§

fn size(&self) -> (u8, u8)

Returns an IndicatorResult size processing by the indicator (count of raw values, count of signals)
source§

fn name(&self) -> &'static str

Returns a name of the indicator
source§

fn init_fn<'a, T: OHLCV>( self, initial_value: &'a T ) -> Result<Box<dyn FnMut(&'a T) -> IndicatorResult>, Error>
where Self: 'static,

Creates an IndicatorInstance function from this IndicatorConfig.
source§

fn over<T, S>(self, inputs: S) -> Result<Vec<IndicatorResult>, Error>
where T: OHLCV, S: AsRef<[T]>, Self: Sized,

Evaluates indicator config over sequence of OHLC and returns sequence of IndicatorResults Read more
source§

impl Serialize for Kaufman

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Copy for Kaufman

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, I, C> IndicatorConfigDyn<T> for C
where T: OHLCV, I: IndicatorInstanceDyn<T> + IndicatorInstance<Config = C> + 'static, C: IndicatorConfig<Instance = I> + Clone + 'static,

source§

fn init( &self, initial_value: &T ) -> Result<Box<dyn IndicatorInstanceDyn<T>>, Error>

Dynamically initializes the State based on the current Configuration
source§

fn over(&self, inputs: &dyn AsRef<[T]>) -> Result<Vec<IndicatorResult>, Error>

Evaluates dynamically dispatched IndicatorConfig over series of OHLC and returns series of IndicatorResults Read more
source§

fn name(&self) -> &'static str

Returns a name of the indicator
source§

fn validate(&self) -> bool

Validates if Configuration is OK
source§

fn set(&mut self, name: &str, value: String) -> Result<(), Error>

Dynamically sets Configuration parameters
source§

fn size(&self) -> (u8, u8)

Returns an IndicatorResult size processing by the indicator (count of raw values, count of signals)
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,