io.improbable.keanu.vertices.utility

Class AssertVertex

java.lang.Object

io.improbable.keanu.vertices.Vertex<BooleanTensor>

io.improbable.keanu.vertices.bool.BooleanVertex

io.improbable.keanu.vertices.utility.AssertVertex

All Implemented Interfaces:

Variable<BooleanTensor,VertexState<BooleanTensor>>, io.improbable.keanu.kotlin.BooleanOperators<BooleanVertex>, NonProbabilistic<BooleanTensor>, Observable<BooleanTensor>

public class AssertVertex
extends BooleanVertex
implements NonProbabilistic<BooleanTensor>

Constructor Summary

Constructors

Constructor and Description
AssertVertex(Vertex<? extends BooleanTensor> predicate)
AssertVertex(Vertex<? extends BooleanTensor> predicate, java.lang.String errorMessage) A vertex that asserts a BooleanVertex is all true on calculation.

Method Summary

Modifier and Type	Method and Description
static BooleanTensor	assertion(BooleanTensor predicateValue, java.lang.String errorMessage, java.lang.String labelQualifiedName)
BooleanTensor	calculate()
java.lang.String	getErrorMessage()
Vertex<? extends BooleanTensor>	getPredicate()

Methods inherited from class io.improbable.keanu.vertices.bool.BooleanVertex

and, and, and, assertTrue, assertTrue, concat, equalTo, getValue, loadValue, not, not, notEqualTo, observe, observe, or, or, or, reshape, saveValue, setAndCascade, setAndCascade, setValue, setValue, slice, take

Methods inherited from class io.improbable.keanu.vertices.Vertex

addChild, addParent, addParents, equals, eval, getChildren, getConnectedGraph, getDegree, getId, getIndentation, getLabel, getObservedValue, getParents, getRank, getReference, getShape, getState, getValue, hashCode, hasValue, isDifferentiable, isObserved, isProbabilistic, lazyEval, observe, observeOwnValue, print, print, removeLabel, save, setAndCascade, setLabel, setLabel, setParents, setParents, setState, setValue, toString, unobserve

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.improbable.keanu.vertices.NonProbabilistic

contradictsObservation

Methods inherited from interface io.improbable.keanu.vertices.Observable

getObservedValue, isObserved, observe, unobserve

Constructor Detail

AssertVertex

public AssertVertex(Vertex<? extends BooleanTensor> predicate,
                    java.lang.String errorMessage)

A vertex that asserts a BooleanVertex is all true on calculation.

Parameters:

predicate - the predicate to evaluate

errorMessage - a message to include in the AssertionError

Throws:

java.lang.AssertionError - if any element of the predicate is false when calculated.

AssertVertex

public AssertVertex(Vertex<? extends BooleanTensor> predicate)

Method Detail

calculate

public BooleanTensor calculate()

Specified by:

calculate in interface NonProbabilistic<BooleanTensor>

assertion

public static BooleanTensor assertion(BooleanTensor predicateValue,
                                      java.lang.String errorMessage,
                                      java.lang.String labelQualifiedName)

getPredicate

public Vertex<? extends BooleanTensor> getPredicate()

getErrorMessage

public java.lang.String getErrorMessage()