Skip to main content

Supertrend

Struct Supertrend 

Source
pub struct Supertrend { /* private fields */ }
Expand description

Supertrend trend-direction indicator.

Returns +1 for uptrend, -1 for downtrend at each bar.

§Example

use quant_indicators::{Indicator, Supertrend};
use quant_primitives::Candle;
use chrono::Utc;
use rust_decimal_macros::dec;

let ts = Utc::now();
let candles: Vec<Candle> = (0..20).map(|i| {
    let d = rust_decimal::Decimal::from(i);
    Candle::new(dec!(100) + d, dec!(110) + d, dec!(90) + d, dec!(105) + d, dec!(1000), ts).unwrap()
}).collect();
let st = Supertrend::new(10, dec!(2)).unwrap();
let series = st.compute(&candles).unwrap();

Implementations§

Source§

impl Supertrend

Source

pub fn new( atr_period: usize, multiplier: Decimal, ) -> Result<Self, IndicatorError>

Create a new Supertrend indicator.

§Parameters
  • atr_period: ATR lookback period (standard: 10–14)
  • multiplier: Band width multiplier (standard: 2.0–3.0)
§Errors

Returns InvalidParameter if atr_period is 0 or multiplier is non-positive.

Source

pub fn atr_period(&self) -> usize

Accessors for config (used by signal generators that need the params).

Source

pub fn multiplier(&self) -> Decimal

Trait Implementations§

Source§

impl Clone for Supertrend

Source§

fn clone(&self) -> Supertrend

Returns a duplicate 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 Supertrend

Source§

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

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

impl Indicator for Supertrend

Source§

fn name(&self) -> &str

The name of this indicator (e.g., “SMA(20)”).
Source§

fn warmup_period(&self) -> usize

Minimum number of candles required before output is valid.
Source§

fn compute(&self, candles: &[Candle]) -> Result<Series, IndicatorError>

Compute the indicator values from candle data.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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,

Source§

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>,

Source§

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>,

Source§

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.