Package edu.cmu.tetrad.bayes

Class Proposition

java.lang.Object

edu.cmu.tetrad.bayes.Proposition

All Implemented Interfaces:

TetradSerializable, Serializable

public final class Proposition
extends Object
implements TetradSerializable

Represents propositions over the variables of a particular BayesIm describing an event of a fairly general sort--namely, conjunctions of propositions that particular variables take on values from a particular disjunctive list of categories. For example, X1 = 1 or 2 and X2 = 3 and X3 = 1 or 3 and X4 = 2 or 3 or 5. The proposition is created by allowing or disallowing particular categories. Notice that "knowing nothing" about a variable is the same as saying that all categories for that variable are allowed, so the proposition by default allows all categories for all variables--i.e. it is a tautology.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Proposition(Proposition proposition)	Copies the info out of the old proposition into a new proposition for the new BayesIm.
Proposition(VariableSource variableSource, Proposition proposition)	Copies the info out of the old proposition into a new proposition for the new BayesIm.

Method Summary

Modifier and Type	Method	Description
void	addCategory(int variable, int category)	addCategory.
void	disallowComplement(int variable, int category)	Without changing the status of the specified category, disallows all other categories for the given variable.
boolean	equals(Object o)
boolean	existsCombination()	existsCombination.
int	getCategoryIndex(String nodeName, String category)	getCategoryIndex.
int	getNodeIndex(String name)	getNodeIndex.
int	getNumAllowed(int variable)	getNumAllowed.
int	getNumAllowedCategories(int i)	getNumAllowedCategories.
int	getNumCategories(int variable)	getNumCategories.
int	getNumVariables()	getNumVariables.
int	getSingleCategory(int variable)	getSingleCategory.
VariableSource	getVariableSource()	Getter for the field variableSource.
int	hashCode()	hashCode.
boolean	isAllowed(int variable, int category)	isAllowed.
boolean	isConditioned(int variable)	isConditioned.
boolean	isPermissibleCombination(int[] point)	isPermissibleCombination.
void	removeCategory(int variable, int category)	removeCategory.
void	restrictToProposition(Proposition proposition)	Restricts this proposition to the categories for each variable that are true in the given proposition.
static Proposition	serializableInstance()	Generates a simple exemplar of this class to test serialization.
void	setCategory(int variable, int category)	Sets the given value to true and all other values to false for the given variable.
void	setToTautology()	Specifies that all variables in the proposition are either completely allowed (true) or completely disallowed (false) for all of their categories.
void	setVariable(int variable, boolean allowed)	Specifies that all categories for the given variable are either all allowed (true) or all disallowed (false).
static Proposition	tautology(VariableSource variableSource)	tautology.
String	toString()	toString.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Proposition

public Proposition(VariableSource variableSource,
 Proposition proposition)

Copies the info out of the old proposition into a new proposition for the new BayesIm.

Parameters:

variableSource - a VariableSource object

proposition - a Proposition object

Proposition

public Proposition(Proposition proposition)

Copies the info out of the old proposition into a new proposition for the new BayesIm.

Parameters:

proposition - a Proposition object

Method Details

tautology

public static Proposition tautology(VariableSource variableSource)

tautology.

Parameters:

variableSource - a VariableSource object

Returns:

a Proposition object

serializableInstance

public static Proposition serializableInstance()

Generates a simple exemplar of this class to test serialization.

Returns:

a Proposition object

getNumAllowedCategories

public int getNumAllowedCategories(int i)

getNumAllowedCategories.

Parameters:

i - a int

Returns:

a int

removeCategory

public void removeCategory(int variable,
 int category)

removeCategory.

Parameters:

variable - a int

category - a int

disallowComplement

public void disallowComplement(int variable,
 int category)

Without changing the status of the specified category, disallows all other categories for the given variable.

Parameters:

variable - a int

category - a int

setCategory

public void setCategory(int variable,
 int category)

Sets the given value to true and all other values to false for the given variable.

Parameters:

variable - a int

category - a int

isPermissibleCombination

public boolean isPermissibleCombination(int[] point)

isPermissibleCombination.

Parameters:

point - an array of objects

Returns:

true iff the given point is true for this proposition.

existsCombination

public boolean existsCombination()

existsCombination.

Returns:

true iff there is some combination of categories for all the variables of the proposition that is allowed.

getNumAllowed

public int getNumAllowed(int variable)

getNumAllowed.

Parameters:

variable - a int

Returns:

a int

getSingleCategory

public int getSingleCategory(int variable)

getSingleCategory.

Parameters:

variable - a int

Returns:

the single category selected for the given variable, or -1 if it is not the case that a single value is selected.

restrictToProposition

public void restrictToProposition(Proposition proposition)

Restricts this proposition to the categories for each variable that are true in the given proposition.

Parameters:

proposition - a Proposition object

getNodeIndex

public int getNodeIndex(String name)

getNodeIndex.

Parameters:

name - a String object

Returns:

the index of the variable with the given name, or -1 if such a variable does not exist.

getCategoryIndex

public int getCategoryIndex(String nodeName,
 String category)

getCategoryIndex.

Parameters:

nodeName - a String object

category - a String object

Returns:

a int

addCategory

public void addCategory(int variable,
 int category)

addCategory.

Parameters:

variable - a int

category - a int

getVariableSource

public VariableSource getVariableSource()

Getter for the field variableSource.

Returns:

the Bayes IM that this is a proposition for.

getNumVariables

public int getNumVariables()

getNumVariables.

Returns:

the number of variables for the proposition.

getNumCategories

public int getNumCategories(int variable)

getNumCategories.

Parameters:

variable - a int

Returns:

the number of categories for the given variable.

setVariable

public void setVariable(int variable,
 boolean allowed)

Specifies that all categories for the given variable are either all allowed (true) or all disallowed (false).

Parameters:

variable - a int

allowed - a boolean

setToTautology

public void setToTautology()

Specifies that all variables in the proposition are either completely allowed (true) or completely disallowed (false) for all of their categories.

isAllowed

public boolean isAllowed(int variable,
 int category)

isAllowed.

Parameters:

variable - a int

category - a int

Returns:

true iff the given category for the given variable is allowed.

isConditioned

public boolean isConditioned(int variable)

isConditioned.

Parameters:

variable - a int

Returns:

true iff some category for the given variable is disallowed.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

hashCode.

Overrides:

hashCode in class Object

Returns:

a int

toString

public String toString()

toString.

Overrides:

toString in class Object

Returns:

a String object