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

Class Bpc

java.lang.Object

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

All Implemented Interfaces:

Algorithm, ClusterAlgorithm, HasParameters, TetradSerializable, Serializable

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

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 that graph that the result should be compared to.
DataType	getDataType()	Returns the data type that the search requires, whether continuous, discrete, or mixed.
String	getDescription()	Returns a short, one-line description of this algorithm.
List<String>	getParameters()	Returns the parameters that this search uses.
Graph	search(DataModel dataSet, Parameters parameters)	Runs the search.

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 dataSet,
 Parameters parameters)

Runs the search.

Runs the BPC algorithm.

Specified by:

search in interface Algorithm

Parameters:

dataSet - The data set to run to the search on.

parameters - The paramters of the search.

Returns:

The result graph.

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

Returns that graph that the result should be compared to.

Returns the true graph if there is one.

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.

Returns the description of the algorithm.

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.

Returns the data type that the algorithm can handle.

Specified by:

getDataType in interface Algorithm

Returns:

This type.

getParameters

public List<String> getParameters()

Returns the parameters that this search uses.

Returns the parameters for the algorithm.

Specified by:

getParameters in interface Algorithm

Specified by:

getParameters in interface HasParameters

Returns:

A list of String names of parameters.