com.cra.figaro.algorithm.sampling

MetropolisHastings

abstract class MetropolisHastings extends UnweightedSampler

Metropolis-Hastings samplers.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MetropolisHastings
  2. UnweightedSampler
  3. Sampler
  4. ProbQueryAlgorithm
  5. Algorithm
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MetropolisHastings(universe: Universe, proposalScheme: ProposalScheme, burnIn: Int, interval: Int, targets: Element[_]*)

    burnIn

    The number of iterations to run before samples are collected

    interval

    The number of iterations to perform between collecting samples

Type Members

  1. type LastUpdate[T] = (T, Int)

    Attributes
    protected
    Definition Classes
    UnweightedSampler
  2. type Sample = Map[Element[_], Any]

    A sample is a map from elements to their values.

    A sample is a map from elements to their values.

    Definition Classes
    UnweightedSampler
  3. type TimesSeen[T] = Map[T, Int]

    Attributes
    protected
    Definition Classes
    UnweightedSampler

Abstract Value Members

  1. abstract def doDistribution[T](target: Element[T]): Stream[(Double, T)]

    Attributes
    protected
    Definition Classes
    ProbQueryAlgorithm
  2. abstract def doExpectation[T](target: Element[T], function: (T) ⇒ Double): Double

    Attributes
    protected
    Definition Classes
    ProbQueryAlgorithm
  3. abstract def doKill(): Unit

    Attributes
    protected
    Definition Classes
    Algorithm
  4. abstract def doProbability[T](target: Element[T], predicate: (T) ⇒ Boolean): Double

    Attributes
    protected
    Definition Classes
    ProbQueryAlgorithm
  5. abstract def doResume(): Unit

    Attributes
    protected
    Definition Classes
    Algorithm
  6. abstract def doStart(): Unit

    Attributes
    protected
    Definition Classes
    Algorithm
  7. abstract def doStop(): Unit

    Attributes
    protected
    Definition Classes
    Algorithm

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def acceptRejectRatio: Double

    Get the acceptance ratio for the sampler

  7. var active: Boolean

    Attributes
    protected
    Definition Classes
    Algorithm
  8. var allLastUpdates: Map[Element[_], LastUpdate[_]]

    Attributes
    protected
    Definition Classes
    UnweightedSampler
  9. var allTimesSeen: Map[Element[_], TimesSeen[_]]

    Attributes
    protected
    Definition Classes
    UnweightedSampler
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. 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
  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def computeDistribution[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.

    Definition Classes
    UnweightedSamplerProbQueryAlgorithm
  14. def computeExpectation[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.

    Definition Classes
    UnweightedSamplerProbQueryAlgorithm
  15. 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
    ProbQueryAlgorithm
  16. var debug: Boolean

    Set this flag to true to obtain debugging information

  17. 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
    ProbQueryAlgorithm
  18. def doInitialize(): Unit

    Attributes
    protected
  19. final def doSample(): Unit

    Attributes
    protected
    Definition Classes
    MetropolisHastingsUnweightedSamplerSampler
  20. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  22. 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
    ProbQueryAlgorithm
  23. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  25. def getSampleCount: Int

    Number of samples taken.

    Number of samples taken.

    Definition Classes
    UnweightedSampler
  26. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  27. def initUpdates(): Unit

    Attributes
    protected
    Definition Classes
    UnweightedSampler
  28. 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
  29. def isActive: Boolean

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

    Definition Classes
    Any
  31. 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
  32. 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
    ProbQueryAlgorithm
  33. final def mhStep(): State

    Attributes
    protected
  34. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  35. def newLastUpdate[T](target: Element[T]): (T, Int)

    Attributes
    protected
    Definition Classes
    UnweightedSampler
  36. def newTimesSeen[T](target: Element[T]): TimesSeen[T]

    Attributes
    protected
    Definition Classes
    UnweightedSampler
  37. final def notify(): Unit

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

    Definition Classes
    AnyRef
  39. 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
  40. 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
    ProbQueryAlgorithm
  41. 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
    ProbQueryAlgorithm
  42. lazy val queryTargets: List[Element[_]]

    Definition Classes
    UnweightedSamplerProbQueryAlgorithm
  43. def resetCounts(): Unit

    Attributes
    protected
    Definition Classes
    UnweightedSamplerSampler
  44. 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
  45. final def sample(): (Boolean, Sample)

    Produce a single sample.

    Produce a single sample.

    Definition Classes
    MetropolisHastingsUnweightedSampler
  46. var sampleCount: Int

    Attributes
    protected
    Definition Classes
    UnweightedSampler
  47. 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
  48. 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
  49. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  50. def test(numSamples: Int, predicates: Seq[Predicate[_]], elementsToTrack: Seq[Element[_]]): (Double, Map[Predicate[_], Double], Map[Element[_], Double])

    Test Metropolis-Hastings by repeatedly running a single step from the same initial state.

    Test Metropolis-Hastings by repeatedly running a single step from the same initial state. For each of a set of predicates, the fraction of times the predicate is satisfied by the resulting state is returned. By the resulting state, we mean the new state if it is accepted and the original state if not.

  51. def toString(): String

    Definition Classes
    AnyRef → Any
  52. def update(): Unit

    Attributes
    protected
    Definition Classes
    UnweightedSamplerSampler
  53. def updateTimesSeenForTarget[T](elem: Element[T], newValue: T): Unit

    Attributes
    protected
    Definition Classes
    UnweightedSampler
  54. def updateTimesSeenWithValue[T](value: T, timesSeen: TimesSeen[T], seen: Int): Unit

    Attributes
    protected
    Definition Classes
    UnweightedSampler
  55. 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
    ProbQueryAlgorithm
  56. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from UnweightedSampler

Inherited from Sampler

Inherited from ProbQueryAlgorithm

Inherited from Algorithm

Inherited from AnyRef

Inherited from Any

Ungrouped