Package org.drip.spaces.tensor

Class R1CombinatorialVector

java.lang.Object
org.drip.spaces.tensor.R1CombinatorialVector
All Implemented Interfaces:
GeneralizedVector, R1GeneralizedVector
Direct Known Subclasses:
BinaryBooleanVector, R1Combinatorial
public class R1CombinatorialVector
extends java.lang.Object
implements R1GeneralizedVector
R1CombinatorialVector exposes the normed/non-normed Discrete Spaces with R1 Combinatorial Vector Elements.



Author:
Lakshmi Krishnamurthy

  • Constructor Summary

    Constructors
    Constructor Description
    R1CombinatorialVector​(java.util.List<java.lang.Double> lsElementSpace)
    R1CombinatorialVector Constructor

  • Method Summary

    Modifier and Type Method Description
    Cardinality cardinality()
    Retrieve the Cardinality of the Vector Space
    java.util.List<java.lang.Double> elementSpace()
    Retrieve the Full Candidate List of Elements
    double hyperVolume()
    Retrieve the "Hyper" Volume of the Vector Space
    boolean isPredictorBounded()
    Indicate if the Predictor Variate Space is bounded from the Left and the Right
    double leftEdge()
    Retrieve the Left Edge
    boolean match​(GeneralizedVector gvOther)
    Compare against the "Other" Generalized Vector Space
    double rightEdge()
    Retrieve the Right Edge
    boolean subset​(GeneralizedVector gvOther)
    Indicate if the "Other" Generalized Vector Space is a Subset of "this"
    boolean validateInstance​(double dblX)
    Validate the Input Instance Ordinate

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • R1CombinatorialVector

      public R1CombinatorialVector​(java.util.List<java.lang.Double> lsElementSpace) throws java.lang.Exception
      R1CombinatorialVector Constructor
      Parameters:
      lsElementSpace - The List Space of Elements
      Throws:
      java.lang.Exception - Thrown if the Inputs are Invalid

  • Method Details

    • elementSpace

      public java.util.List<java.lang.Double> elementSpace()
      Retrieve the Full Candidate List of Elements
      Returns:
      The Full Candidate List of Elements

    • leftEdge

      public double leftEdge()
      Description copied from interface: GeneralizedVector
      Retrieve the Left Edge
      Specified by:
      leftEdge in interface GeneralizedVector
      Returns:
      The Left Edge

    • rightEdge

      public double rightEdge()
      Description copied from interface: GeneralizedVector
      Retrieve the Right Edge
      Specified by:
      rightEdge in interface GeneralizedVector
      Returns:
      The Right Edge

    • validateInstance

      public boolean validateInstance​(double dblX)
      Description copied from interface: R1GeneralizedVector
      Validate the Input Instance Ordinate
      Specified by:
      validateInstance in interface R1GeneralizedVector
      Parameters:
      dblX - The Input Instance Ordinate
      Returns:
      TRUE - Instance Ordinate is a Valid Entry in the Space

    • cardinality

      public Cardinality cardinality()
      Description copied from interface: GeneralizedVector
      Retrieve the Cardinality of the Vector Space
      Specified by:
      cardinality in interface GeneralizedVector
      Returns:
      Cardinality of the Vector Space

    • match

      public boolean match​(GeneralizedVector gvOther)
      Description copied from interface: GeneralizedVector
      Compare against the "Other" Generalized Vector Space
      Specified by:
      match in interface GeneralizedVector
      Parameters:
      gvOther - The "Other" Generalized Vector Space
      Returns:
      TRUE - The "Other" Generalized Vector Space matches this

    • subset

      public boolean subset​(GeneralizedVector gvOther)
      Description copied from interface: GeneralizedVector
      Indicate if the "Other" Generalized Vector Space is a Subset of "this"
      Specified by:
      subset in interface GeneralizedVector
      Parameters:
      gvOther - The "Other" Generalized Vector Space
      Returns:
      TRUE - The "Other" Generalized Vector Space is a Subset of this

    • isPredictorBounded

      public boolean isPredictorBounded()
      Description copied from interface: GeneralizedVector
      Indicate if the Predictor Variate Space is bounded from the Left and the Right
      Specified by:
      isPredictorBounded in interface GeneralizedVector
      Returns:
      The Predictor Variate Space is bounded from the Left and the Right

    • hyperVolume

      public double hyperVolume() throws java.lang.Exception
      Description copied from interface: GeneralizedVector
      Retrieve the "Hyper" Volume of the Vector Space
      Specified by:
      hyperVolume in interface GeneralizedVector
      Returns:
      The "Hyper" Volume of the Vector Space
      Throws:
      java.lang.Exception - Thrown if the Hyper Volume cannot be computed