io.improbable.keanu.vertices.bool.probabilistic

Class BernoulliVertex

java.lang.Object

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

io.improbable.keanu.vertices.bool.BooleanVertex

io.improbable.keanu.vertices.bool.probabilistic.BernoulliVertex

All Implemented Interfaces:

Variable<BooleanTensor,VertexState<BooleanTensor>>, io.improbable.keanu.kotlin.BooleanOperators<BooleanVertex>, ProbabilisticBoolean, HasShape, LogProbGraphSupplier, Observable<BooleanTensor>, Probabilistic<BooleanTensor>, Samplable<BooleanTensor>, SamplableWithManyScalars<BooleanTensor>, SamplableWithShape<BooleanTensor>

public class BernoulliVertex
extends BooleanVertex
implements ProbabilisticBoolean, SamplableWithManyScalars<BooleanTensor>, LogProbGraphSupplier

Constructor Summary

Constructors

Constructor and Description
BernoulliVertex(double probTrue)
BernoulliVertex(DoubleVertex probTrue) One to one constructor for mapping some shape of probTrue to a matching shaped Bernoulli.
BernoulliVertex(long[] shape, double probTrue)
BernoulliVertex(long[] shape, DoubleVertex probTrue) One probTrue that must match a proposed tensor shape of Bernoulli.

Method Summary

Modifier and Type	Method and Description
java.util.Map<Vertex,DoubleTensor>	dLogProb(BooleanTensor value, java.util.Set<? extends Vertex> withRespectTo) The partial derivatives of the natural log prob.
DoubleVertex	getProbTrue()
double	logProb(BooleanTensor value) This is the natural log of the probability at the supplied value.
LogProbGraph	logProbGraph()
BooleanTensor	sampleWithShape(long[] shape, KeanuRandom random)

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.bool.probabilistic.ProbabilisticBoolean

dLogPmf, dLogPmf, dLogPmf, logPmf, logPmf, logPmf

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

dLogProb, dLogProbAtValue, dLogProbAtValue, getValue, keepOnlyProbabilisticVertices, logProbAtValue

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

getObservedValue, isObserved, observe, unobserve

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

sample, sample

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

sample, sampleManyScalars, sampleManyScalars

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

sampleWithShape

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

getShape

Constructor Detail

BernoulliVertex

public BernoulliVertex(long[] shape,
                       DoubleVertex probTrue)

One probTrue that must match a proposed tensor shape of Bernoulli.

If all provided parameters are scalar then the proposed shape determines the shape

Parameters:

shape - the desired shape of the vertex

probTrue - the probability the bernoulli returns true

BernoulliVertex

public BernoulliVertex(DoubleVertex probTrue)

One to one constructor for mapping some shape of probTrue to a matching shaped Bernoulli.

Parameters:

probTrue - probTrue with same shape as desired Bernoulli tensor or scalar

BernoulliVertex

public BernoulliVertex(double probTrue)

BernoulliVertex

public BernoulliVertex(long[] shape,
                       double probTrue)

Method Detail

getProbTrue

public DoubleVertex getProbTrue()

logProb

public double logProb(BooleanTensor value)

Description copied from interface: Probabilistic

This is the natural log of the probability at the supplied value. In the case of continuous vertices, this is actually the log of the density, which will differ from the probability by a constant.

Specified by:

logProb in interface Probabilistic<BooleanTensor>

Parameters:

value - The supplied value.

Returns:

The natural log of the probability function at the supplied value. For continuous variables this is called the PDF (probability density function). For discrete variables this is called the PMF (probability mass function).

logProbGraph

public LogProbGraph logProbGraph()

Specified by:

logProbGraph in interface LogProbGraphSupplier

dLogProb

public java.util.Map<Vertex,DoubleTensor> dLogProb(BooleanTensor value,
                                                   java.util.Set<? extends Vertex> withRespectTo)

Description copied from interface: Probabilistic

The partial derivatives of the natural log prob.

Specified by:

dLogProb in interface Probabilistic<BooleanTensor>

Parameters:

value - at a given value

withRespectTo - list of parents to differentiate with respect to

Returns:

the partial derivatives of the log of the probability function at the supplied value. For continuous variables this is called the PDF (probability density function). For discrete variables this is called the PMF (probability mass function).

sampleWithShape

public BooleanTensor sampleWithShape(long[] shape,
                                     KeanuRandom random)

Specified by:

sampleWithShape in interface SamplableWithShape<BooleanTensor>