git subrepo pull (merge) ore

subrepo:
  subdir:   "ore"
  merged:   "d516dce414"
upstream:
  origin:   "git@gitlab.acadiasoft.net:qs/ore.git"
  branch:   "master"
  commit:   "d561f05ac7"
git-subrepo:
  version:  "0.4.6"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "110b9eb"

Author: jenkins

Docker/.env

@@ -3,7 +3,7 @@ DEBIAN_TAG=11.7
 # it's recommended to include CMAKE_BUILD_TYPE and BOOST_VARIANT in QL_TAG, ORE_TAG, BOOST_TAG
 # to distinguish a release build from a debug build
 
-QL_TAG=1.31.1_55f433ce8
+QL_TAG=1.31.1_d2327d5a7135
 ORE_TAG=latest
 BOOST_TAG=1.78.0
 BOOST_DIR=1_78_0

Docs/AMC/amc.tex

@@ -256,7 +256,8 @@ \subsection{Pricing Engine Configuration}\label{sec:pricing_engine_config}
 
 \begin{enumerate}
 \item \verb+Training.Sequence+: The sequence type for the traning phase, can be \verb+MersenneTwister+,
-  \verb+MersenneTwisterAntithetc+, \verb+Sobol+ or \verb+SobolBrownianBridge+
+  \verb+MersenneTwisterAntithetc+, \verb+Sobol+, \verb+Burley2020Sobol+, \verb+SobolBrownianBridge+,
+  \verb+Burley2020SobolBrownianBridge+
 \item \verb+Training.Seed+: The seed for the random number generation in the training phase
 \item \verb+Training.Samples+: The number of samples to be used for the training phase
 \item \verb+Pricing.Sequence+: The sequence type for the pricing phase, same values allowed as for training

Docs/ScriptedTrade/docs/models.tex

@@ -111,7 +111,8 @@ \subsection{Pricing Engine Configuration}\label{pricingengine_config}
 \item RegressionOrder: The order of the polynomial basis to compute conditional expectations via regression
   analysis. Applies to MC only.
 \item SequenceType: The sequence type used for pricing. Defaults to SobolBrownianBridge. Possible values
-  SobolBrownianBridge, MersenneTwister, MersenneTwisterAnithetic, Sobol. Applies to MC only.
+  SobolBrownianBridge, Burley2020SobolBrownianBridge, MersenneTwister, MersenneTwisterAnithetic, Sobol,
+  Burley2020Sobol. Applies to MC only.
 \item PolynomType: The polynom type used for regression analysis. Defaults to Monomial. Possible values Monomial,
   Laguerre, Hermite, Hyperbolic, Legendre, Chebyshev, Chebychev2nd. Applies to MC only.
 \item TrainingSamples: If given, pricing and training are separate phases and traning phase is using this number of

Docs/UserGuide/parameterisation/simulation.tex

@@ -56,18 +56,18 @@
 %\item {\tt Scenario: } Choose between {\em Simple } and {\em Complex } implementations, the latter optimized for
 % more efficient memory usage. \todo[inline]{Remove Scenario choice}
 \item {\tt DayCounter:} Day count convention used to translate dates to times. Optional, defaults to ActualActual ISDA.
-\item {\tt Sequence:} Choose random sequence generator ({\em MersenneTwister, MersenneTwisterAntithetic, Sobol,
-SobolBrownianBridge}).
+\item {\tt Sequence:} Choose random sequence generator ({\em MersenneTwister, MersenneTwisterAntithetic,
+  Sobol,Burley2020Sobol, SobolBrownianBridge, Burley2020SobolBrownianBridge}).
 \item {\tt Seed:} Random number generator seed
 \item {\tt Samples:} Number of Monte Carlo paths to be produced
 %\item {\tt Fixings: } Choose whether fixings should be simulated or not, and if so which fixing simulation method to
 use ({\em Backward, Forward, BestOfForwardBackward, InterpolatedForwardBackward}), which number of forward horizon days
 to use if one of the {\em Forward } related methods is chosen.
