Package edu.cmu.tetrad.algcomparison.algorithm.oracle.pag

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 Details

  • Method Details

    • runSearch

      public Graph runSearch(DataModel dataModel, Parameters parameters)
      Runs 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

    • getComparisonGraph

      public Graph getComparisonGraph(Graph graph)
      Returns the comparison graph transformed from the true directed graph.
      Specified by:
      getComparisonGraph in interface Algorithm
      Parameters:
      graph - The true directed graph, if there is one.
      Returns:
      The comparison graph transformed from the true directed graph.

    • getDescription

      public String getDescription()
      Returns a description of the algorithm.
      Specified by:
      getDescription in interface Algorithm
      Returns:
      a String representing the description of the algorithm.

    • getDataType

      public DataType getDataType()
      Returns the data type that the search requires, whether continuous, discrete, or mixed.
      Specified by:
      getDataType in interface Algorithm
      Returns:
      the data type required for the search

    • getParameters

      public List<String> getParameters()
      Returns the list of parameters used by the method. The parameters are returned as a List of Strings.
      Specified by:
      getParameters in interface HasParameters
      Returns:
      a List of Strings representing the parameters used by the method.

    • getKnowledge

      public Knowledge getKnowledge()
      Retrieves the knowledge associated with the algorithm.
      Specified by:
      getKnowledge in interface HasKnowledge
      Returns:
      the knowledge object associated with the algorithm

    • setKnowledge

      public void setKnowledge(Knowledge knowledge)
      Sets the knowledge associated with the algorithm.
      Specified by:
      setKnowledge in interface HasKnowledge
      Parameters:
      knowledge - the knowledge object to be set

    • getIndependenceWrapper

      public IndependenceWrapper getIndependenceWrapper()
      Retrieves the IndependenceWrapper associated with the algorithm.
      Specified by:
      getIndependenceWrapper in interface TakesIndependenceWrapper
      Returns:
      the IndependenceWrapper object associated with the algorithm

    • setIndependenceWrapper

      public void setIndependenceWrapper(IndependenceWrapper test)
      Sets the independence wrapper for the algorithm.
      Specified by:
      setIndependenceWrapper in interface TakesIndependenceWrapper
      Parameters:
      test - the independence wrapper