Package edu.cmu.tetrad.annotation

Class AlgorithmAnnotations

java.lang.Object

edu.cmu.tetrad.annotation.AbstractAnnotations<Algorithm>

edu.cmu.tetrad.annotation.AlgorithmAnnotations

public class AlgorithmAnnotations
extends AbstractAnnotations<Algorithm>

Annotations for algorithms. Sep 26, 2017 12:19:41 AM

Author:

Kevin V. Bui (kvb2@pitt.edu)

Field Summary

Fields inherited from class edu.cmu.tetrad.annotation.AbstractAnnotations

annotatedClasses

Method Summary

Modifier and Type	Method	Description
List<AnnotatedClass<Algorithm>>	filterOutExperimental(List<AnnotatedClass<Algorithm>> list)	Filters out algorithms that are not for the given data type.
static AlgorithmAnnotations	getInstance()	Gets the instance of this class.
boolean	handlesUnmeasuredConfounder(Class clazz)	Checks if the algorithm handles unmeasured confounders.
boolean	requiresIndependenceTest(Class clazz)	Checks if the algorithm requires independence test.
boolean	requiresScore(Class clazz)	Checks if the algorithm requires a score.
boolean	takesExternalGraph(Class clazz)	Checks if the algorithm takes an external graph.
boolean	takesKnowledge(Class clazz)	Checks if the algorithm takes knowledge.
boolean	takesMultipleDataset(Class clazz)	Checks if the algorithm takes multiple data sets.

Methods inherited from class edu.cmu.tetrad.annotation.AbstractAnnotations

filterByAnnotation, filterOutByAnnotation, getAnnotatedClasses

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getInstance

public static AlgorithmAnnotations getInstance()

Gets the instance of this class.

Returns:

instance of this class

filterOutExperimental

public List<AnnotatedClass<Algorithm>> filterOutExperimental(List<AnnotatedClass<Algorithm>> list)

Filters out algorithms that are not for the given data type.

Parameters:

list - list of algorithms

Returns:

list of algorithms that are not for the given data type

takesMultipleDataset

public boolean takesMultipleDataset(Class clazz)

Checks if the algorithm takes multiple data sets.

Parameters:

clazz - algorithm class

Returns:

true if the algorithm takes multiple data sets

takesKnowledge

public boolean takesKnowledge(Class clazz)

Checks if the algorithm takes knowledge.

Parameters:

clazz - algorithm class

Returns:

true if the algorithm takes knowledge

takesExternalGraph

public boolean takesExternalGraph(Class clazz)

Checks if the algorithm takes an external graph.

Parameters:

clazz - algorithm class

Returns:

true if the algorithm takes an external graph

requiresIndependenceTest

public boolean requiresIndependenceTest(Class clazz)

Checks if the algorithm requires independence test.

Parameters:

clazz - algorithm class

Returns:

true if the algorithm requires independence test

requiresScore

public boolean requiresScore(Class clazz)

Checks if the algorithm requires a score.

Parameters:

clazz - algorithm class

Returns:

true if the algorithm requires a score

handlesUnmeasuredConfounder

public boolean handlesUnmeasuredConfounder(Class clazz)

Checks if the algorithm handles unmeasured confounders.

Parameters:

clazz - algorithm class

Returns:

true if the algorithm handles unmeasured confounders