t

# VariableElimination 

### Companion object 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
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
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: MultiSet[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

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: Any): Boolean
Definition Classes
AnyRef → Any
2. final def ##(): Int
Definition Classes
AnyRef → Any
3. final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
4. val active: Boolean
Attributes
protected
Definition Classes
Algorithm
5. final def asInstanceOf[T0]: T0
Definition Classes
Any
6. 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
7. def clone(): AnyRef
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
8. 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.

9. val 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.

10. def doElimination(allFactors: List[Factor[T]], targetVariables: Seq[Variable[_]]): Unit
Attributes
protected
11. def doKill(): Unit
Attributes
protected[com.cra.figaro.algorithm]
Definition Classes
OneTimeAlgorithm
12. def doResume(): Unit
Attributes
protected[com.cra.figaro.algorithm]
Definition Classes
OneTimeAlgorithm
13. def doStart(): Unit
Attributes
protected[com.cra.figaro.algorithm]
Definition Classes
OneTimeAlgorithm
14. def doStop(): Unit
Attributes
protected[com.cra.figaro.algorithm]
Definition Classes
OneTimeAlgorithm
15. def eliminateInOrder(order: List[Variable[_]], factors: MultiSet[Factor[T]], map: FactorMap[T]): MultiSet[Factor[T]]
Attributes
protected
16. final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
17. def equals(arg0: Any): Boolean
Definition Classes
AnyRef → Any
18. def finalize(): Unit
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
19. final def getClass(): Class[_]
Definition Classes
AnyRef → Any
20. def getNeededElements(starterElements: List[Element[_]], depth: Int, parameterized: Boolean = false): (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
21. def hashCode(): Int
Definition Classes
AnyRef → Any
22. def initialFactorMap(factors: Traversable[Factor[T]]): FactorMap[T]
Attributes
protected
23. 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
24. def isActive: Boolean
Definition Classes
Algorithm
25. final def isInstanceOf[T0]: Boolean
Definition Classes
Any
26. 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
27. final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
28. final def notify(): Unit
Definition Classes
AnyRef
29. final def notifyAll(): Unit
Definition Classes
AnyRef
30. val recordingFactors: List[Factor[_]]
Attributes
protected
31. 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
32. def run(): Unit

Run the algorithm, performing its computation to completion.

Run the algorithm, performing its computation to completion.

Definition Classes
VariableEliminationOneTime
33. 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
34. 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.

35. 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
36. final def synchronized[T0](arg0: ⇒ T0): T0
Definition Classes
AnyRef
37. val targetFactors: Map[Element[_], Factor[T]]
Attributes
protected[com.cra.figaro]
38. def toString(): String
Definition Classes
AnyRef → Any
39. final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws( ... )
40. final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws( ... )
41. final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws( ... )