Class LvLite
java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm
edu.cmu.tetrad.algcomparison.algorithm.oracle.pag.LvLite
- All Implemented Interfaces:
Algorithm
,ReturnsBootstrapGraphs
,TakesCovarianceMatrix
,HasKnowledge
,HasParameters
,UsesScoreWrapper
,TetradSerializable
,Serializable
@Algorithm(name="LV-Lite",
command="lv-lite",
algoType=allow_latent_common_causes)
@Bootstrapping
@Experimental
public class LvLite
extends AbstractBootstrapAlgorithm
implements Algorithm, UsesScoreWrapper, HasKnowledge, ReturnsBootstrapGraphs, TakesCovarianceMatrix
This class represents the LV-Lite algorithm, which is an implementation of the LV algorithm for learning causal
structures from observational data. It uses a combination of independence tests and scores to search for the best
graph structure given a data set and parameters.
- Author:
- josephramsey
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionLvLite()
This class represents a LvLite algorithm.LvLite
(ScoreWrapper score) LvLite is a class that represents a LvLite algorithm. -
Method Summary
Modifier and TypeMethodDescriptiongetComparisonGraph
(Graph graph) Retrieves a comparison graph by transforming a true directed graph into a partially directed graph (PAG).Retrieves the data type required by the search algorithm.Returns a short, one-line description of this algorithm.Retrieves the knowledge object associated with this method.Retrieves the list of parameters used by the algorithm.Retrieves the ScoreWrapper object associated with this method.runSearch
(DataModel dataModel, Parameters parameters) Runs the search algorithm to find a graph structure based on a given data model and parameters.void
setKnowledge
(Knowledge knowledge) Sets the knowledge object associated with this method.void
setScoreWrapper
(ScoreWrapper score) Sets the score wrapper for the algorithm.Methods inherited from class edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm
getBootstrapGraphs, search
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface edu.cmu.tetrad.algcomparison.algorithm.ReturnsBootstrapGraphs
getBootstrapGraphs
-
Constructor Details
-
LvLite
public LvLite()This class represents a LvLite algorithm.The LvLite algorithm is a bootstrap algorithm that runs a search algorithm to find a graph structure based on a given data set and parameters. It is a subclass of the Abstract BootstrapAlgorithm class and implements the Algorithm interface.
- See Also:
-
LvLite
LvLite is a class that represents a LvLite algorithm.The LvLite algorithm is a bootstrap algorithm that runs a search algorithm to find a graph structure based on a given data set and parameters. It is a subclass of the AbstractBootstrapAlgorithm class and implements the Algorithm interface.
- Parameters:
score
- The score to use.- See Also:
-
-
Method Details
-
runSearch
Runs the search algorithm to find a graph structure based on a given data model and parameters.- Parameters:
dataModel
- The data model to use for the search algorithm.parameters
- The parameters to configure the search algorithm.- Returns:
- The resulting graph structure.
- Throws:
IllegalArgumentException
- if the time lag is greater than 0 and the data model is not an instance of DataSet.
-
getComparisonGraph
Retrieves a comparison graph by transforming a true directed graph into a partially directed graph (PAG).- Specified by:
getComparisonGraph
in interfaceAlgorithm
- Parameters:
graph
- The true directed graph, if there is one.- Returns:
- The comparison graph.
-
getDescription
Returns a short, one-line description of this algorithm. The description is generated by concatenating the descriptions of the test and score objects associated with this algorithm.- Specified by:
getDescription
in interfaceAlgorithm
- Returns:
- The description of this algorithm.
-
getDataType
Retrieves the data type required by the search algorithm.- Specified by:
getDataType
in interfaceAlgorithm
- Returns:
- The data type required by the search algorithm.
-
getParameters
Retrieves the list of parameters used by the algorithm.- Specified by:
getParameters
in interfaceHasParameters
- Returns:
- The list of parameters used by the algorithm.
-
getKnowledge
Retrieves the knowledge object associated with this method.- Specified by:
getKnowledge
in interfaceHasKnowledge
- Returns:
- The knowledge object.
-
setKnowledge
Sets the knowledge object associated with this method.- Specified by:
setKnowledge
in interfaceHasKnowledge
- Parameters:
knowledge
- the knowledge object to be set
-
getScoreWrapper
Retrieves the ScoreWrapper object associated with this method.- Specified by:
getScoreWrapper
in interfaceUsesScoreWrapper
- Returns:
- The ScoreWrapper object associated with this method.
-
setScoreWrapper
Sets the score wrapper for the algorithm.- Specified by:
setScoreWrapper
in interfaceUsesScoreWrapper
- Parameters:
score
- the score wrapper.
-