Package edu.cmu.tetrad.graph

Class IndependenceFact

java.lang.Object

edu.cmu.tetrad.graph.IndependenceFact

All Implemented Interfaces:

TetradSerializable, Serializable, Comparable<IndependenceFact>

public final class IndependenceFact
extends Object
implements TetradSerializable, Comparable<IndependenceFact>

Stores a triple (x, y, z) of nodes. Note that (x, y, z) = (z, y, x). Useful for marking graphs.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IndependenceFact(Node x, Node y, Node... z)	Constructor for IndependenceFact.
IndependenceFact(Node x, Node y, Set<Node> z)	Constructor for IndependenceFact.

Method Summary

Modifier and Type	Method	Description
int	compareTo(IndependenceFact fact)	Note that this compareTo method gives a lexical ordering for independence facts and doesn't reflect independence fact equality.
boolean	equals(Object obj)
Node	getX()	Getter for the field x.
Node	getY()	Getter for the field y.
Set<Node>	getZ()	getZ.
int	hashCode()	hashCode.
static IndependenceFact	serializableInstance()	Generates a simple exemplar of this class to test serialization.
String	toString()	toString.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

IndependenceFact

public IndependenceFact(Node x,
 Node y,
 Set<Node> z)

Constructor for IndependenceFact.

Parameters:

x - a Node object

y - a Node object

z - a Set object

IndependenceFact

public IndependenceFact(Node x,
 Node y,
 Node... z)

Constructor for IndependenceFact.

Parameters:

x - a Node object

y - a Node object

z - a Node object

Method Details

serializableInstance

public static IndependenceFact serializableInstance()

Generates a simple exemplar of this class to test serialization.

Returns:

a IndependenceFact object

getX

public Node getX()

Getter for the field x.

Returns:

a Node object

getY

public Node getY()

Getter for the field y.

Returns:

a Node object

getZ

public Set<Node> getZ()

getZ.

Returns:

a Set object

hashCode

public int hashCode()

hashCode.

Overrides:

hashCode in class Object

Returns:

a int

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

toString.

Overrides:

toString in class Object

Returns:

a String object

compareTo

public int compareTo(IndependenceFact fact)

Note that this compareTo method gives a lexical ordering for independence facts and doesn't reflect independence fact equality. So sorted sets should not be used to check for independence fact existence, for instance. -jdramsey.

Specified by:

compareTo in interface Comparable<IndependenceFact>

Parameters:

fact - a IndependenceFact object

Returns:

a int