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

Class Fofc

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

edu.cmu.tetrad.algcomparison.algorithm.cluster.Fofc

All Implemented Interfaces:

Algorithm, ClusterAlgorithm, ReturnsBootstrapGraphs, TakesCovarianceMatrix, HasKnowledge, HasParameters, TetradSerializable, Serializable

@Algorithm(name="FOFC",
           command="fofc",
           algoType=search_for_structure_over_latents)
@Bootstrapping
public class Fofc
extends AbstractBootstrapAlgorithm
implements Algorithm, HasKnowledge, ClusterAlgorithm, TakesCovarianceMatrix

Find One Factor Clusters.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Fofc()	Constructor for Fofc.

Method Summary

Modifier and Type	Method	Description
Graph	getComparisonGraph(Graph graph)	This method returns a comparison graph that is obtained from the given true directed graph.
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.
Knowledge	getKnowledge()	Returns the knowledge associated with this object.
List<String>	getParameters()	Returns a list of parameters for the search algorithm.
Graph	runSearch(DataModel dataModel, Parameters parameters)	Runs the search algorithm and returns the resulting graph.
void	setKnowledge(Knowledge knowledge)	Sets the knowledge associated with this object.

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.Algorithm

search

Constructor Details

Fofc

public Fofc()

Constructor for Fofc.

Method Details

runSearch

public Graph runSearch(DataModel dataModel,
 Parameters parameters)

Runs the search algorithm and returns the resulting graph.

Parameters:

dataModel - The data model containing the variables.

parameters - The parameters for the search algorithm.

Returns:

The resulting graph.

Throws:

IllegalArgumentException - if the check type parameter is unexpected.

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

This method returns a comparison graph that is obtained from 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 obtained by applying the CPDAG algorithm to the true directed 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()

Returns the data type that the search requires, whether continuous, discrete, or mixed.

Specified by:

getDataType in interface Algorithm

Returns:

The data type required by the search.

getParameters

public List<String> getParameters()

Returns a list of parameters for the search algorithm.

Specified by:

getParameters in interface HasParameters

Returns:

The list of parameters for the search algorithm.

getKnowledge

public Knowledge getKnowledge()

Returns the knowledge associated with this object.

Specified by:

getKnowledge in interface HasKnowledge

Returns:

the knowledge associated with this object

setKnowledge

public void setKnowledge(Knowledge knowledge)

Sets the knowledge associated with this object.

Specified by:

setKnowledge in interface HasKnowledge

Parameters:

knowledge - a knowledge object