Package edu.cmu.tetrad.search

Interface IndependenceTest

All Known Implementing Classes:

CompositeIndependenceTest, IndTestChiSquare, IndTestConditionalCorrelation, IndTestConditionalGaussianLrt, IndTestCramerT, IndTestDegenerateGaussianLrt, IndTestFisherZ, IndTestFisherZConcatenateResiduals, IndTestFisherZFisherPValue, IndTestFisherZPercentIndependent, IndTestFisherZRecursive, IndTestGSquare, IndTestHsic, IndTestIndependenceFacts, IndTestIod, IndTestMixedMultipleTTest, IndTestMnlrLr, 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 Summary

Modifier and Type	Method	Description
default IndependenceResult	checkIndependence(Node x, Node y, Node... z)	Checks the independence fact in question and returns and independence result.
IndependenceResult	checkIndependence(Node x, Node y, Set<Node> z)	checkIndependence.
default boolean	determines(Set<Node> z, Node y)	Returns true if y is determined the variable in z.
default double	getAlpha()	Returns the significance level of the independence test.
default ICovarianceMatrix	getCov()	Returns the covariance matrix.
DataModel	getData()	getData.
default List<DataSet>	getDataSets()	Returns the datasets for this test
default int	getSampleSize()	Returns the sample size.
default Node	getVariable(String name)	Returns The variable by the given name.
default List<String>	getVariableNames()	Returns the list of names for the variables in getNodesInEvidence.
List<Node>	getVariables()	getVariables.
default IndependenceTest	indTestSubset(List<Node> vars)	Returns an Independence test for a sublist of the variables.
boolean	isVerbose()	Returns true if the test prints verbose output.
default void	setAlpha(double alpha)	Sets the significance level.
void	setVerbose(boolean verbose)	Sets whether this test will print verbose output.
String	toString()	Returns a string representation of this test.

Method Details

checkIndependence

IndependenceResult checkIndependence(Node x,
 Node y,
 Set<Node> z)
                              throws InterruptedException

checkIndependence.

Parameters:

x - a Node object

y - a Node object

z - a Set object

Returns:

an IndependenceResult (see).

Throws:

InterruptedException

See Also:

• IndependenceResult

getVariables

List<Node> getVariables()

getVariables.

Returns:

the list of variables over which this independence checker is capable of determining independence relations.

getData

DataModel getData()

getData.

Returns:

The data model for the independence test, either a DataSet or a CovarianceMatrix.

See Also:

• DataSet
• ICovarianceMatrix
• DataModel

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

See Also:

• IndependenceResult

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.