RustQuant

https://docs.rs/RustQuant/0.3.1/RustQuant/
Admin
RustQuant is a Rust library providing comprehensive quantitative finance tools for building...
Tokens:1,906,771
Snippets:23,070
Trust Score:9.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Pointable Init Method

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/curves/struct.FlatCurveBuilder.html

Initializes a memory location with the given initializer, returning the starting address.

```rust
unsafe fn init(init: <T as Pointable>::Init) -> usize

```

--------------------------------

### Example: Convert Money

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/exchange/struct.ExchangeRate.html

Demonstrates converting 100 USD to EUR using a predefined exchange rate. Asserts the converted amount and currency.

```rust
use RustQuant::instruments::*
use RustQuant::utils::assert_approx_equal;

// Use USD and EUR currency constants from the money module.
let usd = Money::new(USD, 100.0);
let eur_usd = ExchangeRate::new(USD, EUR, 0.9186955);  // 1 USD = 0.9186955 EUR
let eur = eur_usd.convert(usd);

assert_approx_equal!(eur.amount, 91.86955, 1e-5);
assert_eq!(eur.currency, EUR);
```

--------------------------------

### Initialize New Book

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/limit_order_book/struct.Book.html

Creates and returns a new, empty limit order book. This is the starting point for managing orders.

```rust
pub fn new() -> Book
```

--------------------------------

### Get Leg Start Date

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/cashflows/struct.Leg.html

Retrieves the start date of the Leg, if one is defined. Returns an Option<Date> as the start date might not always be present.

```rust
pub fn start_date(&self) -> Option<Date>
```

--------------------------------

### init

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/struct.Currency.html

Initializes a new instance of the type.

```APIDOC
## init

### Description
Initializes a with the given initializer.

### Method
`init`

### Parameters
- `init` (<T as Pointable>::Init) - The initializer value.

### Returns
`usize` - The size of the initialized memory.

### Safety
This function is unsafe and should only be called with a valid initializer.
```

--------------------------------

### Get Instrument Error

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/struct.Currency.html

Returns the error on the NPV if available, for example, from a Monte Carlo pricing engine. This is a placeholder for the Instrument trait.

```rust
fn error(&self) -> Option<f64>
```

--------------------------------

### Portfolio::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/portfolios/struct.Portfolio.html

Creates a new, empty Portfolio.

```APIDOC
## Portfolio::new

### Description
Create a new portfolio.

### Signature
```rust
pub const fn new(positions: HashMap<String, Position<I>>) -> Portfolio<I>
```
```

--------------------------------

### Set Start Date for Price History

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/struct.YahooFinanceData.html

Sets the start date for retrieving price history data. This method modifies the struct in place.

```rust
pub fn set_start_date(&mut self, start: OffsetDateTime)
```

--------------------------------

### Book::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/limit_order_book/struct.Book.html

Initializes a new, empty limit order book.

```APIDOC
## Book::new

### Description
Returns a new, empty limit order book.

### Method
`pub fn new() -> Book`

### Returns
A new instance of the `Book` struct.
```

--------------------------------

### Example: AustraliaCalendar Day Count

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/countries/asia/singapore/struct.SingaporeCalendar.html

Demonstrates calculating the number of calendar days between two dates using `AustraliaCalendar`. Note: This example uses `AustraliaCalendar` but illustrates the functionality of `calendar_day_count` which is also implemented for `SingaporeCalendar`.

```rust
use time::macros::date;
use RustQuant::time::day_counting::DayCounter;
use RustQuant::time::countries::oceania::australia::AustraliaCalendar;

let date1 = date!(2023-01-01);
let date2 = date!(2025-01-01);

let calendar = AustraliaCalendar;

assert_eq!(calendar.calendar_day_count(date1, date2), 731);
```

--------------------------------

### Example: Day Count Factor Calculation

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/countries/europe/austria/struct.AustriaCalendar.html

Demonstrates how to compute the day count factor between two dates using a specific day count convention.

```rust
use time::macros::date;
use RustQuant::time::day_counting::DayCounter;
use RustQuant::time::countries::oceania::australia::AustraliaCalendar;
use RustQuant::time::day_counting::DayCountConvention;

let date1 = date!(2023-01-01);
let date2 = date!(2024-01-01);

let calendar = AustraliaCalendar;
let convention = DayCountConvention::Actual_365_Actual;

assert_eq!(calendar.day_count_factor(date1, date2, &convention), 0.997_267_759_562_841_5);

```

--------------------------------

### CloneToUninit and DynClone Implementations

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/struct.DiscountCurve.html

CloneToUninit (experimental) provides a way to clone into uninitialized memory, while DynClone allows for dynamic cloning behavior.

```APIDOC
### impl<T> CloneToUninit for T
where T: Clone,
#### unsafe fn clone_to_uninit(&self, dest: *mut u8)
Performs copy-assignment from `self` to `dest`.

### impl<T> DynClone for T
where T: Clone,
#### fn __clone_box(&self, _: Private) -> *mut ()

```

--------------------------------

### Example: AustraliaCalendar Business Day Count

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/countries/asia/singapore/struct.SingaporeCalendar.html

Demonstrates calculating the number of business days between two dates using `AustraliaCalendar`. Note: This example uses `AustraliaCalendar` but illustrates the functionality of `business_day_count` which is also implemented for `SingaporeCalendar`.

```rust
use time::macros::date;
use RustQuant::time::day_counting::DayCounter;
use RustQuant::time::countries::oceania::australia::AustraliaCalendar;

let date1 = date!(2023-01-01);
let date2 = date!(2023-02-01);

let calendar = AustraliaCalendar;

assert_eq!(calendar.business_day_count(date1, date2), 21);
```

