Package edu.cmu.tetrad.algcomparison.independence

Class Kci

java.lang.Object

edu.cmu.tetrad.algcomparison.independence.Kci

All Implemented Interfaces:

IndependenceWrapper, HasParameters, TetradSerializable, Serializable

@TestOfIndependence(name="KCI-Test (Kernel Conditional Independence Test)",
                    command="kci-test",
                    dataType=Continuous)
@General
public class Kci
extends Object
implements IndependenceWrapper

Wrapper for KCI test.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Kci()	`Kci` constructor.

Method Summary

Modifier and Type	Method	Description
DataType	getDataType()	Returns the data type that the search requires, whether continuous, discrete, or mixed.
String	getDescription()	Returns a short of this independence test.
List<String>	getParameters()	Returns the parameters that this search uses.
IndependenceTest	getTest(DataModel dataSet, Parameters parameters)	Returns true iff x and y are independent conditional on z for the given data set.
void	setVerbose(boolean verbose)	Sets the verbosity level of the KCI test.

Methods inherited from class java.lang.Object

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

Constructor Details

Kci

public Kci()

`Kci` constructor.

Method Details

getTest

public IndependenceTest getTest(DataModel dataSet,
 Parameters parameters)

Returns true iff x and y are independent conditional on z for the given data set.

Returns a KCI test.

Specified by:

getTest in interface IndependenceWrapper

Parameters:

dataSet - The data set to test independence against.

parameters - The paramters of the test.

Returns:

True iff independence holds.

getDescription

public String getDescription()

Returns a short of this independence test.

Returns the name of the test.

Specified by:

getDescription in interface IndependenceWrapper

Returns:

This description.

getDataType

public DataType getDataType()

Returns the data type that the search requires, whether continuous, discrete, or mixed.

Returns the data type of the test, which is continuous.

Specified by:

getDataType in interface IndependenceWrapper

Returns:

This type.

See Also:

• DataType

getParameters

public List<String> getParameters()

Returns the parameters that this search uses.

Returns the parameters of the test.

Specified by:

getParameters in interface HasParameters

Specified by:

getParameters in interface IndependenceWrapper

Returns:

A list of String names of parameters.

setVerbose

public void setVerbose(boolean verbose)

Sets the verbosity level of the KCI test. By default true for this (slow) test.

Parameters:

verbose - a boolean indicating whether verbose output should be enabled (true) or disabled (false).