Cardinality.java

  1. package org.drip.spaces.tensor;

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

  78. /**
  79.  * <i>Cardinality</i> contains the Type and the Measure of the Cardinality of the given Vector Space.
  80.  *
  81.  * <br><br>
  82.  *  <ul>
  83.  *      <li><b>Module </b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/ComputationalCore.md">Computational Core Module</a></li>
  84.  *      <li><b>Library</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/StatisticalLearningLibrary.md">Statistical Learning Library</a></li>
  85.  *      <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>
  86.  *      <li><b>Package</b> = <a href = "https://github.com/lakshmiDRIP/DROP/tree/master/src/main/java/org/drip/spaces/tensor/README.md">R<sup>x</sup> Continuous/Combinatorial Tensor Spaces</a></li>
  87.  *  </ul>
  88.  * <br><br>
  89.  *
  90.  * @author Lakshmi Krishnamurthy
  91.  */

  92. public class Cardinality {

  93.     /**
  94.      * Cardinality Type - Countably Finite
  95.      */

  96.     public static final int CARD_COUNTABLY_FINITE = 1;

  97.     /**
  98.      * Cardinality Type - Countably Infinite
  99.      */

  100.     public static final int CARD_COUNTABLY_INFINITE = 2;

  101.     /**
  102.      * Cardinality Type - Uncountably Infinite
  103.      */

  104.     public static final int CARD_UNCOUNTABLY_INFINITE = 3;

  105.     private int _iType = -1;
  106.     private double _dblNumber = java.lang.Double.NaN;

  107.     /**
  108.      * Countably Finite Cardinality
  109.      *
  110.      * @param dblNumber The Cardinality Number
  111.      *
  112.      * @return The Cardinality Instance
  113.      */

  114.     public static final Cardinality CountablyFinite (
  115.         final double dblNumber)
  116.     {
  117.         try {
  118.             return new Cardinality (CARD_COUNTABLY_FINITE, dblNumber);
  119.         } catch (java.lang.Exception e) {
  120.             e.printStackTrace();
  121.         }

  122.         return null;
  123.     }

  124.     /**
  125.      * Countably Infinite Cardinality
  126.      *
  127.      * @return The Cardinality Instance
  128.      */

  129.     public static final Cardinality CountablyInfinite()
  130.     {
  131.         try {
  132.             return new Cardinality (CARD_COUNTABLY_INFINITE, java.lang.Double.POSITIVE_INFINITY);
  133.         } catch (java.lang.Exception e) {
  134.             e.printStackTrace();
  135.         }

  136.         return null;
  137.     }

  138.     /**
  139.      * Uncountably Infinite Cardinality
  140.      *
  141.      * @return The Cardinality Instance
  142.      */

  143.     public static final Cardinality UncountablyInfinite()
  144.     {
  145.         try {
  146.             return new Cardinality (CARD_UNCOUNTABLY_INFINITE, java.lang.Double.POSITIVE_INFINITY);
  147.         } catch (java.lang.Exception e) {
  148.             e.printStackTrace();
  149.         }

  150.         return null;
  151.     }

  152.     /**
  153.      * Cardinality Constructor
  154.      *
  155.      * @param iType Cardinality Type
  156.      * @param dblNumber Cardinality Number
  157.      *
  158.      * @throws java.lang.Exception Thrown if the Inputs are Invalid
  159.      */

  160.     public Cardinality (
  161.         final int iType,
  162.         final double dblNumber)
  163.         throws java.lang.Exception
  164.     {
  165.         if ((CARD_COUNTABLY_FINITE != (_iType = iType) && CARD_COUNTABLY_INFINITE != _iType &&
  166.             CARD_UNCOUNTABLY_INFINITE != _iType) || java.lang.Double.isNaN (_dblNumber = dblNumber))
  167.             throw new java.lang.Exception ("Cardinality ctr => Invalid Inputs");
  168.     }

  169.     /**
  170.      * Retrieve the Cardinality Type
  171.      *
  172.      * @return The Cardinality Type
  173.      */

  174.     public int type()
  175.     {
  176.         return _iType;
  177.     }

  178.     /**
  179.      * Retrieve the Cardinality Number
  180.      *
  181.      * @return The Cardinality Number
  182.      */

  183.     public double number()
  184.     {
  185.         return _dblNumber;
  186.     }

  187.     /**
  188.      * Indicate if the Current Instance matches the "Other" Cardinality Instance
  189.      *
  190.      * @param cardOther The "Other" Cardinality Instance
  191.      *
  192.      * @return TRUE - The Instances Match
  193.      */

  194.     public boolean match (
  195.         final Cardinality cardOther)
  196.     {
  197.         return null != cardOther && cardOther.type() == _iType && cardOther.number() == _dblNumber;
  198.     }
  199. }