--------------------------------

### Any::type_id

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/nelson_siegel_svensson/struct.NelsonSiegelSvensson.html

Gets the `TypeId` of the NelsonSiegelSvensson instance.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`.

### Returns
The `TypeId` of the instance.
```

--------------------------------

### build

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/struct.EuropeanVanillaOptionBuilder.html

Builds a new EuropeanVanillaOption.

```APIDOC
## build

### Description
Builds a new `EuropeanVanillaOption`.

### Method
`build(&self) -> Result<EuropeanVanillaOption, EuropeanVanillaOptionBuilderError>`

### Errors
If a required field has not been initialized.
```

--------------------------------

### new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/math/rootfinding/brent/struct.Brent.html

Creates a new instance of the Brent solver.

```APIDOC
## pub fn new(function: F, guess: f64, data: RootfinderData) -> Brent<F>

### Description
Create a new Brent solver.

### Parameters
* `function` (F): The function for which to find the root.
* `guess` (f64): An initial guess for the root.
* `data` (RootfinderData): Data structure containing parameters for the root-finding process.

### Returns
A new `Brent<F>` instance.
```

--------------------------------

### Example: AustraliaCalendar Day Count Factor

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/countries/asia/singapore/struct.SingaporeCalendar.html

Demonstrates computing the day count factor between two dates using `AustraliaCalendar` and a specific `DayCountConvention`. Note: This example uses `AustraliaCalendar` but illustrates the functionality of `day_count_factor` which is also implemented for `SingaporeCalendar`.

```rust
use time::macros::date;
use RustQuant::time::day_counting::DayCounter;
use RustQuant::time::countries::oceania::australia::AustraliaCalendar;
use RustQuant::time::day_counting::DayCountConvention;

let date1 = date!(2023-01-01);
let date2 = date!(2024-01-01);

let calendar = AustraliaCalendar;
let convention = DayCountConvention::Actual_365_Actual;

assert_eq!(calendar.day_count_factor(date1, date2, &convention), 0.997_267_759_562_841_5);
```

--------------------------------

### New OrderBook Instance

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/order_book/struct.OrderBook.html

Creates a new, empty OrderBook instance. This is the default way to initialize an OrderBook.

```rust
pub const fn new() -> OrderBook
```

--------------------------------

### Get Calendar Name

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/calendar/struct.CalendarMetadata.html

Returns the name of the calendar.

```rust
pub fn name(&self) -> &'static str
```

--------------------------------

### NelsonSiegelSvensson Implementation

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/trait.CurveModel.html

An example of a type that implements the CurveModel trait.

```APIDOC
### impl CurveModel for NelsonSiegelSvensson

This struct implements the `CurveModel` trait.
```

--------------------------------

### get_years_in_range

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/fn.get_years_in_range.html

Function to get a list of the years in a range of `Dates`.

```APIDOC
## Function get_years_in_range

### Description
Function to get a list of the years in a range of `Dates`.

### Signature
```rust
pub fn get_years_in_range(start: Date, end: Date) -> Vec<i32>
```

### Parameters
* `start` (Date) - The starting date of the range.
* `end` (Date) - The ending date of the range.

### Returns
* `Vec<i32>` - A vector containing all the years within the specified range (inclusive).
```

--------------------------------

### fn and

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/struct.Bernoulli.html

Creates a new `Policy` that requires both `self` and `other` policies to return `Action::Follow` to succeed.

```APIDOC
## fn and<P, B, E>(self, other: P) -> And<T, P>

### Description
Create a new `Policy` that returns `Action::Follow` only if `self` and `other` return `Action::Follow`.

### Parameters
- `other`: `P` - The other policy to combine with.

### Returns
`And<T, P>` - A new policy representing the conjunction of `self` and `other`.

### Type Parameters
- `P`: The type of the other policy.
- `B`: The type of the decision context.
- `E`: The type of the error.

### Constraints
- `T: Policy<B, E>`
- `P: Policy<B, E>`
```

--------------------------------

### Example: Business Day Count Calculation

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/countries/europe/austria/struct.AustriaCalendar.html

Demonstrates how to calculate the total number of business days between two specific dates using a calendar implementation.

```rust
use time::macros::date;
use RustQuant::time::day_counting::DayCounter;
use RustQuant::time::countries::oceania::australia::AustraliaCalendar;

let date1 = date!(2023-01-01);
let date2 = date!(2023-02-01);

let calendar = AustraliaCalendar;

assert_eq!(calendar.business_day_count(date1, date2), 21);

```

--------------------------------

### get_first_friday_of_month

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/fn.get_first_friday_of_month.html

Function to get the date of the first Friday of the month.

```APIDOC
## Function get_first_friday_of_month

### Description
Function to get the date of the first Friday of the month.

### Signature
```rust
pub fn get_first_friday_of_month(year: i32, month: Month) -> Result<Date, Error>
```

### Parameters
* `year` (i32) - The year for which to find the first Friday.
* `month` (Month) - The month for which to find the first Friday.

### Returns
* `Result<Date, Error>` - A Result containing the Date of the first Friday if successful, or an Error if not.
```

--------------------------------

### CurrencyPair::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/currency/struct.CurrencyPair.html

Constructor for creating a new CurrencyPair instance.

```APIDOC
### impl CurrencyPair

#### pub fn new(base: Currency, quote: Currency) -> CurrencyPair
Create a new currency pair.
```

