BinaryTree.java

  1. package org.drip.spaces.big;

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

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

  81. /**
  82.  * <i>BinaryTree</i> contains an Implementation of the Left/Right Binary Tree.
  83.  * 
  84.  * <br><br>
  85.  *  <ul>
  86.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  87.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/StatisticalLearningLibrary.md">Statistical Learning Library</a></li>
  88.  *      <li><b>Project</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/spaces/README.md">R<sup>1</sup> and R<sup>d</sup> Vector/Tensor Spaces (Validated and/or Normed), and Function Classes</a></li>
  89.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/spaces/big/README.md">Big-data In-place Manipulator</a></li>
  90.  *  </ul>
  91.  * <br><br>
  92.  * 
  93.  * @author Lakshmi Krishnamurthy
  94.  */

  96. public class BinaryTree {
  97.     private int _iCount = 1;
  98.     private BinaryTree _btParent = null;
  99.     private BinaryTree _btLeftChild = null;
  100.     private BinaryTree _btRightChild = null;
  101.     private double _dblNode = java.lang.Double.NaN;

  103.     /**
  104.      * BinaryTree Constructor
  105.      * 
  106.      * @param dblNode The Node Value
  107.      * @param btParent The BinaryTree Parent
  108.      * 
  109.      * @throws java.lang.Exception Thrown if the Inputs are invalid
  110.      */

  112.     public BinaryTree (
  113.         final double dblNode,
  114.         final BinaryTree btParent)
  115.         throws java.lang.Exception
  116.     {
  117.         if (!org.drip.numerical.common.NumberUtil.IsValid (_dblNode = dblNode))
  118.             throw new java.lang.Exception ("BinaryTree ctr => Invalid Inputs");

  120.         _iCount = 1;
  121.         _btParent = btParent;
  122.     }

  124.     /**
  125.      * Retrieve the BinaryTree Node Value
  126.      * 
  127.      * @return The BinaryTree Node Value
  128.      */

  130.     public double node()
  131.     {
  132.         return _dblNode;
  133.     }

  135.     /**
  136.      * Retrieve the Parent BinaryTree Instance
  137.      * 
  138.      * @return The Parent BinaryTree Instance
  139.      */

  141.     public BinaryTree parent()
  142.     {
  143.         return _btParent;
  144.     }

  146.     /**
  147.      * Retrieve the Left Child BinaryTree Instance
  148.      * 
  149.      * @return The Left Child BinaryTree Instance
  150.      */

  152.     public BinaryTree leftChild()
  153.     {
  154.         return _btLeftChild;
  155.     }

  157.     /**
  158.      * Retrieve the Right Child BinaryTree Instance
  159.      * 
  160.      * @return The Right Child BinaryTree Instance
  161.      */

  163.     public BinaryTree rightChild()
  164.     {
  165.         return _btRightChild;
  166.     }

  168.     /**
  169.      * Retrieve the Node Instance Count
  170.      * 
  171.      * @return The Node Instance Count
  172.      */

  174.     public int count()
  175.     {
  176.         return _iCount;
  177.     }

  179.     /**
  180.      * Insert a Node into the Tree
  181.      * 
  182.      * @param dblNode The Node to be inserted
  183.      * 
  184.      * @return The Inserted Node
  185.      */

  187.     public BinaryTree insert (
  188.         final double dblNode)
  189.     {
  190.         if (!org.drip.numerical.common.NumberUtil.IsValid (dblNode)) return null;

  192.         if (_dblNode == dblNode) {
  193.             ++_iCount;
  194.             return this;
  195.         }

  197.         try {
  198.             if (dblNode < _dblNode)
  199.                 return null == _btLeftChild ? _btLeftChild = new BinaryTree (dblNode, this) :
  200.                     _btLeftChild.insert (dblNode);

  202.             return null == _btRightChild ? _btRightChild = new BinaryTree (dblNode, this) :
  203.                 _btRightChild.insert (dblNode);
  204.         } catch (java.lang.Exception e) {
  205.             e.printStackTrace();
  206.         }

  208.         return null;
  209.     }

  211.     /**
  212.      * Retrieve the Left Most Child
  213.      * 
  214.      * @return The Left Most Child BinaryTree Instance
  215.      */

  217.     public BinaryTree leftMostChild()
  218.     {
  219.         BinaryTree btParent = this;

  221.         BinaryTree btLeftChild = leftChild();

  223.         while (null != btLeftChild) {
  224.             btParent = btLeftChild;

  226.             btLeftChild = btParent.leftChild();
  227.         }

  229.         return btParent;
  230.     }

  232.     /**
  233.      * Retrieve the Right Most Child
  234.      * 
  235.      * @return The Right Most Child BinaryTree Instance
  236.      */

  238.     public BinaryTree rightMostChild()
  239.     {
  240.         BinaryTree btParent = this;

  242.         BinaryTree btRightChild = rightChild();

  244.         while (null != btRightChild) {
  245.             btParent = btRightChild;

  247.             btRightChild = btParent.rightChild();
  248.         }

  250.         return btParent;
  251.     }

  253.     /**
  254.      * Build a Consolidated Ascending List of all the Constituent Nodes
  255.      * 
  256.      * @param lsNode The Node List
  257.      * 
  258.      * @return TRUE - The Ascending Node List Successfully Built
  259.      */

  261.     public boolean ascendingNodeList (
  262.         final java.util.List<java.lang.Double> lsNode)
  263.     {
  264.         if (null == lsNode) return false;

  266.         if (null != _btLeftChild && !_btLeftChild.ascendingNodeList (lsNode)) return false;

  268.         lsNode.add (_dblNode);

  270.         if (null != _btRightChild && !_btRightChild.ascendingNodeList (lsNode)) return false;

  272.         return true;
  273.     }

  275.     /**
  276.      * Build a Consolidated Ascending List of all the Constituent Nodes
  277.      * 
  278.      * @return The Node List
  279.      */

  281.     public java.util.List<java.lang.Double> ascendingNodeList()
  282.     {
  283.         java.util.List<java.lang.Double> lsNode = new java.util.ArrayList<java.lang.Double>();

  285.         return ascendingNodeList (lsNode) ? lsNode : null;
  286.     }

  288.     /**
  289.      * Build a Consolidated Ascending Array of all the Constituent Nodes
  290.      * 
  291.      * @param adblNode The Node Array
  292.      * @param iUpdateStartIndex The Update Start Index
  293.      * 
  294.      * @return TRUE - The Ascending Node Array Successfully Built
  295.      * 
  296.      * @throws java.lang.Exception Thrown if the Inputs are Invalid
  297.      */

  299.     public int ascendingNodeArray (
  300.         final double[] adblNode,
  301.         final int iUpdateStartIndex)
  302.         throws java.lang.Exception
  303.     {
  304.         if (null == adblNode || 0 == adblNode.length)
  305.             throw new java.lang.Exception ("BinaryTree::ascendingNodeArray => Invalid Inputs");

  307.         int iIndexToUpdate = null == _btLeftChild ? iUpdateStartIndex : _btLeftChild.ascendingNodeArray
  308.             (adblNode, iUpdateStartIndex);

  310.         if (iIndexToUpdate >= adblNode.length)
  311.             throw new java.lang.Exception ("BinaryTree::ascendingNodeArray => Invalid Inputs");

  313.         adblNode[iIndexToUpdate++] = _dblNode;

  315.         return null == _btRightChild ? iIndexToUpdate : _btRightChild.ascendingNodeArray (adblNode,
  316.             iIndexToUpdate);
  317.     }

  319.     /**
  320.      * Build a Consolidated Descending List of all the Constituent Nodes
  321.      * 
  322.      * @param lsNode The Node List
  323.      * 
  324.      * @return TRUE - The Descending Node List Successfully Built
  325.      */

  327.     public boolean descendingNodeList (
  328.         final java.util.List<java.lang.Double> lsNode)
  329.     {
  330.         if (null == lsNode) return false;

  332.         if (null != _btRightChild && !_btRightChild.descendingNodeList (lsNode)) return false;

  334.         lsNode.add (_dblNode);

  336.         if (null != _btLeftChild && !_btLeftChild.descendingNodeList (lsNode)) return false;

  338.         return true;
  339.     }

  341.     /**
  342.      * Build a Consolidated Descending Array of all the Constituent Nodes
  343.      * 
  344.      * @param adblNode The Node Array
  345.      * @param iIndexToUpdate The Index To Update
  346.      * 
  347.      * @return TRUE - The Descending Node Array Successfully Built
  348.      */

  350.     public boolean descendingNodeArray (
  351.         final double[] adblNode,
  352.         final int iIndexToUpdate)
  353.     {
  354.         if (null == adblNode || 0 == adblNode.length) return false;

  356.         if (null != _btLeftChild && !_btLeftChild.descendingNodeArray (adblNode, iIndexToUpdate))
  357.             return false;

  359.         if (iIndexToUpdate >= adblNode.length) return false;

  361.         adblNode[iIndexToUpdate] = _dblNode;

  363.         if (null != _btRightChild && !_btRightChild.descendingNodeArray (adblNode, iIndexToUpdate + 1))
  364.             return false;

  366.         return true;
  367.     }

  369.     /**
  370.      * Build a Consolidated Descending List of all the Constituent Nodes
  371.      * 
  372.      * @return The Node List
  373.      */

  375.     public java.util.List<java.lang.Double> descendingNodeList()
  376.     {
  377.         java.util.List<java.lang.Double> lsNode = new java.util.ArrayList<java.lang.Double>();

  379.         return descendingNodeList (lsNode) ? lsNode : null;
  380.     }
  381. }
Created with JaCoCo 0.7.9.201702052155