-\item {\tt Ordering:} If the sequence type {\em SobolBrownianBridge} is used, ordering of variates ({\em Factors, Steps,
-    Diagonal})
-\item {\tt DirectionIntegers:} If the sequence type {\em SobolBrownianBridge} or {\em Sobol} is used, type of direction
-  integers in Sobol generator ({\em Unit, Jaeckel, SobolLevitan, SobolLevitanLemieux, JoeKuoD5, JoeKuoD6, JoeKuoD7, Kuo,
-    Kuo2, Kuo3})
+\item {\tt Ordering:} If the sequence type {\em SobolBrownianBridge} or {\em Burley2020SobolBrownianBridge} is used,
+  ordering of variates ({\em Factors, Steps, Diagonal})
+\item {\tt DirectionIntegers:} If the sequence type {\em SobolBrownianBridge}, {\em Burley2020SobolBrownianBridge}, {\em
+  Sobol} or {\em Burley2020Sobol} is used, type of direction integers in Sobol generator ({\em Unit, Jaeckel,
+  SobolLevitan, SobolLevitanLemieux, JoeKuoD5, JoeKuoD6, JoeKuoD7, Kuo, Kuo2, Kuo3})
 \item {\tt CloseOutLag}: If this tag is present, this specifies the close-out period length (e.g. 2W) used; otherwise no close-out grid is built. The close-out grid is an auxiliary time grid that is offset from the main default date grid by the close-out period, typically set to the applicable margin period of risk. If present, it is used to evolve the portfolio value and determine close-out values associated with the preceding default date valuation.
 \item {\tt MporMode}: This tag is expected if the previous one is present, permissible values are then {\tt StickyDate} and {\tt ActualDate}. {\tt StickyDate} means that only market data is evolved from the default date to close-out date for close-out date valuation, the valuation as of date remains unchanged and trades do not ``age'' over the period. As a consequence, exposure evolutions will not show spikes caused by cash flows within the close-out period. {\tt ActualDate} means that trades will also age over the close-out period so that one can experience exposure evolution spikes due to cash flows. 
 \end{itemize}
@@ -797,4 +797,4 @@
 \label{lst:simulation_market_configuration}
 \end{longlisting}
 
-\todo[inline]{Comment on cap/floor surface structure and reaction to time decay}
+\todo[inline]{Comment on cap/floor surface structure and reaction to time decay}

Docs/UserGuide/tradecomponents/legdatanotionals.tex

@@ -210,7 +210,7 @@ \subsubsection{Leg Data and Notionals}
   outlined in section \ref{ss:cashflowlegdata}.
 \item CMSLegData: This trade component sub-node is required if \lstinline!LegType! is set to \emph{CMS} (Constant Maturity Swap). It is
   outlined in section \ref{ss:cmslegdata}.
-%\item CMBLegData: This trade component sub-node is required if \lstinline!LegType! is set to \emph{CMB} (Constant Maturity Bond). It is
+% \item CMBLegData: This trade component sub-node is required if \lstinline!LegType! is set to \emph{CMB} (Constant Maturity Bond). It is
 %  outlined in section \ref{ss:cmblegdata}.   
 \item DigitalCMSLegData: This trade component sub-node is required if \lstinline!LegType! is set to \emph{DigitalCMS}. It is
   outlined in section \ref{ss:digitalcmslegdata}.
@@ -228,8 +228,10 @@ \subsubsection{Leg Data and Notionals}
   outlined in section \ref{ss:yylegdata}.
 \item ZeroCouponFixedLegData: This trade component sub-node is required if \lstinline!LegType! is set to \emph{ZeroCouponFixed}. It is
   outlined in section \ref{ss:zerolegdata}.
-%  \item CommodityFloatingLegData: This trade component sub-node is required if \lstinline!LegType! is set to \emph{CommodityFloating} It is
-%outlined in section \ref{ss:commodity_floating_leg_data}.
-%\item CommodityFixedLegData: This trade component sub-node is required if \lstinline!LegType! is set to \emph{CommodityFixed} It is outlined in section \ref{ss:commodity_fixed_leg_data}.
-%\item EquityMarginLegData: This trade component sub-node is required if \lstinline!LegType! is set to \emph{EquityMargin} It is outlined in section \ref{ss:equity_margin_leg_data}.  
+ %  \item FormulaBasedLegData: This trade component sub-node is required if \lstinline!LegType! is set to \emph{FormulaBased}. It is
+ % outlined in section \ref{ss:formulalegdata}.
+ % \item CommodityFloatingLegData: This trade component sub-node is required if \lstinline!LegType! is set to \emph{CommodityFloating} It is
+% outlined in section \ref{ss:commodity_floating_leg_data}.
+% \item CommodityFixedLegData: This trade component sub-node is required if \lstinline!LegType! is set to \emph{CommodityFixed} It is outlined in section \ref{ss:commodity_fixed_leg_data}.
+% \item EquityMarginLegData: This trade component sub-node is required if \lstinline!LegType! is set to \emph{EquityMargin} It is outlined in section \ref{ss:equity_margin_leg_data}.  
 \end{itemize}