--------------------------------

### deref_mut

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/currency/struct.CurrencyPair.html

Dereferences a pointer to get a mutable reference to the object.

```APIDOC
## deref_mut

### Description
Mutably dereferences the given pointer.

### Method
`deref_mut`

### Parameters
- **ptr** (`usize`) - The pointer to dereference.

### Returns
`&'a mut T` - A mutable reference to the object.
```

--------------------------------

### deref

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/currency/struct.CurrencyPair.html

Dereferences a pointer to get an immutable reference to the object.

```APIDOC
## deref

### Description
Dereferences the given pointer.

### Method
`deref`

### Parameters
- **ptr** (`usize`) - The pointer to dereference.

### Returns
`&'a T` - An immutable reference to the object.
```

--------------------------------

### BlackDermanToy::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/black_derman_toy/struct.BlackDermanToy.html

Constructor for creating a new Black-Derman-Toy process instance.

```APIDOC
### impl BlackDermanToy

#### pub fn new( sigma: impl Into<ModelParameter>, theta: impl Into<ModelParameter>, ) -> BlackDermanToy

Create a new Black-Derman-Toy process.
```

--------------------------------

### Get Currency Symbol

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/struct.Currency.html

Retrieves the currency's symbol.

```rust
pub fn symbol(&self) -> &str
```

--------------------------------

### init

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/currency/struct.CurrencyPair.html

Initializes a new instance of the type using an initializer.

```APIDOC
## init

### Description
Initializes a with the given initializer.

### Method
`init`

### Parameters
- **init** (`<T as Pointable>::Init`) - The initializer for the new instance.
```

--------------------------------

### Get Currency Name

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/struct.Currency.html

Retrieves the currency's name.

```rust
pub fn name(&self) -> &str
```

--------------------------------

### init

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/holiday/struct.Holiday.html

Initializes a new instance of the type using the provided initializer.

```APIDOC
## init

### Description
Initializes a with the given initializer.

### Safety
This function is unsafe and must be used with care.

### Method
`init(init: <T as Pointable>::Init) -> usize`
```

--------------------------------

### Example: Calendar Day Count Calculation

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/countries/europe/austria/struct.AustriaCalendar.html

Demonstrates how to calculate the total number of calendar days between two specific dates using a calendar implementation.

```rust
use time::macros::date;
use RustQuant::time::day_counting::DayCounter;
use RustQuant::time::countries::oceania::australia::AustraliaCalendar;

let date1 = date!(2023-01-01);
let date2 = date!(2025-01-01);

let calendar = AustraliaCalendar;

assert_eq!(calendar.calendar_day_count(date1, date2), 731);

```

--------------------------------

### from

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/struct.Currency.html

Creates a new instance from a given value.

```APIDOC
## from

### Description
Returns the argument unchanged.

### Method
`from`

### Parameters
- `t` (T) - The value to create the instance from.

### Returns
`T` - The newly created instance.
```

--------------------------------

### impl<T> Any for T

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/cashflows/struct.Cashflow.html

Provides the `type_id` method to get the `TypeId` of a type.

```APIDOC
## fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`.
```

--------------------------------

### PolicyExt And Method

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/curves/struct.FlatCurveBuilder.html

Creates a new Policy that requires both self and other policies to return Action::Follow.

```rust
fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

```

--------------------------------

### YahooFinanceData::set_start_date

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/struct.YahooFinanceData.html

Sets the start date for the price history retrieval.

```APIDOC
#### pub fn set_start_date(&mut self, start: OffsetDateTime)
Sets the start date for the price history.
```

--------------------------------

### Data::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/io/struct.Data.html

Constructor for the Data struct, initializing it with a specified format and path.

```APIDOC
## impl Data

### pub fn new(format: DataFormat, path: String) -> Data

Creates a new `Data` struct.
```

--------------------------------

### Leg::start_date

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/cashflows/legs/struct.Leg.html

Retrieves the start date of the leg, if one is defined.

```APIDOC
## Leg::start_date

### Description
Returns the start date of the leg.

### Signature
```rust
pub fn start_date(&self) -> Option<Date>
```
```

--------------------------------

### deref_mut

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/holiday/struct.Holiday.html

Dereferences a raw pointer to get a mutable reference to the object.

```APIDOC
## deref_mut

### Description
Mutably dereferences the given pointer.

### Safety
This function is unsafe and must be used with care.

### Method
`deref_mut<'a>(ptr: usize) -> &'a mut T`
```

--------------------------------

### EuropeanVanillaOptionBuilder Methods

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/options/struct.EuropeanVanillaOptionBuilder.html

Methods for configuring and building a EuropeanVanillaOption.

```APIDOC
## EuropeanVanillaOptionBuilder

Builder for `EuropeanVanillaOption`.

### Methods

#### `strike(&mut self, value: f64) -> &mut EuropeanVanillaOptionBuilder`

The strike price of the option.

#### `expiry(&mut self, value: Date) -> &mut EuropeanVanillaOptionBuilder`

The expiry date of the option.

#### `type_flag(&mut self, value: TypeFlag) -> &mut EuropeanVanillaOptionBuilder`

The type of the option (call or put).

#### `build(&self) -> Result<EuropeanVanillaOption, EuropeanVanillaOptionBuilderError>`

Builds a new `EuropeanVanillaOption`.

##### Errors

If a required field has not been initialized.
```

--------------------------------

### deref_mut

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/fx/currency/struct.Currency.html

Dereferences a pointer to get a mutable reference to the currency value.

```APIDOC
## deref_mut

