Class TrekMimic

java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm
edu.cmu.tetrad.algcomparison.algorithm.oracle.cpdag.TrekMimic
All Implemented Interfaces:
Algorithm, ReturnsBootstrapGraphs, AcceptsKnowledge, HasParameters, TetradSerializable, Serializable
@Algorithm(name="Trek-MIMIC", command="trek-mimic", algoType=search_for_structure_over_latents, dataType=Continuous) @Bootstrapping public class TrekMimic extends AbstractBootstrapAlgorithm implements Algorithm, AcceptsKnowledge, ReturnsBootstrapGraphs
Algorithm-comparison wrapper for the Trek-MIMIC search.

This wrapper delegates the actual work to TrekMimic, which now performs the full search through its search() method.

Author:
josephramsey
See Also:

  • Constructor Details

    • TrekMimic

      public TrekMimic()
      Constructs the wrapper.

  • Method Details

    • getComparisonGraph

      public Graph getComparisonGraph(Graph graph)
      Returns that graph that the result should be compared to.
      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 a short, one-line description of this algorithm. This will be printed in the report.
      Specified by:
      getDescription in interface Algorithm
      Returns:
      This description.

    • getDataType

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

    • getParameters

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

    • getKnowledge

      public Knowledge getKnowledge()
      Returns a knowledge object.
      Specified by:
      getKnowledge in interface AcceptsKnowledge
      Returns:
      a knowledge object.

    • setKnowledge

      public void setKnowledge(Knowledge knowledge)
      Sets a knowledge object.
      Specified by:
      setKnowledge in interface AcceptsKnowledge
      Parameters:
      knowledge - a knowledge object.

    • setInputs

      public void setInputs(Collection<Node> inputs)
      Sets the observed variables known to be inputs to the latent structure.
      Parameters:
      inputs - the input variables

    • setOutputs

      public void setOutputs(Collection<Node> outputs)
      Sets the observed variables known to be outputs from the latent structure.
      Parameters:
      outputs - the output variables

    • getInputNames

      public List<String> getInputNames()
      Returns the currently specified input variable names.
      Returns:
      the input variable names

    • setInputNames

      public void setInputNames(Collection<String> inputNames)
      Sets the input variable names directly.
      Parameters:
      inputNames - the input variable names

    • getOutputNames

      public List<String> getOutputNames()
      Returns the currently specified output variable names.
      Returns:
      the output variable names

    • setOutputNames

      public void setOutputNames(Collection<String> outputNames)
      Sets the output variable names directly.
      Parameters:
      outputNames - the output variable names

    • clearInputOutputKnowledge

      public void clearInputOutputKnowledge()
      Clears any supplied input/output role knowledge.