io.improbable.keanu.util

Class DescriptionCreator

java.lang.Object

io.improbable.keanu.util.DescriptionCreator

public class DescriptionCreator
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DescriptionCreator()

Method Summary

Modifier and Type	Method and Description
java.lang.String	createDescription(Vertex<?> vertex) This method constructs an equation to describe how a vertex is calculated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DescriptionCreator

public DescriptionCreator()

Method Detail

createDescription

public java.lang.String createDescription(Vertex<?> vertex)

This method constructs an equation to describe how a vertex is calculated. The description is generated by recursively stepping up through the BayesNet and generating descriptions. Descriptions of common vertices will use infix operators. Descriptions will not recurse any further than labelled vertices.

It is suggested that to use this feature, you label as many vertices as possible to avoid complex descriptions.

Parameters:

vertex - The vertex to create the description of

Returns:

An String equation describing how this vertex is calculated.
E.g. "This Vertex = that + (three * Const(4))"