### Description
Mutably dereferences the given pointer.

### Signature
`unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T`
```

--------------------------------

### Portfolio::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/struct.Portfolio.html

Creates a new Portfolio instance with the provided HashMap of positions.

```APIDOC
## Portfolio::new

```rust
pub const fn new(positions: HashMap<String, Position<I>>) -> Portfolio<I>
```

**Description:**
Create a new portfolio.
```

--------------------------------

### new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/rootfinding/brent/struct.Brent.html

Creates a new Brent solver instance with the provided function, initial guess, and rootfinder data.

```APIDOC
## pub fn new(function: F, guess: f64, data: RootfinderData) -> Brent<F>

Create a new Brent solver.
```

--------------------------------

### deref

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/fx/currency/struct.Currency.html

Dereferences a pointer to get an immutable reference to the currency value.

```APIDOC
## deref

### Description
Dereferences the given pointer.

### Signature
`unsafe fn deref<'a>(ptr: usize) -> &'a T`
```

--------------------------------

### FiniteDifferencePricer::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/options/finite_difference_pricer/struct.FiniteDifferencePricer.html

Constructor for FiniteDifferencePricer. Initializes a new instance with all necessary option and pricing parameters.

```APIDOC
## FiniteDifferencePricer::new

### Description
Constructor for FiniteDifferencePricer. Initializes a new instance with all necessary option and pricing parameters.

### Signature
```rust
pub fn new(
    initial_price: f64,
    strike_price: f64,
    risk_free_rate: f64,
    volatility: f64,
    evaluation_date: Option<Date>,
    expiration_date: Date,
    time_steps: u32,
    price_steps: u32,
    type_flag: TypeFlag,
    exercise_flag: ExerciseFlag,
) -> FiniteDifferencePricer
```

### Parameters
* `initial_price`: f64 - The initial price of the underlying asset.
* `strike_price`: f64 - The strike price of the option.
* `risk_free_rate`: f64 - The risk-free interest rate.
* `volatility`: f64 - The volatility of the underlying asset.
* `evaluation_date`: Option<Date> - The date when the option is evaluated (optional).
* `expiration_date`: Date - The expiration date of the option.
* `time_steps`: u32 - The number of time steps for the finite difference method.
* `price_steps`: u32 - The number of price steps for the finite difference method.
* `type_flag`: TypeFlag - The type of the option (e.g., Call or Put).
* `exercise_flag`: ExerciseFlag - The style of the option (e.g., European or American).
```

--------------------------------

### leap_year_count

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/fn.leap_year_count.html

Function to get the number of leap years in a range of `Dates`.

```APIDOC
## Function leap_year_count

### Description
Function to get the number of leap years in a range of `Dates`.

### Signature
```rust
pub fn leap_year_count(start: Date, end: Date) -> i64
```

### Parameters
* `start` (Date) - The start date of the range.
* `end` (Date) - The end date of the range.

### Returns
* `i64` - The total number of leap years within the specified range.

### Example
```rust
use time::{Date, Month};
use RustQuant::time::utilities::leap_year_count;

let start = Date::from_calendar_date(2023, Month::July, 1).unwrap();
let end = Date::from_calendar_date(2025, Month::January, 1).unwrap();

let number_of_leap_years = leap_year_count(start, end);

assert_eq!(number_of_leap_years, 1);
```
```

--------------------------------

### get_days_in_years_in_range

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/fn.get_days_in_years_in_range.html

Function to get the number of days for each year in a range of `Dates`.

```APIDOC
## Function get_days_in_years_in_range

### Description
Function to get the number of days for each year in a range of `Dates`.

### Signature
```rust
pub fn get_days_in_years_in_range(start: Date, end: Date) -> Vec<u16>
```

### Example
```rust
use time::{Date, Month};
use RustQuant::time::utilities::get_days_in_years_in_range;

let start = Date::from_calendar_date(2023, Month::July, 1).unwrap();
let end = Date::from_calendar_date(2025, Month::January, 1).unwrap();

let days_in_years = get_days_in_years_in_range(start, end);

assert_eq!(days_in_years, vec![365, 366, 365]);
```
```

--------------------------------

### ExchangeRate Conversion Panic Example

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/struct.ExchangeRate.html

Demonstrates a scenario where `ExchangeRate::convert` will panic due to a mismatch between the money's currency and the exchange rate's `from_currency`. This highlights the importance of matching currencies for conversion.

```rust
use RustQuant::instruments::*;

let usd = Money::new(EUR, 100.0);                       // Notice the wrong currency
let eur_usd = ExchangeRate::new(USD, EUR, 0.9186955);   // 1 USD = 0.9186955 EUR

eur_usd.convert(usd);  // This will panic
```

--------------------------------

### deref_mut Function

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/curves/struct.SpotCurve.html

Dereferences a raw pointer to get a mutable reference.

```APIDOC
#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
Mutably dereferences the given pointer. Read more
```

--------------------------------

### CoxIngersollRoss::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/struct.CoxIngersollRoss.html

Constructor for creating a new CoxIngersollRoss process instance.

```APIDOC
## impl CoxIngersollRoss

### pub fn new( mu: impl Into<ModelParameter>, sigma: impl Into<ModelParameter>, theta: impl Into<ModelParameter>, ) -> CoxIngersollRoss

Create a new Cox-Ingersoll-Ross process.
```

--------------------------------

### Example: Panic on Currency Mismatch

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/exchange/struct.ExchangeRate.html

Illustrates a panic scenario when attempting to convert money where the input currency does not match the ExchangeRate's 'from_currency'.

```rust
use RustQuant::instruments::*

