Struct CAGR 

#[repr(C)]
pub struct CAGR {
    pub period: usize,
}

Calculates the Compound Annual Growth Rate (CAGR) for returns.

CAGR represents the mean annual growth rate of an investment over a specified period, assuming the profits were reinvested at the end of each period.

Formula: CAGR = (Ending Value / Beginning Value)^(Period/Days) - 1

For returns: CAGR = ((1 + Total Return)^(Period/Days)) - 1

Fields

period: usize

The number of periods per year for annualization (e.g., 252 for trading days).

Implementations

impl CAGR

pub fn new(period: Option<usize>) -> Self

Creates a new CAGR instance.

Trait Implementations

impl Clone for CAGR

fn clone(&self) -> CAGR

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CAGR

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

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for CAGR

type Target = CAGR

The Python output type

type Output = Bound<'py, <CAGR as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PortfolioStatistic for CAGR

type Item = f64

fn name(&self) -> String

Returns the name of this statistic for display and identification purposes.

fn calculate_from_returns( &self, returns: &BTreeMap<UnixNanos, f64>, ) -> Option<Self::Item>

Calculates the statistic from time-indexed returns data.

fn calculate_from_realized_pnls( &self, realized_pnls: &[f64], ) -> Option<Self::Item>

Calculates the statistic from realized profit and loss values.

fn calculate_from_orders( &self, orders: Vec<Box<dyn Order>>, ) -> Option<Self::Item>

Calculates the statistic from order data.

fn calculate_from_positions(&self, positions: &[Position]) -> Option<Self::Item>

Calculates the statistic from position data.

fn check_valid_returns(&self, returns: &Returns) -> bool

Validates that returns data is not empty.

fn downsample_to_daily_bins(&self, returns: &Returns) -> Returns

Downsamples high-frequency returns to daily bins for daily statistics calculation.

fn calculate_std(&self, returns: &Returns) -> f64

Calculates the standard deviation of returns with Bessel’s correction.

impl PyClass for CAGR

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for CAGR

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Calculates the Compound Annual Growth Rate (CAGR) for returns. /// /// CAGR represents the mean annual growth rate of an investment over a specified period, /// assuming the profits were reinvested at the end of each period. /// /// Formula: CAGR = (Ending Value / Beginning Value)^(Period/Days) - 1 /// /// For returns: CAGR = ((1 + Total Return)^(Period/Days)) - 1

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<CAGR>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for CAGR

const TEXT_SIGNATURE: &'static str = "(period=None)"

impl PyMethods<CAGR> for PyClassImplCollector<CAGR>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for CAGR

const NAME: &'static str = "CAGR"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for CAGR

impl ExtractPyClassWithClone for CAGR