IndexFunction

Related Docs: object IndexFunction | package indexfunction

abstract class IndexFunction[V] extends PartialFunction[Int, V] with Serializable

An index function is a (partial) function from some subset of collection indices to some values, and which can be concatenated with other such functions such that they now cover an expanded index range, and the "right" side function has had its domain shifted. An index function is defined on an index interval with a particular width, and its domain is some subset of that interval.

V

The type of value returned by this function.

Self Type
IndexFunction[V]
Linear Supertypes
Serializable, Serializable, PartialFunction[Int, V], (Int) ⇒ V, AnyRef, Any
Known Subclasses
Ordering
1. Alphabetic
2. By Inheritance
Inherited
1. IndexFunction
2. Serializable
3. Serializable
4. PartialFunction
5. Function1
6. AnyRef
7. Any
1. Hide All
2. Show All
Visibility
1. Public
2. All

Abstract Value Members

1. abstract def apply(v1: Int): V

Definition Classes
Function1
2. abstract def domain: Iterator[Int]

Obtain a new iterator over the indices that the function is defined on.

Obtain a new iterator over the indices that the function is defined on.

returns

An iterator over the function domain

3. abstract def isDefinedAt(x: Int): Boolean

Definition Classes
PartialFunction
4. abstract def range: Iterator[V]

Obtain a new iterator over the function range values

Obtain a new iterator over the function range values

returns

An iterator over values that may be returned by the function

5. abstract def width: Int

The width of the integer index interval that contains the domain.

The width of the integer index interval that contains the domain. All indices this function is defined on are on the interval [0, width)

returns

The width of the interval [0, width) containing the function domain.

Concrete Value Members

1. final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
3. final def ++(that: IndexFunction[V]): IndexFunction[V]

Concatenate two index functions.

Concatenate two index functions.

that

The right-hand function of the concatenation

returns

The concatenation of left and right index functions, defined as:

`(f1 ++ f2)(j) = if (j < f1.width) f1(j) else f2(j - f1.width)`
4. final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
5. def andThen[C](k: (V) ⇒ C): PartialFunction[Int, C]

Definition Classes
PartialFunction → Function1
6. def applyOrElse[A1 <: Int, B1 >: V](x: A1, default: (A1) ⇒ B1): B1

Definition Classes
PartialFunction
7. final def asInstanceOf[T0]: T0

Definition Classes
Any
8. def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
9. def compose[A](g: (A) ⇒ Int): (A) ⇒ V

Definition Classes
Function1
Annotations
@unspecialized()
10. final def eq(arg0: AnyRef): Boolean

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

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

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

Definition Classes
AnyRef → Any
14. def hashCode(): Int

Definition Classes
AnyRef → Any
15. final def isInstanceOf[T0]: Boolean

Definition Classes
Any
16. def lift: (Int) ⇒ Option[V]

Definition Classes
PartialFunction
17. final def ne(arg0: AnyRef): Boolean

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

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

Definition Classes
AnyRef
20. def orElse[A1 <: Int, B1 >: V](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

Definition Classes
PartialFunction
21. def runWith[U](action: (V) ⇒ U): (Int) ⇒ Boolean

Definition Classes
PartialFunction
22. final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
23. final def toMap: Map[Int, V]

Obtain a Scala Map from values in the domain to their corresponding range values.

Obtain a Scala Map from values in the domain to their corresponding range values.

returns

A Scala Map that is equivalent to this function

24. def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )