io.improbable.keanu.network

Class TransitiveClosure

java.lang.Object

io.improbable.keanu.network.TransitiveClosure

public class TransitiveClosure
extends java.lang.Object

A Transitive Closure is defined as a given vertex and all the vertices that it affects (downstream) OR all of the vertices that affects it (upstream). Unlike a Lambda Section it does not stop at observed or probabilistic vertices.

For example:

A = SomeDistribution(...) B = A.cos() C = SomeDistribution(B, ...) D = C.times(2)

The downstream Transitive Closure of A would be [A, B, C, D] The upstream Transitive Closure of D would be [D, C, B, A] The upstream Transitive Closure of C would be [C, B, A]

Method Summary

Modifier and Type	Method and Description
static TransitiveClosure	getDownstreamVertices(Vertex<?> aVertex, boolean includeNonProbabilistic)
static TransitiveClosure	getDownstreamVerticesForCollection(java.util.List<Vertex> vertices, boolean includeNonProbabilistic)
static TransitiveClosure	getUpstreamVertices(Vertex<?> aVertex, boolean includeNonProbabilistic)
static TransitiveClosure	getUpstreamVerticesForCollection(java.util.List<Vertex> vertices, boolean includeNonProbabilistic)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getUpstreamVertices

public static TransitiveClosure getUpstreamVertices(Vertex<?> aVertex,
                                                    boolean includeNonProbabilistic)

Parameters:

aVertex - the starting vertex

includeNonProbabilistic - false if only the probabilistic or observed vertices are wanted

Returns:

All upstream vertices, not including non probabilistic if includeNonProbabilistic is false.

getDownstreamVertices

public static TransitiveClosure getDownstreamVertices(Vertex<?> aVertex,
                                                      boolean includeNonProbabilistic)

Parameters:

aVertex - the starting vertex

includeNonProbabilistic - false if only the probabilistic and observed are wanted

Returns:

All downstream vertices, not including non probabilistic if includeNonProbabilistic is false.

getUpstreamVerticesForCollection

public static TransitiveClosure getUpstreamVerticesForCollection(java.util.List<Vertex> vertices,
                                                                 boolean includeNonProbabilistic)

Parameters:

vertices - the starting vertices

includeNonProbabilistic - false if only the probabilistic or observed vertices are wanted

Returns:

All upstream vertices, not including non probabilistic if includeNonProbabilistic is false.

getDownstreamVerticesForCollection

public static TransitiveClosure getDownstreamVerticesForCollection(java.util.List<Vertex> vertices,
                                                                   boolean includeNonProbabilistic)

Parameters:

vertices - the starting vertices

includeNonProbabilistic - false if only the probabilistic or observed vertices are wanted

Returns:

All upstream vertices, not including non probabilistic if includeNonProbabilistic is false.