let usd = Money::new(EUR, 100.0);                       // Notice the wrong currency
let eur_usd = ExchangeRate::new(USD, EUR, 0.9186955);   // 1 USD = 0.9186955 EUR

eur_usd.convert(usd);  // This will panic
```

--------------------------------

### deref Function

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/curves/struct.SpotCurve.html

Dereferences a raw pointer to get an immutable reference.

```APIDOC
#### unsafe fn deref<'a>(ptr: usize) -> &'a T
Dereferences the given pointer. Read more
```

--------------------------------

### PolicyExt And Implementation

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/enum.ExerciseFlag.html

Combines two policies into a new policy that requires both to return Action::Follow.

```rust
fn and<P, B, E>(self, other: P) -> And<T, P>
```

--------------------------------

### Pointable Dereference

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/curves/struct.DiscountCurve.html

Dereferences a raw pointer to get a reference to the object.

```APIDOC
unsafe fn deref<'a>(ptr: usize) -> &'a T
```

```APIDOC
unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
```

--------------------------------

### CloneToUninit Trait Implementation

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/curves/struct.ForwardCurve.html

Documentation for the nightly-only experimental `CloneToUninit` trait implementation.

```APIDOC
### impl<T> CloneToUninit for T
where T: Clone,

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)
Performs copy-assignment from `self` to `dest`. Read more
```

--------------------------------

### Get Entropy of Gaussian Distribution

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/math/distributions/gaussian/struct.Gaussian.html

Returns the entropy of the Gaussian distribution.

```rust
let gaussian = Gaussian::new(0.0, 1.0);

assert_approx_equal!(gaussian.entropy(), 1.4189385, 1e-7);
```

--------------------------------

### EuropeanVanillaOption::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/options/struct.EuropeanVanillaOption.html

Constructor for creating a new European vanilla option.

```APIDOC
## EuropeanVanillaOption::new

### Signature
```
pub fn new( strike: f64, expiry: Date, type_flag: TypeFlag, ) -> EuropeanVanillaOption
```

### Description
Create a new vanilla option.
```

--------------------------------

### Get Variance of Gaussian Distribution

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/math/distributions/gaussian/struct.Gaussian.html

Returns the variance of the Gaussian distribution.

```rust
let gaussian = Gaussian::new(0.0, 1.0);

assert_eq!(gaussian.variance(), 1.0);
```

--------------------------------

### PolicyExt And Method

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/struct.FlatCurveBuilder.html

Combines two policies into a new policy that requires both to return `Action::Follow` to succeed. Requires both policies to operate on the same bounds and errors.

```rust
fn and<P, B, E>(self, other: P) -> And<T, P>
where
    T: Policy<B, E>,
    P: Policy<B, E>,

```

--------------------------------

### Any Trait Implementation

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/options/black_scholes_merton/struct.BlackScholesMerton.html

Provides the `type_id` method to get the `TypeId` of the struct.

```APIDOC
## fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`.

Source: [Source](Source)
```

--------------------------------

### init

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/time/struct.Holiday.html

Initializes a type with the given initializer.

```APIDOC
#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§
```

--------------------------------

### Get Currency Code

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/struct.Currency.html

Retrieves the ISO 4217 currency code.

```rust
pub fn code(&self) -> ISO_4217
```

--------------------------------

### init

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/fx/currency/struct.Currency.html

Initializes a currency value from an initializer.

```APIDOC
## init

### Description
Initializes a with the given initializer.

### Signature
`unsafe fn init(init: <T as Pointable>::Init) -> usize`
```

--------------------------------

### Currency::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/currency/struct.Currency.html

Creates a new Currency instance with the provided details.

```APIDOC
### impl Currency
Source
#### pub fn new( name: &'static str, symbol: &'static str, code: ISO_4217, minor: usize, fractions: usize, ) -> Currency
Create a new currency.
```

--------------------------------

### YahooFinanceData::set_date_range

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/struct.YahooFinanceData.html

Sets both the start and end dates for the price history retrieval.

```APIDOC
#### pub fn set_date_range(&mut self, start: OffsetDateTime, end: OffsetDateTime)
Sets both the start and end dates for the price history.
```

--------------------------------

### Policy Combination: or

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/analytic_option_pricer/struct.AnalyticOptionPricerBuilder.html

Creates a new Policy that returns Action::Follow if either the current policy or the other policy returns Action::Follow.

```APIDOC
## fn or<P, B, E>(self, other: P) -> Or<T, P>

### Description
Creates a new `Policy` that returns `Action::Follow` if either `self` or `other` returns `Action::Follow`.

### Parameters
- `other`: Another policy to combine with.

### Returns
A new `Or` policy combining `self` and `other`.
```

--------------------------------

### Get Holiday Fields

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/time/holiday/struct.Holiday.html

Methods to retrieve the name, date, and description of a holiday.

```rust
pub fn name(&self) -> &'static str
```

```rust
pub fn date(&self) -> Date
```

```rust
pub fn description(&self) -> Option<&'static str>
```

--------------------------------

### Policy Combination: Or

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/math/interpolation/struct.LinearInterpolator.html

Creates a new policy that returns Action::Follow if either the current policy or another policy returns Action::Follow.

```APIDOC
## fn or<P, B, E>(self, other: P) -> Or<T, P>

### Description
Creates a new `Policy` that returns `Action::Follow` if either `self` or `other` returns `Action::Follow`.

### Parameters
* `other`: The other policy to combine with.

