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

Class SvarFci

java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm
edu.cmu.tetrad.algcomparison.algorithm.oracle.pag.SvarFci
All Implemented Interfaces:
Algorithm, ReturnsBootstrapGraphs, TakesCovarianceMatrix, HasKnowledge, HasParameters, TakesIndependenceWrapper, TetradSerializable, Serializable
@Algorithm(name="SvarFCI", command="svar-fci", algoType=allow_latent_common_causes) @TimeSeries @Bootstrapping public class SvarFci extends AbstractBootstrapAlgorithm implements Algorithm, HasKnowledge, TakesIndependenceWrapper, ReturnsBootstrapGraphs, TakesCovarianceMatrix
The SvarFci class is an implementation of the SVAR Fast Causal Inference algorithm.
See Also:

  • Constructor Details

    • SvarFci

      public SvarFci()
      Represents a constructor for the SvarFci class.

    • SvarFci

      public SvarFci(IndependenceWrapper test)
      Represents a constructor for the SvarFci class.
      Parameters:
      test - The IndependenceWrapper object used in the constructor.

  • Method Details

    • runSearch

      public Graph runSearch(DataModel dataModel, Parameters parameters)
      Executes the search algorithm to find a graph structure that best fits the given dataset and parameters.
      Parameters:
      dataModel - The dataset to perform the search on.
      parameters - The parameters to configure the search.
      Returns:
      The graph structure that best fits the dataset.

    • getComparisonGraph

      public Graph getComparisonGraph(Graph graph)
      Returns a comparison graph based on 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.

    • getDescription

      public String getDescription()
      Returns the description of the method. The description is a combination of "SvarFCI (SVAR Fast Causal Inference) using" and the description of the independence test object.
      Specified by:
      getDescription in interface Algorithm
      Returns:
      the description of the method.

    • getDataType

      public DataType getDataType()
      Retrieves the data type required by the search algorithm.
      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 required for this method.
      Specified by:
      getParameters in interface HasParameters
      Returns:
      The list of parameters.

    • getKnowledge

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

    • setKnowledge

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

    • getIndependenceWrapper

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

    • setIndependenceWrapper

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