io.improbable.keanu.vertices.dbl.probabilistic

Class UniformVertex

java.lang.Object

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

io.improbable.keanu.vertices.dbl.DoubleVertex

io.improbable.keanu.vertices.dbl.probabilistic.UniformVertex

All Implemented Interfaces:

Variable<DoubleTensor,VertexState<DoubleTensor>>, io.improbable.keanu.kotlin.DoubleOperators<DoubleVertex>, io.improbable.keanu.kotlin.NumberOperators<DoubleVertex>, Differentiable, ProbabilisticDouble, HasShape, LogProbGraphSupplier, Observable<DoubleTensor>, Probabilistic<DoubleTensor>, Samplable<DoubleTensor>, SamplableWithManyScalars<DoubleTensor>, SamplableWithShape<DoubleTensor>

public class UniformVertex
extends DoubleVertex
implements Differentiable, ProbabilisticDouble, SamplableWithManyScalars<DoubleTensor>, LogProbGraphSupplier

Constructor Summary

Constructors

Constructor and Description
UniformVertex(double xMin, double xMax)
UniformVertex(double xMin, DoubleVertex xMax)
UniformVertex(DoubleVertex xMin, double xMax)
UniformVertex(DoubleVertex xMin, DoubleVertex xMax) One to one constructor for mapping some shape of mu and sigma to a matching shaped Uniform Vertex
UniformVertex(long[] tensorShape, double xMin, double xMax)
UniformVertex(long[] tensorShape, double xMin, DoubleVertex xMax)
UniformVertex(long[] tensorShape, DoubleVertex xMin, double xMax)
UniformVertex(long[] tensorShape, DoubleVertex xMin, DoubleVertex xMax) One xMin or xMax or both that match a proposed tensor shape of Uniform Vertex

Method Summary

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

Methods inherited from class io.improbable.keanu.vertices.dbl.DoubleVertex

abs, acos, asin, atan, atan2, ceil, concat, cos, div, div, divideBy, divideBy, equalTo, exp, floor, getValue, greaterThan, greaterThanOrEqualTo, lambda, lambda, lessThan, lessThanOrEqualTo, loadValue, log, logGamma, matrixDeterminant, matrixInverse, matrixMultiply, max, min, minus, minus, multiply, multiply, notEqualTo, observe, observe, permute, plus, plus, pow, pow, reshape, reverseDiv, reverseMinus, round, saveValue, setAndCascade, setAndCascade, setValue, setValue, setWithMask, setWithMask, sigmoid, sin, slice, sum, sum, take, tan, times, times, toGreaterThanMask, toGreaterThanMask, toGreaterThanOrEqualToMask, toGreaterThanOrEqualToMask, toInteger, toLessThanMask, toLessThanMask, toLessThanOrEqualToMask, toLessThanOrEqualToMask, transpose, unaryMinus

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.dbl.Differentiable

forwardModeAutoDifferentiation, reverseModeAutoDifferentiation, withRespectToSelf

Methods inherited from interface io.improbable.keanu.vertices.dbl.probabilistic.ProbabilisticDouble

dLogPdf, dLogPdf, dLogPdf, dLogPdf, dLogPdf, dLogPdf, logPdf, logPdf, logPdf

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

UniformVertex

public UniformVertex(long[] tensorShape,
                     DoubleVertex xMin,
                     DoubleVertex xMax)

One xMin or xMax or both that match a proposed tensor shape of Uniform Vertex

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

Parameters:

tensorShape - desired tensor shape

xMin - the inclusive lower bound of the Uniform with either the same shape as specified for this vertex or a scalar

xMax - the exclusive upper bound of the Uniform with either the same shape as specified for this vertex or a scalar

UniformVertex

public UniformVertex(DoubleVertex xMin,
                     DoubleVertex xMax)

One to one constructor for mapping some shape of mu and sigma to a matching shaped Uniform Vertex

Parameters:

xMin - the inclusive lower bound of the Uniform with either the same shape as specified for this vertex or a scalar

xMax - the exclusive upper bound of the Uniform with either the same shape as specified for this vertex or a scalar

UniformVertex

public UniformVertex(DoubleVertex xMin,
                     double xMax)

UniformVertex

public UniformVertex(double xMin,
                     DoubleVertex xMax)

UniformVertex

public UniformVertex(double xMin,
                     double xMax)

UniformVertex

public UniformVertex(long[] tensorShape,
                     DoubleVertex xMin,
                     double xMax)

UniformVertex

public UniformVertex(long[] tensorShape,
                     double xMin,
                     DoubleVertex xMax)

UniformVertex

public UniformVertex(long[] tensorShape,
                     double xMin,
                     double xMax)

Method Detail

getXMin

public DoubleVertex getXMin()

getXMax

public DoubleVertex getXMax()

logProb

public double logProb(DoubleTensor 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<DoubleTensor>

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(DoubleTensor 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<DoubleTensor>

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 DoubleTensor sampleWithShape(long[] shape,
                                    KeanuRandom random)

Specified by:

sampleWithShape in interface SamplableWithShape<DoubleTensor>