RustQuant 0.3.1

A Rust library for quantitative finance.
Documentation 
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

//! RustQuant: A Rust library for quantitative finance tools.
//!
//! Copyright (C) 2022-2024 <https://github.com/avhz>
//!
//! Dual licensed under Apache 2.0 and MIT.
//!
//! See:
//! - [LICENSE-APACHE.md](https://github.com/avhz/RustQuant/blob/main/LICENSE-APACHE.md)
//! - [LICENSE-MIT.md](https://github.com/avhz/RustQuant/blob/main/LICENSE-MIT.md)
//!
//! Contact me at: <RustQuantContact@gmail.com>
//!
//! Any contributions are greatly appreciated. Make a PR or open an issue !
//!
//! I'm particularly interested in hearing from people with strong experience
//! in implementing quantitative software in a professional setting.
//!
//! # Installation
//!
//! In your Rust project's root directory, simply run:
//!
//! ```bash
//! cargo add RustQuant
//! ```
//!
//! This will add the latest version to your project.
//!
//! If you require a specific version, add the following to your Cargo.toml file:
//!
//! ```toml
//! [dependencies]
//! RustQuant = "*"
//! ```
//!
//! replacing `"*"` with the version number you require, such as `"0.0.17"`.

// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// GLOBAL SETTINGS
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

// Strictly enforce documentation.
#![forbid(missing_docs)]
//
// When writing mathematical equations in documentation, Clippy suggests to
// put backticks inside the LaTeX block. This suppresses that behavior.
#![allow(clippy::doc_markdown)]
//
// Allow snake case.
// This is because much of this library is based on mathematics, so I
// want to adhere to the standard mathematical notation.
#![allow(non_snake_case)]
//
// Strictly enforce SAFETY comments.
// There is no unsafe code currently, but for anyone to add any, it must be
// documented with a SAFETY comment.
#![forbid(clippy::undocumented_unsafe_blocks)]

// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// RUSTQUANT MODULES
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

/// The RustQuant prelude.
pub mod prelude {
    pub use RustQuant_autodiff::*;
    pub use RustQuant_cashflows::*;
    pub use RustQuant_data::*;
    pub use RustQuant_error::*;
    pub use RustQuant_instruments::*;
    pub use RustQuant_iso::*;
    pub use RustQuant_math::*;
    pub use RustQuant_ml::*;
    pub use RustQuant_portfolios::*;
    pub use RustQuant_stochastics::*;
    pub use RustQuant_time::*;
    pub use RustQuant_trading::*;
    pub use RustQuant_utils::*;
}

/// The `autodiff` module.
pub mod autodiff {
    pub use RustQuant_autodiff::*;
}

/// The `cashflows` module.
pub mod cashflows {
    pub use RustQuant_cashflows::*;
}

/// The `data` module.
pub mod data {
    pub use RustQuant_data::*;
}

/// The `error` module.
pub mod error {
    pub use RustQuant_error::*;
}

/// The `instruments` module.
pub mod instruments {
    pub use RustQuant_instruments::*;
}

/// The `iso` module.
pub mod iso {
    pub use RustQuant_iso::*;
}

/// The `math` module.
pub mod math {
    pub use RustQuant_math::*;
}

/// The `ml` module.
pub mod ml {
    pub use RustQuant_ml::*;
}

/// The `portfolios` module.
pub mod portfolios {
    pub use RustQuant_portfolios::*;
}

/// The `stochastics` module.
pub mod stochastics {
    pub use RustQuant_stochastics::*;
}

/// The `time` module.
pub mod time {
    pub use RustQuant_time::*;
}

/// The `trading` module.
pub mod trading {
    pub use RustQuant_trading::*;
}

/// The `utils` module.
#[macro_use]
pub mod utils {
    pub use RustQuant_utils::*;
}