RangeMapLike

Implementation trait for RangeMap

A mapping from disjoint nonempty ranges to non-null values. Queries look up the value associated with the range (if any) that contains a specified key.

In contrast to RangeSet, no "coalescing" is done of connected ranges, even if they are mapped to the same value.

Usage example:

import org.feijoas.mango.common.collect.mutable
import org.feijoas.mango.common.collect.Range
import math.Ordering.Int

// mutable range map
val rangeMap = mutable.RangeMap(Range.open(3, 7) -> "1") //Map((3..7) -> 1)
rangeMap += Range.closed(9, 10) -> "2"              // Map((3..7) -> 1, [9..10] -> 2)
rangeMap += Range.closed(12, 16) -> "3"             // Map((3..7) -> 1, [9..10] -> 2, [12..16] -> 3)

val sub = rangeMap.subRangeMap(Range.closed(5, 11)) // Map([5..7) -> 1, [9..10] -> 2)
sub.put(Range.closed(7, 9), "4")                    // sub = Map([5..7) -> 1, [7..9] -> 4, (9..10] -> 2)

// rangeMap = Map((3..7) -> 1, [7..9] -> 4, (9..10] -> 2, [12..16] -> 3)

Self Type: RangeMapLike[K, V, O, Repr]
Annotations: @Beta()
Since: 0.9

Linear Supertypes

HasNewBuilder[(Range[K, O], V), Repr], AnyRef, Any

Known Subclasses

RangeMap, RangeMap, RangeMap, RangeMapLike, RangeMapLike

Abstract Value Members

abstract def asMapOfRanges(): Map[Range[K, O], V]

Returns this RangeMap as a map of ranges.
Returns this RangeMap as a map of ranges.
Warning: This differs from Guava which returns an unmodifiable view of this RangeMap which modifications to its range map are guaranteed to read through to the returned map.
It is guaranteed that no empty ranges will be in the returned Map.
abstract def get(key: K): Option[V]

Returns the value associated with the specified key in a Some, or None if there is no such value.
Returns the value associated with the specified key in a Some, or None if there is no such value.
Specifically, if any range in this range map contains the specified key, the value associated with that range is returned.
abstract def getEntry(key: K): Option[(Range[K, O], V)]

Returns the range containing this key and its associated value in a Some, if such a range is present in the range map, or None otherwise.
abstract def newBuilder: Builder[(Range[K, O], V), Repr]

Attributes
protected[this]
Definition Classes
HasNewBuilder
abstract def span(): Option[Range[K, O]]

Returns the minimal range enclosing the ranges in this RangeMap in a Some or None if this range map is empty
abstract def subRangeMap(range: Range[K, O]): Repr

Returns a view of the part of this range map that intersects with range.
Returns a view of the part of this range map that intersects with range.
For example, if rangeMap had the entries [1, 5] => "foo", (6, 8) => "bar", (10, ‥) => "baz" then rangeMap.subRangeMap(Range.open(3, 12)) would return a range map with the entries (3, 5) => "foo", (6, 8) => "bar", (10, 12) => "baz".
The returned range map supports all optional operations that this range map supports.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(obj: Any): Boolean

Returns true if obj is another RangeMap that has an equivalent #asMapOfRanges().
Returns true if obj is another RangeMap that has an equivalent #asMapOfRanges().

Definition Classes
RangeMapLike → AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Returns asMapOfRanges().hashCode().
Returns asMapOfRanges().hashCode().

Definition Classes
RangeMapLike → AnyRef → Any
def isEmpty: Boolean

Returns true if this range map contains no ranges.
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Returns a readable string representation of this range map.
Returns a readable string representation of this range map.

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package collect

trait RangeMapLike[K, V, O <: Ordering[K], +Repr <: RangeMapLike[K, V, O, Repr] with RangeMap[K, V, O]] extends HasNewBuilder[(Range[K, O], V), Repr]

Abstract Value Members

abstract def asMapOfRanges(): Map[Range[K, O], V]

abstract def get(key: K): Option[V]

abstract def getEntry(key: K): Option[(Range[K, O], V)]

abstract def newBuilder: Builder[(Range[K, O], V), Repr]

abstract def span(): Option[Range[K, O]]

abstract def subRangeMap(range: Range[K, O]): Repr

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(obj: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def isEmpty: Boolean

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from HasNewBuilder[(Range[K, O], V), Repr]

Inherited from AnyRef

Inherited from Any

Ungrouped