Class FciMax
java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm
edu.cmu.tetrad.algcomparison.algorithm.oracle.pag.FciMax
- All Implemented Interfaces:
Algorithm,ReturnsBootstrapGraphs,TakesCovarianceMatrix,HasKnowledge,HasParameters,TakesIndependenceWrapper,TetradSerializable,Serializable
@Algorithm(name="FCI-Max",
command="fci-max",
algoType=allow_latent_common_causes)
@Bootstrapping
public class FciMax
extends AbstractBootstrapAlgorithm
implements Algorithm, HasKnowledge, TakesIndependenceWrapper, ReturnsBootstrapGraphs, TakesCovarianceMatrix
FCI-Max algorithm.
- Version:
- $Id: $Id
- Author:
- josephramsey
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionFciMax()Constructor for FciMax.FciMax(IndependenceWrapper test) Constructor for FciMax. -
Method Summary
Modifier and TypeMethodDescriptiongetComparisonGraph(Graph graph) Returns the comparison graph transformed from the true directed graph.Returns the data type that the search requires, whether continuous, discrete, or mixed.Returns a description of the algorithm.Retrieves the IndependenceWrapper associated with the algorithm.Retrieves the knowledge associated with the algorithm.Returns the list of parameters used by the method.runSearch(DataModel dataModel, Parameters parameters) Runs a search algorithm to discover the causal graph structure.voidSets the independence wrapper for the algorithm.voidsetKnowledge(Knowledge knowledge) Sets the knowledge associated with the algorithm.Methods inherited from class edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm
getBootstrapGraphs, searchMethods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface edu.cmu.tetrad.algcomparison.algorithm.ReturnsBootstrapGraphs
getBootstrapGraphs
-
Constructor Details
-
FciMax
public FciMax()Constructor for FciMax.
-
FciMax
Constructor for FciMax.
- Parameters:
test- aIndependenceWrapperobject
-
-
Method Details
-
runSearch
Runs a search algorithm to discover the causal graph structure.- Parameters:
dataModel- the data set on which the search algorithm will be performedparameters- the parameters for the search algorithm- Returns:
- the discovered causal graph structure
- Throws:
InterruptedException
-
getComparisonGraph
Returns the comparison graph transformed from the true directed graph.- Specified by:
getComparisonGraphin interfaceAlgorithm- Parameters:
graph- The true directed graph, if there is one.- Returns:
- The comparison graph transformed from the true directed graph.
-
getDescription
Returns a description of the algorithm.- Specified by:
getDescriptionin interfaceAlgorithm- Returns:
- a String representing the description of the algorithm.
-
getDataType
Returns the data type that the search requires, whether continuous, discrete, or mixed.- Specified by:
getDataTypein interfaceAlgorithm- Returns:
- the data type required for the search
-
getParameters
Returns the list of parameters used by the method. The parameters are returned as a List of Strings.- Specified by:
getParametersin interfaceHasParameters- Returns:
- a List of Strings representing the parameters used by the method.
-
getKnowledge
Retrieves the knowledge associated with the algorithm.- Specified by:
getKnowledgein interfaceHasKnowledge- Returns:
- the knowledge object associated with the algorithm
-
setKnowledge
Sets the knowledge associated with the algorithm.- Specified by:
setKnowledgein interfaceHasKnowledge- Parameters:
knowledge- the knowledge object to be set
-
getIndependenceWrapper
Retrieves the IndependenceWrapper associated with the algorithm.- Specified by:
getIndependenceWrapperin interfaceTakesIndependenceWrapper- Returns:
- the IndependenceWrapper object associated with the algorithm
-
setIndependenceWrapper
Sets the independence wrapper for the algorithm.- Specified by:
setIndependenceWrapperin interfaceTakesIndependenceWrapper- Parameters:
test- the independence wrapper
-