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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
//! # Centaur Technical Indicators
//!
//! **Centaur Technical Indicators** is a comprehensive, highly configurable Technical Indicators library for Rust.
//! It empowers you to design, compute, and experiment with a wide variety of
//! technical indicators for financial data analysis.
//!
//! ## Why Centaur Technical Indicators?
//! - **Configurable**: Nearly every parameter (from periods to models) is customizable.
//! - **Modern**: Suitable for stocks, crypto, and any asset with arbitrary trading calendars.
//! - **Powerful**: Use industry standards or create your own quant-style indicators.
//! - **Powered by Rust**: Written in pure Rust through and through
//!
//! ## Philosophy
//! Prefer customizing your indicators to fit your market and strategy, just like the best quants do.
//! Centaur Technical Indicators gives you the flexibility to do just that.
//!
//! ## Library Structure
//!
//! - Indicators are grouped into modules by type (e.g., `momentum_indicators`, `trend_indicators`).
//! - Each module is split into:
//! - **single**: Calculate the indicator for a single period or the whole slice.
//! - **bulk**: Compute the indicator value over a rolling window or for each element in a series.
//!
//! ## Quick Start
//!
//! ```rust
//! use centaur_technical_indicators::momentum_indicators::bulk::relative_strength_index;
//! use centaur_technical_indicators::ConstantModelType;
//! let prices = vec![100.0, 102.0, 103.0, 102.5, 102.8, 103.1, 103.8, 103.9, 104.4, 103.6, 103.1,
//! 102.9, 103.3, 103.7];
//! let my_rsi = relative_strength_index(&prices, ConstantModelType::SmoothedMovingAverage, 14);
//! println!("Your RSI: {:?}", my_rsi);
//! ```
//!
//! ## Modules
//! - [`basic_indicators`] - Fundamental stats (mean, median, std, etc.)
//! - [`candle_indicators`] - Candle chart tools (Ichimoku, bands, envelopes, etc.)
//! - [`chart_trends`] - Trend and peak/valley analysis
//! - [`correlation_indicators`] - Asset correlation metrics
//! - [`momentum_indicators`] - Momentum and oscillator indicators
//! - [`moving_average`] - Moving averages: simple, smoothed, exponential, McGinley, etc.
//! - [`other_indicators`] - ROI, true range, internal bar strength, etc.
//! - [`strength_indicators`] - Volume and vigor metrics
//! - [`trend_indicators`] - Trend direction and strength
//! - [`volatility_indicators`] - Volatility measures
//!
//! ## API Reference
//!
//! See each module for detailed function docs and examples.
//!
//! ## Types
//! All shared enums and types are re-exported at the crate root for convenience.
//!
//! ## More docs
//!
//! This repository is part of a structured documentation suite:
//!
//! - **Tutorials:** [See here](https://github.com/ChironMind/CentaurTechnicalIndicators-Rust-tutorials)
//! - **How-To Guides:** [See here](https://github.com/ChironMind/CentaurTechnicalIndicators-Rust-how-to-guides)
//! - **Benchmarks:** [See here](https://github.com/ChironMind/CentaurTechnicalIndicators-Rust-benchmarks)
//! - **Explanations:** [Centaur Technologies](https://tech.centaurresearchtechnologies.com/)
//! - **Reference:** You're here!
//!
//! ---
pub use *;
pub use *;