io.improbable.keanu.vertices.dbl.nonprobabilistic.operators.unary

Class SumVertex

java.lang.Object

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

io.improbable.keanu.vertices.dbl.DoubleVertex

io.improbable.keanu.vertices.dbl.nonprobabilistic.operators.unary.DoubleUnaryOpVertex

io.improbable.keanu.vertices.dbl.nonprobabilistic.operators.unary.SumVertex

All Implemented Interfaces:

Variable<DoubleTensor,VertexState<DoubleTensor>>, io.improbable.keanu.kotlin.DoubleOperators<DoubleVertex>, io.improbable.keanu.kotlin.NumberOperators<DoubleVertex>, Differentiable, NonProbabilistic<DoubleTensor>, Observable<DoubleTensor>

public class SumVertex
extends DoubleUnaryOpVertex
implements Differentiable

Field Summary

Fields inherited from class io.improbable.keanu.vertices.dbl.nonprobabilistic.operators.unary.DoubleUnaryOpVertex

INPUT_VERTEX_NAME, inputVertex

Constructor Summary

Constructors

Constructor and Description
SumVertex(DoubleVertex inputVertex) Performs a sum across all dimensions
SumVertex(DoubleVertex inputVertex, int[] overDimensions) Performs a sum across specified dimensions.

Method Summary

Modifier and Type	Method and Description
PartialDerivative	forwardModeAutoDifferentiation(java.util.Map<Vertex,PartialDerivative> derivativeOfParentsWithRespectToInput)
int[]	getOverDimensions()
protected DoubleTensor	op(DoubleTensor value)
java.util.Map<Vertex,PartialDerivative>	reverseModeAutoDifferentiation(PartialDerivative derivativeOfOutputWithRespectToSelf)

Methods inherited from class io.improbable.keanu.vertices.dbl.nonprobabilistic.operators.unary.DoubleUnaryOpVertex

calculate, getInputVertex

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

withRespectToSelf

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

SumVertex

public SumVertex(DoubleVertex inputVertex,
                 int[] overDimensions)

Performs a sum across specified dimensions. Negative dimension indexing is not supported.

Parameters:

inputVertex - the vertex to have its values summed

overDimensions - dimensions to sum over

SumVertex

public SumVertex(DoubleVertex inputVertex)

Performs a sum across all dimensions

Parameters:

inputVertex - the vertex to have its values summed

Method Detail

op

protected DoubleTensor op(DoubleTensor value)

Specified by:

op in class DoubleUnaryOpVertex

forwardModeAutoDifferentiation

public PartialDerivative forwardModeAutoDifferentiation(java.util.Map<Vertex,PartialDerivative> derivativeOfParentsWithRespectToInput)

Specified by:

forwardModeAutoDifferentiation in interface Differentiable

reverseModeAutoDifferentiation

public java.util.Map<Vertex,PartialDerivative> reverseModeAutoDifferentiation(PartialDerivative derivativeOfOutputWithRespectToSelf)

Specified by:

reverseModeAutoDifferentiation in interface Differentiable

getOverDimensions

public int[] getOverDimensions()