io.improbable.keanu.vertices

Class Vertex<T>

java.lang.Object

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

All Implemented Interfaces:

Variable<T,VertexState<T>>, Observable<T>

Direct Known Subclasses:

BooleanVertex, DoubleVertex, GenericVertex, IntegerVertex

public abstract class Vertex<T>
extends java.lang.Object
implements Observable<T>, Variable<T,VertexState<T>>

Constructor Summary

Constructors

Constructor and Description
Vertex()
Vertex(long[] initialShape)

Method Summary

Modifier and Type	Method and Description
void	addChild(Vertex<?> v)
void	addParent(Vertex<?> parent)
void	addParents(java.util.Collection<? extends Vertex> parents)
boolean	equals(java.lang.Object o)
T	eval() This causes a backwards propagating calculation of the vertex value.
java.util.Set<Vertex>	getChildren()
java.util.Set<Vertex>	getConnectedGraph()
int	getDegree()
VertexId	getId()
int	getIndentation()
VertexLabel	getLabel()
java.util.Optional<T>	getObservedValue()
java.util.Set<Vertex>	getParents()
int	getRank()
VariableReference	getReference()
long[]	getShape()
VertexState<T>	getState()
T	getValue()
int	hashCode()
boolean	hasValue()
boolean	isDifferentiable()
boolean	isObserved()
boolean	isProbabilistic()
T	lazyEval() This is similar to eval() except it only propagates as far up the graph as required until there are values present to operate on.
void	loadValue(NetworkLoader loader)
void	observe(T value) This marks the vertex's value as being observed and unchangeable.
void	observeOwnValue() Cause this vertex to observe its own value, for example when generating test data
<V extends Vertex<T>> V	print()
<V extends Vertex<T>> V	print(java.lang.String message, boolean printData)
<V extends Vertex<T>> V	removeLabel()
void	save(NetworkSaver netSaver)
void	saveValue(NetworkSaver netSaver)
void	setAndCascade(T value) This sets the value in this vertex and tells each child vertex about the new change.
<V extends Vertex<T>> V	setLabel(java.lang.String label)
<V extends Vertex<T>> V	setLabel(VertexLabel label) Set a label for this vertex.
void	setParents(java.util.Collection<? extends Vertex> parents)
void	setParents(Vertex<?>... parents)
void	setState(VertexState<T> newState)
void	setValue(T value) Sets the value if the vertex isn't already observed.
java.lang.String	toString()
void	unobserve()

Methods inherited from class java.lang.Object

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

Constructor Detail

Vertex

public Vertex()

Vertex

public Vertex(long[] initialShape)

Method Detail

setLabel

public <V extends Vertex<T>> V setLabel(VertexLabel label)

Set a label for this vertex. This allows easy retrieval of this vertex using nothing but a label name.

Type Parameters:

V - vertex type

Parameters:

label - The label to apply to this vertex. Uniqueness is only enforced on instantiation of a Bayes Net

Returns:

this

setLabel

public <V extends Vertex<T>> V setLabel(java.lang.String label)

getLabel

public VertexLabel getLabel()

removeLabel

public <V extends Vertex<T>> V removeLabel()

lazyEval

public final T lazyEval()

This is similar to eval() except it only propagates as far up the graph as required until there are values present to operate on. On a graph that is completely uninitialized, this would be the same as eval()

Returns:

the value of the vertex based on the already calculated upstream values

eval

public final T eval()

This causes a backwards propagating calculation of the vertex value. This propagation only happens for vertices with values dependent on parent values i.e. non-probabilistic vertices. This will also cause probabilistic vertices that have no value to set their value by calling their sample method.

Returns:

The value at this vertex after recalculating any parent non-probabilistic vertices.

isProbabilistic

public final boolean isProbabilistic()

Returns:

True if the vertex is probabilistic, false otherwise. A probabilistic vertex is defined as a vertex whose value is not derived from it's parents. However, the probability of the vertex's value may be dependent on it's parents values.

isDifferentiable

public final boolean isDifferentiable()

Returns:

True if the vertex is differentiable, false otherwise.

setValue

public void setValue(T value)

Sets the value if the vertex isn't already observed.

Parameters:

value - the observed value

getValue

public T getValue()

Specified by:

getValue in interface Variable<T,VertexState<T>>

getState

public VertexState<T> getState()

Specified by:

getState in interface Variable<T,VertexState<T>>

setState

public void setState(VertexState<T> newState)

hasValue

public boolean hasValue()

getShape

public long[] getShape()

Specified by:

getShape in interface Variable<T,VertexState<T>>

getRank

public int getRank()

print

public <V extends Vertex<T>> V print()

print

public <V extends Vertex<T>> V print(java.lang.String message,
                                     boolean printData)

setAndCascade

public void setAndCascade(T value)

This sets the value in this vertex and tells each child vertex about the new change. This causes a cascading change of values if any of the children vertices are non-probabilistic vertices (e.g. mathematical operations).

Parameters:

value - The new value at this vertex

observe

public void observe(T value)

This marks the vertex's value as being observed and unchangeable.

Non-probabilistic vertices of continuous types (integer, double) are prohibited from being observed due to its negative impact on inference algorithms. Non-probabilistic booleans are allowed to be observed as well as user defined types.

Specified by:

observe in interface Observable<T>

Parameters:

value - the value to be observed

observeOwnValue

public void observeOwnValue()

Cause this vertex to observe its own value, for example when generating test data

unobserve

public void unobserve()

Specified by:

unobserve in interface Observable<T>

isObserved

public boolean isObserved()

Specified by:

isObserved in interface Observable<T>

getObservedValue

public java.util.Optional<T> getObservedValue()

Specified by:

getObservedValue in interface Observable<T>

getReference

public VariableReference getReference()

Specified by:

getReference in interface Variable<T,VertexState<T>>

getId

public VertexId getId()

getIndentation

public int getIndentation()

getChildren

public java.util.Set<Vertex> getChildren()

addChild

public void addChild(Vertex<?> v)

setParents

public void setParents(java.util.Collection<? extends Vertex> parents)

setParents

public void setParents(Vertex<?>... parents)

addParents

public void addParents(java.util.Collection<? extends Vertex> parents)

addParent

public void addParent(Vertex<?> parent)

getParents

public java.util.Set<Vertex> getParents()

getDegree

public int getDegree()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getConnectedGraph

public java.util.Set<Vertex> getConnectedGraph()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

save

public void save(NetworkSaver netSaver)

saveValue

public void saveValue(NetworkSaver netSaver)

loadValue

public void loadValue(NetworkLoader loader)