Package edu.cmu.tetrad.algcomparison.algorithm.other

Record Class RlcdParams

java.lang.Object
java.lang.Record
edu.cmu.tetrad.algcomparison.algorithm.other.RlcdParams
Record Components:
alpha - the significance level for statistical tests, typically in the range [0, 1]. A smaller value (e.g., 0.05) indicates stricter criteria for rejecting the null hypothesis.
stage1Method - a string specifying the approach used in stage 1. Common values include "all", but other custom methods can also be specified as needed.
maxSamples - an integer specifying the maximum number of samples to process. A value of -1 indicates that all available samples should be used.
rankTestMethod - a string indicating the method for rank testing. Supported methods include "svd" (for singular value decomposition) and "wilks" (for Wilks' lambda test via a hook to rank tests).
svdTau - a numerical threshold (double) used in singular value decomposition for determining the rank. Singular values below this threshold are considered negligible.
useGin - a boolean parameter that specifies whether the GIN (Generalized Independent Noise) method will be applied to orient leftover edges in the causal graph.
public record RlcdParams(double alpha, String stage1Method, int maxSamples, String rankTestMethod, double svdTau, boolean useGin) extends Record
The RlcdParams record encapsulates the configuration parameters for RLCD (Rank-based Local Causal Discovery). It provides various options for controlling the behavior and methods used in RLCD analysis.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RlcdParams(double alpha, String stage1Method, int maxSamples, String rankTestMethod, double svdTau, boolean useGin)
    Creates an instance of a RlcdParams record class.
    RlcdParams(Parameters ps)
    Constructs an instance of RlcdParams using the provided Parameters object.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    alpha()
    Returns the value of the alpha record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    maxSamples()
    Returns the value of the maxSamples record component.
    String
    rankTestMethod()
    Returns the value of the rankTestMethod record component.
    String
    stage1Method()
    Returns the value of the stage1Method record component.
    double
    svdTau()
    Returns the value of the svdTau record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    useGin()
    Returns the value of the useGin record component.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • RlcdParams

      public RlcdParams(Parameters ps)
      Constructs an instance of RlcdParams using the provided Parameters object.
      Parameters:
      ps - the Parameters object containing configuration values. Keys and their default values include: - "alpha": a double value with a default of 0.05. - "rlcd.stage1_method": a string specifying the stage 1 method, defaulting to "all". - "rlcd.max_samples": an integer representing the maximum number of samples, defaulting to -1 (interpreted as all samples). - "rlcd.rank_test": a string specifying the rank test method, defaulting to "svd". - "rlcd.svd_tau": a double numerical threshold for singular value decomposition, defaulting to 1e-7. - "rlcd.use_gin": a boolean indicating whether to orient leftover edges using GIN, defaulting to false.

    • RlcdParams

      public RlcdParams(double alpha, String stage1Method, int maxSamples, String rankTestMethod, double svdTau, boolean useGin)
      Creates an instance of a RlcdParams record class.
      Parameters:
      alpha - the value for the alpha record component
      stage1Method - the value for the stage1Method record component
      maxSamples - the value for the maxSamples record component
      rankTestMethod - the value for the rankTestMethod record component
      svdTau - the value for the svdTau record component
      useGin - the value for the useGin record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • alpha

      public double alpha()
      Returns the value of the alpha record component.
      Returns:
      the value of the alpha record component

    • stage1Method

      public String stage1Method()
      Returns the value of the stage1Method record component.
      Returns:
      the value of the stage1Method record component

    • maxSamples

      public int maxSamples()
      Returns the value of the maxSamples record component.
      Returns:
      the value of the maxSamples record component

    • rankTestMethod

      public String rankTestMethod()
      Returns the value of the rankTestMethod record component.
      Returns:
      the value of the rankTestMethod record component

    • svdTau

      public double svdTau()
      Returns the value of the svdTau record component.
      Returns:
      the value of the svdTau record component

    • useGin

      public boolean useGin()
      Returns the value of the useGin record component.
      Returns:
      the value of the useGin record component