io.improbable.keanu.backend.keanu.compiled

Class KeanuCompiledGraphBuilder

java.lang.Object

io.improbable.keanu.backend.keanu.compiled.KeanuCompiledGraphBuilder

All Implemented Interfaces:

ComputableGraphBuilder<ComputableGraph>

public class KeanuCompiledGraphBuilder
extends java.lang.Object
implements ComputableGraphBuilder<ComputableGraph>

Constructor Summary

Constructors

Constructor and Description
KeanuCompiledGraphBuilder()

Method Summary

Modifier and Type	Method and Description
VariableReference	add(VariableReference left, VariableReference right) Creates an addition operation for the left and right arguments.
io.improbable.keanu.backend.keanu.compiled.WrappedCompiledGraph	build()
void	connect(java.util.Map<? extends Vertex<?>,? extends Vertex<?>> connections)
void	create(Vertex visiting)
void	createConstant(Vertex visiting)
void	createVariable(Vertex visiting)
java.util.Collection<VariableReference>	getLatentVariables()
java.lang.String	getSource()
void	registerOutput(VariableReference output)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.improbable.keanu.backend.ComputableGraphBuilder

convert, convert

Constructor Detail

KeanuCompiledGraphBuilder

public KeanuCompiledGraphBuilder()

Method Detail

createConstant

public void createConstant(Vertex visiting)

Specified by:

createConstant in interface ComputableGraphBuilder<ComputableGraph>

Parameters:

visiting - create this vertex as a constant in the computable graph that is being built.

createVariable

public void createVariable(Vertex visiting)

Specified by:

createVariable in interface ComputableGraphBuilder<ComputableGraph>

Parameters:

visiting - create this vertex as a variable in the computable graph that is being built.

create

public void create(Vertex visiting)

Specified by:

create in interface ComputableGraphBuilder<ComputableGraph>

Parameters:

visiting - create this vertex in the compiled graph that is being built.

registerOutput

public void registerOutput(VariableReference output)

Specified by:

registerOutput in interface ComputableGraphBuilder<ComputableGraph>

Parameters:

output - a variable reference to a variable that should be used as an output. This lets the builder know that the variable should not be mutated and to possibly trim any operations that is not needed for this output.

getLatentVariables

public java.util.Collection<VariableReference> getLatentVariables()

Specified by:

getLatentVariables in interface ComputableGraphBuilder<ComputableGraph>

add

public VariableReference add(VariableReference left,
                             VariableReference right)

Description copied from interface: ComputableGraphBuilder

Creates an addition operation for the left and right arguments. This is used for adding two graphs that aren't otherwise connected. This happens when summing multiple logProb graphs to form a joint logProb variable

Specified by:

add in interface ComputableGraphBuilder<ComputableGraph>

Parameters:

left - a variable reference to the left arg

right - a variable reference to the right arg

Returns:

a new variable reference for the resulting sum

connect

public void connect(java.util.Map<? extends Vertex<?>,? extends Vertex<?>> connections)

Specified by:

connect in interface ComputableGraphBuilder<ComputableGraph>

Parameters:

connections - tells the graph builder that any time a vertex is referenced in a connection to reroute it to another vertex. This is used to hook up proxy vertices that aren't actually connected to parents until they are being added to a graph with this builder.

getSource

public java.lang.String getSource()

Returns:

The java source to be used for compilation. This will be the entire .java file that represents a class that can be used for doing a calculation described by the graph that was passed to this builder.

build

public io.improbable.keanu.backend.keanu.compiled.WrappedCompiledGraph build()

Specified by:

build in interface ComputableGraphBuilder<ComputableGraph>

Returns:

a computable graph that can be used for a calculation described by the vertices used to build it.