Package org.drip.dynamics.evolution

Class LSQMPointRecord

java.lang.Object
org.drip.dynamics.evolution.LSQMPointRecord
public class LSQMPointRecord
extends java.lang.Object
LSQMPointRecord contains the Record of the Evolving Point Latent State Quantification Metrics.

Author:
Lakshmi Krishnamurthy

  • Constructor Summary

    Constructors
    Constructor Description
    LSQMPointRecord()
    Empty LSQMPointRecord Constructor

  • Method Summary

    Modifier and Type Method Description
    boolean containsLatentState​(LatentStateLabel lsl)
    Indicate if Quantification Metrics are available for the specified Latent State
    boolean containsQM​(LatentStateLabel lsl, java.lang.String strQM)
    Indicate if the Value for the specified Quantification Metric is available
    java.util.Set<java.lang.String> latentStateLabel()
    Retrieve the Latent State Labels
    double qm​(LatentStateLabel lsl, java.lang.String strQM)
    Retrieve the specified Quantification Metric Value
    boolean setQM​(LatentStateLabel lsl, java.lang.String strQM, double dblValue)
    Set the LSQM Value

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • LSQMPointRecord

      public LSQMPointRecord()
      Empty LSQMPointRecord Constructor

  • Method Details

    • latentStateLabel

      public java.util.Set<java.lang.String> latentStateLabel()
      Retrieve the Latent State Labels
      Returns:
      The Latent State Labels

    • containsLatentState

      public boolean containsLatentState​(LatentStateLabel lsl)
      Indicate if Quantification Metrics are available for the specified Latent State
      Parameters:
      lsl - The Latent State Label
      Returns:
      TRUE - Quantification Metrics are available for the specified Latent State

    • setQM

      public boolean setQM​(LatentStateLabel lsl, java.lang.String strQM, double dblValue)
      Set the LSQM Value
      Parameters:
      lsl - The Latent State Label
      strQM - The Quantification Metric
      dblValue - The QM's Value
      Returns:
      TRUE - The QM successfully set

    • containsQM

      public boolean containsQM​(LatentStateLabel lsl, java.lang.String strQM)
      Indicate if the Value for the specified Quantification Metric is available
      Parameters:
      lsl - The Latent State Label
      strQM - The Quantification Metric
      Returns:
      TRUE - The Requested Value is available

    • qm

      public double qm​(LatentStateLabel lsl, java.lang.String strQM) throws java.lang.Exception
      Retrieve the specified Quantification Metric Value
      Parameters:
      lsl - The Latent State Label
      strQM - The Quantification Metric
      Returns:
      The Quantification Metric Value
      Throws:
      java.lang.Exception - Thrown if the Quantification Metric is not available