Class IcaLingam

java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm
edu.cmu.tetrad.algcomparison.algorithm.continuous.dag.IcaLingam
All Implemented Interfaces:
Algorithm, ReturnsBootstrapGraphs, HasParameters, TetradSerializable, Serializable
@Bootstrapping public class IcaLingam extends AbstractBootstrapAlgorithm implements Algorithm, ReturnsBootstrapGraphs
ICA-LiNGAM, the former name of LiNGAM.

Backward compatibility only. This class is retained under its original name so that sessions saved by Tetrad 7.6.10 and earlier, which refer to it by this class name, continue to load. Its registration annotations are commented out, so it does not appear in the chooser; new work should use Lingam. Every method delegates to Lingam, so a restored session runs the same search as the LiNGAM box.

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

  • Constructor Details

    • IcaLingam

      public IcaLingam()
      No-arg constructor. Used for reflection; do not delete.

  • Method Details

    • runSearch

      public Graph runSearch(DataModel dataSet, Parameters parameters) throws InterruptedException
      Runs the search on the given data by delegating to the successor algorithm and returns the resulting graph.
      Parameters:
      dataSet - the data to search over.
      parameters - the parameters of the search.
      Returns:
      the graph the successor returns.
      Throws:
      InterruptedException - if the search is interrupted.

    • 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.

    • getBHat

      public Matrix getBHat()
      Returns the B-Hat matrix found by the most recent search.
      Returns:
      the B-Hat matrix