Package edu.cmu.tetrad.data
Class Clusters
java.lang.Object
edu.cmu.tetrad.data.Clusters
- All Implemented Interfaces:
TetradSerializable
,Serializable
Stores clusters of variables for MimBuild, Purify, etc.
- Version:
- $Id: $Id
- Author:
- josephramsey, Ricardo Silva
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addToCluster
(int index, String var) Adds the given variable to the given index.boolean
getCluster
(int index) getCluster.getClusterName
(int index) getClusterName.Getter for the fieldclusters
.int
Getter for the fieldnumClusters
.getVarsNotInCluster
(List<String> varNames) getVarsNotInCluster.int
hashCode()
Computes a hashcode.boolean
isEmpty()
isEmpty.void
removeFromClusters
(String var) Removes the given variable from the clusters.static Clusters
Generates a simple exemplar of this class to test serialization.void
setClusterName
(int index, String name) setClusterName.void
setNumClusters
(int numClusters) Sets the number of clusters represented, or -1 if the number is allowed to vary.toString()
toString.
-
Constructor Details
-
Clusters
public Clusters()Constructs a blank knowledge object. -
Clusters
Copy constructor.- Parameters:
clusters
- the clusters to copy.
-
-
Method Details
-
serializableInstance
Generates a simple exemplar of this class to test serialization.- Returns:
- a simple exemplar of this class to test serialization.
-
addToCluster
Adds the given variable to the given index. If a variable which is being added is already in a index, it is moved to the new index. This information is used specifically by algorithm such as Purify and MIM Build. The first variation only put an Integer associated with the index, i.e., the clusterings forms a partition where the integer represents the index id for the corresponding variable. The second variation associates a list of Integers with each observed variable. When reading clustering information, one has to pay attention if the object retrieved is an Integer or a list of Integers.- Parameters:
index
- the index.var
- the variable (a String name). R. Silva (04/2003)
-
getVarsNotInCluster
getVarsNotInCluster.
- Parameters:
varNames
- the names of the variables.- Returns:
- the list of edges not in any tier.
-
getNumClusters
public int getNumClusters()Getter for the field
numClusters
.- Returns:
- the number of measurement clusters for use in Purify and MIM Build. R. Silva (04/2003)
-
setNumClusters
public void setNumClusters(int numClusters) Sets the number of clusters represented, or -1 if the number is allowed to vary.- Parameters:
numClusters
- the number of clusters represented, or -1 if the number is allowed to vary.
-
getClusters
Getter for the field
clusters
.- Returns:
- a copy of the cluster map, which is a map from variable names to integers.
-
getCluster
getCluster.
- Parameters:
index
- the index of the desired index.- Returns:
- a copy of this index.
-
getClusterName
getClusterName.
- Parameters:
index
- a int- Returns:
- a
String
object
-
setClusterName
setClusterName.
- Parameters:
index
- a intname
- aString
object
-
removeFromClusters
Removes the given variable from the clusters.- Parameters:
var
- the variable to remove.
-
hashCode
public int hashCode()Computes a hashcode. -
equals
Compares this object to another.
-
toString
toString.
-
isEmpty
public boolean isEmpty()isEmpty.
- Returns:
- true if there are no clusters, false otherwise.
-