Package edu.cmu.tetrad.algcomparison.algorithm

Interface Algorithm

All Superinterfaces:
HasParameters, Serializable, TetradSerializable
All Known Subinterfaces:
MultiDataSetAlgorithm
All Known Implementing Classes:
Bfci, Boss, Bpc, Ccd, Cfci, Cpc, Cstar, Dagma, DirectLingam, Eb, ExternalAlgorithm, ExternalAlgorithmBnlearnMmhc, ExternalAlgorithmBNTPc, ExternalAlgorithmIntersection, ExternalAlgorithmPcalgGes, ExternalAlgorithmPcalgPc, ExternalAlgorithmTetrad, FactorAnalysis, Fas, Fask, FaskConcatenated, FaskLofsConcatenated, FaskPw, FaskVote, FasLofs, Fci, FciIod, FciMax, Fges, FgesConcatenated, FgesMb, FgesMeasurement, FirstInflection, Fofc, Ftfc, GesMe, Gfci, Glasso, Grasp, GraspFci, IcaLingam, IcaLingD, Images, Mgm, PagSampleRfci, Pc, Pcd, PcLingam, PcMb, R1, R2, R3, RestrictedBoss, Rfci, RfciBsc, Rskew, RskewE, SingleGraphAlg, Skew, SkewE, Sp, SpFci, StabilitySelection, StARS, SvarFci, SvarGfci, Tanh
public interface Algorithm extends HasParameters, TetradSerializable
Interface that algorithm must implement.
Author:
josephramsey

  • Method Details

    • search

      Graph search(DataModel dataSet, Parameters parameters)
      Runs the search.
      Parameters:
      dataSet - The data set to run to the search on.
      parameters - The paramters of the search.
      Returns:
      The result graph.

    • getComparisonGraph

      Graph getComparisonGraph(Graph graph)
      Returns that graph that the result should be compared to.
      Parameters:
      graph - The true directed graph, if there is one.
      Returns:
      The comparison graph.

    • getDescription

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

    • getDataType

      DataType getDataType()
      Returns the data type that the search requires, whether continuous, discrete, or mixed.
      Returns:
      This type.

    • getParameters

      List<String> getParameters()
      Returns the parameters that this search uses.
      Specified by:
      getParameters in interface HasParameters
      Returns:
      A list of String names of parameters.