Packages

class Histogram[T] extends Stat with LazyLogging

The histogram's state is stored in an indexed array, where the index is the bin number and the values are the counts.

e.g. a range of 0 to 3 with 3 bins will result in these bins: [0, 1), [1, 2), [2, 3) and the array will contain three entries.

T

a comparable type which must have a StatHelperFunctions type class

Linear Supertypes
LazyLogging, Stat, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Histogram
  2. LazyLogging
  3. Stat
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Histogram(sft: SimpleFeatureType, property: String, initialBins: Int, initialEndpoints: (T, T))(implicit defaults: MinMaxDefaults[T], ct: ClassTag[T])

    sft

    simple feature type

    property

    property name for the attribute the histogram is being made for

    initialBins

    number of bins the histogram has

    initialEndpoints

    lower/upper end of histogram

Type Members

  1. type S = Histogram[T]
    Definition Classes
    Histogram → Stat

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: Histogram[T]): Histogram[T]

    Creates a new histogram by combining another histogram with this one.

    Creates a new histogram by combining another histogram with this one. Bounds and length will both be the greater from each histogram.

    other

    the other stat to add

    Definition Classes
    Histogram → Stat
  4. def +(other: Stat)(implicit d: DummyImplicit): Stat

    Non type-safe add - if stats are not the same type, will throw an exception

    Non type-safe add - if stats are not the same type, will throw an exception

    other

    the other stat to add

    Definition Classes
    Stat
  5. def +=(other: Histogram[T]): Unit

    Copies another histogram into this one.

    Copies another histogram into this one. Current bounds and length will be expanded if necessary.

    other

    the other stat to add

    Definition Classes
    Histogram → Stat
  6. def +=(other: Stat)(implicit d: DummyImplicit): Unit

    Non type-safe add - if stats are not the same type, will throw an exception

    Non type-safe add - if stats are not the same type, will throw an exception

    other

    the other stat to add

    Definition Classes
    Stat
  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def addCountsFrom(other: Histogram[T]): Unit

    Copies another histogram into this one.

    Copies another histogram into this one. In comparison to +=, this method will preserve the current bounds and length.

    other

    other histogram

  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def bounds(i: Int): (T, T)
  11. def bounds: (T, T)
  12. def clear(): Unit

    Clears the stat to its original state when first initialized.

    Clears the stat to its original state when first initialized. Necessary method used by the StatIterator.

    Definition Classes
    Histogram → Stat
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  14. def count(i: Int): Long
  15. implicit val ct: ClassTag[T]
  16. implicit val defaults: MinMaxDefaults[T]
  17. def directIndex(value: Long): Int
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  22. def indexOf(value: T): Int
  23. def isEmpty: Boolean

    Necessary method used by the StatIterator.

    Necessary method used by the StatIterator. Indicates if the stat has any values or not

    returns

    true if stat contains values

    Definition Classes
    Histogram → Stat
  24. def isEquivalent(other: Stat): Boolean

    Compares the two stats for equivalence.

    Compares the two stats for equivalence. We don't use standard 'equals' as it gets messy with mutable state and hash codes

    other

    other stat to compare

    returns

    true if equals

    Definition Classes
    Histogram → Stat
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def length: Int
  27. lazy val logger: Logger
    Attributes
    protected
    Definition Classes
    LazyLogging
    Annotations
    @transient()
  28. def max: T
  29. def medianValue(i: Int): T
  30. def min: T
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  34. def observe(sf: SimpleFeature): Unit

    Compute statistics based upon the given simple feature.

    Compute statistics based upon the given simple feature. This method will be called for every SimpleFeature a query returns.

    sf

    feature to evaluate

    Definition Classes
    Histogram → Stat
  35. val property: String
  36. val sft: SimpleFeatureType

    The simple feature type that this stat operates on

    The simple feature type that this stat operates on

    Definition Classes
    Histogram → Stat
  37. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  38. def toJson: String

    Returns a JSON representation of the Stat

    Returns a JSON representation of the Stat

    returns

    stat as a json string

    Definition Classes
    Stat
  39. def toJsonObject: Map[String, Any]

    Returns a representation of the Stat to be serialized

    Returns a representation of the Stat to be serialized

    This function should return a representation (view) of the Stat to be serialized as JSON. Instances of Map can be used to represent JSON dictionaries or Seq for JSON arrays. A collection.SortedMap such as collection.immutable.ListMap is recommended if key order should be deterministic. Other types may be used but could require the creation and registration of custom serializers dependent on the JSON framework being utilized (currently Gson).

    returns

    stat as a json serializable object

    Definition Classes
    Histogram → Stat
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. def unobserve(sf: SimpleFeature): Unit

    Tries to remove the given simple feature from the compiled statistics.

    Tries to remove the given simple feature from the compiled statistics. Note: may not be possible to un-observe a feature, in which case this method will have no effect.

    sf

    feature to un-evaluate

    Definition Classes
    Histogram → Stat
  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( ... ) @native()
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from LazyLogging

Inherited from Stat

Inherited from AnyRef

Inherited from Any

Ungrouped