Skip to content

Commit 4dd84d4

Browse files
committed
Merge branch 'feature/QPR-13706' into 'master'
QPR-13706: fix typos in other catalogues Closes QPR-13706 See merge request qs/oreplus!3080
2 parents f8ea030 + c739afb commit 4dd84d4

87 files changed

Lines changed: 1794 additions & 1820 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Docs/AMC/amc.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ \section{Overview}\label{overview}
191191
evolution model driving the XVA simulation, the scenario NPVs in the classic approach are in general not consistent in
192192
this sense unless the market scenarios are fully implied by the cross asset model. Here ``fully implied'' means that not
193193
only rate curves, but also market volatility and correlation term structures like FX volatility surfaces, swaption
194-
volatilties or CMS correlation term structures as well as other parmeters used by the single trade pricers have to be
194+
volatilities or CMS correlation term structures as well as other parameters used by the single trade pricers have to be
195195
deduced from the cross asset model, e.g. the mean reversion of the Hull White 1F model and a sutaible model volatility
196196
feeding into a Bermudan swaption pricer.
197197

@@ -613,7 +613,7 @@ \subsection{Multi Leg Options / MC pricing engine}
613613
\item \verb+IrCalibrationStrategy+ can be \verb+None+, \verb+CoterminalATM+, \verb+UnderlyingATM+
614614
\item \verb+FXCalibration+ can be \verb+None+ or \verb+Bootstrap+
615615
\item \verb+ExtrapolateFxVolatility+ can be \verb+true+ or \verb+false+; if false, no calibration instruments are used
616-
that require extrapolation of the market fx volatilty surface in option expiry direction
616+
that require extrapolation of the market fx volatility surface in option expiry direction
617617
\item \verb+Corr_Key1_Key2+: These entries describe the cross asset model correlations to be used; the syntax for
618618
\verb+Key1+ and \verb+Key2+ is the same as in the simulation configuration for the cross asset model, see \cite{oreug}.
619619
\end{enumerate}

Docs/BondPricingConfig/bondpricingconfig.tex

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ \section{Overview}\label{overview}
143143