Docs/UserGuide/tradedata/convertiblebond.tex

@@ -2,8 +2,23 @@ \subsubsection{Convertible Bond}
 \label{ss:convertible_bond}
 
 A convertible bond is set up using a {\tt ConvertibleBondData} block as shown in listing
-\ref{lst:convertiblebonddata1}. The bond details are read from reference data in this case. The meanings and allowable
-values of the elements in the block are as follows:
+\ref{lst:convertiblebonddata1}. The bond details are read from reference data in this case. 
+
+A convertible bond is a bond, that can be converted into a prespecified number of shares, given by:
+$$
+NumberOfShares = \frac{BondNotional}{ConversionRatio}
+$$
+
+Where the Conversion Ratio is specified in the underlying bond reference data.
+
+The shares are usually from the bond issuer, but it is also possible that the shares arefrom a different issuer (exchangeables). In addition, the share currency can be differentfrom the bond currency in both cases (cross-currency convertibles).
+
+
+The bond might be callable by the issuer (typically in American style) and / or puttableby the investor (typically in Bermudan style). The issuer calls can be “hard calls”,which are call rights in the traditional sense, as opposed to “soft calls” which can onlythe exercised if the equity price observed on the exercise date is above a prespecifiedthreshold given by TriggerRatios. If a soft call is exercised, the investor has the right to convert the bond intoshares instead of accepting the payment from the issuer call (“forced conversion”).
+
+
+The meanings and allowable
+values of the elements in the {\tt ConvertibleBondData} block are as follows:
 
 \begin{itemize}
   \item SecurityId: The underlying security identifier\\
@@ -124,8 +139,21 @@ \subsubsection{Convertible Bond}
   Allowable values: true, false
 
 \item TriggerRatios: A list of trigger ratios $T$ for soft calls. A soft call can be executed only if the equity price
-  on the exercise date is above the conversion price times the trigger ratio, i.e. $S_t > C^P_tT$. Only applicable to
+  on the exercise date is above the Conversion Price (defined below) times the trigger ratio, i.e. $S_t > C^P_tT$. Only applicable to
   Calls, not to Puts. Required for soft calls, can be omitted otherwise.\\
+  
+$$
+Conversion Price, C^P_t = \frac{1}{ConversionRatio}
+$$
+  
+For cross-currency trades the conversion price is usually quoted in equity ccy, i.e.  
+  
+$$
+Conversion Price, C^P_t = \frac{1}{ConversionRatio \cdot X_t}
+$$  
+  
+where $X_t$ converts one equity ccy unit to bond ccy  
+  
   Allowable values: Any positive real number.
 
 \item NofMTriggers: A list of n-of-m trigger specifications for calls, i.e. the soft-call trigger defined by

Docs/UserGuide/tradedata/equitycliquetoption.tex

@@ -40,8 +40,8 @@ \subsubsection{Equity Cliquet Option}
     <OptionType>Call</OptionType>
     <Moneyness>1.0</Moneyness>
     <LocalCap>0.07</LocalCap>
-    <LocalFloor></LocalFloor>
-    <GlobalCap></GlobalCap>
+    <LocalFloor>-0.06</LocalFloor>
+    <GlobalCap>0.07</GlobalCap>
     <GlobalFloor>-0.07</GlobalFloor>
     <ScheduleData>
         <Dates>
