Package edu.cmu.tetrad.algcomparison.algorithm.cluster

Class Ftfc

java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm
edu.cmu.tetrad.algcomparison.algorithm.cluster.Ftfc
All Implemented Interfaces:
Algorithm, ClusterAlgorithm, ReturnsBootstrapGraphs, TakesCovarianceMatrix, HasKnowledge, HasParameters, TetradSerializable, Serializable
@Algorithm(name="FTFC", command="ftfc", algoType=search_for_structure_over_latents) @Bootstrapping public class Ftfc extends AbstractBootstrapAlgorithm implements Algorithm, HasKnowledge, ClusterAlgorithm, TakesCovarianceMatrix
FTFC.
Version:
$Id: $Id
Author:
josephramsey
See Also:

  • Constructor Details

    • Ftfc

      public Ftfc()

      Constructor for Ftfc.

  • Method Details

    • runSearch

      public Graph runSearch(DataModel dataSet, Parameters parameters)
      Runs the search algorithm to find a causal graph.
      Parameters:
      dataSet - The data set or covariance matrix to search.
      parameters - The search parameters.
      Returns:
      The causal graph discovered by the search algorithm.
      Throws:
      IllegalArgumentException - if the dataSet is not a dataset or a covariance matrix.

    • getComparisonGraph

      public Graph getComparisonGraph(Graph graph)
      Retrieves the comparison graph for the given true directed graph.
      Specified by:
      getComparisonGraph in interface Algorithm
      Parameters:
      graph - The true directed graph, if there is one.
      Returns:
      The comparison graph, which is a completed partially directed acyclic graph (CPDAG) of the input graph.

    • getDescription

      public String getDescription()
      Returns a short, one-line description of this algorithm. This will be printed in the report.
      Specified by:
      getDescription in interface Algorithm
      Returns:
      The description of the algorithm.

    • getDataType

      public DataType getDataType()
      Returns the type of the data set that the search algorithm requires. The data set can be continuous, discrete, or mixed.
      Specified by:
      getDataType in interface Algorithm
      Returns:
      The data type required by the search algorithm.

    • getParameters

      public List<String> getParameters()
      Retrieves the list of parameters supported by this algorithm. The parameters include ALPHA, USE_WISHART, USE_GAP, PRECOMPUTE_COVARIANCES, and VERBOSE.
      Specified by:
      getParameters in interface HasParameters
      Returns:
      The list of parameters supported by this algorithm.

    • getKnowledge

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

    • setKnowledge

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