nautilus_analysis/python/statistics/
cagr.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2025 Nautech Systems Pty Ltd. All rights reserved.
3//  https://nautechsystems.io
4//
5//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6//  You may not use this file except in compliance with the License.
7//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9//  Unless required by applicable law or agreed to in writing, software
10//  distributed under the License is distributed on an "AS IS" BASIS,
11//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//  See the License for the specific language governing permissions and
13//  limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16use std::collections::BTreeMap;
17
18use pyo3::prelude::*;
19
20use super::transform_returns;
21use crate::{statistic::PortfolioStatistic, statistics::cagr::CAGR};
22
23#[pymethods]
24impl CAGR {
25    #[new]
26    #[pyo3(signature = (period=None))]
27    fn py_new(period: Option<usize>) -> Self {
28        Self::new(period)
29    }
30
31    #[getter]
32    #[pyo3(name = "name")]
33    fn py_name(&self) -> String {
34        self.name()
35    }
36
37    #[pyo3(name = "calculate_from_returns")]
38    fn py_calculate_from_returns(&self, raw_returns: BTreeMap<u64, f64>) -> Option<f64> {
39        self.calculate_from_returns(&transform_returns(raw_returns))
40    }
41
42    fn __repr__(&self) -> String {
43        format!("CAGR({})", self.name())
44    }
45}
nautilus_analysis/python/statistics/cagr.rs

nautilus_analysis/python/statistics/
cagr.rs
