Package com.bayesserver.learning.structure

Class LinkConstraint

java.lang.Object

com.bayesserver.learning.structure.LinkConstraint

public final class LinkConstraint
extends Object

Defines a constraint on a link between two nodes during structural learning.

Constructor Summary

Constructors

Constructor	Description
LinkConstraint(Node a, Node b, LinkConstraintMethod method, LinkConstraintFailureMode failureMode)	Initializes a new instance of the LinkConstraint class.
LinkConstraint(Node a, Node b, Integer temporalOrder, LinkConstraintMethod method, LinkConstraintFailureMode failureMode)	Initializes a new instance of the LinkConstraint class.

Method Summary

Modifier and Type	Method	Description
Node	getA()	Gets the first node involved in the constraint.
Node	getB()	Gets the second node involved in the constraint.
LinkConstraintFailureMode	getFailureMode()	Gets the action to take when this link constraint is violated.
LinkConstraintMethod	getMethod()	Gets the method used to constrain nodes getA() and getB().
Integer	getTemporalOrder()	Gets the temporal order of the constraint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LinkConstraint

public LinkConstraint(Node a,
                      Node b,
                      LinkConstraintMethod method,
                      LinkConstraintFailureMode failureMode)

Initializes a new instance of the LinkConstraint class.

Parameters:

a - The first node in the link constraint.

b - The second node in the link constraint.

method - The constraint method.

failureMode - The action taken if the link constraint is violated.

Throws:

NullPointerException - Raised if either [a] or [b] is null.

LinkConstraint

public LinkConstraint(Node a,
                      Node b,
                      Integer temporalOrder,
                      LinkConstraintMethod method,
                      LinkConstraintFailureMode failureMode)

Initializes a new instance of the LinkConstraint class.

Parameters:

a - The first node in the link constraint.

b - The second node in the link constraint.

temporalOrder - The order of the temporal link constraint (temporal nodes only).

method - The constraint method.

failureMode - The action taken if the link constraint is violated.

Throws:

NullPointerException - Raised if either [a] or [b] is null.

Method Detail

getA

public Node getA()

Gets the first node involved in the constraint. The type of constraint is defined using the getMethod().

See Also:

getMethod()

getB

public Node getB()

Gets the second node involved in the constraint. The type of constraint is defined using the getMethod().

See Also:

getMethod()

getTemporalOrder

public Integer getTemporalOrder()

Gets the temporal order of the constraint. Used for temporal links such as those found in time series and sequence networks (Dynamic Bayesian networks).

getMethod

public LinkConstraintMethod getMethod()

Gets the method used to constrain nodes getA() and getB().

getFailureMode

public LinkConstraintFailureMode getFailureMode()

Gets the action to take when this link constraint is violated.