Slice

Represents a slice object. A slice is a sequence of indices for some underlying sequence or tensor.

The companion object provides some helpful implicit conversion functions that allow for easy creation of slices.

For example:

3               // Slice object representing the following indices: '[3]'.
2 :: 6          // Slice object representing the following indices: '[2, 3, 4, 5]'.
3 :: 4 :: 12    // Slice object representing the following indices: '[3, 7, 10]'.
0 :: 1 :: -2    // Slice object representing the following indices: '[0, 3, 6, ..., length - 3]'.
6 :: -2 :: 3    // Slice object representing the following indices: '[6, 4]'.
-3 :: -2 :: -10 // Slice object representing the following indices: '[length - 3, length - 5, ..., length - 10]'.
2 :: -          // Slice object representing the following indices: '[2, 3, ..., length - 1]'.
0 :: 1 :: -     // Slice object representing the following indices: '[0, 3, 6, ..., length - 1]'.

Note how the end index is exclusive and the step size is optional.

Linear Supertypes

Serializable, Serializable, Product, Equals, Indexer, AnyRef, Any

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 assertWithinBounds(underlyingSequenceLength: Int): Unit

Asserts that the indices specified by this slice are within the valid size bounds for the provided underlying sequence length.
Asserts that the indices specified by this slice are within the valid size bounds for the provided underlying sequence length. Throws an IndexOutOfBoundsException exception if they are not.
underlyingSequenceLength
Underlying sequence length.

Annotations
@throws( ... ) @throws( ... )
Exceptions thrown
IllegalArgumentException If the underlying sequence length is not positive.
IndexOutOfBoundsException If the indices specified by this slice are not within the valid size bounds for the provided underlying sequence length.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val end: Int

End index for this slice.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val inclusive: Boolean

Boolean value indicating whether this slice inclusive with respect to end or not.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def length(underlyingSequenceLength: Int = 1): Int

Length of this slice.
Length of this slice.
The length of a slice can only be computed if:
- end - start has the same sign as step, or
- the underlying sequence length is provided. Note that by underlying sequence we refer to the sequence that this slice is used to index.
underlyingSequenceLength
Underlying sequence length.

Annotations
@throws( ... ) @throws( ... )
Exceptions thrown
IllegalArgumentException If the underlying sequence length is not positive, or if the slice is invalid for some reason.
IndexOutOfBoundsException If the indices specified by this slice are not within the valid size bounds for the provided underlying sequence length.
def length: Int

Length of this slice.
Length of this slice.
If end - start has the opposite sign of step, then the length of this slice is considered unknown and a value of -1 is returned. This can be avoided by providing the underlying sequence length in the length method of this class.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val start: Int

Start index for this slice.
val step: Int

Step for this slice.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toArray(underlyingSequenceLength: Int): Array[Int]

Returns an array containing the indices represented by this slice, for the specified underlying sequence length.
Returns an array containing the indices represented by this slice, for the specified underlying sequence length.
This method takes case of negative indexing and the returned array is guaranteed to only have positive elements.
underlyingSequenceLength
Underlying sequence length.
returns
Array containing the indices represented by this slice, for the specified underlying sequence length.

Annotations
@throws( ... ) @throws( ... )
Exceptions thrown
IllegalArgumentException If the underlying sequence length is not positive.
IndexOutOfBoundsException If the indices specified by this slice are not within the valid size bounds for the provided underlying sequence length.
def toString(): String

Definition Classes
Slice → 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 Docs: object Slice | package core

case class Slice extends Indexer with Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def assertWithinBounds(underlyingSequenceLength: Int): Unit

def clone(): AnyRef

val end: Int

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val inclusive: Boolean

final def isInstanceOf[T0]: Boolean

def length(underlyingSequenceLength: Int = 1): Int

def length: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val start: Int

val step: Int

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

def toArray(underlyingSequenceLength: Int): Array[Int]

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Indexer

Inherited from AnyRef

Inherited from Any

Ungrouped