Package edu.cmu.tetrad.algcomparison.algorithm.cluster

Class Bpc

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.cluster.Bpc

All Implemented Interfaces:

Algorithm, ClusterAlgorithm, TakesCovarianceMatrix, HasParameters, TetradSerializable, Serializable

@Algorithm(name="BPC",
           command="bpc",
           algoType=search_for_structure_over_latents)
@Bootstrapping
public class Bpc
extends Object
implements Algorithm, ClusterAlgorithm, TakesCovarianceMatrix

Build Pure Clusters.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Bpc()	Constructs a new BPC algorithm.

Method Summary

Modifier and Type	Method	Description
Graph	getComparisonGraph(Graph graph)	Returns the comparison graph for the given true directed graph.
DataType	getDataType()	Retrieves the data type of the algorithm's output.
String	getDescription()	Returns a short, one-line description of this algorithm.
List<String>	getParameters()	Retrieves the list of parameters used by the algorithm.
Graph	search(DataModel dataModel, Parameters parameters)	Runs the search algorithm to build a graph using the given data model and parameters.

Methods inherited from class java.lang.Object

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

Constructor Details

Bpc

public Bpc()

Constructs a new BPC algorithm.

Method Details

search

public Graph search(DataModel dataModel,
 Parameters parameters)
             throws InterruptedException

Runs the search algorithm to build a graph using the given data model and parameters.

Specified by:

search in interface Algorithm

Parameters:

dataModel - The data model to be used for the search.

parameters - The parameters for the search algorithm.

Returns:

The resulting graph.

Throws:

IllegalArgumentException - If the check type is unexpected.

InterruptedException

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

Returns the comparison graph for 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.

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()

Retrieves the data type of the algorithm's output.

Specified by:

getDataType in interface Algorithm

Returns:

The data type of the algorithm's output.

getParameters

public List<String> getParameters()

Retrieves the list of parameters used by the algorithm.

Specified by:

getParameters in interface HasParameters

Returns:

A list of strings representing the parameters used by the algorithm.