com.cra.figaro.algorithm.sampling

ElementSampler

Related Docs: object ElementSampler | package sampling

abstract class ElementSampler extends BaseUnweightedSampler

An abstract class to generates samples from the marginal distribution of an element.

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

Instance Constructors

  1. new ElementSampler(target: Element[_])

    target

    The element to generate samples from

Type Members

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

    Attributes
    protected
    Definition Classes
    BaseUnweightedSampler
  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
    BaseUnweightedSampler
  3. type TimesSeen[T] = Map[T, Int]

    Attributes
    protected
    Definition Classes
    BaseUnweightedSampler

Abstract Value Members

  1. abstract def doKill(): Unit

    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    Algorithm
  2. abstract def doResume(): Unit

    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    Algorithm
  3. abstract def doStart(): Unit

    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    Algorithm
  4. abstract def doStop(): Unit

    Attributes
    protected[com.cra.figaro.algorithm]
    Definition Classes
    Algorithm

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. var allLastUpdates: Map[Element[_], LastUpdate[_]]

    Attributes
    protected
    Definition Classes
    BaseUnweightedSampler
  6. var allTimesSeen: Map[Element[_], TimesSeen[_]]

    Attributes
    protected
    Definition Classes
    BaseUnweightedSampler
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  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. def doInitialize(): Unit

    Attributes
    protected
  11. def doSample(): Unit

    Attributes
    protected
    Definition Classes
    BaseUnweightedSamplerSampler
  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 getSampleCount: Int

    Number of samples taken

    Number of samples taken

    Definition Classes
    BaseUnweightedSampler
  17. def hashCode(): Int

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

    Attributes
    protected
    Definition Classes
    BaseUnweightedSampler
  19. 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
  20. def isActive: Boolean

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

    Definition Classes
    Any
  22. 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
  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  24. def newLastUpdate[T](target: Element[T]): LastUpdate[T]

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

    Attributes
    protected
    Definition Classes
    BaseUnweightedSampler
  26. final def notify(): Unit

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

    Definition Classes
    AnyRef
  28. lazy val queryTargets: List[Element[_]]

    Definition Classes
    BaseUnweightedSampler
  29. def resetCounts(): Unit

    Attributes
    protected
    Definition Classes
    BaseUnweightedSamplerSampler
  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 sample(): (Boolean, Sample)

    Produce a single sample.

    Produce a single sample.

    Definition Classes
    ElementSamplerBaseUnweightedSampler
  32. var sampleCount: Int

    Attributes
    protected
    Definition Classes
    BaseUnweightedSampler
  33. 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
  34. 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
  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  36. def toString(): String

    Definition Classes
    AnyRef → Any
  37. val universe: Universe

    Definition Classes
    BaseUnweightedSampler
  38. def update(): Unit

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

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

    Attributes
    protected
    Definition Classes
    BaseUnweightedSampler
  41. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from BaseUnweightedSampler

Inherited from Sampler

Inherited from Algorithm

Inherited from AnyRef

Inherited from Any

Ungrouped