polars_ta/lib.rs
1//! # polars-ta
2//!
3//! Native Polars Series interface for technical analysis indicators.
4//! Numerically identical to ta-lib's C implementation.
5//!
6//! ## Quick Start
7//!
8//! ```rust,no_run
9//! use polars::prelude::*;
10//! use polars_ta::trend::sma_series;
11//!
12//! let close = Series::new("close".into(), &[1.0f64, 2.0, 3.0, 4.0, 5.0]);
13//! let result = sma_series(&close, 3).unwrap();
14//! // result: Series of length 3 = [2.0, 3.0, 4.0]
15//! ```
16//!
17//! ## Output Convention
18//!
19//! Output Series are **shorter** than input Series by `lookback` elements,
20//! matching ta-lib's C API. The caller is responsible for index alignment.
21//!
22//! ## Modules
23//!
24//! - [`trend`] — Moving averages and trend indicators
25//! - [`oscillator`] — Momentum oscillators
26//! - [`volume`] — Volume-based indicators
27//! - [`volatility`] — Volatility measures
28
29pub mod math_ops;
30pub mod math_transform;
31pub mod oscillator;
32pub mod price_transform;
33pub mod trend;
34pub mod volatility;
35pub mod volume;