@@ -84,13 +84,13 @@ \subsubsection{Equity Cliquet Option}
 	\item Moneyness: Adjustment of option return. The moneyness M each forward starting option is being struck at.\\
 	Allowable values: Any real number. Expressed in decimal form where 1.0 is at-the-money, 1.1 is 110\% of the at-the-money strike, 0.9  is 90\% of the at-the-money strike, etc.
 	\item LocalCap[Optional]: The local cap, $cap_{l}$, in each of the option return. \\
-	Allowable values: Any real number. If left blank or omitted, no local cap is applied.
+	Allowable values: Any real number. If omitted, no local cap is applied. Can't be left blank.
 	\item LocalFloor[Optional]: The local floor, $floor_{l}$, in each of the option return. \\
-	Allowable values: Any real number. If left blank or omitted, no local floor is applied.
+	Allowable values: Any real number. If omitted, no local floor is applied.  Can't be left blank.
 	\item GlobalCap[Optional]: The global cap, $cap_{g}$, for the option return. \\
-	Allowable values: Any real number. If left blank or omitted, no global cap is applied.
+	Allowable values: Any real number. If omitted, no global cap is applied.  Can't be left blank.
 	\item GlobalFloor[Optional]: The global floor,$floor_{g}$, for the option return. \\
-	Allowable values: Any real number. If left blank or omitted, no global floor is applied.
+	Allowable values: Any real number. If omitted, no global floor is applied.  Can't be left blank.
 	\item ScheduleData: A schedule of dates that define the valuation dates of the consecutive forward starting options forming the Equity Cliquet Option. The first date in the schedule is the start date of the first consecutive option, the second date in the schedule is the end/valuation date of the first consecutive option, and also the start date of the second consecutive option, etc.  The last date is the final valuation date, with payoff of the whole Cliquet option at this date plus \lstinline!SettlementDays!. \\
 	 Allowable values: A node on the same form as \lstinline!ScheduleData!, (see \ref{ss:schedule_data}). 
 	\item SettlementDays[Optional]: Number of days from the last valuation date to the payoff being paid or received. The payoff date is determined with regards to calendar and

Docs/UserGuide/userguide.tex

@@ -2851,7 +2851,8 @@ \subsubsection*{Pricing Engine Configuration}
 
 \begin{enumerate}
 \item \verb+Training.Sequence+: The sequence type for the traning phase, can be \verb+MersenneTwister+,
-  \verb+MersenneTwisterAntithetc+, \verb+Sobol+ or \verb+SobolBrownianBridge+
+  \verb+MersenneTwisterAntithetc+, \verb+Sobol+, \verb+Burley2020Sobol+, \verb+SobolBrownianBridge+,
+  \verb+Burley2020SobolBrownianBridge+
 \item \verb+Training.Seed+: The seed for the random number generation in the training phase
 \item \verb+Training.Samples+: The number of samples to be used for the training phase
 \item \verb+Pricing.Sequence+: The sequence type for the pricing phase, same values allowed as for training
@@ -5131,17 +5132,17 @@ \subsubsection{Parameters}\label{sec:sim_params}
 % more efficient memory usage. \todo[inline]{Remove Scenario choice}
 \item {\tt DayCounter:} Day count convention used to translate dates to times. Optional, defaults to ActualActual ISDA.
 \item {\tt Sequence:} Choose random sequence generator ({\em MersenneTwister, MersenneTwisterAntithetic, Sobol,
-SobolBrownianBridge}).
+  Burley2020Sobol, SobolBrownianBridge, Burley2020SobolBrownianBridge}).
 \item {\tt Seed:} Random number generator seed
 \item {\tt Samples:} Number of Monte Carlo paths to be produced
 %\item {\tt Fixings: } Choose whether fixings should be simulated or not, and if so which fixing simulation method to
 use ({\em Backward, Forward, BestOfForwardBackward, InterpolatedForwardBackward}), which number of forward horizon days
 to use if one of the {\em Forward } related methods is chosen.
