com.cra.figaro.algorithm.factored

VariableElimination

trait VariableElimination[T] extends FactoredAlgorithm[T] with OneTime

Trait of algorithms that perform variable elimination.

T

The type of entries in the factors.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. VariableElimination
  2. OneTime
  3. FactoredAlgorithm
  4. Algorithm
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val dependentAlgorithm: (Universe, List[NamedEvidence[_]]) ⇒ () ⇒ Double

    The algorithm to compute probability of specified evidence in a dependent universe.

    The algorithm to compute probability of specified evidence in a dependent universe. We use () => Double to represent this algorithm instead of an instance of ProbEvidenceAlgorithm. Typical usage is to return the result of ProbEvidenceAlgorithm.computeProbEvidence when invoked.

    Definition Classes
    FactoredAlgorithm
  2. abstract val dependentUniverses: List[(Universe, List[NamedEvidence[_]])]

    A list of universes that depend on this universe such that evidence on those universes should be taken into account in this universe.

    A list of universes that depend on this universe such that evidence on those universes should be taken into account in this universe.

    Definition Classes
    FactoredAlgorithm
  3. abstract def finish(factorsAfterElimination: Set[Factor[T]], eliminationOrder: List[Variable[_]]): Unit

    All implementation of variable elimination must specify what to do after variables have been eliminated.

  4. abstract def getFactors(neededElements: List[Element[_]], targetElements: List[Element[_]], upperBounds: Boolean = false): List[Factor[T]]

    All implementations of factored algorithms must specify a way to get the factors from the given universe and dependent universes.

    All implementations of factored algorithms must specify a way to get the factors from the given universe and dependent universes.

    Definition Classes
    FactoredAlgorithm
  5. abstract val semiring: Semiring[T]

    The sum, product operations on the factor types and appropriate values for zero and one must be defined.

    The sum, product operations on the factor types and appropriate values for zero and one must be defined.

    Definition Classes
    FactoredAlgorithm
  6. abstract val showTiming: Boolean

    Flag indicating whether the run time of each step should be displayed.

  7. abstract val targetElements: List[Element[_]]

    Target elements that should not be eliminated but should be available for querying.

  8. abstract val universe: Universe

    The universe on which this variable elimination algorithm should be applied.

    The universe on which this variable elimination algorithm should be applied.

    Definition Classes
    VariableEliminationFactoredAlgorithm

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. var active: Boolean

    Attributes
    protected
    Definition Classes
    Algorithm
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def cleanUp(): Unit

    Called when the algorithm is killed.

    Called when the algorithm is killed. By default, does nothing. Can be overridden.

    Definition Classes
    Algorithm
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val comparator: Option[(T, T) ⇒ Boolean]

    Some variable elimination algorithms, such as computing the most probable explanation, record values of variables as they are eliminated.

    Some variable elimination algorithms, such as computing the most probable explanation, record values of variables as they are eliminated. Such values are stored in a factor that maps values of the other variables to a value of the eliminated variable. This factor is produced by finding the value of the variable that "maximizes" the entry associated with the value in the product factor resulting from eliminating this variable, for some maximization function. The recordingFunction determines which of two entries is greater according to the maximization function. It returns true iff the second entry is greater. The recording function is an option so that variable elimination algorithms that do not use it can ignore it.

  11. var debug: Boolean

    By default, implementations that inherit this trait have no debug information.

    By default, implementations that inherit this trait have no debug information. Override this if you want a debugging option.

  12. def doElimination(allFactors: List[Factor[T]], targetVariables: Seq[Variable[_]]): Unit

    Attributes
    protected
  13. def doKill(): Unit

    Attributes
    protected
    Definition Classes
    OneTimeAlgorithm
  14. def doResume(): Unit

    Attributes
    protected
    Definition Classes
    OneTimeAlgorithm
  15. def doStart(): Unit

    Attributes
    protected
    Definition Classes
    OneTimeAlgorithm
  16. def doStop(): Unit

    Attributes
    protected
    Definition Classes
    OneTimeAlgorithm
  17. def eliminationOrder(factors: Traversable[Factor[T]], toPreserve: Traversable[Variable[_]]): List[Variable[_]]

    Method for choosing the elimination order.

    Method for choosing the elimination order. The default order chooses first the variable that minimizes the number of extra factor entries that would be created when it is eliminated. Override this method if you want a different rule.

  18. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  22. def getNeededElements(starterElements: List[Element[_]], depth: Int): (List[Element[_]], Boolean)

    Get the elements that are needed by the query target variables and the evidence variables.

    Get the elements that are needed by the query target variables and the evidence variables. Also compute the values of those variables to the given depth. Only get factors for elements that are actually used by the target variables. This is more efficient. Also, it avoids problems when values of unused elements have not been computed.

    In addition to getting all the needed elements, it determines if any of the conditioned, constrained, or dependent universe parent elements has * in its range. If any of these elements has * in its range, the lower and upper bounds of factors will be different, so we need to compute both. If they don't, we don't need to compute bounds.

    Definition Classes
    FactoredAlgorithm
  23. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  24. def initialize(): Unit

    Called when the algorithm is started before running any steps.

    Called when the algorithm is started before running any steps. By default, does nothing. Can be overridden.

    Definition Classes
    Algorithm
  25. def isActive: Boolean

    Definition Classes
    Algorithm
  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  27. def kill(): Unit

    Kill the algorithm so that it is inactive.

    Kill the algorithm so that it is inactive. It will no longer be able to provide answers.Throws AlgorithmInactiveException if the algorithm is not active.

    Definition Classes
    Algorithm
  28. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  31. var recordingFactors: List[Factor[_]]

    Attributes
    protected
  32. def resume(): Unit

    Resume the computation of the algorithm, if it has been stopped.

    Resume the computation of the algorithm, if it has been stopped. Throws AlgorithmInactiveException if the algorithm is not active.

    Definition Classes
    Algorithm
  33. def run(): Unit

    Run the algorithm, performing its computation to completion.

    Run the algorithm, performing its computation to completion.

    Definition Classes
    VariableEliminationOneTime
  34. def start(): Unit

    Start the algorithm and make it active.

    Start the algorithm and make it active. After it returns, the algorithm must be ready to provide answers. Throws AlgorithmActiveException if the algorithm is already active.

    Definition Classes
    Algorithm
  35. def starterElements: List[Element[_]]

    Elements towards which queries are directed.

    Elements towards which queries are directed. By default, these are the target elements. This is overridden by DecisionVariableElimination, where it also includes utility variables.

  36. def stop(): Unit

    Stop the algorithm from computing.

    Stop the algorithm from computing. The algorithm is still ready to provide answers after it returns. Throws AlgorithmInactiveException if the algorithm is not active.

    Definition Classes
    Algorithm
  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  38. var targetFactors: Map[Element[_], Factor[T]]

    Attributes
    protected[com.cra.figaro]
  39. def toString(): String

    Definition Classes
    AnyRef → Any
  40. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from OneTime

Inherited from FactoredAlgorithm[T]

Inherited from Algorithm

Inherited from AnyRef

Inherited from Any

Ungrouped