COM.hugin.HAPI
Class JunctionTree

java.lang.Object
  |
  +--COM.hugin.HAPI.JunctionTree

public class JunctionTree
extends java.lang.Object

Thic class represents the JunctionTrees in the compiled domain.


Method Summary
 boolean cgEvidenceIsPropagated()
          Returns 'true' if CG evidence has been propagated in this JunctionTree; otherwise, returns 'false'.
 boolean equilibriumIs(Domain.Equilibrium equilibrium)
          Tests the Equilibrium type.
 boolean evidenceIsPropagated()
          Returns 'true' if evidence has been propagated in this JunctionTree; otherwise, returns 'false'.
 boolean evidenceModeIs(Domain.EvidenceMode mode)
          Returns 'true' if the EvidenceMode matches 'mode'; otherwise, returns 'false'.
 boolean evidenceToPropagate()
          Returns 'true' if the JunctionTree contains evidence that has not been propagated; otherwise, returns 'false'.
 CliqueList getCliques()
          Returns the Cliques of this JunctionTree.
 double getConflict()
          Returns the conflict measure of the data inserted in this JunctionTree.
 Clique getRoot()
          Returns the root clique of this JunctionTree.
 boolean likelihoodIsPropagated()
          Returns 'true' if likelihoods have been propagated in this JunctionTree; otherwise, returns 'false'.
 void propagate(Domain.Equilibrium equilibrium, Domain.EvidenceMode evidenceMode)
          Propagates evidence in this JunctionTree.
 boolean tablesToPropagate()
          Returns 'true' if this JunctionTree contains updated tables that have not been propagated; otherwise, returns 'false'.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

cgEvidenceIsPropagated

public boolean cgEvidenceIsPropagated()
                               throws ExceptionObjectNotAlive
Returns 'true' if CG evidence has been propagated in this JunctionTree; otherwise, returns 'false'.

Returns:
A boolean.

equilibriumIs

public boolean equilibriumIs(Domain.Equilibrium equilibrium)
                      throws ExceptionObjectNotAlive
Tests the Equilibrium type. Returns 'true' if the equilibrium of this JunctionTree can be obtained through a propagation using 'equilibrium' as the Equilibrium type; otherwise, returns 'false'.

Parameters:
equilibrium - the type of Equilibrium to test for.
Returns:
A boolean.

evidenceIsPropagated

public boolean evidenceIsPropagated()
                             throws ExceptionObjectNotAlive
Returns 'true' if evidence has been propagated in this JunctionTree; otherwise, returns 'false'.

Returns:
A boolean.

evidenceModeIs

public boolean evidenceModeIs(Domain.EvidenceMode mode)
                       throws ExceptionObjectNotAlive
Returns 'true' if the EvidenceMode matches 'mode'; otherwise, returns 'false'.

Parameters:
mode - the type of EvidenceMode to test for.
Returns:
A boolean.

evidenceToPropagate

public boolean evidenceToPropagate()
                            throws ExceptionObjectNotAlive
Returns 'true' if the JunctionTree contains evidence that has not been propagated; otherwise, returns 'false'.

Returns:
A boolean

getCliques

public CliqueList getCliques()
                      throws ExceptionObjectNotAlive
Returns the Cliques of this JunctionTree.

Returns:
A CliqueList

getConflict

public double getConflict()
                   throws ExceptionHugin,
                          ExceptionObjectNotAlive
Returns the conflict measure of the data inserted in this JunctionTree.

Returns:
A double.

getRoot

public Clique getRoot()
               throws ExceptionObjectNotAlive
Returns the root clique of this JunctionTree.

Returns:
A Clique.

likelihoodIsPropagated

public boolean likelihoodIsPropagated()
                               throws ExceptionObjectNotAlive
Returns 'true' if likelihoods have been propagated in this JunctionTree; otherwise, returns 'false'.

Returns:
A boolean.

propagate

public void propagate(Domain.Equilibrium equilibrium,
                      Domain.EvidenceMode evidenceMode)
               throws ExceptionObjectNotAlive
Propagates evidence in this JunctionTree.

Parameters:
equilibrium - the type of Equilibrium reached after the propagation.
evidenceMode - the EvidenceMode used.

tablesToPropagate

public boolean tablesToPropagate()
                          throws ExceptionObjectNotAlive
Returns 'true' if this JunctionTree contains updated tables that have not been propagated; otherwise, returns 'false'.

Returns:
A boolean.