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

Class DirectLingam

java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm
edu.cmu.tetrad.algcomparison.algorithm.continuous.dag.DirectLingam
All Implemented Interfaces:
Algorithm, ReturnsBootstrapGraphs, HasParameters, UsesScoreWrapper, TetradSerializable, Serializable
@Algorithm(name="Direct-LiNGAM", command="direct-lingam", algoType=forbid_latent_common_causes, dataType=Continuous) @Bootstrapping public class DirectLingam extends AbstractBootstrapAlgorithm implements Algorithm, UsesScoreWrapper, ReturnsBootstrapGraphs
Direct LiNGAM.
Version:
$Id: $Id
Author:
bryanandrews
See Also:

  • Constructor Details

    • DirectLingam

      public DirectLingam()

      Constructor for DirectLingam.

    • DirectLingam

      public DirectLingam(ScoreWrapper score)

      Constructor for DirectLingam.

      Parameters:
      score - a ScoreWrapper object

  • Method Details

    • runSearch

      public Graph runSearch(DataModel dataModel, Parameters parameters)
      Runs the Direct LiNGAM search algorithm on the given data model with the specified parameters.
      Parameters:
      dataModel - the data model to run the search algorithm on
      parameters - the parameters for the search algorithm
      Returns:
      the resulting graph from the search algorithm
      Throws:
      IllegalArgumentException - if the data model is not an instance of DataSet

    • getComparisonGraph

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

    • 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:
      The description of the algorithm.

    • getDataType

      public DataType getDataType()
      Returns the data type of the algorithm, which can be Continuous, Discrete, Mixed, Graph, Covariance, or All.
      Specified by:
      getDataType in interface Algorithm
      Returns:
      The data type of the algorithm.

    • getParameters

      public List<String> getParameters()
      Returns a list of parameters for the DirectLingam algorithm.
      Specified by:
      getParameters in interface HasParameters
      Returns:
      the list of parameters

    • getScoreWrapper

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

    • setScoreWrapper

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