144144
\begin{itemize}
145145
\item ReferenceCurve: a rate curve determining the baseline discounting curve for bond valuation.
146-
\item CreditCurve [optional]: a credit curve determining the default probabilty during the lifetime of a bond. This can
146+
\item CreditCurve [optional]: a credit curve determining the default probability during the lifetime of a bond. This can
147147
e.g. be
148148
\begin{itemize}
149149
\item a CDS curve of the same issuer and seniority as the bond to proxy the credit risk
@@ -154,7 +154,7 @@ \section{Overview}\label{overview}
154154
\end{itemize}
155155
In all cases, the security spread can be used to represent additional credit / liquidity risk, see below.
156156
\item SecuritySpread [optional]: a single additional discounting spread. This can generally be interpreted as part of
157-
the credit risk (generating additional default probabilty) or as part of the baseline discounting (liquidity
157+
the credit risk (generating additional default probability) or as part of the baseline discounting (liquidity
158158
spread). Assumed to be zero if not given. Exception: If a price quote is given and the security spread is configured
159159
in the security curve config, but no market data is given for the security spread, the security spread is implied from
160160
the price quote.
@@ -216,7 +216,7 @@ \subsection{Credit Curve Config}
216216
The credit curve represents the survival probability entering the bond pricing. It also provides a recovery rate that is
217217
used as a fallback if the recovery rate from the security curve config is not available.
218218
219-
The curve config can either be explicitly set up or ore can auto-generate it. Listing
219+
The curve config can either be explicitly set up or ORE can auto-generate it. Listing
220220
\ref{lst:autogen_default_curve_config} shows an auto-generated config for the bond from section \ref{refdata}:
221221
222222
\begin{itemize}
@@ -257,7 +257,7 @@ \subsection{Security Curve Config}
257257
258258
The security curve config points to additional market data used for bond pricing.
259259
260-
It can be explicitly set up or ore can auto-generate it. Listing \ref{lst:autogen_security_curve_config} shows an
260+
It can be explicitly set up or ORE can auto-generate it. Listing \ref{lst:autogen_security_curve_config} shows an
261261
auto-generated config for the bond from section \ref{refdata}:
262262
263263
\begin{itemize}

Docs/CodingStandards/ore_coding_standards.tex

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ \section*{git usage - pull requests}
165165
\textbf{Optional:} \texttt{\% git push bob bob\_widget}
166166
\item Once the coding task in complete, developer pushes the branch to the origin repo. Care should be taken not to push to origin/master.\\
167167
\texttt{\% git push origin bob\_widget}
168-
\item Then go to codebasehq.com \url{https://qrm.codebasehq.com/projects/openxva/repositories/openxva/tree/master} and click on "Merge Request" and then "New Merge Request" with the following details:
168+
\item Then go to codebasehq.com \url{https://qrm.codebasehq.com/projects/openxva/repositories/openxva/tree/master} and click on ``Merge Request'' and then ``New Merge Request'' with the following details:
169169
\begin{itemize}
170170
\item \textbf{Subject} A short description
171171
\item \textbf{User} The merge manager (currently Niall O'Sullivan)
@@ -182,9 +182,9 @@ \section*{git usage - pull requests}
182182

183183
The git workflow for the merge manager is as follows
184184
\begin{enumerate}
185-
\item Note that everyone who has a codebase account can preform these tasks, currently there is one designated manager who may delegate.
185+
\item Note that everyone who has a codebase account can perform these tasks, currently there is one designated manager who may delegate.
186186
\item go to merge requests in codebase
187-
\item if there are no conflicts, click on "merge request"
187+
\item if there are no conflicts, click on ``merge request''
188188
\item if there are conflicts, send it back to the developer
189189
\item Once the request has been merged, the temporary branch should be deleted. This is not strictly necessary but means origin is kept cleaner and avoids conflicts.\\
190190
\texttt{\% git push -{}-delete origin bob\_widget}
@@ -219,7 +219,7 @@ \subsection*{Policy on personal github accounts}
219219
This policy statement does not supersede your employment contract.
220220

221221
\subsection*{Policy on opensourcerisk.org forum accounts}
222-
Quaternion developers are permitted and encouraged to create a forum account and engage with the community. As we are representing Quaternion on the forum you should indicate this in your profile somehow, one example of this is to use the Quaternion "Q" logo as an avatar. There are no strict posting rules on the forum however if your account is associated with Quaternion it is expected that all posts and messages are formal and polite.
222+
Quaternion developers are permitted and encouraged to create a forum account and engage with the community. As we are representing Quaternion on the forum you should indicate this in your profile somehow, one example of this is to use the Quaternion ``Q'' logo as an avatar. There are no strict posting rules on the forum however if your account is associated with Quaternion it is expected that all posts and messages are formal and polite.
223223

224224
%-------------------------------------------------------------------------------
225225
\section*{ORE and ORE+ code layout}

Docs/CommodityModel/CommodityModel.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ \section{One Factor Model}
7272
%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7373
\subsection{Time Dependent Multiplier}
7474
%%%%%%%%%%%%%%%%%%%%%%%%%%%%
75-
Seasonality is observed in the market for both commodity future price curves and option volatilities. To incorporate the seasonality in the modelling a time dependent multiplier is introduced in the literature. Andersen \cite{Andersen} suggests\footnote{See section 7.2 in Andersen \cite{Andersen} for the discussion on dependence of seasonality adjustment to calendar days and expiry of future contracts.} that the time dependent variable depends on the maturity of the futures contract. By following this approach, we define it in the one factor case\footnote{Andersen worked on a two factor set up, where the first factor affects the short-end of the futures curve and has the form the $e^{b(T)}$, and the second factor has an additional term containing $e^{a(T)}h_{\infty}$ for long futures maturities.} as follows
75+
Seasonality is observed in the market for both commodity future price curves and option volatilities. To incorporate the seasonality in the modelling a time dependent multiplier is introduced in the literature. Andersen \cite{Andersen} suggests\footnote{See section 7.2 in Andersen \cite{Andersen} for the discussion on dependence of seasonality adjustment to calendar days and expiry of future contracts.} that the time dependent variable depends on the maturity of the futures contract. By following this approach, we define it in the one factor case\footnote{Andersen worked on a two factor set up, where the first factor affects the short-end of the futures curve and has the form $e^{b(T)}$, and the second factor has an additional term containing $e^{a(T)}h_{\infty}$ for long futures maturities.} as follows
7676
%
7777
$$
7878
m_i(T) = e^{b_i(T)}

Docs/ComputeEnvironment/computeenvironment.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,7 @@ \subsection{Populating the input variates}
455455

456456
where \verb+k+ loops over the dimensions (e.g. number of assets) and \verb+j+ loops over the time steps and \verb+rv+ is
457457
a vector of vectors storing the indices of the required random variates by dimensions and time steps. The external
458-
random variable contructor used in this case is
458+
random variable constructor used in this case is
459459

460460
\begin{minted}[fontsize=\footnotesize]{xml}
461461
ExternalRandomVariable::ExternalRandomVariable(std::size_t id)
@@ -650,7 +650,7 @@ \subsection{Variable management}
650650
\begin{itemize}
651651
\item input variables: {\tt x[offset + i]}, with x a buffer in the global address space
652652
\item input variates: {\tt r[offset + i]}, with r a buffer in the global address space
653-
\item intermediate variables: {\tt b[offset + i]}, with b a buffer in the global address space. It is refered to as the
653+
\item intermediate variables: {\tt b[offset + i]}, with b a buffer in the global address space. It is referred to as the
654654
values buffer. Note that this buffer also contains conditional expectation arguments and results and all output
655655
variables.
656656
\end{itemize}

Docs/CreditModel/creditmodel.tex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ \subsection{Credit-worthiness model and transition matrices}
120120

121121
\begin{itemize}
122122
\item $Y_i$ is the systematic part of the credit risk driven by global credit factors $G_j$ (shared between entities),
123-
which are standard Brownian motions with correlation $dG_k\,dG_l = \rho_{kl}\,dt$. The $\beta_{ij}$ are entity-specifc
123+
which are standard Brownian motions with correlation $dG_k\,dG_l = \rho_{kl}\,dt$. The $\beta_{ij}$ are entity-specific
124124
loadings.
125125
\item $Z_i$ is the idiosyncratic part of the credit risk of entity $i$, driven by standard Brownian motions $W_i$ which are independent of all
126126
global factors $G_j$
@@ -494,15 +494,15 @@ \subsection{CreditMigrationHelper}
494494
\item computing the conditional transition matrices
495495
\item generating the issuer-risk pnl at the simulation horizon based on the conditional matrices and the NPVs for all
496496
credit states computed with multi-state pricing engines
497-
\item generating the counterparty-risk pnl at the simulation horizon based on the conditional migration probabilty to
497+
\item generating the counterparty-risk pnl at the simulation horizon based on the conditional migration probability to
498498
default and the usual NPV for relevant derivative trades
499499
\end{itemize}
500500
\item Evaluation $\neq$ Analytic: generate the credit-risk pnl using calls to
501501
\begin{itemize}
502502
\item \verb+initEntityStateSimulation()+: Compute conditional transition matrices for large step (TerminalSimulation)
503503
\item for each ``inner'' simulation path: simulate the entity state using \verb+simulateEntityStates()+
504504
\item for each ``inner'' simulation path: generate credit-risk pnl using \verb+generateMigrationPnl()+ based on the
505-
simulated entity state at the terminal time step and for issuer and counterparty risk (this is donw similar to
505+
simulated entity state at the terminal time step and for issuer and counterparty risk (this is done similar to
506506
Evaluation = Analytic described above)
507507
\end{itemize}
508508
\end{itemize}

Docs/Design/aad.tex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ \section{Automatic Differentiation}
8080
\frac{\partial y}{\partial c} &= \frac{\partial y}{\partial e} \cdot \frac{\partial e}{\partial c} = -d
8181
\end{align*}
8282

83-
The following section provides a brief introduction to the AD mechanics, {\em Forward} and {\em Backward} modes. The latter is also referred to as Adjoint Algorithmic Differentiation (AAD) and particularly important for fast sensitivity calulation.
83+
The following section provides a brief introduction to the AD mechanics, {\em Forward} and {\em Backward} modes. The latter is also referred to as Adjoint Algorithmic Differentiation (AAD) and particularly important for fast sensitivity calculation.
8484

8585
%------------------------------------------------------------------------------------------------------------
8686
\subsection{Automatic Differentiation Basics}
@@ -270,7 +270,7 @@ \subsection{Computation Graphs in ORE}
270270
the operator overloading path introducing an ``active'' {\tt Real} data type, replacing the
271271
``inactive'' {\tt Real} type across the entire ORE libraries, we extract the computation graph
272272
explicitly from the script in its AST representation in order to utilize AAD in the scripted trade
273-
processing only. Thus we avoid negative perfomance impact (recall the ``factor 4'' overhead)
273+
processing only. Thus we avoid negative performance impact (recall the ``factor 4'' overhead)
274274
elsewhere and in the valuation of vanilla instruments. Moreover, we make the ``AAD activation'' of the
275275
scripted trade framework configurable, i.e. we can switch AAD on and off without recompiling the
276276
code base. How this works is discussed briefly in the following.
@@ -1008,7 +1008,7 @@ \subsubsection{Portfolio decomposition}\label{aad:dynamic_delta_subportfolios}
10081008
10091009
In general the calculations described in the previous sections are performed on suitable subsets of the whole
10101010
portfolio. First of all, if the dynamic delta is required for each individual trade, these subsets consist of a single
1011-
trade. If the dynamic delta is only required on the portfolio level, the porfolio is first decomposed into
1011+
trade. If the dynamic delta is only required on the portfolio level, the portfolio is first decomposed into
10121012
10131013
\begin{itemize}
10141014
\item ``plain vanilla'' trades for which the calculations can be done on an the level of aggregated npvs

Docs/Design/ore_design.tex

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ \subsection*{Applications}
293293
OREApp ore(params);
294294
return ore.run();
295295
} catch (const exception& e) {
296-
cout << endl << "an error occured: " << e.what() << endl;
296+
cout << endl << "an error occurred: " << e.what() << endl;
297297
return -1;
298298
}
299299
}
@@ -839,7 +839,7 @@ \subsubsection{Scenario Generation}
839839
\end{listing}
840840

841841
The scenario object refers to a unique reference date and contains an arbitrarily large number of data points that are identified by a RiskFactorKey. The key identifies the risk factor class (25 types so far in ORE, see the definition in
842-
{\tt OREAnalytics/orea/scenario/scenario.hpp}, e.g. {\tt DiscoutCurve}, {\tt IndexCurve}, {\tt SwaptionVolatility}, etc.), a name (e.g. a currency or index name), and an integer indicating the position of the data item in a vector, matrix or cube. A market
842+
{\tt OREAnalytics/orea/scenario/scenario.hpp}, e.g. {\tt DiscountCurve}, {\tt IndexCurve}, {\tt SwaptionVolatility}, etc.), a name (e.g. a currency or index name), and an integer indicating the position of the data item in a vector, matrix or cube. A market
843843
evolution or path is hence represented by a vector of scenarios. So far there is only one derived class from the base Scenario in ORE, {\tt SimpleScenario}, which stores the scenario data in simple vectors and maps, also serializable.
844844

845845
\subsubsection{Engine}
@@ -848,19 +848,19 @@ \subsubsection{Engine}
848848
\item {\bf ValuationEngine} - performs a market simulation, prices a portfolio under scenarios, possibly through time, and fills a resulting NPV cube, with the help of the ValuationCalculator class; the ValuationEngine is used for Monte Carlo simulations of the market evolution but also the hypothetical scenario analytics below
849849
\item {\bf SensitivityAnalysis}, also performed with the help of ValuationEngine and ValuationCalculator: This class wraps functionality to perform a sensitivity analysis for a given portfolio.
850850
\begin{itemize}
851-
\item builds the "simulation" market to which sensitivity scenarios are applied,
851+
\item builds the ``simulation'' market to which sensitivity scenarios are applied,
852852
\item builds the portfolio linked to this simulation market
853853
\item generates sensitivity scenarios
854-
\item runs the scenario "engine" to apply these and compute the NPV impacts of all required shifts
854+
\item runs the scenario ``engine'' to apply these and compute the NPV impacts of all required shifts
855855
\item compiles first and second order sensitivities for all factors and all trades
856856
\item fills result structures that can be queried
857857
\end{itemize}
858858
\item {\bf StressTest}, also performed with the help of ValuationEngine and ValuationCalculator: This class wraps functionality to perform a stress testing analysis for a given portfolio and
859859
\begin{itemize}
860-
\item builds the "simulation" market to which stress scenarios are applied,
860+
\item builds the ``simulation'' market to which stress scenarios are applied,
861861
\item builds the portfolio linked to this simulation market
862862
\item generates stress scenarios
863-
\item runs the scenario "engine" to apply these and compute the NPV impacts of all required shifts
863+
\item runs the scenario ``engine'' to apply these and compute the NPV impacts of all required shifts
864864
\item fills result structures that can be queried
865865
\item writes stress test report to a file
866866
\end{itemize}
@@ -969,7 +969,7 @@ \subsubsection{Aggregation, Cubes, XVA and Post Process}
969969
\end{itemize}
970970
\item {\tt ExposureAllocator}/ {\tt RelativeFairValueNetExposureAllocator}/ {\tt RelativeFairValueGrossExposureAllocator}/ {\tt RelativeXvaExposureAllocator}/ {\tt NoneExposureAllocator}: calculates EPE/ENE based on selected AllocationMethod
971971
\item {\tt CollateralExposureHelper}: This class contains helper functions to aid in the calculation of collateralised exposures. It can be used to calculate margin requirements in the presence of e.g. thresholds and minimum transfer amounts, update collateral account details with e.g. new margin call info, and return collateralised exposures to the user/invoker.
972-
\item {\tt CollateralAccount}: This class holds information corresponding to collateral cash accounts. It stores a balance as well as an asof date for the balance. The class also includes "margin" information relating to the most recent margin call (e.g. call amount, status, expected pay date. The idea is that this class can be updated on-the-run with new margin requirements and collateral balances, and the timestamps updated accordingly.
972+
\item {\tt CollateralAccount}: This class holds information corresponding to collateral cash accounts. It stores a balance as well as an asof date for the balance. The class also includes ``margin'' information relating to the most recent margin call (e.g. call amount, status, expected pay date. The idea is that this class can be updated on-the-run with new margin requirements and collateral balances, and the timestamps updated accordingly.
973973
\item {\tt CVASpreadSensitivityCalculator}: Compute hazard rate and CDS spread sensitivities for a given exposure profile on an externally provided sensitivity grid.
974974
\end{itemize}
975975

@@ -1706,7 +1706,7 @@ \subsection*{Current Scope}
17061706
for data management outside (before and after) calling {\tt ORE.run()} and to facilitate
17071707
ORE-based application development in Python.
17081708
1709-
We curently extend the SWIG wrapper scope mainly upon client request, rather than embarking
1709+
We currently extend the SWIG wrapper scope mainly upon client request, rather than embarking
17101710
on a systematic internal extension project.
17111711
17121712
\subsection*{Python Wheels}
@@ -1929,7 +1929,7 @@ \subsection*{RESTORE}
19291929
to maintain such data manually
19301930
\end{itemize}
19311931
1932-
\subsubsection*{RESTORE Implemenation}
1932+
\subsubsection*{RESTORE Implementation}
19331933
19341934
Source code components and their purpose
19351935
\begin{itemize}

0 commit comments

Comments
 (0)