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 SummaryConstructorsConstructorDescriptionFciMax()Constructor for FciMax.FciMax(IndependenceWrapper test) Constructor for FciMax.
- 
Method SummaryModifier 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.AbstractBootstrapAlgorithmgetBootstrapGraphs, searchMethods inherited from class java.lang.Objectequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface edu.cmu.tetrad.algcomparison.algorithm.ReturnsBootstrapGraphsgetBootstrapGraphs
- 
Constructor Details- 
FciMaxpublic FciMax()Constructor for FciMax. 
- 
FciMaxConstructor for FciMax. - Parameters:
- test- a- IndependenceWrapperobject
 
 
- 
- 
Method Details- 
runSearchRuns a search algorithm to discover the causal graph structure.- Parameters:
- dataModel- the data set on which the search algorithm will be performed
- parameters- the parameters for the search algorithm
- Returns:
- the discovered causal graph structure
- Throws:
- InterruptedException
 
- 
getComparisonGraphReturns the comparison graph transformed from the true directed graph.- Specified by:
- getComparisonGraphin interface- Algorithm
- Parameters:
- graph- The true directed graph, if there is one.
- Returns:
- The comparison graph transformed from the true directed graph.
 
- 
getDescriptionReturns a description of the algorithm.- Specified by:
- getDescriptionin interface- Algorithm
- Returns:
- a String representing the description of the algorithm.
 
- 
getDataTypeReturns the data type that the search requires, whether continuous, discrete, or mixed.- Specified by:
- getDataTypein interface- Algorithm
- Returns:
- the data type required for the search
 
- 
getParametersReturns the list of parameters used by the method. The parameters are returned as a List of Strings.- Specified by:
- getParametersin interface- HasParameters
- Returns:
- a List of Strings representing the parameters used by the method.
 
- 
getKnowledgeRetrieves the knowledge associated with the algorithm.- Specified by:
- getKnowledgein interface- HasKnowledge
- Returns:
- the knowledge object associated with the algorithm
 
- 
setKnowledgeSets the knowledge associated with the algorithm.- Specified by:
- setKnowledgein interface- HasKnowledge
- Parameters:
- knowledge- the knowledge object to be set
 
- 
getIndependenceWrapperRetrieves the IndependenceWrapper associated with the algorithm.- Specified by:
- getIndependenceWrapperin interface- TakesIndependenceWrapper
- Returns:
- the IndependenceWrapper object associated with the algorithm
 
- 
setIndependenceWrapperSets the independence wrapper for the algorithm.- Specified by:
- setIndependenceWrapperin interface- TakesIndependenceWrapper
- Parameters:
- test- the independence wrapper
 
 
-