com.cra.figaro.algorithm.factored

ProbQueryVariableElimination

Related Doc: package factored

class ProbQueryVariableElimination extends OneTimeProbQuery with ProbabilisticVariableElimination

Variable elimination algorithm that computes the conditional probability of query elements.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ProbQueryVariableElimination
  2. ProbabilisticVariableElimination
  3. VariableElimination
  4. FactoredAlgorithm
  5. OneTimeProbQuery
  6. OneTime
  7. ProbQueryAlgorithm
  8. BaseProbQueryAlgorithm
  9. Algorithm
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ProbQueryVariableElimination(universe: Universe, targets: Element[_]*)(showTiming: Boolean, dependentUniverses: List[(Universe, List[NamedEvidence[_]])], dependentAlgorithm: (Universe, List[NamedEvidence[_]]) ⇒ () ⇒ Double)

Type Members

  1. class NotATargetException[T] extends AlgorithmException

    Definition Classes
    BaseProbQueryAlgorithm

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. var 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[(Double, Double) ⇒ 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.

    Definition Classes
    VariableElimination
  9. def computeDistribution[T](target: Element[T]): Stream[(Double, T)]

    Computes the normalized distribution over a single target element.

    Computes the normalized distribution over a single target element.

    Definition Classes
    ProbQueryVariableEliminationBaseProbQueryAlgorithm
  10. def computeExpectation[T](target: Element[T], function: (T) ⇒ Double): Double

    Computes the expectation of a given function for single target element.

    Computes the expectation of a given function for single target element.

    Definition Classes
    ProbQueryVariableEliminationBaseProbQueryAlgorithm
  11. def computeProbability[T](target: Element[T], predicate: (T) ⇒ Boolean): Double

    Return an estimate of the probability of the predicate under the marginal probability distribution of the target.

    Return an estimate of the probability of the predicate under the marginal probability distribution of the target.

    Definition Classes
    BaseProbQueryAlgorithm
  12. def computeProjection[T](target: Element[T]): List[(T, Double)]

    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    BaseProbQueryAlgorithm
  13. 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.

    Definition Classes
    VariableElimination
  14. 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
    ProbQueryVariableEliminationFactoredAlgorithm
  15. 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
    ProbQueryVariableEliminationFactoredAlgorithm
  16. def distribution[T](target: Element[T]): Stream[(Double, T)]

    Return an estimate of the marginal probability distribution over the target that lists each element with its probability.

    Return an estimate of the marginal probability distribution over the target that lists each element with its probability. The result is a lazy stream. It is up to the algorithm how the stream is ordered. Throws NotATargetException if called on a target that is not in the list of targets of the algorithm. Throws AlgorithmInactiveException if the algorithm is inactive.

    Definition Classes
    BaseProbQueryAlgorithm
  17. def doDistribution[T](target: Element[T]): Stream[(Double, T)]

    Attributes
    protected
    Definition Classes
    OneTimeProbQueryBaseProbQueryAlgorithm
  18. def doElimination(allFactors: List[Factor[Double]], targetVariables: Seq[Variable[_]]): Unit

    Attributes
    protected
    Definition Classes
    VariableElimination
  19. def doExpectation[T](target: Element[T], function: (T) ⇒ Double): Double

    Attributes
    protected
    Definition Classes
    OneTimeProbQueryBaseProbQueryAlgorithm
  20. def doKill(): Unit

    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    OneTimeAlgorithm
  21. def doProbability[T](target: Element[T], predicate: (T) ⇒ Boolean): Double

    Attributes
    protected
    Definition Classes
    OneTimeProbQueryBaseProbQueryAlgorithm
  22. def doProjection[T](target: Element[T]): List[(T, Double)]

    Attributes
    protected
    Definition Classes
    OneTimeProbQueryBaseProbQueryAlgorithm
  23. def doResume(): Unit

    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    OneTimeAlgorithm
  24. def doStart(): Unit

    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    OneTimeAlgorithm
  25. def doStop(): Unit

    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    OneTimeAlgorithm
  26. def eliminateInOrder(order: List[Variable[_]], factors: MultiSet[Factor[Double]], map: FactorMap[Double]): MultiSet[Factor[Double]]

    Attributes
    protected
    Definition Classes
    VariableElimination
  27. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  29. def expectation[T](target: Element[T], function: (T) ⇒ Double): Double

    Return an estimate of the expectation of the function under the marginal probability distribution of the target.

    Return an estimate of the expectation of the function under the marginal probability distribution of the target. Throws NotATargetException if called on a target that is not in the list of targets of the algorithm. Throws AlgorithmInactiveException if the algorithm is inactive.

    Definition Classes
    BaseProbQueryAlgorithm
  30. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. def finish(factorsAfterElimination: MultiSet[Factor[Double]], eliminationOrder: List[Variable[_]]): Unit

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

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

    Definition Classes
    ProbQueryVariableEliminationVariableElimination
  32. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  33. def getFactors(allElements: List[Element[_]], targetElements: List[Element[_]], upper: Boolean = false): List[Factor[Double]]

    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
    ProbabilisticVariableEliminationFactoredAlgorithm
  34. 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
  35. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  36. def initialFactorMap(factors: Traversable[Factor[Double]]): FactorMap[Double]

    Attributes
    protected
    Definition Classes
    VariableElimination
  37. 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
  38. def isActive: Boolean

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

    Definition Classes
    Any
  40. 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
  41. def mean(target: Element[Double]): Double

    Return the mean of the probability density function for the given continuous element.

    Return the mean of the probability density function for the given continuous element.

    Definition Classes
    BaseProbQueryAlgorithm
  42. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  45. def posteriorElement[T](target: Element[T], universe: Universe = Universe.universe): Element[T]

    Return an element representing the posterior probability distribution of the given element.

    Return an element representing the posterior probability distribution of the given element.

    Definition Classes
    ProbQueryAlgorithm
  46. def probability[T](target: Element[T], value: T): Double

    Return an estimate of the probability that the target produces the value.

    Return an estimate of the probability that the target produces the value. Throws NotATargetException if called on a target that is not in the list of targets of the algorithm. Throws AlgorithmInactiveException if the algorithm is inactive.

    Definition Classes
    BaseProbQueryAlgorithm
  47. def probability[T](target: Element[T], predicate: (T) ⇒ Boolean): Double

    Return an estimate of the probability of the predicate under the marginal probability distribution of the target.

    Return an estimate of the probability of the predicate under the marginal probability distribution of the target. Throws NotATargetException if called on a target that is not in the list of targets of the algorithm. Throws AlgorithmInactiveException if the algorithm is inactive.

    Definition Classes
    BaseProbQueryAlgorithm
  48. lazy val queryTargets: List[Element[_]]

  49. var recordingFactors: List[Factor[_]]

    Attributes
    protected
    Definition Classes
    VariableElimination
  50. 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
  51. def run(): Unit

    Run the algorithm, performing its computation to completion.

    Run the algorithm, performing its computation to completion.

    Definition Classes
    VariableEliminationOneTime
  52. val semiring: SumProductSemiring

    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
    ProbQueryVariableEliminationFactoredAlgorithm
  53. val showTiming: Boolean

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

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

    Definition Classes
    ProbQueryVariableEliminationVariableElimination
  54. 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
  55. 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.

    Definition Classes
    VariableElimination
  56. 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
  57. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  58. val targetElements: List[Element[_]]

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

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

    Definition Classes
    ProbQueryVariableEliminationVariableElimination
  59. var targetFactors: Map[Element[_], Factor[Double]]

    Attributes
    protected[com.cra.figaro]
    Definition Classes
    VariableElimination
  60. def toString(): String

    Definition Classes
    AnyRef → Any
  61. 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
    ProbQueryVariableEliminationVariableEliminationFactoredAlgorithmProbQueryAlgorithm
  62. def variance(target: Element[Double]): Double

    Return the variance of the probability density function for the given continuous element.

    Return the variance of the probability density function for the given continuous element.

    Definition Classes
    BaseProbQueryAlgorithm
  63. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from VariableElimination[Double]

Inherited from FactoredAlgorithm[Double]

Inherited from OneTimeProbQuery

Inherited from OneTime

Inherited from ProbQueryAlgorithm

Inherited from Algorithm

Inherited from AnyRef

Inherited from Any

Ungrouped