geotrellis.process

BoundedCache

trait BoundedCache[K, V] extends CacheStrategy[K, V]

A hash backed cache with a size boundary Operations on this cache may required O(N) time to execute (N = size of cache)

Linear Supertypes
CacheStrategy[K, V], AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BoundedCache
  2. CacheStrategy
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def cacheFree(l: Long): Unit

    Attempt to free l amount of cache space this method is called once after an insert would have failed due to space constraints.

    Attempt to free l amount of cache space this method is called once after an insert would have failed due to space constraints. After this method returns the insert will be retried

  2. abstract def lookup(k: K): Option[V]

    Lookup the value for key k

    Lookup the value for key k

    returns

    Some(v) if the value was cached, None otherwise

    Definition Classes
    CacheStrategy
  3. abstract val maxSize: Long

    Maximum size of the cache

  4. abstract val sizeOf: (V) ⇒ Long

    Return the size of a a given cache item If items are objects (for example) this might just be: (x) => 1 If items are arrays of ints and the maxSize is in bytes this function might be: (x) => x.

    Return the size of a a given cache item If items are objects (for example) this might just be: (x) => 1 If items are arrays of ints and the maxSize is in bytes this function might be: (x) => x.length * 4

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. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from BoundedCache[K, V] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (BoundedCache[K, V], B)

    Implicit information
    This member is added by an implicit conversion from BoundedCache[K, V] to ArrowAssoc[BoundedCache[K, V]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def canInsert(v: V): Boolean

    returns true iff v can be inserted into the cache without violating the size boundary

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  11. var currentSize: Long

  12. def ensuring(cond: (BoundedCache[K, V]) ⇒ Boolean, msg: ⇒ Any): BoundedCache[K, V]

    Implicit information
    This member is added by an implicit conversion from BoundedCache[K, V] to Ensuring[BoundedCache[K, V]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (BoundedCache[K, V]) ⇒ Boolean): BoundedCache[K, V]

    Implicit information
    This member is added by an implicit conversion from BoundedCache[K, V] to Ensuring[BoundedCache[K, V]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): BoundedCache[K, V]

    Implicit information
    This member is added by an implicit conversion from BoundedCache[K, V] to Ensuring[BoundedCache[K, V]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): BoundedCache[K, V]

    Implicit information
    This member is added by an implicit conversion from BoundedCache[K, V] to Ensuring[BoundedCache[K, V]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from BoundedCache[K, V] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def getOrInsert(k: K, vv: ⇒ V): V

    Lookup the value for key k If the value is in the cache, return it.

    Lookup the value for key k If the value is in the cache, return it. Otherwise, insert the value v and return it

    Note: This method does not guarantee that v will be in the cache when it returns

    returns

    the cached value keyed to k or the computed value of v

    Definition Classes
    CacheStrategy
  22. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  23. def insert(k: K, v: V): Boolean

    Insert the value v (keyed by k) into the cache

    Insert the value v (keyed by k) into the cache

    returns

    true if the value was inserted into the cache

    Definition Classes
    BoundedCacheCacheStrategy
  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. final def notify(): Unit

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

    Definition Classes
    AnyRef
  28. def remove(k: K): Option[V]

    Remove k from the cache

    Remove k from the cache

    Definition Classes
    BoundedCacheCacheStrategy
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  30. def toString(): String

    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  34. def [B](y: B): (BoundedCache[K, V], B)

    Implicit information
    This member is added by an implicit conversion from BoundedCache[K, V] to ArrowAssoc[BoundedCache[K, V]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from BoundedCache[K, V] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (boundedCache: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from BoundedCache[K, V] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (boundedCache: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: BoundedCache[K, V]

    Implicit information
    This member is added by an implicit conversion from BoundedCache[K, V] to ArrowAssoc[BoundedCache[K, V]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (boundedCache: ArrowAssoc[BoundedCache[K, V]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: BoundedCache[K, V]

    Implicit information
    This member is added by an implicit conversion from BoundedCache[K, V] to Ensuring[BoundedCache[K, V]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (boundedCache: Ensuring[BoundedCache[K, V]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from CacheStrategy[K, V]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BoundedCache[K, V] to StringAdd

Inherited by implicit conversion any2stringfmt from BoundedCache[K, V] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from BoundedCache[K, V] to ArrowAssoc[BoundedCache[K, V]]

Inherited by implicit conversion any2Ensuring from BoundedCache[K, V] to Ensuring[BoundedCache[K, V]]

Ungrouped