com.cra.figaro.algorithm

Anytime

trait Anytime extends Algorithm

An anytime algorithm is able to improve its estimated answers over time. Anytime algorithms run in their own thread using an actor.

An anytime algorithm must implement initialize, runStep, and handle methods. runStep will typically send a Handle message to the actor containing a Service, and the algorithm will provide a handle method to implement this Service. The handle method will return a Response, which is sent back to runStep.

Linear Supertypes
Algorithm, AnyRef, Any
Known Subclasses
AnytimeDecisionMetropolisHastings, AnytimeElementSampler, AnytimeMPE, AnytimeMPESampler, AnytimeMetropolisHastings, AnytimeMetropolisHastingsAnnealer, AnytimeParticleBeliefPropagation, AnytimeProbEvidence, AnytimeProbEvidenceSampler, AnytimeProbQuery, AnytimeProbQuerySampler, AnytimeProbabilisticBeliefPropagation, AnytimeSampler
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Anytime
  2. Algorithm
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. class Runner extends Actor

    A class representing the actor running the algorithm.

Abstract Value Members

  1. abstract def handle(service: Service): Response

    A handler of services provided by the algorithm.

  2. abstract def runStep(): Unit

    Run a single step of the algorithm.

    Run a single step of the algorithm. The algorithm must be able to provide answers after each step.

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. 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 customConf: Config

    The actor running the algorithm.

  9. def doKill(): Unit

    Attributes
    protected
    Definition Classes
    Anytime → Algorithm

  10. def doResume(): Unit

    Attributes
    protected
    Definition Classes
    Anytime → Algorithm

  11. def doStart(): Unit

    Attributes
    protected
    Definition Classes
    Anytime → Algorithm

  12. def doStop(): Unit

    Attributes
    protected
    Definition Classes
    Anytime → Algorithm

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

    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  18. 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

  19. def isActive: Boolean

    Definition Classes
    Algorithm

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  21. 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

  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  25. 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

  26. var runner: ActorRef

  27. var running: Boolean

  28. def shutdown: Unit

    Release all resources from this anytime algorithm.

  29. 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

  30. 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

  31. def stopUpdate(): Unit

    Optional function to run when the algorithm is stopped (not killed).

    Optional function to run when the algorithm is stopped (not killed). Used in samplers to update lazy values.

  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  33. var system: ActorSystem

  34. def toString(): String

    Definition Classes
    AnyRef → Any

  35. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Algorithm

Inherited from AnyRef

Inherited from Any

Ungrouped