Interface IndependenceTest

All Known Implementing Classes:
CompositeIndependenceTest, IndTestBasisFunctionLrt, IndTestBasisFunctionLrtFullSample, IndTestChiSquare, IndTestConditionalCorrelation, IndTestConditionalGaussianLrt, IndTestCramerT, IndTestDegenerateGaussianLrt, IndTestDegenerateGaussianLrtFullSample, IndTestFisherZ, IndTestFisherZConcatenateResiduals, IndTestFisherZFisherPValue, IndTestFisherZPercentIndependent, IndTestFisherZRecursive, IndTestGSquare, IndTestHsic, IndTestIndependenceFacts, IndTestIod, IndTestMixedMultipleTTest, IndTestMulti, IndTestMultinomialLogisticRegression, IndTestMultinomialLogisticRegressionWald, IndTestMvpLrt, IndTestPositiveCorr, IndTestProbabilistic, IndTestRegression, IndTestSepsetDci, IndTestTrekSep, Kci, MsepTest, ProbabilisticMapIndependence, ScoreIndTest

public interface IndependenceTest
Gives an interface that can be implemented by classes that do conditional independence testing. These classes are capable of serving as conditional independence "oracles" for constraint-based searches. Many methods are given defaults so that such a test will be easy to implement in Python using JPype.
Version:
$Id: $Id
Author:
josephramsey
  • Method Details

    • checkIndependence

      IndependenceResult checkIndependence(Node x, Node y, Set<Node> z) throws InterruptedException
      Checks the independence between two variables x and y given a conditioning set z.
      Parameters:
      x - The first variable to test, represented as a Node object.
      y - The second variable to test, represented as a Node object.
      z - The set of conditioning variables, represented as a Set of Node objects.
      Returns:
      An IndependenceResult object representing the outcome of the independence test.
      Throws:
      InterruptedException - If the process is interrupted during the execution.
    • getVariables

      List<Node> getVariables()
      Retrieves the list of variables associated with this independence test.
      Returns:
      A list of Node objects representing the variables.
    • getData

      DataModel getData()
      Retrieves the data model associated with this test.
      Returns:
      A DataModel object representing the data model.
    • isVerbose

      boolean isVerbose()
      Returns true if the test prints verbose output.
      Returns:
      True if the case.
    • setVerbose

      void setVerbose(boolean verbose)
      Sets whether this test will print verbose output.
      Parameters:
      verbose - True, if so.
    • toString

      String toString()
      Returns a string representation of this test.
      Overrides:
      toString in class Object
      Returns:
      This string.
    • indTestSubset

      default IndependenceTest indTestSubset(List<Node> vars)
      Returns an Independence test for a sublist of the variables.
      Parameters:
      vars - The sublist of variables.
      Returns:
      a IndependenceTest object
    • checkIndependence

      default IndependenceResult checkIndependence(Node x, Node y, Node... z) throws InterruptedException
      Checks the independence fact in question and returns and independence result.
      Parameters:
      x - a Node object
      y - a Node object
      z - a Node object
      Returns:
      The independence result.
      Throws:
      InterruptedException - if any.
      See Also:
    • getSampleSize

      default int getSampleSize()
      Returns the sample size.
      Returns:
      This size.
    • getVariable

      default Node getVariable(String name)
      Returns The variable by the given name.
      Parameters:
      name - a String object
      Returns:
      This variable.
    • getVariableNames

      default List<String> getVariableNames()
      Returns the list of names for the variables in getNodesInEvidence.
      Returns:
      this list.
    • determines

      default boolean determines(Set<Node> z, Node y)
      Returns true if y is determined the variable in z.
      Parameters:
      z - a Set object
      y - a Node object
      Returns:
      True, if so.
    • getAlpha

      default double getAlpha()
      Returns the significance level of the independence test.
      Returns:
      This level.
      Throws:
      UnsupportedOperationException - if there is no significance level.
    • setAlpha

      default void setAlpha(double alpha)
      Sets the significance level.
      Parameters:
      alpha - This level.
    • getCov

      default ICovarianceMatrix getCov()
      Returns the covariance matrix.
      Returns:
      This matrix.
      Throws:
      UnsupportedOperationException - If this method is not supported for a particular test.
    • getDataSets

      default List<DataSet> getDataSets()
      Returns the datasets for this test
      Returns:
      these datasets.
      Throws:
      UnsupportedOperationException - If this method is not supported for a particular test.