Package edu.cmu.tetrad.algcomparison.algorithm.continuous.dag

Class Fask

java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm
edu.cmu.tetrad.algcomparison.algorithm.continuous.dag.Fask
All Implemented Interfaces:
Algorithm, ReturnsBootstrapGraphs, HasKnowledge, HasParameters, TakesExternalGraph, TakesIndependenceWrapper, UsesScoreWrapper, TetradSerializable, Serializable
@Bootstrapping @Algorithm(name="FASK", command="fask", algoType=forbid_latent_common_causes, dataType=Continuous) public class Fask extends AbstractBootstrapAlgorithm implements Algorithm, HasKnowledge, UsesScoreWrapper, TakesIndependenceWrapper, TakesExternalGraph
Wraps the IMaGES algorithm for continuous variables.

Requires that the parameter 'randomSelectionSize' be set to indicate how many datasets should be taken at a time (randomly). This cannot given multiple values.

Version:
$Id: $Id
Author:
josephramsey
See Also:

  • Constructor Details

  • Method Details

    • runSearch

      public Graph runSearch(DataModel dataModel, Parameters parameters)
      Runs the Fask search algorithm on the given data model with the specified parameters.
      Parameters:
      dataModel - the data model to run the search on
      parameters - the parameters for the search
      Returns:
      the resulting graph from the search
      Throws:
      IllegalStateException - if the data model is not a DataSet or if there are missing values
      IllegalArgumentException - if there are missing values in the data set

    • getComparisonGraph

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

    • getDescription

      public String getDescription()
      Returns a short, one-line description of the FASK algorithm. This description will be printed in the report.
      Specified by:
      getDescription in interface Algorithm
      Returns:
      A short description of the FASK algorithm.
      Throws:
      IllegalStateException - if the FASK algorithm is not initialized with either a test or an algorithm.

    • getDataType

      public DataType getDataType()
      Retrieves the data type of the dataset.
      Specified by:
      getDataType in interface Algorithm
      Returns:
      The data type of the dataset.

    • getParameters

      public List<String> getParameters()
      Returns the list of parameter names that are used by the algorithm. These parameters are looked up in the ParamMap, so if they are not already defined, they will need to be defined there.
      Specified by:
      getParameters in interface HasParameters
      Returns:
      The list of parameter names used by the algorithm.

    • getKnowledge

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

    • setKnowledge

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

    • getIndependenceWrapper

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

    • setIndependenceWrapper

      public void setIndependenceWrapper(IndependenceWrapper independenceWrapper)
      Sets the independence wrapper for the object.
      Specified by:
      setIndependenceWrapper in interface TakesIndependenceWrapper
      Parameters:
      independenceWrapper - the independence wrapper to be set. Must implement the IndependenceWrapper interface.

    • setExternalGraph

      public void setExternalGraph(Algorithm algorithm)
      Sets the external graph to be used by the algorithm.
      Specified by:
      setExternalGraph in interface TakesExternalGraph
      Parameters:
      algorithm - The algorithm object.

    • getScoreWrapper

      public ScoreWrapper getScoreWrapper()
      Retrieves the ScoreWrapper object associated with this class.
      Specified by:
      getScoreWrapper in interface UsesScoreWrapper
      Returns:
      The ScoreWrapper object.

    • setScoreWrapper

      public void setScoreWrapper(ScoreWrapper score)
      Sets the score wrapper for the object.
      Specified by:
      setScoreWrapper in interface UsesScoreWrapper
      Parameters:
      score - the score wrapper to be set.