-\item {\tt Ordering:} If the sequence type {\em SobolBrownianBridge} is used, ordering of variates ({\em Factors, Steps,
-    Diagonal})
-\item {\tt DirectionIntegers:} If the sequence type {\em SobolBrownianBridge} or {\em Sobol} is used, type of direction
-  integers in Sobol generator ({\em Unit, Jaeckel, SobolLevitan, SobolLevitanLemieux, JoeKuoD5, JoeKuoD6, JoeKuoD7, Kuo,
-    Kuo2, Kuo3})
+\item {\tt Ordering:} If the sequence type {\em SobolBrownianBridge} or {\em Burley2020SobolBrownianBridge} is used,
+  ordering of variates ({\em Factors, Steps, Diagonal})
+\item {\tt DirectionIntegers:} If the sequence type {\em SobolBrownianBridge}, {\em Burley2020SobolBrownianBridge}, {\em
+  Sobol} or {\em Burley2020Sobol} is used, type of direction integers in Sobol generator ({\em Unit, Jaeckel,
+  SobolLevitan, SobolLevitanLemieux, JoeKuoD5, JoeKuoD6, JoeKuoD7, Kuo, Kuo2, Kuo3})
 \item {\tt CloseOutLag}: If this tag is present, this specifies the close-out period length (e.g. 2W) used; otherwise no close-out grid is built. The close-out grid is an auxiliary time grid that is offset from the main default date grid by the close-out period, typically set to the applicable margin period of risk. If present, it is used to evolve the portfolio value and determine close-out values associated with the preceding default date valuation.
 \item {\tt MporMode}: This tag is expected if the previous one is present, permissible values are then {\tt StickyDate} and {\tt ActualDate}. {\tt StickyDate} means that only market data is evolved from the default date to close-out date for close-out date valuation, the valuation as of date remains unchanged and trades do not ``age'' over the period. As a consequence, exposure evolutions will not show spikes caused by cash flows within the close-out period. {\tt ActualDate} means that trades will also age over the close-out period so that one can experience exposure evolution spikes due to cash flows. 
 \end{itemize}

OREData/ored/portfolio/basketvarianceswap.cpp

@@ -228,8 +228,12 @@ XMLNode* BasketVarianceSwap::toXML(XMLDocument& doc) {
     XMLUtils::appendNode(tradeNode, valuationSchedule);
 
     XMLUtils::addChild(doc, tradeNode, "SettlementDate", settlementDate_);
-    XMLUtils::addChild(doc, tradeNode, "Cap", cap_);
-    XMLUtils::addChild(doc, tradeNode, "Floor", floor_);
+    if (!cap_.empty()) {
+        XMLUtils::addChild(doc, tradeNode, "Cap", cap_);
+    }
+    if (!floor_.empty()) {
+        XMLUtils::addChild(doc, tradeNode, "Floor", floor_);
+    }
     XMLUtils::addChild(doc, tradeNode, "SquaredPayoff", squaredPayoff_);
 
     return node;

OREData/ored/portfolio/tarf.cpp

@@ -121,8 +121,8 @@ using namespace QuantExt;
         "  d = DATEINDEX(FixingAndSimDates[a], FixingDates, GT);\n"
         "  IF s > 0 THEN\n"
         "    IF d > 1 THEN\n"
-        // including Hits[d-1] in the regression is not stable
-        "      _AMC_NPV[s] = LongShort * NPVMEM( bwdPayoff, _AMC_SimDates[s], a, 1 == 1, AccProfit[d-1]);\n"
+        // including Hits[d-1] or AccProfit[d-1] in the regression is not stable
+        "      _AMC_NPV[s] = LongShort * NPVMEM( bwdPayoff, _AMC_SimDates[s], a);\n"
         "    ELSE\n"
         "      _AMC_NPV[s] = LongShort * NPVMEM( bwdPayoff, _AMC_SimDates[s], a);\n"
         "    END;\n"
@@ -229,7 +229,7 @@ using namespace QuantExt;
         "  d = DATEINDEX(FixingAndSimDates[a], FixingDates, GT);\n"
         "  IF s > 0 THEN\n"
         "    IF d > 1 THEN\n"
-        "      _AMC_NPV[s] = LongShort * NPVMEM( bwdPayoff, _AMC_SimDates[s], a, 1 == 1, AccProfitPoints[d-1]);\n"
+        "      _AMC_NPV[s] = LongShort * NPVMEM( bwdPayoff, _AMC_SimDates[s], a);\n"
         "    ELSE\n"
         "      _AMC_NPV[s] = LongShort * NPVMEM( bwdPayoff, _AMC_SimDates[s], a);\n"
         "    END;\n"