QPR-12417 include cashflows only if specified in pe config

Author: pcaspers

Docs/ScriptedTrade/docs/language.tex

@@ -467,7 +467,7 @@
   numeraire
 \item $d\leq p$ must hold
 \item if $p$ lies on or before the evaluation date, the result is zero; $X$ is not evaluated in this case. 
-Note that $X$ is evaluated in the LOGPAY function though, see \ref{function_logpay}.
+Note that $X$ is evaluated in the LOGPAY function if past cashflows are included, see \ref{function_logpay}.
 \item avoids reading non-relevant past fixings from the index history
 \item if $d$ lies before (but $p$ after) the evaluation date, it is set to the evaluation date, i.e. the result is
   computed as of the evaluation date
@@ -515,9 +515,8 @@
 under leg number $2$ and flow Type ``Interest''. The same holds for Payoff3, but if any amounts were booked using the
 slot parameter $3$ previously they will be overwritten with the current amount.
 
-Note: Even if $p$ lies on or before the evaluation date, a cashflow entry will be generated. If one wants to explicitly
-avoid that, e.g. because past fixings are not available to evaluate the past paid amounts, it can be done with an IF
-construct comparing the pay date with TODAY.
+Note: If IncludePastCashflows in the pricing engine config is set to true then even if $p$ lies on or before the
+evaluation date, a cashflow entry will be generated.
 
 % ====================================================
 \stsubsection{Function {\tt NPV, NPVMEM}}\label{function_npv}

Docs/ScriptedTrade/docs/models.tex

@@ -49,6 +49,7 @@ \subsection{Pricing Engine Configuration}\label{pricingengine_config}
       <Parameter name="TimeStepsPerYear">24</Parameter>
       <Parameter name="Interactive">false</Parameter>
       <Parameter name="BootstrapTolerance">0.1</Parameter>
+      <Parameter name="IncludePastCashflows">true</Parameter>
       <!-- product specific parameters -->
       <Parameter name="RegressionOrder_SingleAssetOption(EQ)">6</Parameter>
       <Parameter name="RegressionOrder_SingleAssetOption(FX)">6</Parameter>
@@ -136,6 +137,8 @@ \subsection{Pricing Engine Configuration}\label{pricingengine_config}
   only. The moneyness is defined as a ``standardised moneyness'' $\ln(K/F) / \sigma\sqrt{t}$ with $K$ strike, $F$ ATMF
   forward, $\sigma$ ATMF market vol, $t$ option time to expiry
 \item BootstrapTolerance: tolerance for calibration bootstrap, only applies to model = GaussianCam
+\item IncludePastCashflows: if true, LOGPAY() will generate cashflow information for pay dates on or before the
+  reference date. Optional, defaults to false.
 \item Interactive: If true an interactive session is started on script execution for debugging purposes; should be false
   except for debugging purposes
 \item UseAD: If true and RunType in the global pricing engine parameters is SensitivityDelta, a first order pnl

OREData/ored/portfolio/builders/scriptedtrade.cpp

