Skip to content

Commit dc622dc

Browse files
committed
QPR-11988 update doc and bugfix
1 parent 5842535 commit dc622dc

2 files changed

Lines changed: 98 additions & 2 deletions

File tree

Docs/UserGuide/pricing/pricingengines.tex

Lines changed: 97 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3622,6 +3622,7 @@ \subsection{Product Type: EquityBarrierOption, FxBarrierOption}
36223622
\begin{itemize}
36233623
\item BlackScholesMerton/AnalyticBarrierEngine
36243624
\item BlackScholesMerton/FdBlackScholesBarrierEngine
3625+
\item ScriptedTrade / ScriptedTrade (fx only)
36253626
\end{itemize}
36263627

36273628
Engine description:
@@ -3686,13 +3687,45 @@ \subsection{Product Type: EquityBarrierOption, FxBarrierOption}
36863687
\label{lst:peconfig_EquityBarrierOption_BlackScholesMerton_FdBlackScholesBarrierEngine}
36873688
\end{longlisting}
36883689

3690+
ScriptedTrade/ScriptedTrade delegates to the scripted trade engine and the associated pricing engine configuration for
3691+
Product Type ScriptedTrade, see there for details. A sample configuration is given in listing
3692+
\ref{lst:peconfig_FxBarrierOption_ScriptedTrade_ScriptedTrade}. Only FxBarrierOptions are supported at the moment.
3693+
Typical use case for this pricing engine config would XVA calculation within the AMC framework.
3694+
3695+
The parameters have the following meaning:
3696+
3697+
\begin{itemize}
3698+
\item SensitivityTemplate [optional]: the sensitivity template to use
3699+
\end{itemize}
3700+
3701+
\begin{longlisting}
3702+
\begin{minted}[fontsize=\footnotesize]{xml}
3703+
<Product type="FxBarrierOption">
3704+
<Model>ScriptedTrade</Model>
3705+
<ModelParameters/>
3706+
<Engine>ScriptedTrade</Engine>
3707+
<EngineParameters>
3708+
<Parameter name="SensitivityTemplate">FX_MC</Parameter>
3709+
</EngineParameters>
3710+
</Product>
3711+
\end{minted}
3712+
\caption{Configuration for Product FxBarrierOption, Model ScriptedTrade, Engine ScriptedTrade}
3713+
\label{lst:peconfig_FxBarrierOption_ScriptedTrade_ScriptedTrade}
3714+
\end{longlisting}
3715+
36893716
%--------------------------------------------------------
36903717
\subsection{Product Type: EquityDoubleBarrierOption, FxDoubleBarrierOption}
36913718
%--------------------------------------------------------
36923719

36933720
Used by trade type: EquityDoubleBarrierOption, FxDoubleBarrierOption
36943721

3695-
Available Model/Engine pairs: GarmanKohlhagen/AnalyticDoubleBarrierEngine (both fx and equity)
3722+
Available Model/Engine pairs:
3723+
\begin{itemize}
3724+
\item GarmanKohlhagen/AnalyticDoubleBarrierEngine (both fx and equity)
3725+
\item ScriptedTrade / ScriptedTrade (fx only)
3726+
\end{itemize}
3727+
3728+
36963729

36973730
Engine description:
36983731

@@ -3721,6 +3754,69 @@ \subsection{Product Type: EquityDoubleBarrierOption, FxDoubleBarrierOption}
37213754
\label{lst:peconfig_FxDoubleBarrierOption_GarmanKohlhagen_AnalyticDoubleBarrierEngine}
37223755
\end{longlisting}
37233756

3757+
ScriptedTrade/ScriptedTrade delegates to the scripted trade engine and the associated pricing engine configuration for
3758+
Product Type ScriptedTrade, see there for details. A sample configuration is given in listing
3759+
\ref{lst:peconfig_FxDoubleBarrierOption_ScriptedTrade_ScriptedTrade}. Only FxBarrierOptions are supported at the moment.
3760+
Typical use case for this pricing engine config would XVA calculation within the AMC framework.
3761+
3762+
The parameters have the following meaning:
3763+
3764+
\begin{itemize}
3765+
\item SensitivityTemplate [optional]: the sensitivity template to use
3766+
\end{itemize}
3767+
3768+
\begin{longlisting}
3769+
\begin{minted}[fontsize=\footnotesize]{xml}
3770+
<Product type="FxDoubleBarrierOption">
3771+
<Model>ScriptedTrade</Model>
3772+
<ModelParameters/>
3773+
<Engine>ScriptedTrade</Engine>
3774+
<EngineParameters>
3775+
<Parameter name="SensitivityTemplate">FX_MC</Parameter>
3776+
</EngineParameters>
3777+
</Product>
3778+
\end{minted}
3779+
\caption{Configuration for Product FxDoubleBarrierOption, Model ScriptedTrade, Engine ScriptedTrade}
3780+
\label{lst:peconfig_FxDoubleBarrierOption_ScriptedTrade_ScriptedTrade}
3781+
\end{longlisting}
3782+
3783+
3784+
%--------------------------------------------------------
3785+
\subsection{Product Type: FxEuropeanBarrierOption}
3786+
%--------------------------------------------------------
3787+
3788+
Available Model/Engine pairs:
3789+
\begin{itemize}
3790+
\item ScriptedTrade / ScriptedTrade
3791+
\end{itemize}
3792+
3793+
Engine description:
3794+
3795+
ScriptedTrade/ScriptedTrade delegates to the scripted trade engine and the associated pricing engine configuration for
3796+
Product Type ScriptedTrade, see there for details. A sample configuration is given in listing
3797+
\ref{lst:peconfig_FxDoubleBarrierOption_ScriptedTrade_ScriptedTrade}. Only FxBarrierOptions are supported at the moment.
3798+
Typical use case for this pricing engine config would XVA calculation within the AMC framework.
3799+
3800+
The parameters have the following meaning:
3801+
3802+
\begin{itemize}
3803+
\item SensitivityTemplate [optional]: the sensitivity template to use
3804+
\end{itemize}
3805+
3806+
\begin{longlisting}
3807+
\begin{minted}[fontsize=\footnotesize]{xml}
3808+
<Product type="FxDoubleBarrierOption">
3809+
<Model>ScriptedTrade</Model>
3810+
<ModelParameters/>
3811+
<Engine>ScriptedTrade</Engine>
3812+
<EngineParameters>
3813+
<Parameter name="SensitivityTemplate">FX_MC</Parameter>
3814+
</EngineParameters>
3815+
</Product>
3816+
\end{minted}
3817+
\caption{Configuration for Product FxDoubleBarrierOption, Model ScriptedTrade, Engine ScriptedTrade}
3818+
\label{lst:peconfig_FxDoubleBarrierOption_ScriptedTrade_ScriptedTrade}
3819+
\end{longlisting}
37243820

37253821
%--------------------------------------------------------
37263822
\subsection{Product Type: EquityDigitalOption, FxDigitalOption}

OREData/ored/portfolio/builders/fxbarrieroption.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
#include <ored/portfolio/fxkikobarrieroption.hpp>
2020
#include <ored/portfolio/genericbarrieroption.hpp>
2121
#include <ored/utilities/parsers.hpp>
22-
#include <ored/utilities/optionpaymentdates.hpp>
22+
#include <ored/portfolio/structuredtradewarning.hpp>
2323
namespace ore {
2424
namespace data {
2525

0 commit comments

Comments
 (0)