io.improbable.keanu.tensor.jvm

Class Slicer.SlicerBuilder

java.lang.Object

io.improbable.keanu.tensor.jvm.Slicer.SlicerBuilder

Enclosing class:

Slicer

public static class Slicer.SlicerBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SlicerBuilder()

Method Summary

Modifier and Type	Method and Description
Slicer.SlicerBuilder	all() Take all indices.
Slicer	build()
Slicer.SlicerBuilder	ellipsis() Means take all from this point.
Slicer.SlicerBuilder	slice() Take all indices.
Slicer.SlicerBuilder	slice(java.lang.Integer start)
Slicer.SlicerBuilder	slice(java.lang.Integer start, java.lang.Integer stop)
Slicer.SlicerBuilder	slice(java.lang.Integer start, java.lang.Integer stop, java.lang.Integer step)
Slicer.SlicerBuilder	slice(java.lang.Long start)
Slicer.SlicerBuilder	slice(java.lang.Long start, java.lang.Long stop)
Slicer.SlicerBuilder	slice(java.lang.Long start, java.lang.Long stop, java.lang.Long step)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SlicerBuilder

public SlicerBuilder()

Method Detail

slice

public Slicer.SlicerBuilder slice(java.lang.Long start,
                                  java.lang.Long stop,
                                  java.lang.Long step)

Parameters:

start - index to start at

stop - index to stop at

step - step from start to stop

Returns:

a slice for dimension that takes all indices after (inclusively) the start and up to the stop (exclusively) with a step of step.

slice

public Slicer.SlicerBuilder slice(java.lang.Integer start,
                                  java.lang.Integer stop,
                                  java.lang.Integer step)

slice

public Slicer.SlicerBuilder slice(java.lang.Long start,
                                  java.lang.Long stop)

Parameters:

start - index to start at

stop - index to stop at

Returns:

a slice for dimension that takes all indices after (inclusively) the start and up to the stop (exclusively).

slice

public Slicer.SlicerBuilder slice(java.lang.Integer start,
                                  java.lang.Integer stop)

slice

public Slicer.SlicerBuilder slice(java.lang.Long start)

Parameters:

start - index to start at

Returns:

a slice for dimension that takes all indices after (inclusively) the start.

slice

public Slicer.SlicerBuilder slice(java.lang.Integer start)

slice

public Slicer.SlicerBuilder slice()

Take all indices. This is the same as all().

Returns:

a slice for dimension that takes all indices

all

public Slicer.SlicerBuilder all()

Take all indices. This is the same as slice().

Returns:

a slice for dimension that takes all indices

ellipsis

public Slicer.SlicerBuilder ellipsis()

Means take all from this point. This can only be used once and could for example allow slicing dimensions from the right. e.g. a given shape of (2,3,4) could be sliced [...,2] which would be the same as [:,:,2].

Returns:

a slice for dimension that takes all indices

build

public Slicer build()