Package edu.cmu.tetrad.bayes
Class UpdatedBayesIm
java.lang.Object
edu.cmu.tetrad.bayes.UpdatedBayesIm
- All Implemented Interfaces:
BayesIm
,Simulator
,VariableSource
,Im
,TetradSerializable
,Serializable
Represents a Bayes IM in which all of the conditional probability tables have been updated to take into account
evidence. Updated conditional probability values of variables with respect to comabinations of their parent values
are calculated on the fly. Values that do not change due to being d-separated from a variable conditional on its
parents are not calculated; rather, these are simply looked up in the underlying Bayes IM and returned.
- Author:
- josephramsey
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionUpdatedBayesIm
(BayesIm bayesIm) Constructs Bayes net in which CPT's updated for the given evidence are calculated on the fly.UpdatedBayesIm
(BayesIm bayesIm, Evidence evidence) Constructs Bayes net in which CPT's updated for the given evidence are calculated on the fly. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clearRow
(int nodeIndex, int rowIndex) Assigns random probability values to the child values of this row that add to 1.void
clearTable
(int nodeIndex) Randomizes every row in the table for the given node index.boolean
Returns true iff this Bayes net is equal to the given Bayes net.Returns the underlying Bayes PM.int
getCorrespondingNodeIndex
(int nodeIndex, BayesIm otherBayesIm) Returns the index of the given node in the given BayesIm.getDag()
$DescriptionReturns the list of measured variables.getNode
(int nodeIndex) Returns the name of the given node.Returns the name of the given node.int
getNodeIndex
(Node node) Returns the index of the given node.int
getNumColumns
(int nodeIndex) Returns the number of columns.int
Returns the name of the given node.int
getNumParents
(int nodeIndex) Returns the number of parents for the given node.int
getNumRows
(int nodeIndex) Returns the number of rows.int
getParent
(int nodeIndex, int parentIndex) Returns the ith parent of the givne node.int
getParentDim
(int nodeIndex, int parentIndex) Returns the dimension of the given parent for the given node.int[]
getParentDims
(int nodeIndex) Returns the dimensions of the pararents of the given node.int[]
getParents
(int nodeIndex) Returns the parents of the given node.int
getParentValue
(int nodeIndex, int rowIndex, int colIndex) Returns the given parent value.int[]
getParentValues
(int nodeIndex, int rowIndex) Returns the parents values of the given node.double
getProbability
(int nodeIndex, int rowIndex, int colIndex) Calculates the probability for the given node, at the given row and column of the conditional probability table (CPT), updated for the evidence provided in the constuctor.int
getRowIndex
(int nodeIndex, int[] values) Returns a row index.Returns the list of variable names.Returns the list of variables.boolean
isIncomplete
(int nodeIndex) Returns true iff the given node has a Double.NaN value in it.boolean
isIncomplete
(int nodeIndex, int rowIndex) Returns true iff the given row in the given node has a Double.NaN value in it.void
Normalizes all rows in the tables associated with each of node in turn.void
normalizeNode
(int nodeIndex) Normalizes all rows in the table associated with a given node.void
normalizeRow
(int nodeIndex, int rowIndex) Normalizes the given row.void
randomizeIncompleteRows
(int nodeIndex) Randomizes any row in the table for the given node index that has a Double.NaN value in it.void
randomizeRow
(int nodeIndex, int rowIndex) Assigns random probability values to the child values of this row that add to 1.void
randomizeTable
(int nodeIndex) Randomizes every row in the table for the given node index.static UpdatedBayesIm
Generates a simple exemplar of this class to test serialization.void
setProbability
(int nodeIndex, double[][] probMatrix) Sets the probability for the given node.void
setProbability
(int nodeIndex, int rowIndex, int colIndex, double value) Sets the probability for the given node at a given row and column in the table for that node.simulateData
(int sampleSize, boolean latentDataSaved) Simulates a sample with the given sample size.simulateData
(DataSet dataSet, boolean latentDataSaved) Overwrites the given dataSet with a new simulated dataSet, to avoid allocating memory.toString()
Prints out the probability table for each variable.
-
Constructor Details
-
UpdatedBayesIm
Constructs Bayes net in which CPT's updated for the given evidence are calculated on the fly. -
UpdatedBayesIm
Constructs Bayes net in which CPT's updated for the given evidence are calculated on the fly.
-
-
Method Details
-
serializableInstance
Generates a simple exemplar of this class to test serialization. -
getBayesPm
Description copied from interface:BayesIm
Returns the underlying Bayes PM.- Specified by:
getBayesPm
in interfaceBayesIm
- Returns:
- the underlying Bayes PM.
-
getDag
Description copied from interface:BayesIm
$Description -
getNumNodes
public int getNumNodes()Description copied from interface:BayesIm
Returns the name of the given node.- Specified by:
getNumNodes
in interfaceBayesIm
- Returns:
- the number of nodes in the model.
-
getNode
Description copied from interface:BayesIm
Returns the name of the given node. -
getNode
Description copied from interface:BayesIm
Returns the name of the given node. -
getNodeIndex
Description copied from interface:BayesIm
Returns the index of the given node.- Specified by:
getNodeIndex
in interfaceBayesIm
- Parameters:
node
- the given node.- Returns:
- the index for that node, or -1 if the node is not in the BayesIm.
-
getNumColumns
public int getNumColumns(int nodeIndex) Description copied from interface:BayesIm
Returns the number of columns.- Specified by:
getNumColumns
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node.- Returns:
- the number of columns in the table of the given node N with index 'nodeIndex'--that is, the number of possible values that N can take on. That is, if P(N=v0 | P1=v1, P2=v2, ... Pn=vn) is a conditional probability stored in 'probs', then the maximum number of rows in the table for N is #vals(N).
- See Also:
-
getNumRows
public int getNumRows(int nodeIndex) Description copied from interface:BayesIm
Returns the number of rows.- Specified by:
getNumRows
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node.- Returns:
- the number of rows in the table of the given node, which would be the total number of possible combinations of parent values for a given node. That is, if P(N=v0 | P1=v1, P2=v2, ... Pn=vn) is a conditional probability stored in 'probs', then the maximum number of rows in the table for N is #vals(P1) x #vals(P2) x ... x #vals(Pn).
- See Also:
-
getNumParents
public int getNumParents(int nodeIndex) Description copied from interface:BayesIm
Returns the number of parents for the given node.- Specified by:
getNumParents
in interfaceBayesIm
- Parameters:
nodeIndex
- the given node.- Returns:
- the number of parents of the given node.
-
getParent
public int getParent(int nodeIndex, int parentIndex) Description copied from interface:BayesIm
Returns the ith parent of the givne node. -
getParentDim
public int getParentDim(int nodeIndex, int parentIndex) Description copied from interface:BayesIm
Returns the dimension of the given parent for the given node.- Specified by:
getParentDim
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node.parentIndex
- the index of the parent.- Returns:
- the dimension of the given parent for the given node.
-
getParentDims
public int[] getParentDims(int nodeIndex) Description copied from interface:BayesIm
Returns the dimensions of the pararents of the given node.- Specified by:
getParentDims
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node.- Returns:
- (a defensive copy of) the array representing the dimensionality of each parent of a node, that is, the number of values which that node can take on. The order of entries in this array is the same as the order of entries of nodes returned by getParents() for that node.
- See Also:
-
getParents
public int[] getParents(int nodeIndex) Description copied from interface:BayesIm
Returns the parents of the given node.- Specified by:
getParents
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node.- Returns:
- (a defensive copy of) the array containing all of the parents of a given node in the order in which they are stored internally.
- See Also:
-
getParentValues
public int[] getParentValues(int nodeIndex, int rowIndex) Description copied from interface:BayesIm
Returns the parents values of the given node.- Specified by:
getParentValues
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node.rowIndex
- the index of the row in question.- Returns:
- an array containing the combination of parent values for a given node and given row in the probability table for that node. To get the combination of parent values from the row number, the row number is represented using a variable-base place value system, where the bases for each place value are the dimensions of the parents in the order in which they are given by getParentDims(). For instance, if the row number (base 10) is 103 and the parent dimension array is [3 5 7], we calculate the first value as 103 / 7 = 14 with a remainder of 5. We then divide 14 / 5 = 2 with a remainder of 4. We then divide 2 / 3 = 0 with a remainder of 2. The variable place value representation is [2 4 5], which is the combination of parent values. This is the inverse function of getRowIndex().
- See Also:
-
getParentValue
public int getParentValue(int nodeIndex, int rowIndex, int colIndex) Description copied from interface:BayesIm
Returns the given parent value.- Specified by:
getParentValue
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node.rowIndex
- the index of the row in question.colIndex
- the index of the column in question.- Returns:
- the value in the probability table for the given node, at the given row and column.
-
getProbability
public double getProbability(int nodeIndex, int rowIndex, int colIndex) Calculates the probability for the given node, at the given row and column of the conditional probability table (CPT), updated for the evidence provided in the constuctor.- Specified by:
getProbability
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node in question.rowIndex
- the row in the table for this for node which represents the combination of parent values in question.colIndex
- the column in the table for this node which represents the value of the node in question.- Returns:
- the probability for the given node at the given row and column in the table for that node. To get the node index, use getNodeIndex(). To get the row index, use getRowIndex(). To get the column index, use getCategoryIndex() from the underlying BayesPm(). The value returned will represent a conditional probability of the form P(N=v0 | P1=v1, P2=v2, ... , Pn=vn), where N is the node referenced by nodeIndex, v0 is the value referenced by colIndex, and the combination of parent values indicated is the combination indicated by rowIndex.
- See Also:
-
getRowIndex
public int getRowIndex(int nodeIndex, int[] values) Description copied from interface:BayesIm
Returns a row index.- Specified by:
getRowIndex
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node in question.values
- the combination of parent values in question.- Returns:
- the row in the table at which the given combination of parent values is represented for the given node.
The row is calculated as a variable-base place-value number. For instance, if the array of parent dimensions is
[3, 5, 7] and the parent value combination is [2, 4, 5], then the row number is (7 * (5 * (3 * 0 + 2) + 4)) + 5 =
103. This is the inverse function to getVariableValues().
Note: If the node has n values, the length of 'values' must be >= the number of parents. Only the first n values are used.
- See Also:
-
normalizeAll
public void normalizeAll()Description copied from interface:BayesIm
Normalizes all rows in the tables associated with each of node in turn.- Specified by:
normalizeAll
in interfaceBayesIm
-
normalizeNode
public void normalizeNode(int nodeIndex) Description copied from interface:BayesIm
Normalizes all rows in the table associated with a given node.- Specified by:
normalizeNode
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node in question.
-
normalizeRow
public void normalizeRow(int nodeIndex, int rowIndex) Description copied from interface:BayesIm
Normalizes the given row.- Specified by:
normalizeRow
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node in question.rowIndex
- the index of the row in question.
-
setProbability
public void setProbability(int nodeIndex, double[][] probMatrix) Description copied from interface:BayesIm
Sets the probability for the given node. The matrix row represent row index, the row in the table for this for node which represents the combination of parent values in question. of the CPT. The matrix column represent column index, the column in the table for this node which represents the value of the node in question.- Specified by:
setProbability
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node in question.probMatrix
- a matrix containing probabilities of a node along with its parents
-
setProbability
public void setProbability(int nodeIndex, int rowIndex, int colIndex, double value) Description copied from interface:BayesIm
Sets the probability for the given node at a given row and column in the table for that node. To get the node index, use getNodeIndex(). To get the row index, use getRowIndex(). To get the column index, use getCategoryIndex() from the underlying BayesPm(). The value returned will represent a conditional probability of the form P(N=v0 | P1=v1, P2=v2, ... , Pn=vn), where N is the node referenced by nodeIndex, v0 is the value referenced by colIndex, and the combination of parent values indicated is the combination indicated by rowIndex.- Specified by:
setProbability
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node in question.rowIndex
- the row in the table for this for node which represents the combination of parent values in question.colIndex
- the column in the table for this node which represents the value of the node in question.value
- the desired probability to be set.- See Also:
-
getCorrespondingNodeIndex
Description copied from interface:BayesIm
Returns the index of the given node in the given BayesIm.- Specified by:
getCorrespondingNodeIndex
in interfaceBayesIm
- Parameters:
nodeIndex
- the index of the node in this BayesIm.otherBayesIm
- the BayesIm in which the node is to be found.- Returns:
- the index of the node with the given name in the specified BayesIm.
-
clearRow
public void clearRow(int nodeIndex, int rowIndex) Description copied from interface:BayesIm
Assigns random probability values to the child values of this row that add to 1. -
randomizeRow
public void randomizeRow(int nodeIndex, int rowIndex) Description copied from interface:BayesIm
Assigns random probability values to the child values of this row that add to 1.- Specified by:
randomizeRow
in interfaceBayesIm
- Parameters:
nodeIndex
- the node for the table that this row belongs to.rowIndex
- the index of the row.
-
randomizeIncompleteRows
public void randomizeIncompleteRows(int nodeIndex) Description copied from interface:BayesIm
Randomizes any row in the table for the given node index that has a Double.NaN value in it.- Specified by:
randomizeIncompleteRows
in interfaceBayesIm
- Parameters:
nodeIndex
- the node for the table whose incomplete rows are to be randomized.
-
randomizeTable
public void randomizeTable(int nodeIndex) Description copied from interface:BayesIm
Randomizes every row in the table for the given node index.- Specified by:
randomizeTable
in interfaceBayesIm
- Parameters:
nodeIndex
- the node for the table to be randomized.
-
clearTable
public void clearTable(int nodeIndex) Description copied from interface:BayesIm
Randomizes every row in the table for the given node index.- Specified by:
clearTable
in interfaceBayesIm
- Parameters:
nodeIndex
- the node for the table to be randomized.
-
isIncomplete
public boolean isIncomplete(int nodeIndex, int rowIndex) Description copied from interface:BayesIm
Returns true iff the given row in the given node has a Double.NaN value in it.- Specified by:
isIncomplete
in interfaceBayesIm
- Parameters:
nodeIndex
- the node for the table whose incomplete rows are to be checked.rowIndex
- the index of the row in question.- Returns:
- true iff one of the values in the given row is Double.NaN.
-
isIncomplete
public boolean isIncomplete(int nodeIndex) Description copied from interface:BayesIm
Returns true iff the given node has a Double.NaN value in it.- Specified by:
isIncomplete
in interfaceBayesIm
- Parameters:
nodeIndex
- the node for the table whose incomplete rows are to be checked.- Returns:
- true iff any value in the table for the given node is Double.NaN.
-
simulateData
Description copied from interface:BayesIm
Simulates a sample with the given sample size.- Specified by:
simulateData
in interfaceBayesIm
- Specified by:
simulateData
in interfaceSimulator
- Parameters:
sampleSize
- the sample size.latentDataSaved
- true iff the latent data is to be saved.- Returns:
- the simulated sample as a DataSet.
-
simulateData
Description copied from interface:BayesIm
Overwrites the given dataSet with a new simulated dataSet, to avoid allocating memory. The given dataSet must have the necessary number of columns.- Specified by:
simulateData
in interfaceBayesIm
- Parameters:
dataSet
- the dataSet to be overwritten.latentDataSaved
- true iff the latent data is to be saved.- Returns:
- the simulated sample as a DataSet.
-
getVariables
Description copied from interface:BayesIm
Returns the list of variables.- Specified by:
getVariables
in interfaceBayesIm
- Specified by:
getVariables
in interfaceVariableSource
- Returns:
- the list of variable for this Bayes net.
-
getVariableNames
Description copied from interface:BayesIm
Returns the list of variable names.- Specified by:
getVariableNames
in interfaceBayesIm
- Specified by:
getVariableNames
in interfaceVariableSource
- Returns:
- the list of variable names for this Bayes net.
-
getMeasuredNodes
Description copied from interface:BayesIm
Returns the list of measured variables.- Specified by:
getMeasuredNodes
in interfaceBayesIm
- Returns:
- the list of measured variableNodes.
-
equals
Description copied from interface:BayesIm
Returns true iff this Bayes net is equal to the given Bayes net. The sense of equality may vary depending on the type of Bayes net. -
toString
Prints out the probability table for each variable. -
getEvidence
-