io.improbable.keanu.tensor.bool

Interface BooleanTensor

All Superinterfaces:

io.improbable.keanu.kotlin.BooleanOperators<BooleanTensor>, Tensor<java.lang.Boolean>

All Known Implementing Classes:

SimpleBooleanTensor

public interface BooleanTensor
extends Tensor<java.lang.Boolean>, io.improbable.keanu.kotlin.BooleanOperators<BooleanTensor>

Nested Class Summary

Nested classes/interfaces inherited from interface io.improbable.keanu.tensor.Tensor

Tensor.FlattenedView<T>

Field Summary

Fields inherited from interface io.improbable.keanu.tensor.Tensor

ONE_BY_ONE_SHAPE, SCALAR_SHAPE, SCALAR_STRIDE

Method Summary

Modifier and Type	Method and Description
boolean	allFalse()
boolean	allTrue()
default BooleanTensor	and(boolean that)
BooleanTensor	and(BooleanTensor that)
BooleanTensor	andInPlace(BooleanTensor that)
boolean[]	asFlatBooleanArray()
BooleanTensor	booleanWhere(BooleanTensor trueValue, BooleanTensor falseValue)
static BooleanTensor	concat(int dimension, BooleanTensor[] toConcat)
static BooleanTensor	create(boolean... values)
static BooleanTensor	create(boolean[] values, long... shape)
static BooleanTensor	create(boolean value, long[] shape)
DoubleTensor	doubleWhere(DoubleTensor trueValue, DoubleTensor falseValue)
BooleanTensor	duplicate()
static BooleanTensor	falses(long... shape)
IntegerTensor	integerWhere(IntegerTensor trueValue, IntegerTensor falseValue)
BooleanTensor	not()
BooleanTensor	notInPlace()
default BooleanTensor	or(boolean that)
BooleanTensor	or(BooleanTensor that)
BooleanTensor	orInPlace(BooleanTensor that)
BooleanTensor	reshape(long... newShape)
static BooleanTensor	scalar(boolean scalarValue)
BooleanTensor	slice(int dimension, long index)
static BooleanTensor	stack(int dimension, BooleanTensor... toStack)
DoubleTensor	toDoubleMask()
IntegerTensor	toIntegerMask()
static BooleanTensor	trues(long... shape)
static BooleanTensor	vector(boolean... values)
<T,TENSOR extends Tensor<T>> TENSOR	where(TENSOR trueValue, TENSOR falseValue)
BooleanTensor	xor(BooleanTensor that)
BooleanTensor	xorInPlace(BooleanTensor that)

Methods inherited from interface io.improbable.keanu.tensor.Tensor

asFlatArray, asFlatDoubleArray, asFlatIntegerArray, asFlatList, create, createFilled, elementwiseEquals, elementwiseEquals, elementwiseEquals, getFlattenedView, getLength, getRank, getShape, getValue, getValue, hasSameShapeAs, hasSameShapeAs, isLengthOne, isMatrix, isScalar, isShapePlaceholder, isVector, scalar, setValue

Method Detail

create

static BooleanTensor create(boolean value,
                            long[] shape)

create

static BooleanTensor create(boolean[] values,
                            long... shape)

create

static BooleanTensor create(boolean... values)

scalar

static BooleanTensor scalar(boolean scalarValue)

Specified by:

scalar in interface Tensor<java.lang.Boolean>

vector

static BooleanTensor vector(boolean... values)

trues

static BooleanTensor trues(long... shape)

falses

static BooleanTensor falses(long... shape)

stack

static BooleanTensor stack(int dimension,
                           BooleanTensor... toStack)

Parameters:

dimension - the dimension along which toStack are stacked

toStack - an array of BooleanTensor's of the same shape

Returns:

a BooleanTensor with toStack joined along a new dimension

e.g. A, B, C = BooleanTensor.trues(4, 2)

BooleanTensor.stack(0, A, B, C) gives BooleanTensor.trues(3, 4, 2)

BooleanTensor.stack(1, A, B, C) gives BooleanTensor.trues(4, 3, 2)

BooleanTensor.stack(2, A, B, C) gives BooleanTensor.trues(4, 2, 3)

BooleanTensor.stack(-1, A, B, C) gives BooleanTensor.trues(4, 2, 3)

concat

static BooleanTensor concat(int dimension,
                            BooleanTensor[] toConcat)

reshape

BooleanTensor reshape(long... newShape)

Specified by:

reshape in interface Tensor<java.lang.Boolean>

duplicate

BooleanTensor duplicate()

Specified by:

duplicate in interface Tensor<java.lang.Boolean>

and

BooleanTensor and(BooleanTensor that)

Specified by:

and in interface io.improbable.keanu.kotlin.BooleanOperators<BooleanTensor>

and

default BooleanTensor and(boolean that)

Specified by:

and in interface io.improbable.keanu.kotlin.BooleanOperators<BooleanTensor>

or

BooleanTensor or(BooleanTensor that)

Specified by:

or in interface io.improbable.keanu.kotlin.BooleanOperators<BooleanTensor>

or

default BooleanTensor or(boolean that)

Specified by:

or in interface io.improbable.keanu.kotlin.BooleanOperators<BooleanTensor>

xor

BooleanTensor xor(BooleanTensor that)

not

BooleanTensor not()

Specified by:

not in interface io.improbable.keanu.kotlin.BooleanOperators<BooleanTensor>

doubleWhere

DoubleTensor doubleWhere(DoubleTensor trueValue,
                         DoubleTensor falseValue)

integerWhere

IntegerTensor integerWhere(IntegerTensor trueValue,
                           IntegerTensor falseValue)

booleanWhere

BooleanTensor booleanWhere(BooleanTensor trueValue,
                           BooleanTensor falseValue)

where

<T,TENSOR extends Tensor<T>> TENSOR where(TENSOR trueValue,
                                          TENSOR falseValue)

andInPlace

BooleanTensor andInPlace(BooleanTensor that)

orInPlace

BooleanTensor orInPlace(BooleanTensor that)

xorInPlace

BooleanTensor xorInPlace(BooleanTensor that)

notInPlace

BooleanTensor notInPlace()

allTrue

boolean allTrue()

allFalse

boolean allFalse()

toDoubleMask

DoubleTensor toDoubleMask()

toIntegerMask

IntegerTensor toIntegerMask()

slice

BooleanTensor slice(int dimension,
                    long index)

Specified by:

slice in interface Tensor<java.lang.Boolean>

asFlatBooleanArray

boolean[] asFlatBooleanArray()