ExecutionInitializer.java

  1. package org.drip.function.r1tor1solver;

  2. /*
  3.  * -*- mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  4.  */

  5. /*!
  6.  * Copyright (C) 2020 Lakshmi Krishnamurthy
  7.  * Copyright (C) 2019 Lakshmi Krishnamurthy
  8.  * Copyright (C) 2018 Lakshmi Krishnamurthy
  9.  * Copyright (C) 2017 Lakshmi Krishnamurthy
  10.  * Copyright (C) 2016 Lakshmi Krishnamurthy
  11.  * Copyright (C) 2015 Lakshmi Krishnamurthy
  12.  * Copyright (C) 2014 Lakshmi Krishnamurthy
  13.  * Copyright (C) 2013 Lakshmi Krishnamurthy
  14.  * Copyright (C) 2012 Lakshmi Krishnamurthy
  15.  *
  16.  *  This file is part of DROP, an open-source library targeting analytics/risk, transaction cost analytics,
  17.  *      asset liability management analytics, capital, exposure, and margin analytics, valuation adjustment
  18.  *      analytics, and portfolio construction analytics within and across fixed income, credit, commodity,
  19.  *      equity, FX, and structured products. It also includes auxiliary libraries for algorithm support,
  20.  *      numerical analysis, numerical optimization, spline builder, model validation, statistical learning,
  21.  *      and computational support.
  22.  *  
  23.  *      https://lakshmidrip.github.io/DROP/
  24.  *  
  25.  *  DROP is composed of three modules:
  26.  *  
  27.  *  - DROP Product Core - https://lakshmidrip.github.io/DROP-Product-Core/
  28.  *  - DROP Portfolio Core - https://lakshmidrip.github.io/DROP-Portfolio-Core/
  29.  *  - DROP Computational Core - https://lakshmidrip.github.io/DROP-Computational-Core/
  30.  *
  31.  *  DROP Product Core implements libraries for the following:
  32.  *  - Fixed Income Analytics
  33.  *  - Loan Analytics
  34.  *  - Transaction Cost Analytics
  35.  *
  36.  *  DROP Portfolio Core implements libraries for the following:
  37.  *  - Asset Allocation Analytics
  38.  *  - Asset Liability Management Analytics
  39.  *  - Capital Estimation Analytics
  40.  *  - Exposure Analytics
  41.  *  - Margin Analytics
  42.  *  - XVA Analytics
  43.  *
  44.  *  DROP Computational Core implements libraries for the following:
  45.  *  - Algorithm Support
  46.  *  - Computation Support
  47.  *  - Function Analysis
  48.  *  - Model Validation
  49.  *  - Numerical Analysis
  50.  *  - Numerical Optimizer
  51.  *  - Spline Builder
  52.  *  - Statistical Learning
  53.  *
  54.  *  Documentation for DROP is Spread Over:
  55.  *
  56.  *  - Main                     => https://lakshmidrip.github.io/DROP/
  57.  *  - Wiki                     => https://github.com/lakshmiDRIP/DROP/wiki
  58.  *  - GitHub                   => https://github.com/lakshmiDRIP/DROP
  59.  *  - Repo Layout Taxonomy     => https://github.com/lakshmiDRIP/DROP/blob/master/Taxonomy.md
  60.  *  - Javadoc                  => https://lakshmidrip.github.io/DROP/Javadoc/index.html
  61.  *  - Technical Specifications => https://github.com/lakshmiDRIP/DROP/tree/master/Docs/Internal
  62.  *  - Release Versions         => https://lakshmidrip.github.io/DROP/version.html
  63.  *  - Community Credits        => https://lakshmidrip.github.io/DROP/credits.html
  64.  *  - Issues Catalog           => https://github.com/lakshmiDRIP/DROP/issues
  65.  *  - JUnit                    => https://lakshmidrip.github.io/DROP/junit/index.html
  66.  *  - Jacoco                   => https://lakshmidrip.github.io/DROP/jacoco/index.html
  67.  *
  68.  *  Licensed under the Apache License, Version 2.0 (the "License");
  69.  *      you may not use this file except in compliance with the License.
  70.  *  
  71.  *  You may obtain a copy of the License at
  72.  *      http://www.apache.org/licenses/LICENSE-2.0
  73.  *  
  74.  *  Unless required by applicable law or agreed to in writing, software
  75.  *      distributed under the License is distributed on an "AS IS" BASIS,
  76.  *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  77.  *  
  78.  *  See the License for the specific language governing permissions and
  79.  *      limitations under the License.
  80.  */

  81. /**
  82.  * <i>ExecutionInitializer</i> implements the initialization execution and customization functionality.
  83.  * <br><br>
  84.  * ExecutionInitializer performs two types of variate initialization:
  85.  * <br>
  86.  * <ul>
  87.  *  <li>
  88.  *      Bracketing initialization: This brackets the fixed point using the bracketing algorithm described in
  89.  *          https://lakshmidrip.github.io/DROP-Numerical-Core/. If successful, a pair of variate/OF
  90.  *          coordinate nodes that bracket the fixed point are generated. These brackets are eventually used
  91.  *          by routines that iteratively determine the fixed point. Bracketing initialization is controlled
  92.  *          by the parameters in BracketingControlParams.
  93.  *  </li>
  94.  *  <li>
  95.  *      Convergence Zone initialization: This generates a variate that lies within the convergence zone for
  96.  *          the iterative determination of the fixed point using the Newton's method. Convergence Zone
  97.  *          Determination is controlled by the parameters in ConvergenceControlParams.
  98.  *  </li>
  99.  * </ul>
  100.  *
  101.  * ExecutionInitializer behavior can be customized/optimized through several of the initialization heuristics
  102.  *  techniques implemented in the InitializationHeuristics class.
  103.  *
  104.  *  <br><br>
  105.  *  <ul>
  106.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  107.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/NumericalAnalysisLibrary.md">Numerical Analysis Library</a></li>
  108.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/function/README.md">R<sup>d</sup> To R<sup>d</sup> Function Analysis</a></li>
  109.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/function/r1tor1solver/README.md">Built-in R<sup>1</sup> To R<sup>1</sup> Solvers</a></li>
  110.  *  </ul>
  111.  *
  112.  * @author Lakshmi Krishnamurthy
  113.  */

  114. public class ExecutionInitializer {

  115.     class StartingVariateOF {
  116.         public double _dblOF = java.lang.Double.NaN;
  117.         public double _dblVariate = java.lang.Double.NaN;

  118.         public StartingVariateOF (
  119.             final double dblVariate,
  120.             final double dblOF)
  121.             throws java.lang.Exception
  122.         {
  123.             if (!org.drip.numerical.common.NumberUtil.IsValid (_dblOF = dblOF) ||
  124.                 !org.drip.numerical.common.NumberUtil.IsValid (_dblVariate = dblVariate))
  125.                 throw new java.lang.Exception ("StartingVariateOF constructor: Invalid inputs!");
  126.         }
  127.     }

  128.     private boolean _bTrendBracketRight = false;
  129.     private org.drip.function.definition.R1ToR1 _of = null;
  130.     private org.drip.function.r1tor1solver.ConvergenceControlParams _ccp = null;

  131.     private java.util.SortedMap<java.lang.Double, java.lang.Double> _mapOFMap = new
  132.         java.util.TreeMap<java.lang.Double, java.lang.Double>();

  133.     private double evaluateOF (
  134.         final double dblVariate)
  135.         throws java.lang.Exception
  136.     {
  137.         if (_mapOFMap.containsKey (dblVariate)) return _mapOFMap.get (dblVariate);

  138.         double dblOF = _of.evaluate (dblVariate);

  139.         if (org.drip.numerical.common.NumberUtil.IsValid (dblOF)) _mapOFMap.put (dblVariate, dblOF);

  140.         return dblOF;
  141.     }

  142.     private StartingVariateOF validateVariate (
  143.         final double dblVariate,
  144.         final org.drip.function.r1tor1solver.BracketingOutput bop)
  145.     {
  146.         double dblOF = java.lang.Double.NaN;

  147.         try {
  148.             dblOF = evaluateOF (dblVariate);
  149.         } catch (java.lang.Exception e) {
  150.             dblOF = java.lang.Double.NaN;
  151.         }

  152.         if (!bop.incrOFCalcs() || !org.drip.numerical.common.NumberUtil.IsValid (dblOF)) return null;

  153.         _mapOFMap.put (dblVariate, dblOF);

  154.         try {
  155.             return new StartingVariateOF (dblVariate, dblOF);
  156.         } catch (java.lang.Exception e) {
  157.             e.printStackTrace();
  158.         }

  159.         return null;
  160.     }

  161.     private StartingVariateOF initializeBracketingVariate (
  162.         final int iNumExpansions,
  163.         final double dblBracketVariateStart,
  164.         final double dblBracketWidthStart,
  165.         final double dblBracketWidthExpansionFactor,
  166.         final org.drip.function.r1tor1solver.BracketingOutput bop)
  167.     {
  168.         StartingVariateOF sv = validateVariate (dblBracketVariateStart, bop);

  169.         if (null != sv) return sv;

  170.         double dblVariate = dblBracketVariateStart;
  171.         int iNumExpansionsCurrent = iNumExpansions;
  172.         double dblBracketWidth = dblBracketWidthStart;
  173.         double dblBracketLeft = dblVariate - dblBracketWidth;
  174.         double dblBracketRight = dblVariate + dblBracketWidth;

  175.         while (0 <= iNumExpansionsCurrent--) {
  176.             if (_bTrendBracketRight) {
  177.                 if (null != (sv = validateVariate (dblBracketRight, bop))) return sv;

  178.                 if (null != (sv = validateVariate (dblBracketLeft, bop))) return sv;
  179.             } else {
  180.                 if (null != (sv = validateVariate (dblBracketLeft, bop))) return sv;

  181.                 if (null != (sv = validateVariate (dblBracketRight, bop))) return sv;
  182.             }

  183.             dblBracketWidth *= dblBracketWidthExpansionFactor;
  184.             dblBracketLeft = dblVariate - dblBracketWidth;
  185.             dblBracketRight = dblVariate + dblBracketWidth;
  186.         }

  187.         return null;
  188.     }

  189.     private boolean bracketingDone (
  190.         final double dblVariateLeft,
  191.         final double dblVariateRight,
  192.         final double dblOFLeft,
  193.         final double dblOFRight,
  194.         final double dblOFGoal,
  195.         final org.drip.function.r1tor1solver.BracketingOutput bop)
  196.     {
  197.         if (!org.drip.numerical.common.NumberUtil.IsValid (dblOFLeft) || !org.drip.numerical.common.NumberUtil.IsValid
  198.             (dblOFRight))
  199.             return false;

  200.         if (((dblOFLeft - dblOFGoal) * (dblOFRight - dblOFGoal)) > 0.) return false;

  201.         double dblOF = java.lang.Double.NaN;
  202.         double dblOFPrev = java.lang.Double.NaN;
  203.         double dblVariate = java.lang.Double.NaN;
  204.         double dblVariatePrev = java.lang.Double.NaN;

  205.         for (java.util.Map.Entry<java.lang.Double, java.lang.Double> me : _mapOFMap.entrySet()) {
  206.             dblVariate = me.getKey();

  207.             dblOF = me.getValue();

  208.             if (org.drip.numerical.common.NumberUtil.IsValid (dblVariatePrev) &&
  209.                 org.drip.numerical.common.NumberUtil.IsValid (dblOFPrev) && (((dblOF - dblOFGoal) * (dblOFPrev -
  210.                     dblOFGoal)) < 0.)) {
  211.                 try {
  212.                     bop.done (dblVariatePrev, dblVariate, dblOFPrev, dblOF,
  213.                         org.drip.function.r1tor1solver.VariateIteratorPrimitive.Bisection (dblVariatePrev,
  214.                             dblVariate));
  215.                 } catch (java.lang.Exception e) {
  216.                 }

  217.                 return true;
  218.             }

  219.             dblOFPrev = dblOF;
  220.             dblVariatePrev = dblVariate;
  221.         }

  222.         try {
  223.             bop.done (dblVariateLeft, dblVariateRight, dblOFLeft, dblOFRight,
  224.                 org.drip.function.r1tor1solver.VariateIteratorPrimitive.Bisection (dblVariateLeft, dblVariateRight));
  225.         } catch (java.lang.Exception e) {
  226.         }

  227.         return true;
  228.     }

  229.     private boolean isInConvergenceZone (
  230.         final double dblConvergenceZoneVariate,
  231.         final double dblOFGoal,
  232.         final org.drip.function.r1tor1solver.ConvergenceOutput cop)
  233.         throws java.lang.Exception
  234.     {
  235.         if (!cop.incrOFCalcs())
  236.             throw new java.lang.Exception
  237.                 ("ExecutionInitializer::isInConvergenceZone => Cannot increment OF in the output");

  238.         double dblOFValue = evaluateOF (dblConvergenceZoneVariate) - dblOFGoal;

  239.         if (!org.drip.numerical.common.NumberUtil.IsValid (dblOFValue))
  240.             throw new java.lang.Exception
  241.                 ("ExecutionInitializer::isInConvergenceZone => Cannot evaluate OF for variate " +
  242.                     dblConvergenceZoneVariate);

  243.         if (!cop.incrOFDerivCalcs())
  244.             throw new java.lang.Exception
  245.                 ("ExecutionInitializer::isInConvergenceZone => Cannot increment OF deriv count in the output");

  246.         org.drip.numerical.differentiation.Differential diff1D = _of.differential (dblConvergenceZoneVariate, 1);

  247.         if (null == diff1D)
  248.             throw new java.lang.Exception
  249.                 ("ExecutionInitializer::isInConvergenceZone => Cannot evaluate OF first deriv for variate " +
  250.                     dblConvergenceZoneVariate);

  251.         if (!cop.incrOFDerivCalcs() && !cop.incrOFDerivCalcs())
  252.             throw new java.lang.Exception
  253.                 ("ExecutionInitializer::isInConvergenceZone => Cannot increment OF deriv in the output");

  254.         org.drip.numerical.differentiation.Differential diff2D = _of.differential (dblConvergenceZoneVariate, 2);

  255.         if (null == diff2D)
  256.             throw new java.lang.Exception
  257.                 ("ExecutionInitializer::isInConvergenceZone => Cannot evaluate OF second deriv for variate "
  258.                     + dblConvergenceZoneVariate);

  259.         return java.lang.Math.abs (dblOFValue * diff2D.calcSlope (false)) < (diff1D.calcSlope (false) *
  260.             diff1D.calcSlope (false) * _ccp.getConvergenceZoneEdgeLimit());
  261.     }

  262.     private boolean leftOFValidityEdgeReached (
  263.         final double dblVariateLeft,
  264.         final double dblOFLeft,
  265.         final org.drip.function.r1tor1solver.InitializationHeuristics ih)
  266.     {
  267.         return !org.drip.numerical.common.NumberUtil.IsValid (dblOFLeft) || (null != ih &&
  268.             org.drip.numerical.common.NumberUtil.IsValid (ih.getBracketFloor()) && dblVariateLeft <
  269.                 ih.getBracketFloor());
  270.     }

  271.     private boolean rightOFValidityEdgeReached (
  272.         final double dblVariateRight,
  273.         final double dblOFRight,
  274.         final org.drip.function.r1tor1solver.InitializationHeuristics ih)
  275.     {
  276.         return !org.drip.numerical.common.NumberUtil.IsValid (dblOFRight) || (null != ih &&
  277.             org.drip.numerical.common.NumberUtil.IsValid (ih.getBracketCeiling()) && dblVariateRight >
  278.                 ih.getBracketCeiling());
  279.     }

  280.     private double getStartingBracketVariate (
  281.         final org.drip.function.r1tor1solver.BracketingControlParams bcp,
  282.         final org.drip.function.r1tor1solver.InitializationHeuristics ih)
  283.     {
  284.         if (null != ih && org.drip.numerical.common.NumberUtil.IsValid (ih.getStartingBracketMid()))
  285.             return ih.getStartingBracketMid();

  286.         if (null != ih && org.drip.numerical.common.NumberUtil.IsValid (ih.getStartingBracketLeft()) &&
  287.             org.drip.numerical.common.NumberUtil.IsValid (ih.getStartingBracketRight()))
  288.             return 0.5 * (ih.getStartingBracketLeft() + ih.getStartingBracketRight());

  289.         return bcp.getVariateStart();
  290.     }

  291.     private double getStartingBracketWidth (
  292.         final org.drip.function.r1tor1solver.BracketingControlParams bcp,
  293.         final org.drip.function.r1tor1solver.InitializationHeuristics ih)
  294.     {
  295.         if (null != ih) {
  296.             double dblBracketStartLeft = ih.getStartingBracketLeft();

  297.             double dblBracketStartRight = ih.getStartingBracketRight();

  298.             if (org.drip.numerical.common.NumberUtil.IsValid (dblBracketStartLeft) &&
  299.                 org.drip.numerical.common.NumberUtil.IsValid (dblBracketStartRight) && dblBracketStartRight >
  300.                     dblBracketStartLeft)
  301.                 return dblBracketStartRight - dblBracketStartLeft;
  302.         }

  303.         return bcp.getStartingBracketWidth();
  304.     }

  305.     /**
  306.      * ExecutionInitializer constructor
  307.      *
  308.      * @param of Objective Function
  309.      * @param ccp Convergence Control Parameters
  310.      * @param bTrendBracketRight TRUE - Start Right Trending in search of a Bracket Variate
  311.      *
  312.      * @throws java.lang.Exception Thrown if inputs are invalid
  313.      */

  314.     public ExecutionInitializer (
  315.         final org.drip.function.definition.R1ToR1 of,
  316.         final org.drip.function.r1tor1solver.ConvergenceControlParams ccp,
  317.         final boolean bTrendBracketRight)
  318.         throws java.lang.Exception
  319.     {
  320.         if (null == (_of = of))
  321.             throw new java.lang.Exception ("ExecutionInitializer constructor: Invalid inputs");

  322.         if (null == (_ccp = ccp)) _ccp = new org.drip.function.r1tor1solver.ConvergenceControlParams();

  323.         _bTrendBracketRight = bTrendBracketRight;
  324.     }

  325.     /**
  326.      * Set up the bracket to be used for the eventual search kick-off
  327.      *
  328.      * @param ih Optional InitializationHeuristics instance
  329.      * @param dblOFGoal The OF Goal
  330.      *
  331.      * @return The Bracketing Output
  332.      */

  333.     public org.drip.function.r1tor1solver.BracketingOutput initializeBracket (
  334.         final org.drip.function.r1tor1solver.InitializationHeuristics ih,
  335.         final double dblOFGoal)
  336.     {
  337.         org.drip.function.r1tor1solver.BracketingControlParams bcp = (null != ih && null != ih.getCustomBCP()) ?
  338.             ih.getCustomBCP() : new org.drip.function.r1tor1solver.BracketingControlParams();

  339.         int iNumExpansions = bcp.getNumExpansions();

  340.         org.drip.function.r1tor1solver.BracketingOutput bop = new
  341.             org.drip.function.r1tor1solver.BracketingOutput();

  342.         StartingVariateOF sv = initializeBracketingVariate (iNumExpansions, getStartingBracketVariate (bcp,
  343.             ih), getStartingBracketWidth (bcp, ih), bcp.getBracketWidthExpansionFactor(), bop);

  344.         if (null == sv) return bop;

  345.         double dblOFLeft = sv._dblOF;
  346.         double dblOFRight = sv._dblOF;
  347.         double dblPreviousOFLeft = sv._dblOF;
  348.         double dblPreviousOFRight = sv._dblOF;
  349.         double dblVariateLeft = sv._dblVariate;
  350.         double dblVariateRight = sv._dblVariate;
  351.         boolean bLeftOFValidityEdgeReached = false;
  352.         boolean bRightOFValidityEdgeReached = false;
  353.         double dblPreviousVariateLeft = sv._dblVariate;
  354.         double dblPreviousVariateRight = sv._dblVariate;

  355.         double dblBracketWidth = bcp.getStartingBracketWidth();

  356.         while (0 <= iNumExpansions--) {
  357.             if (!bop.incrIterations()) return null;

  358.             if (bLeftOFValidityEdgeReached && bRightOFValidityEdgeReached) return bop;

  359.             if (!bLeftOFValidityEdgeReached) {
  360.                 dblPreviousVariateLeft = dblVariateLeft;
  361.                 dblVariateLeft -= dblBracketWidth;
  362.                 dblPreviousOFLeft = dblOFLeft;

  363.                 try {
  364.                     if (bracketingDone (dblVariateLeft, dblVariateRight, dblOFLeft = evaluateOF
  365.                         (dblVariateLeft), dblOFRight, dblOFGoal, bop) && bop.incrOFCalcs())
  366.                         return bop;
  367.                 } catch (java.lang.Exception e) {
  368.                     dblOFLeft = java.lang.Double.NaN;
  369.                 }

  370.                 if (bLeftOFValidityEdgeReached = leftOFValidityEdgeReached (dblVariateLeft, dblOFLeft, ih)) {
  371.                     dblOFLeft = dblPreviousOFLeft;
  372.                     dblVariateLeft = dblPreviousVariateLeft;
  373.                 }
  374.             }

  375.             if (!bRightOFValidityEdgeReached) {
  376.                 dblPreviousVariateRight = dblVariateRight;
  377.                 dblVariateRight += dblBracketWidth;
  378.                 dblPreviousOFRight = dblOFRight;

  379.                 try {
  380.                     if (bracketingDone (dblVariateLeft, dblVariateRight, dblOFLeft, dblOFRight = evaluateOF
  381.                         (dblVariateRight), dblOFGoal, bop) && bop.incrOFCalcs())
  382.                         return bop;
  383.                 } catch (java.lang.Exception e) {
  384.                     dblOFRight = java.lang.Double.NaN;
  385.                 }

  386.                 if (bRightOFValidityEdgeReached = rightOFValidityEdgeReached (dblVariateRight, dblOFRight,
  387.                     ih)) {
  388.                     dblOFRight = dblPreviousOFRight;
  389.                     dblVariateRight = dblPreviousVariateRight;
  390.                 }
  391.             }

  392.             if (bracketingDone (dblVariateLeft, dblVariateRight, dblOFLeft, dblOFRight, dblOFGoal, bop))
  393.                 return bop;

  394.             dblBracketWidth *= bcp.getBracketWidthExpansionFactor();
  395.         }

  396.         return null;
  397.     }

  398.     /**
  399.      * Initialize the starting variate to within the fixed point convergence zone
  400.      *
  401.      * @param ih Optional InitializationHeuristics instance
  402.      * @param dblOFGoal The OF Goal
  403.      *
  404.      * @return The Convergence Zone Output
  405.      */

  406.     public org.drip.function.r1tor1solver.ConvergenceOutput initializeVariate (
  407.         final org.drip.function.r1tor1solver.InitializationHeuristics ih,
  408.         final double dblOFGoal)
  409.     {
  410.         if (!org.drip.numerical.common.NumberUtil.IsValid (dblOFGoal)) return null;

  411.         org.drip.function.r1tor1solver.ConvergenceOutput cop = new org.drip.function.r1tor1solver.ConvergenceOutput();

  412.         org.drip.function.r1tor1solver.BracketingOutput bop = initializeBracket (ih, dblOFGoal);

  413.         if (null != bop && bop.done()) return bop.makeConvergenceVariate();

  414.         double dblConvergenceZoneVariate = _ccp.getConvergenceZoneVariateBegin();

  415.         int iFixedPointConvergenceIterations = _ccp.getFixedPointConvergenceIterations();

  416.         while (0 != iFixedPointConvergenceIterations--) {
  417.             if (!cop.incrIterations()) return cop;

  418.             try {
  419.                 if (isInConvergenceZone (dblConvergenceZoneVariate, dblOFGoal, cop)) {
  420.                     cop.done (dblConvergenceZoneVariate);

  421.                     return cop;
  422.                 }
  423.             } catch (java.lang.Exception e) {
  424.                 // e.printStackTrace();
  425.             }

  426.             try {
  427.                 if (isInConvergenceZone (-1. * dblConvergenceZoneVariate, dblOFGoal, cop)) {
  428.                     cop.done (-1. * dblConvergenceZoneVariate);

  429.                     return cop;
  430.                 }
  431.             } catch (java.lang.Exception e) {
  432.                 // e.printStackTrace();
  433.             }

  434.             dblConvergenceZoneVariate *= _ccp.getConvergenceZoneVariateBumpFactor();
  435.         }

  436.         return null;
  437.     }

  438.     /**
  439.      * Initialize the starting bracket within the specified boundary
  440.      *
  441.      * @param ih Initialization Heuristics containing the hard search edges
  442.      * @param dblOFGoal The OF Goal
  443.      *
  444.      * @return Results of the Verification
  445.      */

  446.     public org.drip.function.r1tor1solver.BracketingOutput verifyHardSearchEdges (
  447.         final org.drip.function.r1tor1solver.InitializationHeuristics ih,
  448.         final double dblOFGoal)
  449.     {
  450.         if (null == ih || !org.drip.numerical.common.NumberUtil.IsValid (ih.getSearchStartLeft()) ||
  451.             !org.drip.numerical.common.NumberUtil.IsValid (ih.getSearchStartRight()) ||
  452.                 !org.drip.numerical.common.NumberUtil.IsValid (dblOFGoal))
  453.             return null;

  454.         try {
  455.             org.drip.function.r1tor1solver.BracketingOutput bop = new
  456.                 org.drip.function.r1tor1solver.BracketingOutput();

  457.             if (bracketingDone (ih.getSearchStartLeft(), ih.getSearchStartRight(), evaluateOF
  458.                 (ih.getSearchStartLeft()), evaluateOF (ih.getSearchStartRight()), dblOFGoal, bop) &&
  459.                     bop.incrOFCalcs())
  460.                 return bop;
  461.         } catch (java.lang.Exception e) {
  462.         }

  463.         return null;
  464.     }
  465. }