### Returns
A new `Or` policy combining `self` and `other`.
```

--------------------------------

### Get Country Code

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/countries/europe/austria/struct.AustriaCalendar.html

Returns the ISO 3166-1 country code for Austria.

```rust
fn country_code(&self) -> ISO_3166
```

--------------------------------

### StochasticProcessConfig::new Constructor

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/process/struct.StochasticProcessConfig.html

Creates a new instance of StochasticProcessConfig. Use this to initialize the simulation parameters.

```rust
pub fn new(
    x_0: f64,
    t_0: f64,
    t_n: f64,
    n_steps: usize,
    m_paths: usize,
    parallel: bool,
) -> StochasticProcessConfig
```

--------------------------------

### Get All Values (Date)

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/curves/struct.Curve.html

Returns a Vec containing all the values stored in the curve.

```rust
pub fn values(&self) -> Vec<f64>
```

--------------------------------

### Get Terminal Date of DiscountCurve

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/curves/struct.DiscountCurve.html

Returns the latest date present in the DiscountCurve.

```rust
fn terminal_date(&self) -> Date
```

--------------------------------

### Get Initial Date of DiscountCurve

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/curves/struct.DiscountCurve.html

Returns the earliest date present in the DiscountCurve.

```rust
fn initial_date(&self) -> Date
```

--------------------------------

### Pointable::init

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/struct.Exponential.html

Initializes a pointer with the given initializer.

```APIDOC
## unsafe fn init(init: <T as Pointable>::Init) -> usize
Initializes a with the given initializer.
```

--------------------------------

### Get TypeId

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/cashflows/quotes/struct.SimpleQuote.html

Returns the `TypeId` of the `self` value. This is part of the `Any` trait implementation.

```rust
fn type_id(&self) -> TypeId>
```

--------------------------------

### Create New YahooFinanceData Instance

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/struct.YahooFinanceData.html

Initializes a new YahooFinanceData struct with a specified ticker symbol. Use this to begin collecting financial data.

```rust
pub fn new(ticker: String) -> YahooFinanceData
```

--------------------------------

### Get Quote Value

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/cashflows/quotes/struct.SimpleQuote.html

Retrieves the current value of the quote as an Option<f64>.

```rust
fn value(&self) -> Option<f64>
```

--------------------------------

### Create New BlackDermanToy Instance

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/black_derman_toy/struct.BlackDermanToy.html

Constructs a new Black-Derman-Toy process with specified parameters. Use this function to initialize the model with its volatility and underlying value.

```rust
pub fn new( sigma: impl Into<ModelParameter>, theta: impl Into<ModelParameter>, ) -> BlackDermanToy
```

--------------------------------

### Create New Portfolio

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/portfolios/struct.Portfolio.html

Constructs a new Portfolio instance with a given HashMap of positions.

```rust
pub const fn new(positions: HashMap<String, Position<I>>) -> Portfolio<I>
```

--------------------------------

### date_sequence

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/fn.date_sequence.html

Generates a vector of Date objects from a start date to an end date, inclusive.

```APIDOC
## date_sequence

### Description
Function to generate a sequence of dates from a start date, end date.

### Signature
```rust
pub fn date_sequence(start: Date, end: Date) -> Vec<Date>
```

### Parameters
* `start` (Date) - The starting date of the sequence.
* `end` (Date) - The ending date of the sequence.

### Returns
* `Vec<Date>` - A vector containing all dates from `start` to `end`, inclusive.
```

--------------------------------

### init Function

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/curves/struct.SpotCurve.html

Initializes a memory location with the given initializer.

```APIDOC
#### unsafe fn init(init: <T as Pointable>::Init) -> usize
Initializes a with the given initializer. Read more
```

--------------------------------

### Get Country Code

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/time/countries/asia/hong_kong/struct.HongKongCalendar.html

Retrieves the ISO 3166-1 country code for Hong Kong.

```rust
fn country_code(&self) -> ISO_3166;
```

--------------------------------

### Holiday Constructor: new_with_description

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/time/struct.Holiday.html

Creates a new Holiday instance with a name, date, and a description.

```APIDOC
#### pub fn new_with_description( name: &'static str, date: Date, description: &'static str, ) -> Holiday

Create a new holiday with a description.
```

--------------------------------

### Get Kurtosis of Gaussian Distribution

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/math/distributions/gaussian/struct.Gaussian.html

Returns the kurtosis of the Gaussian distribution, which is always 0.

```rust
let gaussian = Gaussian::new(0.0, 1.0);

assert_eq!(gaussian.kurtosis(), 0.0);
```

--------------------------------

### Get Skewness of Gaussian Distribution

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/math/distributions/gaussian/struct.Gaussian.html

Returns the skewness of the Gaussian distribution, which is always 0.

```rust
let gaussian = Gaussian::new(0.0, 1.0);

assert_eq!(gaussian.skewness(), 0.0);
```

--------------------------------

### Graph::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/autodiff/graph/struct.Graph.html

Instantiates a new, empty graph.

```APIDOC
## Graph::new

### Description
Instantiate a new graph.

### Signature
```rust
pub const fn new() -> Graph
```
```

--------------------------------

### Currency::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/struct.Currency.html

Creates a new Currency instance with the provided name, symbol, ISO code, minor unit, and fractions.

```APIDOC
## impl Currency

### pub fn new( name: &'static str, symbol: &'static str, code: ISO_4217, minor: usize, fractions: usize, ) -> Currency

