Skip to content

Commit

Permalink
docs: add section on problems and add notes on defining problems
Browse files Browse the repository at this point in the history
  • Loading branch information
ashutosh-b-b committed Feb 9, 2024
1 parent 9534761 commit a7358f7
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/pages.jl
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
pages = [
"Home" => "index.md",
"Getting started" => "getting_started.md",
"Problems" => "problems.md",
"Solver Algorithms" => ["MLP.md",
"DeepSplitting.md",
"DeepBSDE.md",
Expand Down
15 changes: 14 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# HighDimPDE.jl


**HighDimPDE.jl** is a Julia package to **solve Highly Dimensional non-linear, non-local PDEs** of the form
**HighDimPDE.jl** is a Julia package to **solve Highly Dimensional non-linear, non-local PDEs** of the forms:

1. Partial Integro Differential Equations:
```math
\begin{aligned}
(\partial_t u)(t,x) &= \int_{\Omega} f\big(t,x,{\bf x}, u(t,x),u(t,{\bf x}), ( \nabla_x u )(t,x ),( \nabla_x u )(t,{\bf x} ) \big) \, d{\bf x} \\
Expand All @@ -12,6 +13,18 @@

where $u \colon [0,T] \times \Omega \to \R$, $\Omega \subseteq \R^d$ is subject to initial and boundary conditions, and where $d$ is large.

2. Parabolic Partial Differential Equations:
```math
\begin{aligned}
(\partial_t u)(t,x) &= f\big(t,x, u(t,x), ( \nabla_x u )(t,x )\big)
+ \big\langle \mu(t,x), ( \nabla_x u )( t,x ) \big\rangle + \tfrac{1}{2} \text{Trace} \big(\sigma(t,x) [ \sigma(t,x) ]^* ( \text{Hess}_x u)(t, x ) \big).
\end{aligned}
```

where $u \colon [0,T] \times \Omega \to \R$, $\Omega \subseteq \R^d$ is subject to initial and boundary conditions, and where $d$ is large.

!!! note
The difference between the two problems is that in Partial Integro Differential Equations, the integrand is integrated over **x**, while in Parabolic Integro Differential Equations, the function `f` is just evaluated for `x`.

**HighDimPDE.jl** implements solver algorithms that break down the curse of dimensionality, including

Expand Down
8 changes: 8 additions & 0 deletions docs/src/problems.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
```@docs
PIDEProblem
ParabolicPDEProblem
```

!!! note
While choosing to define a PDE using `PIDEProblem`, not that the function being integrated `f` is a function of `f(x, y, v_x, v_y, ∇v_x, ∇v_y)` out of which `y` is the integrating variable and `x` is constant throughout the integration.
If a PDE has no integral and the non linear term `f` is just evaluated as `f(x, v_x, ∇v_x)` then we suggest using `ParabolicPDEProblem`
2 changes: 2 additions & 0 deletions docs/src/tutorials/nnstopping.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `NNStopping`

## Solving for optimal strategy and expected payoff of a Bermudan Max-Call option

We will calculate optimal strategy for Bermudan Max-Call option with following drift, diffusion and payoff:
Expand Down

0 comments on commit a7358f7

Please sign in to comment.