Class

com.cra.figaro.algorithm.decision

ProbQueryVariableEliminationDecision

Related Doc: package decision

Permalink

class ProbQueryVariableEliminationDecision[T, U] extends OneTimeProbQuery with ProbabilisticVariableEliminationDecision with DecisionAlgorithm[T, U]

Decision VariableElimination algorithm that computes the expected utility of decision elements using the default elimination order.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ProbQueryVariableEliminationDecision
  2. DecisionAlgorithm
  3. ProbabilisticVariableEliminationDecision
  4. VariableElimination
  5. FactoredAlgorithm
  6. OneTimeProbQuery
  7. OneTime
  8. ProbQueryAlgorithm
  9. BaseProbQueryAlgorithm
  10. Algorithm
  11. AnyRef
  12. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ProbQueryVariableEliminationDecision(universe: Universe, utilityNodes: List[Element[_]], target: Element[_])(showTiming: Boolean, dependentUniverses: List[(Universe, List[NamedEvidence[_]])], dependentAlgorithm: (Universe, List[NamedEvidence[_]]) ⇒ () ⇒ Double)

    Permalink

Type Members

  1. class NotATargetException[T] extends AlgorithmException

    Permalink
    Definition Classes
    BaseProbQueryAlgorithm

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. var active: Boolean

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

    Permalink
    Definition Classes
    Any
  6. def cleanUp(): Unit

    Permalink

    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

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

    Permalink

    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)]

    Permalink

    Returns distribution of the target, ignoring utilities.

    Returns distribution of the target, ignoring utilities.

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

    Permalink

    Returns expectation of the target, ignoring utilities

    Returns expectation of the target, ignoring utilities

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

    Permalink

    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)]

    Permalink
    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    BaseProbQueryAlgorithm
  13. def computeUtility(): Map[(T, U), DecisionSample]

    Permalink

    Returns the computed utility of all parent/decision tuple values.

    Returns the computed utility of all parent/decision tuple values. For VE, these are not samples but the actual computed expected utility for all combinations of the parent and decision.

    Definition Classes
    ProbQueryVariableEliminationDecisionDecisionAlgorithm
  14. var debug: Boolean

    Permalink

    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
  15. val dependentAlgorithm: (Universe, List[NamedEvidence[_]]) ⇒ () ⇒ Double

    Permalink

    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
    ProbQueryVariableEliminationDecisionFactoredAlgorithm
  16. val dependentUniverses: List[(Universe, List[NamedEvidence[_]])]

    Permalink

    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
    ProbQueryVariableEliminationDecisionFactoredAlgorithm
  17. def distribution[T](target: Element[T]): Stream[(Double, T)]

    Permalink

    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
  18. def doDistribution[T](target: Element[T]): Stream[(Double, T)]

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    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
  31. def finalize(): Unit

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

    Permalink

    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
    ProbQueryVariableEliminationDecisionVariableElimination
  33. final def getClass(): Class[_]

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

    Permalink

    Create the factors for decision factors.

    Create the factors for decision factors. Each factor is hardcoded as a tuple of (Double, Double), where the first value is the probability and the second is the utility.

    Definition Classes
    ProbabilisticVariableEliminationDecisionFactoredAlgorithm
  35. def getNeededElements(starterElements: List[Element[_]], depth: Int): (List[Element[_]], Boolean)

    Permalink

    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
  36. def getUtility(p: T, d: U): DecisionSample

    Permalink

    Get the total utility and weight for a specific value of a parent and decision.

    Get the total utility and weight for a specific value of a parent and decision.

    Definition Classes
    DecisionAlgorithm
  37. def getUtility(): Map[(T, U), DecisionSample]

    Permalink

    Get the total utility and weight for all sampled values of the parent and decision.

    Get the total utility and weight for all sampled values of the parent and decision.

    Definition Classes
    DecisionAlgorithm
  38. def getUtilityNodes: List[Element[_]]

    Permalink

    Retrieve utility nodes in the model

    Retrieve utility nodes in the model

    Definition Classes
    ProbQueryVariableEliminationDecisionProbabilisticVariableEliminationDecision
  39. def hashCode(): Int

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

    Permalink
    Attributes
    protected
    Definition Classes
    VariableElimination
  41. def initialize(): Unit

    Permalink

    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
  42. def isActive: Boolean

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

    Permalink
    Definition Classes
    Any
  44. def kill(): Unit

    Permalink

    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
  45. def makeUtilFactor(e: Element[_]): Factor[(Double, Double)]

    Permalink

    Makes a utility factor an element designated as a utility.

    Makes a utility factor an element designated as a utility. This is factor of a tuple (Double, Double) where the first value is 1.0 and the second is a possible utility of the element.

    Definition Classes
    ProbabilisticVariableEliminationDecision
  46. def mean(target: Element[Double]): Double

    Permalink

    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
  47. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  48. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  49. final def notifyAll(): Unit

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

    Permalink

    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
  51. def probability[T](target: Element[T], value: T): Double

    Permalink

    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
  52. def probability[T](target: Element[T], predicate: (T) ⇒ Boolean): Double

    Permalink

    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
  53. lazy val queryTargets: List[Element[_$6]] forSome {type _$6}

    Permalink
  54. var recordingFactors: List[Factor[_]]

    Permalink
    Attributes
    protected
    Definition Classes
    VariableElimination
  55. def resume(): Unit

    Permalink

    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
  56. def run(): Unit

    Permalink

    Run the algorithm, performing its computation to completion.

    Run the algorithm, performing its computation to completion.

    Definition Classes
    VariableEliminationOneTime
  57. val semiring: SumProductUtilitySemiring

    Permalink

    Semiring for Decisions uses a sum-product-utility semiring.

    Semiring for Decisions uses a sum-product-utility semiring.

    Definition Classes
    ProbabilisticVariableEliminationDecisionFactoredAlgorithm
  58. def setPolicy(e: Decision[T, U]): Unit

    Permalink

    Sets the policy for the given decision.

    Sets the policy for the given decision. This will get the computed utility of the algorithm and call setPolicy on the decision. Note there is no error checking here, so the decision in the argument must match the target decision in the algorithm.

    Definition Classes
    DecisionAlgorithm
  59. val showTiming: Boolean

    Permalink

    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
    ProbQueryVariableEliminationDecisionVariableElimination
  60. def start(): Unit

    Permalink

    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
  61. def starterElements: List[Element[_]]

    Permalink

    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
    ProbabilisticVariableEliminationDecisionVariableElimination
  62. def stop(): Unit

    Permalink

    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
  63. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  64. val targetElements: List[Element[_ >: _$9 with _$6]] forSome {type _$9, type _$6}

    Permalink

    The variable elimination eliminates all variables except on all decision nodes and their parents.

    The variable elimination eliminates all variables except on all decision nodes and their parents. Thus the target elements is both the decision element and the parent element.

    Definition Classes
    ProbQueryVariableEliminationDecisionVariableElimination
  65. var targetFactors: Map[Element[_], Factor[(Double, Double)]]

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

    Permalink
    Definition Classes
    AnyRef → Any
  67. val universe: Universe

    Permalink

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

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

    Definition Classes
    ProbQueryVariableEliminationDecisionVariableEliminationFactoredAlgorithmProbQueryAlgorithm
  68. def variance(target: Element[Double]): Double

    Permalink

    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
  69. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from DecisionAlgorithm[T, U]

Inherited from VariableElimination[(Double, Double)]

Inherited from FactoredAlgorithm[(Double, Double)]

Inherited from OneTimeProbQuery

Inherited from OneTime

Inherited from ProbQueryAlgorithm

Inherited from Algorithm

Inherited from AnyRef

Inherited from Any

Ungrouped