c

com.cra.figaro.experimental.marginalmap

StructuredMarginalMAPAlgorithm

abstract class StructuredMarginalMAPAlgorithm extends StructuredAlgorithm with MarginalMAPAlgorithm

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StructuredMarginalMAPAlgorithm
  2. MarginalMAPAlgorithm
  3. StructuredAlgorithm
  4. Algorithm
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StructuredMarginalMAPAlgorithm(universe: Universe, mapElements: Element[_]*)
  2. new StructuredMarginalMAPAlgorithm(universe: Universe, collection: ComponentCollection, mapElements: Element[_]*)

    universe

    Universe on which to perform inference.

    mapElements

    Elements for which to compute MAP queries. Elements not in this sequence are summed over.

Type Members

  1. class NotATargetException [T] extends AlgorithmException
    Definition Classes
    MarginalMAPAlgorithm

Abstract Value Members

  1. abstract def doKill(): Unit
    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    Algorithm
  2. abstract def doMostLikelyValue[T](target: Element[T]): T
    Attributes
    protected
    Definition Classes
    MarginalMAPAlgorithm
  3. abstract def doResume(): Unit
    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    Algorithm
  4. abstract def doStart(): Unit
    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    Algorithm
  5. abstract def doStop(): Unit
    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    Algorithm
  6. abstract def rangingStrategy: RangingStrategy

    Strategy to use for ranging atomic components.

    Strategy to use for ranging atomic components. This is only called once. Note that this is called during initialization, so subclasses that override this can declare this as a lazy val or a def but not a val.

    Definition Classes
    StructuredAlgorithm
  7. abstract def refiningStrategy(): RefiningStrategy

    Strategy to use for refinement at a single iteration.

    Strategy to use for refinement at a single iteration. This may return a new strategy for each iteration.

    returns

    A refining strategy to be used for a single iteration.

    Definition Classes
    StructuredAlgorithm
  8. abstract def solvingStrategy(): SolvingStrategy

    Strategy to use for solving at a single iteration.

    Strategy to use for solving at a single iteration. This may return a new strategy for each iteration.

    returns

    A solving strategy to be used for a single iteration.

    Definition Classes
    StructuredAlgorithm

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 check[T](target: Element[T]): Unit
    Attributes
    protected
    Definition Classes
    MarginalMAPAlgorithm
  7. def checkConstraintBounds(): Unit

    Verify that all constraint factors satisfy the bounds needed for the correctness of this algorithm.

    Verify that all constraint factors satisfy the bounds needed for the correctness of this algorithm. This gets executed before solving. By default, this method does nothing; subclasses can override this to throw an exception if the bounds requirements are not met.

    Definition Classes
    StructuredAlgorithm
  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 collection: ComponentCollection
    Definition Classes
    StructuredAlgorithm
  11. def computeMostLikelyValue[T](target: Element[T]): T

    Returns the most likely value for the target element.

    Returns the most likely value for the target element. Throws an IllegalArgumentException if the range of the target contains star.

    Definition Classes
    StructuredMarginalMAPAlgorithmMarginalMAPAlgorithm
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  17. def initialize(): Unit

    Initialize the problem by adding all permanent elements to it.

    Initialize the problem by adding all permanent elements to it. This is to ensure that all top-level elements are correctly added to the top-level problem.

    Definition Classes
    StructuredAlgorithmAlgorithm
  18. def isActive: Boolean
    Definition Classes
    Algorithm
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. 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
  21. val mapElements: Element[_]*
  22. def mostLikelyValue[T](target: Element[T]): T

    Returns an estimate of the max a posteriori value of the target.

    Returns an estimate of the max a posteriori value of the target.

    Definition Classes
    MarginalMAPAlgorithm
    Exceptions thrown

    AlgorithmInactiveException if the algorithm is inactive.

    NotATargetException if called on a target that is not in the list of MAP elements.

  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def neededBounds(): Set[Bounds]

    All bounds for which this algorithm needs to compute solutions.

    All bounds for which this algorithm needs to compute solutions. This is determined by looking for components that have * in their range, and have constraint factors associated with them. If such a component exists, we need both lower and upper bounds. Otherwise, just one of the bounds suffices because they are equivalent; it defaults to lower in this case.

    returns

    All bounds for which this algorithm should compute solutions.

    Definition Classes
    StructuredAlgorithm
  25. final def notify(): Unit
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  27. val problem: Problem

    Inference problem to be solved.

    Inference problem to be solved.

    Definition Classes
    StructuredAlgorithm
  28. def problemTargets: List[Element[_]]

    List of targets that should not be eliminated when solving the problem.

    List of targets that should not be eliminated when solving the problem.

    returns

    Targets for the problem.

    Definition Classes
    StructuredMarginalMAPAlgorithmStructuredAlgorithm
  29. def processSolutions(solutions: Map[Bounds, Solution]): Unit

    Extract the solution in a way that allows fast queries to the algorithm.

    Extract the solution in a way that allows fast queries to the algorithm. This usually involves storing some form of the solution in a variable, but the exact implementation is up to the algorithm that overrides this.

    solutions

    A map from bounds to computed solutions for those bounds. Contains one key for each of the bounds needed, according to neededBounds().

    Definition Classes
    StructuredMarginalMAPAlgorithmStructuredAlgorithm
  30. 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
  31. def runStep(): Unit

    Run a single iteration of refinement/solving, then record the solutions.

    Run a single iteration of refinement/solving, then record the solutions.

    Definition Classes
    StructuredAlgorithm
  32. 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
  33. 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
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. var targetFactors: Map[Variable[_], Factor[_]]
    Attributes
    protected
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. val universe: Universe
    Definition Classes
    StructuredAlgorithm
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from MarginalMAPAlgorithm

Inherited from StructuredAlgorithm

Inherited from Algorithm

Inherited from AnyRef

Inherited from Any

Ungrouped