Create a new currency.
```

--------------------------------

### Get Mode of Gaussian Distribution

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/math/distributions/gaussian/struct.Gaussian.html

Returns the mode of the Gaussian distribution, which is equal to its mean.

```rust
let gaussian = Gaussian::new(0.0, 1.0);

assert_eq!(gaussian.mode(), gaussian.mean());
```

--------------------------------

### Create Asay82 Option Pricing Parameters

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/options/struct.Asay82.html

Use this function to initialize Asay82 with specific volatility and forward price values. This is the primary way to create an instance for pricing calculations.

```rust
pub struct Asay82 { /* private fields */ }
```

```rust
pub fn new(f: f64, v: f64) -> Asay82
```

--------------------------------

### Get Median of Gaussian Distribution

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/math/distributions/gaussian/struct.Gaussian.html

Returns the median of the Gaussian distribution, which is equal to its mean.

```rust
let gaussian = Gaussian::new(0.0, 1.0);

assert_eq!(gaussian.median(), gaussian.mean());
```

--------------------------------

### Get Mean of Gaussian Distribution

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/math/distributions/gaussian/struct.Gaussian.html

Returns the mean of the Gaussian distribution, which is equal to its median.

```rust
let gaussian = Gaussian::new(0.0, 1.0);

assert_eq!(gaussian.mean(), 0.0);
```

--------------------------------

### Build EuropeanVanillaOption

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/options/struct.EuropeanVanillaOptionBuilder.html

Builds a new EuropeanVanillaOption. Returns a Result which is Ok if successful, or an error if required fields are missing.

```rust
pub fn build( &self, ) -> Result<EuropeanVanillaOption, EuropeanVanillaOptionBuilderError>
```

--------------------------------

### fn or

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/struct.Bernoulli.html

Creates a new `Policy` that succeeds if either `self` or `other` policy returns `Action::Follow`.

```APIDOC
## fn or<P, B, E>(self, other: P) -> Or<T, P>

### Description
Create a new `Policy` that returns `Action::Follow` if either `self` or `other` returns `Action::Follow`.

### Parameters
- `other`: `P` - The other policy to combine with.

### Returns
`Or<T, P>` - A new policy representing the disjunction of `self` and `other`.

### Type Parameters
- `P`: The type of the other policy.
- `B`: The type of the decision context.
- `E`: The type of the error.

### Constraints
- `T: Policy<B, E>`
- `P: Policy<B, E>`
```

--------------------------------

### Get Minor Unit Digits

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/struct.Currency.html

Retrieves the number of digits after the decimal separator for the currency.

```rust
pub fn minor(&self) -> usize
```

--------------------------------

### Get Minimum of Two CurrencyPairs

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/currency/struct.CurrencyPair.html

Method to return the minimum of two CurrencyPair instances.

```rust
fn min(self, other: Self) -> Self
where Self: Sized,
```

--------------------------------

### Create New PowerOption

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/options/power/struct.PowerOption.html

Constructor for creating a new PowerOption instance. Requires an OptionContract, strike price, and the power parameter.

```rust
pub fn new(contract: OptionContract, strike: f64, power: f64) -> PowerOption
```

--------------------------------

### Get Maximum of Two CurrencyPairs

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/currency/struct.CurrencyPair.html

Method to return the maximum of two CurrencyPair instances.

```rust
fn max(self, other: Self) -> Self
where Self: Sized,
```

--------------------------------

### and

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/fx/currency/struct.CurrencyPair.html

Combines two policies, requiring both to return `Action::Follow`.

```APIDOC
## and

### Description
Create a new `Policy` that returns `Action::Follow` only if `self` and `other` return `Action::Follow`.

### Method
`and`

### Parameters
- **self** (`T`) - The first policy.
- **other** (`P`) - The second policy.
```

--------------------------------

### Get All Keys (Time)

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/curves/struct.Curve.html

Returns a Vec containing all the keys (indices) present in the curve.

```rust
pub fn keys(&self) -> Vec<Time>
```

--------------------------------

### Get All Keys (Date)

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/curves/struct.Curve.html

Returns a Vec containing all the keys (indices) present in the curve.

```rust
pub fn keys(&self) -> Vec<Date>
```

--------------------------------

### Combine Policies for AsianOption

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/struct.AsianOption.html

Creates a new Policy that returns Action::Follow only if both self and other policies return Action::Follow.

```rust
fn and<P, B, E>(self, other: P) -> And<Self, P>
where Self: Policy<B, E>, P: Policy<B, E>,
```

--------------------------------

### Pointable DerefMut Method

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/curves/struct.FlatCurveBuilder.html

Dereferences a raw pointer to get a mutable reference to the object.

```rust
unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

```

--------------------------------

### Instantiate Graph with Capacity

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/autodiff/graph/struct.Graph.html

Creates a new graph with a specified initial capacity for its vertices. This can improve performance by reducing reallocations when the graph size is known beforehand.

```rust
pub fn with_capacity(capacity: usize) -> Graph
```

--------------------------------

### Pointable Deref Method

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/curves/struct.FlatCurveBuilder.html

Dereferences a raw pointer to get an immutable reference to the object.

```rust
unsafe fn deref<'a>(ptr: usize) -> &'a T

```

--------------------------------

### OrderBook::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/order_book/struct.OrderBook.html

Creates a new, empty OrderBook instance.

```APIDOC
## OrderBook::new

### Description
Creates a new `OrderBook` instance.

### Method
`pub const fn new() -> OrderBook`
```

--------------------------------

### CurrencyPair::new Constructor

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/fx/struct.CurrencyPair.html

Creates a new instance of CurrencyPair with specified base and quote currencies.

```APIDOC
## impl CurrencyPair

