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

Class Gin

java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm
edu.cmu.tetrad.algcomparison.algorithm.oracle.cpdag.Gin
All Implemented Interfaces:
Algorithm, ReturnsBootstrapGraphs, TakesCovarianceMatrix, HasParameters, TakesIndependenceWrapper, TetradSerializable, Serializable
@Algorithm(name="GIN", command="gin", algoType=forbid_latent_common_causes) @Bootstrapping @Experimental public class Gin extends AbstractBootstrapAlgorithm implements Algorithm, TakesIndependenceWrapper, ReturnsBootstrapGraphs, TakesCovarianceMatrix
GIN (Generalized Independent Noise Search)
Version:
$Id: $Id
Author:
josephramsey
See Also:

  • Constructor Details

    • Gin

      public Gin()
      Default constructor for the Gin class. This constructor is used for reflection purposes and should not be removed.

  • Method Details

    • getComparisonGraph

      public Graph getComparisonGraph(Graph graph)
      Description copied from interface: Algorithm
      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()
      Description copied from interface: Algorithm
      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()
      Description copied from interface: Algorithm
      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()
      Description copied from interface: HasParameters
      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.

    • getIndependenceWrapper

      public IndependenceWrapper getIndependenceWrapper()
      Description copied from interface: TakesIndependenceWrapper
      Returns the independence wrapper.
      Specified by:
      getIndependenceWrapper in interface TakesIndependenceWrapper
      Returns:
      the independence wrapper.

    • setIndependenceWrapper

      public void setIndependenceWrapper(IndependenceWrapper test)
      Description copied from interface: TakesIndependenceWrapper
      Sets the independence wrapper.
      Specified by:
      setIndependenceWrapper in interface TakesIndependenceWrapper
      Parameters:
      test - the independence wrapper.