Class FfCi

java.lang.Object

edu.cmu.tetrad.algcomparison.independence.FfCi

All Implemented Interfaces:

IndependenceWrapper, HasParameters, TetradSerializable, Serializable

@TestOfIndependence(name="FFCI (Fourier Features Conditional Independence)",
                    command="ffci-test",
                    dataType=Mixed)
@General
@Mixed
public class FfCi
extends Object
implements IndependenceWrapper

Wrapper for FFCI test with a reduced parameter set. Exposed parameters: - alpha - permutations - numFeatures (applied to XY and Z) - lambda - bandwidthMultiplier - verbose

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FfCi()	Default constructor for the FfCi class.

Method Summary

Modifier and Type	Method	Description
DataType	getDataType()	Provides the data type of the test.
String	getDescription()	Provides a description of the independence test.
List<String>	getParameters()	Provides a list of parameters required for configuring the test.
IndependenceTest	getTest(DataModel dataSet, Parameters parameters)	Creates and configures an instance of the FfCi independence test with specified parameters derived from the provided dataset and parameter set.

Methods inherited from class Object

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

Constructor Details

FfCi

public FfCi()

Default constructor for the FfCi class. Initializes a new instance of the FfCi class with default settings. This constructor is primarily used to instantiate objects of FfCi and does not perform additional configuration beyond basic initialization.

Method Details

getTest

public IndependenceTest getTest(DataModel dataSet,
 Parameters parameters)

Creates and configures an instance of the FfCi independence test with specified parameters derived from the provided dataset and parameter set.

Specified by:

getTest in interface IndependenceWrapper

Parameters:

dataSet - the dataset to be used for the independence test

parameters - the parameter set containing values such as alpha, permutations, number of features, lambda, bandwidth multiplier, approximation type, and verbosity

Returns:

an instance of IndependenceTest configured with the specified parameters

getDescription

public String getDescription()

Provides a description of the independence test.

Specified by:

getDescription in interface IndependenceWrapper

Returns:

a string representing the description of the test

getDataType

public DataType getDataType()

Provides the data type of the test.

Specified by:

getDataType in interface IndependenceWrapper

Returns:

the data type of the test

getParameters

public List<String> getParameters()

Provides a list of parameters required for configuring the test.

Specified by:

getParameters in interface HasParameters

Specified by:

getParameters in interface IndependenceWrapper

Returns:

a list of parameter names