### pub fn new(base: Currency, quote: Currency) -> CurrencyPair

#### Description
Create a new currency pair.

#### Parameters
* `base` (Currency) - The base currency.
* `quote` (Currency) - The quote currency.

#### Returns
A new `CurrencyPair` instance.
```

--------------------------------

### Get Terminal Date of Curve

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/curves/trait.Curves.html

Retrieves the latest date present in the curve data.

```rust
fn terminal_date(&self) -> Date;
```

--------------------------------

### AnalyticOptionPricer General Methods

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/analytic_option_pricer/struct.AnalyticOptionPricer.html

Methods for creating and managing the AnalyticOptionPricer instance.

```APIDOC
## pub fn new(option: O, model: M) -> AnalyticOptionPricer<O, M>

### Description
Create a new instance of the pricer.

### Method
new

### Parameters
- **option** (O) - The option object.
- **model** (M) - The pricing model.

### Returns
- AnalyticOptionPricer<O, M> - A new instance of the pricer.
```

```APIDOC
## pub fn option(&self) -> &O

### Description
Return a reference to the option.

### Method
option

### Returns
- &O - A reference to the option object.
```

```APIDOC
## pub fn model(&self) -> &M

### Description
Return a reference to the model.

### Method
model

### Returns
- &M - A reference to the pricing model.
```

```APIDOC
## pub fn set_option(&mut self, option: O)

### Description
Update the option.

### Method
set_option

### Parameters
- **option** (O) - The new option object to set.
```

```APIDOC
## pub fn set_model(&mut self, model: M)

### Description
Update the model.

### Method
set_model

### Parameters
- **model** (M) - The new pricing model to set.
```

--------------------------------

### Get Initial Date of Curve

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/data/curves/trait.Curves.html

Retrieves the earliest date present in the curve data.

```rust
fn initial_date(&self) -> Date;
```

--------------------------------

### BlackScholesMerton::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/struct.BlackScholesMerton.html

Constructor for creating a new BlackScholesMerton option instance.

```APIDOC
## impl BlackScholesMerton

### pub fn new( cost_of_carry: f64, underlying_price: f64, strike_price: f64, volatility: f64, risk_free_rate: f64, evaluation_date: Option<Date>, expiration_date: Date, option_type: TypeFlag, ) -> BlackScholesMerton

#### Description
New European Option
```

--------------------------------

### contains_leap_year

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/fn.contains_leap_year.html

Determines if the period between the start and end dates contains at least one leap year.

```APIDOC
## contains_leap_year

### Description
Function to check if a range of years contains a leap year.

### Signature
```rust
pub fn contains_leap_year(start: Date, end: Date) -> bool
```

### Parameters
- **start** (Date) - The starting date of the range.
- **end** (Date) - The ending date of the range.

### Returns
- **bool** - `true` if the range contains a leap year, `false` otherwise.
```

--------------------------------

### GradientDescent::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/math/optimization/struct.GradientDescent.html

Constructor for the GradientDescent optimizer.

```APIDOC
## GradientDescent::new

### Description
Returns a new instance of the gradient descent optimizer.

### Panics
Panics if tolerance is not positive.
```

--------------------------------

### Get Market Identifier Code

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/countries/europe/austria/struct.AustriaCalendar.html

Returns the ISO 10383 market identifier code for Austria.

```rust
fn market_identifier_code(&self) -> ISO_10383
```

--------------------------------

### Black76::new

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/instruments/options/struct.Black76.html

Creates a new instance of Black76 with the provided forward price, risk-free rate, and volatility.

```APIDOC
## Black76::new

### Description
Create a new Black (1976) option pricing parameters.

### Signature
```rust
pub fn new(f: f64, r: f64, v: f64) -> Black76
```

### Parameters
* `f` (f64): The forward price.
* `r` (f64): The risk-free interest rate.
* `v` (f64): The volatility.
```

--------------------------------

### build

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/struct.AnalyticOptionPricerBuilder.html

Builds a new `AnalyticOptionPricer`.

```APIDOC
### pub fn build( &self, ) -> Result<AnalyticOptionPricer<O, M>, AnalyticOptionPricerBuilderError>

Builds a new `AnalyticOptionPricer`.

##### §Errors
If a required field has not been initialized.
```

--------------------------------

### Get Calendar Country Code

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/calendar/struct.CalendarMetadata.html

Returns the ISO 3166-1 country code associated with the calendar.

```rust
pub fn country_code(&self) -> ISO_3166
```

--------------------------------

### Get Position Weights

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/portfolios/struct.Portfolio.html

Calculates and returns the current market value weights of all positions in the portfolio.

```rust
pub fn position_weights(&self) -> HashMap<String, f32>
```

--------------------------------

### Create New Currency Instance

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/prelude/fx/struct.Currency.html

Constructs a new Currency instance. Ensure all parameters are correctly provided to represent a valid currency.

```rust
pub fn new( name: &'static str,
 symbol: &'static str,
 code: ISO_4217,
 minor: usize,
 fractions: usize,
) -> Currency
```

--------------------------------

### Get Variance of Poisson Distribution

Source: https://docs.rs/RustQuant/0.3.1/RustQuant/math/distributions/poisson/struct.Poisson.html

Returns the variance of the Poisson distribution, which is equal to its lambda parameter.

```rust
let poisson = Poisson::new(1.0);

assert_eq!(poisson.variance(), 1.0);
```
Tokens:
Raw