Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for new methods #95

Merged
merged 1 commit into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/src/payoffs/asset_payoffs.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,6 @@ DiffFusion.IndexConvexityAdjustment
DiffFusion.VanillaAssetOption
```

```@docs
DiffFusion.BarrierAssetOption
```
4 changes: 4 additions & 0 deletions docs/src/pricing_configuration/paths.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ DiffFusion.asset
DiffFusion.forward_asset
```

```@docs
DiffFusion.forward_asset_and_zero_bonds
```

```@docs
DiffFusion.fixing
```
Expand Down
5 changes: 5 additions & 0 deletions docs/src/products/cash_flows.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,11 @@ DiffFusion.RelativeReturnIndexCoupon
DiffFusion.VanillaAssetOptionFlow
```

```@docs
DiffFusion.BarrierAssetOptionFlow
```


## Cash Flow and Coupon Methods

```@docs
Expand Down
23 changes: 23 additions & 0 deletions docs/src/scenarios/scenario_generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,26 @@ DiffFusion.concatenate_scenarios
```@docs
DiffFusion.aggregate
```

## Scenario Generation Using Parallel Computations

We implement various strategies for parallelisation of scenario generation: multi-threading multi-processing and a mixed approach.

It turns out that Julia's garbage collection impedes scaling properties of multi-threaded scenario generation. Parallel garbage collection introduced with Julia 1.10 does not seem to help.

Fortunately, multi-processing can be used efficiently for scenario generation. This circumvents the garbage collection limitation.

We also find that a combination of multi-processing and multi-threading can be most efficient. With such a mixed approach we can leverage the lower overhead from multi-threading and mitigate the impact of single-threaded garbage collection.


```@docs
DiffFusion.scenarios_parallel
```

```@docs
DiffFusion.scenarios_multi_threaded
```

```@docs
DiffFusion.scenarios_distributed
```
22 changes: 22 additions & 0 deletions docs/src/utils/utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,3 +152,25 @@ DiffFusion.bachelier_implied_stdev
```@docs
DiffFusion.bachelier_implied_volatility
```

## Barrier Pricing Formulas

```@docs
DiffFusion.black_scholes_vanilla_price
```

```@docs
DiffFusion.black_scholes_barrier_price
```

```@docs
DiffFusion.up_hit_probability
```

```@docs
DiffFusion.down_hit_probability
```

```@docs
DiffFusion.barrier_no_hit_probability
```
2 changes: 1 addition & 1 deletion src/analytics/ScenariosParallel.jl
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ end
)

Combined multi-processing (distributed) and multi-threaded calculation of
`ScenarioCube` or a vector of `CashFlowLeg` objects and a vector of scenario
`ScenarioCube` for a vector of `CashFlowLeg` objects and a vector of scenario
observation `times`.

Multi-processing is implemented via `Distributed` module. The number of
Expand Down
Loading