TopographyEdgeMap.java

  1. package org.drip.spaces.graph;

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

  78. /**
  79.  * <i>TopographyEdgeMap</i> maintains a Map of the Topography Connection Edges. The References are:
  80.  *
  81.  * <br><br>
  82.  *  <ul>
  83.  *      <li>
  84.  *          Wikipedia (2018a): Graph (Abstract Data Type)
  85.  *              https://en.wikipedia.org/wiki/Graph_(abstract_data_type)
  86.  *      </li>
  87.  *      <li>
  88.  *          Wikipedia (2018b): Graph Theory https://en.wikipedia.org/wiki/Graph_theory
  89.  *      </li>
  90.  *      <li>
  91.  *          Wikipedia (2018c): Graph (Discrete Mathematics)
  92.  *              https://en.wikipedia.org/wiki/Graph_(discrete_mathematics)
  93.  *      </li>
  94.  *      <li>
  95.  *          Wikipedia (2018d): Dijkstra's Algorithm https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm
  96.  *      </li>
  97.  *      <li>
  98.  *          Wikipedia (2018e): Bellman-Ford Algorithm
  99.  *              https://en.wikipedia.org/wiki/Bellman%E2%80%93Ford_algorithm
  100.  *      </li>
  101.  *  </ul>
  102.  *
  103.  * <br><br>
  104.  *  <ul>
  105.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  106.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/StatisticalLearningLibrary.md">Statistical Learning Library</a></li>
  107.  *      <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>
  108.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/spaces/graph/README.md">Graph Representation and Traversal Algorithms</a></li>
  109.  *  </ul>
  110.  * <br><br>
  111.  *
  112.  * @author Lakshmi Krishnamurthy
  113.  */

  115. public class TopographyEdgeMap
  116. {
  117.     private java.util.Map<java.lang.String, org.drip.spaces.graph.Edge> _edgeMap = new
  118.         org.drip.analytics.support.CaseInsensitiveHashMap<org.drip.spaces.graph.Edge>();

  120.     /**
  121.      * Empty TopographyEdgeMap Constructor
  122.      */

  124.     public TopographyEdgeMap()
  125.     {
  126.     }

  128.     /**
  129.      * Add an Edge
  130.      * 
  131.      * @param edge The Edge
  132.      * 
  133.      * @return TRUE - The Edge successfully added
  134.      */

  136.     public boolean addEdge (
  137.         final org.drip.spaces.graph.Edge edge)
  138.     {
  139.         if (null == edge)
  140.         {
  141.             return false;
  142.         }

  144.         java.lang.String source = edge.source();

  146.         java.lang.String destination = edge.destination();

  148.         _edgeMap.put (
  149.             source + "_" + destination,
  150.             edge
  151.         );

  153.         try
  154.         {
  155.             _edgeMap.put (
  156.                 destination + "_" + source,
  157.                 new org.drip.spaces.graph.Edge (
  158.                     destination,
  159.                     source,
  160.                     edge.weight()
  161.                 )
  162.             );

  164.             return true;
  165.         }
  166.         catch (java.lang.Exception e)
  167.         {
  168.             e.printStackTrace();
  169.         }

  171.         return false;
  172.     }

  174.     /**
  175.      * Retrieve the Edge Map
  176.      * 
  177.      * @return The Edge Map
  178.      */

  180.     public java.util.Map<java.lang.String, org.drip.spaces.graph.Edge> edgeMap()
  181.     {
  182.         return _edgeMap;
  183.     }

  185.     /**
  186.      * Retrieve the Edge connecting the Source and the Destination
  187.      * 
  188.      * @param source The Source
  189.      * @param destination The Destination
  190.      * 
  191.      * @return The Edge connecting the Source and the Destination
  192.      */

  194.     public org.drip.spaces.graph.Edge edge (
  195.         final java.lang.String source,
  196.         final java.lang.String destination)
  197.     {
  198.         if (null == source || source.isEmpty() ||
  199.             null == destination || destination.isEmpty())
  200.         {
  201.             return null;
  202.         }

  204.         java.lang.String key = source + "_" + destination;

  206.         return _edgeMap.containsKey (key) ? _edgeMap.get (key) : null;
  207.     }

  209.     /**
  210.      * Retrieve all the Edges corresponding to the Source Vertex
  211.      * 
  212.      * @param source The Source Vertex
  213.      * 
  214.      * @return Edges corresponding to the Source Vertex
  215.      */

  217.     public java.util.List<org.drip.spaces.graph.Edge> edgeList (
  218.         final java.lang.String source)
  219.     {
  220.         if (null == source || source.isEmpty())
  221.         {
  222.             return null;
  223.         }

  225.         java.util.List<org.drip.spaces.graph.Edge> edgeList = new
  226.             java.util.ArrayList<org.drip.spaces.graph.Edge>();

  228.         for (java.util.Map.Entry<java.lang.String, org.drip.spaces.graph.Edge> edgeMapEntry :
  229.             _edgeMap.entrySet())
  230.         {
  231.             java.lang.String key = edgeMapEntry.getKey();

  233.             if (key.startsWith (source))
  234.             {
  235.                 edgeList.add (edgeMapEntry.getValue());
  236.             }
  237.         }

  239.         return edgeList;
  240.     }
  241. }
Created with JaCoCo 0.7.9.201702052155