@@ -320,7 +320,7 @@ ScriptedTradeEngineBuilder::engine(const std::string& id, const ScriptedTrade& s
         engine = boost::make_shared<ScriptedInstrumentPricingEngine>(
             script.npv(), script.results(), model_, ast_, context, script.code(), interactive_, amcCam_ != nullptr,
             std::set<std::string>(script.stickyCloseOutStates().begin(), script.stickyCloseOutStates().end()),
-            generateAdditionalResults);
+            generateAdditionalResults, includePastCashflows_);
     } else if (modelCG_) {
         auto rt = globalParameters_.find("RunType");
         bool useCachedSensis = useAd_ && (rt != globalParameters_.end() && rt->second == "SensitivityDelta");
@@ -485,6 +485,7 @@ void ScriptedTradeEngineBuilder::populateModelParameters() {
     useExternalComputeDevice_ =
         parseBool(engineParameter("UseExternalComputeDevice", {resolvedProductTag_}, false, "false"));
     externalComputeDevice_ = engineParameter("ExternalComputeDevice", {}, false, "");
+    includePastCashflows_ = parseBool(engineParameter("IncludePastCashflows", {resolvedProductTag_}, false, "false"));
 
     // usage of ad or an external device implies usage of cg
     if (useAd_ || useExternalComputeDevice_)

OREData/ored/portfolio/builders/scriptedtrade.hpp

@@ -161,6 +161,7 @@ class ScriptedTradeEngineBuilder : public EngineBuilder {
     bool useAd_;
     bool useExternalComputeDevice_;
     std::string externalComputeDevice_;
+    bool includePastCashflows_;
 };
 
 } // namespace data

OREData/ored/scripting/computationgraphbuilder.cpp

@@ -119,12 +119,12 @@ class ASTRunner : public AcyclicVisitor,
                   public Visitor<LoopNode> {
 public:
     ASTRunner(ComputationGraph& g, const std::vector<std::string>& opLabels, const boost::shared_ptr<ModelCG> model,
-              const bool generatePayLog, const std::string& script, bool& interactive, Context& context,
-              ASTNode*& lastVisitedNode, std::set<std::size_t>& keepNodes,
+              const bool generatePayLog, const bool includePastCashflows, const std::string& script, bool& interactive,
+              Context& context, ASTNode*& lastVisitedNode, std::set<std::size_t>& keepNodes,
               std::vector<ComputationGraphBuilder::PayLogEntry>& payLogEntries)
         : g_(g), opLabels_(opLabels), model_(model), size_(model ? model->size() : 1), generatePayLog_(generatePayLog),
-          script_(script), interactive_(interactive), keepNodes_(keepNodes), payLogEntries_(payLogEntries),
-          context_(context), lastVisitedNode_(lastVisitedNode) {
+          includePastCashflows_(includePastCashflows), script_(script), interactive_(interactive),
+          keepNodes_(keepNodes), payLogEntries_(payLogEntries), context_(context), lastVisitedNode_(lastVisitedNode) {
         filter.emplace(size_, true);
         value.push(RandomVariable());
         filter_node.push(ComputationGraph::nan);
@@ -1029,7 +1029,7 @@ class ASTRunner : public AcyclicVisitor,
         QL_REQUIRE(model_, "model is null");
         // handle case of past payments: do not evaluate the other parameters, since not needed (e.g. past fixings)
         Date pay = boost::get<EventVec>(paydate).value;
-        if (pay <= model_->referenceDate() && !log) {
+        if (pay <= model_->referenceDate() && (!log || !includePastCashflows_)) {
             value.push(RandomVariable(size_, 0.0));
             std::size_t node = cg_const(g_, 0.0);
             value_node.push(node);
@@ -1465,6 +1465,7 @@ class ASTRunner : public AcyclicVisitor,
     const boost::shared_ptr<ModelCG> model_;
     const Size size_;
     const bool generatePayLog_;
+    const bool includePastCashflows_;
     const std::string script_;
     bool& interactive_;
     std::set<std::size_t>& keepNodes_;
@@ -1481,14 +1482,15 @@ class ASTRunner : public AcyclicVisitor,
 
 } // namespace
 
-void ComputationGraphBuilder::run(const bool generatePayLog, const std::string& script, bool interactive) {
+void ComputationGraphBuilder::run(const bool generatePayLog, const bool includePastCashflows, const std::string& script,
+                                  bool interactive) {
 
     keepNodes_.clear();
     payLogEntries_.clear();
 
     ASTNode* loc;
-    ASTRunner runner(g_, opLabels_, model_, generatePayLog, script, interactive, *context_, loc, keepNodes_,
-                     payLogEntries_);
+    ASTRunner runner(g_, opLabels_, model_, generatePayLog, generatePayLog && includePastCashflows, script, interactive,
+                     *context_, loc, keepNodes_, payLogEntries_);
 
     randomvariable_output_pattern pattern;
     if (model_ == nullptr || model_->type() == ModelCG::Type::MC) {

OREData/ored/scripting/computationgraphbuilder.hpp

@@ -49,7 +49,8 @@ class ComputationGraphBuilder {
     ComputationGraphBuilder(ComputationGraph& g, const std::vector<std::string>& opLabels, const ASTNodePtr root,
                             const boost::shared_ptr<Context> context, const boost::shared_ptr<ModelCG> model = nullptr)
         : g_(g), opLabels_(opLabels), root_(root), context_(context), model_(model) {}
-    void run(const bool generatePayLog, const std::string& script = "", bool interactive = false);
+    void run(const bool generatePayLog, const bool includePastCashflows = false, const std::string& script = "",
+             bool interactive = false);
     const std::set<std::size_t>& keepNodes() const { return keepNodes_; }
     const std::vector<PayLogEntry>& payLogEntries() const { return payLogEntries_; }
 

OREData/ored/scripting/engines/scriptedinstrumentpricingengine.cpp

@@ -112,7 +112,7 @@ void ScriptedInstrumentPricingEngine::calculate() const {
     if (generateAdditionalResults_)
         paylog = boost::make_shared<PayLog>();
 
-    engine.run(script_, interactive_, paylog);
+    engine.run(script_, interactive_, paylog, includePastCashflows_);
 
     // extract npv result and set it
 

OREData/ored/scripting/engines/scriptedinstrumentpricingengine.hpp

@@ -34,15 +34,18 @@ namespace data {
 
 class ScriptedInstrumentPricingEngine : public QuantExt::ScriptedInstrument::engine {
 public:
-    ScriptedInstrumentPricingEngine(
-        const std::string& npv, const std::vector<std::pair<std::string, std::string>>& additionalResults,
-        const boost::shared_ptr<Model>& model, const ASTNodePtr ast, const boost::shared_ptr<Context>& context,
-        const std::string& script = "", const bool interactive = false,
-        const bool amcEnabled = false,
-        const std::set<std::string>& amcStickyCloseOutStates = {}, const bool generateAdditionalResults = false)
+    ScriptedInstrumentPricingEngine(const std::string& npv,
+                                    const std::vector<std::pair<std::string, std::string>>& additionalResults,
+                                    const boost::shared_ptr<Model>& model, const ASTNodePtr ast,
+                                    const boost::shared_ptr<Context>& context, const std::string& script = "",
+                                    const bool interactive = false, const bool amcEnabled = false,
+                                    const std::set<std::string>& amcStickyCloseOutStates = {},
+                                    const bool generateAdditionalResults = false,
+                                    const bool includePastCashflows = false)
         : npv_(npv), additionalResults_(additionalResults), model_(model), ast_(ast), context_(context),
           script_(script), interactive_(interactive), amcEnabled_(amcEnabled),
-          amcStickyCloseOutStates_(amcStickyCloseOutStates), generateAdditionalResults_(generateAdditionalResults) {
+          amcStickyCloseOutStates_(amcStickyCloseOutStates), generateAdditionalResults_(generateAdditionalResults),
+          includePastCashflows_(includePastCashflows) {
         registerWith(model_);
     }
 
@@ -65,6 +68,7 @@ class ScriptedInstrumentPricingEngine : public QuantExt::ScriptedInstrument::eng
     const bool amcEnabled_;
     const std::set<std::string> amcStickyCloseOutStates_;
     const bool generateAdditionalResults_;
+    const bool includePastCashflows_;
 };
 
 } // namespace data

OREData/ored/scripting/engines/scriptedinstrumentpricingenginecg.cpp

@@ -68,11 +68,12 @@ ScriptedInstrumentPricingEngineCG::ScriptedInstrumentPricingEngineCG(
     const std::string& npv, const std::vector<std::pair<std::string, std::string>>& additionalResults,
     const boost::shared_ptr<ModelCG>& model, const ASTNodePtr ast, const boost::shared_ptr<Context>& context,
     const Model::McParams& mcParams, const std::string& script, const bool interactive,
-    const bool generateAdditionalResults, const bool useCachedSensis, const bool useExternalComputeFramework)
+    const bool generateAdditionalResults, const bool includePastCashflows, const bool useCachedSensis,
+    const bool useExternalComputeFramework)
     : npv_(npv), additionalResults_(additionalResults), model_(model), ast_(ast), context_(context),
       mcParams_(mcParams), script_(script), interactive_(interactive),
-      generateAdditionalResults_(generateAdditionalResults), useCachedSensis_(useCachedSensis),
-      useExternalComputeFramework_(useExternalComputeFramework) {
+      generateAdditionalResults_(generateAdditionalResults), includePastCashflows_(includePastCashflows),
+      useCachedSensis_(useCachedSensis), useExternalComputeFramework_(useExternalComputeFramework) {
 
     // register with model
 
@@ -138,7 +139,7 @@ void ScriptedInstrumentPricingEngineCG::buildComputationGraph() const {
         // build graph
 
         ComputationGraphBuilder cgBuilder(*g, getRandomVariableOpLabels(), ast_, workingContext_, model_);
-        cgBuilder.run(generateAdditionalResults_, script_, interactive_);
+        cgBuilder.run(generateAdditionalResults_, includePastCashflows_, script_, interactive_);
         cgVersion_ = model_->cgVersion();
         DLOG("Built computation graph version " << cgVersion_ << " size is " << g->size());
         TLOGGERSTREAM(ssaForm(*g, getRandomVariableOpLabels()));

OREData/ored/scripting/engines/scriptedinstrumentpricingenginecg.hpp

@@ -44,7 +44,8 @@ class ScriptedInstrumentPricingEngineCG : public QuantExt::ScriptedInstrument::e
                                       const boost::shared_ptr<ModelCG>& model, const ASTNodePtr ast,
                                       const boost::shared_ptr<Context>& context, const Model::McParams& mcParams,
                                       const std::string& script = "", const bool interactive = false,
-                                      const bool generateAdditionalResults = false, const bool useCachedSensis = false,
+                                      const bool generateAdditionalResults = false,
+                                      const bool includePastCashflows = false, const bool useCachedSensis = false,
                                       const bool useExternalComputeFramework = false);
 
     bool lastCalculationWasValid() const { return lastCalculationWasValid_; }
@@ -106,6 +107,7 @@ class ScriptedInstrumentPricingEngineCG : public QuantExt::ScriptedInstrument::e
     const std::string script_;
     const bool interactive_;
     const bool generateAdditionalResults_;
+    const bool includePastCashflows_;
     const bool useCachedSensis_;
     const bool useExternalComputeFramework_;
 };