Packages

class Z3Frequency extends Stat with LazyLogging

Estimates frequency counts at scale. Tracks geometry and date attributes as a single value.

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

Instance Constructors

  1. new Z3Frequency(sft: SimpleFeatureType, geom: String, dtg: String, period: TimePeriod, precision: Int, eps: Double = 0.005, confidence: Double = 0.95)

    sft

    simple feature type

    geom

    geometry attribute in the sft

    dtg

    date attribute in the sft

    period

    time period to use for z index

    precision

    number of bits of z-index that will be used

    eps

    (epsilon) with probability at least @see confidence, estimates will be within eps * N

    confidence

    percent - with probability at least confidence, estimates will be within @see eps * N

Type Members

  1. type S = Z3Frequency
    Definition Classes
    Z3Frequency → Stat

Value Members

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

    Combine two stats into a new stat

    Combine two stats into a new stat

    other

    the other stat to add

    Definition Classes
    Z3Frequency → 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: Z3Frequency): Unit

    Add another stat to this stat.

    Add another stat to this stat. Avoids allocating another object.

    other

    the other stat to add

    Definition Classes
    Z3Frequency → 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. 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
    Z3Frequency → Stat
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  11. val confidence: Double
  12. def count(geom: Geometry, dtg: Date): Long

    Gets the count for the given values

    Gets the count for the given values

    geom

    geometry

    dtg

    date

    returns

    count of the values

  13. def countDirect(bin: Short, z3: Long): Long

    Gets the count for a time bin and z3.

    Gets the count for a time bin and z3. Useful if the values are known ahead of time.

    bin

    period since the epoch

    z3

    z value

    returns

    count of the values

  14. val dtg: String
  15. val eps: Double
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. val geom: String
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  21. 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
    Z3Frequency → Stat
  22. 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
    Z3Frequency → Stat
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. lazy val logger: Logger
    Attributes
    protected
    Definition Classes
    LazyLogging
    Annotations
    @transient()
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  28. 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
    Z3Frequency → Stat
  29. val period: TimePeriod
  30. val precision: Int
  31. val sft: SimpleFeatureType

    The simple feature type that this stat operates on

    The simple feature type that this stat operates on

    Definition Classes
    Z3Frequency → Stat
  32. def size: Long

    Number of observations in the frequency map

    Number of observations in the frequency map

    returns

    number of observations

  33. def splitByTime: Seq[(Short, Z3Frequency)]

    Split the stat into a separate stat per time bin of z data.

    Split the stat into a separate stat per time bin of z data. Allows for separate handling of the reduced data set.

  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. 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
  36. def toJsonObject: 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
    Z3Frequency → Stat
  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. 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
    Z3Frequency → Stat
  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( ... ) @native()
  41. 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