io.improbable.keanu.templating

Class SequenceBuilder<T>

java.lang.Object

io.improbable.keanu.templating.SequenceBuilder<T>

Type Parameters:

T - The data type provided to user-provided sequence factory functions, if building from data

public class SequenceBuilder<T>
extends java.lang.Object

SequenceBuilder allows sequences to be constructed in steps

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SequenceBuilder.FromCount An intermediate builder, with a set count
class	SequenceBuilder.FromCountFactories Build some number of sequence items
class	SequenceBuilder.FromDataFactories Build Sequence from some provided Data
class	SequenceBuilder.FromIterator An intermediate builder, with a set data iterator

Constructor Summary

Constructors

Constructor and Description
SequenceBuilder()

Method Summary

Modifier and Type	Method and Description
SequenceBuilder.FromCount	count(int count) Build a fixed number of sequence items without additional data
SequenceBuilder.FromIterator	fromIterator(java.util.Iterator<T> iterator) Build an unspecified number of sequence items with data from an iterator
SequenceBuilder.FromIterator	fromIterator(java.util.Iterator<T> iterator, int sizeHint) Build a number of sequence items with data from an iterator
static VertexLabel	getUnscopedLabel(VertexLabel proxyLabel, boolean hasSequenceName) This function is best described by how it operates on labels passed to it: 1.
SequenceBuilder<T>	named(java.lang.String sequenceName)
static VertexLabel	proxyLabelFor(VertexLabel label)
SequenceBuilder<T>	withInitialState(Vertex<?> vertex)
SequenceBuilder<T>	withInitialState(VertexDictionary initialState)
SequenceBuilder<T>	withInitialState(VertexLabel label, Vertex<?> vertex)
SequenceBuilder<T>	withTransitionMapping(java.util.Map<VertexLabel,VertexLabel> transitionMapping)

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceBuilder

public SequenceBuilder()

Method Detail

proxyLabelFor

public static VertexLabel proxyLabelFor(VertexLabel label)

withInitialState

public SequenceBuilder<T> withInitialState(Vertex<?> vertex)

named

public SequenceBuilder<T> named(java.lang.String sequenceName)

withInitialState

public SequenceBuilder<T> withInitialState(VertexLabel label,
                                           Vertex<?> vertex)

withInitialState

public SequenceBuilder<T> withInitialState(VertexDictionary initialState)

withTransitionMapping

public SequenceBuilder<T> withTransitionMapping(java.util.Map<VertexLabel,VertexLabel> transitionMapping)

count

public SequenceBuilder.FromCount count(int count)

Build a fixed number of sequence items without additional data

Parameters:

count - count

Returns:

A builder with count set

fromIterator

public SequenceBuilder.FromIterator fromIterator(java.util.Iterator<T> iterator)

Build an unspecified number of sequence items with data from an iterator

Parameters:

iterator - iterator

Returns:

A builder with data set

fromIterator

public SequenceBuilder.FromIterator fromIterator(java.util.Iterator<T> iterator,
                                                 int sizeHint)

Build a number of sequence items with data from an iterator

Parameters:

iterator - iterator

sizeHint - A hint of the iterator cardinality. Does not need to be exact

Returns:

A builder with data set

getUnscopedLabel

public static VertexLabel getUnscopedLabel(VertexLabel proxyLabel,
                                           boolean hasSequenceName)

This function is best described by how it operates on labels passed to it: 1. `Sequence_Item_INDEX.HASHCODE.proxy_for.LABEL` becomes `proxy_for.LABEL` 2. `IDENTIFYING_NAMESPACE.Sequence_Item_INDEX.HASHCODE.proxy_for.LABEL` becomes `proxy_for.LABEL` 3. `Sequence_Item_INDEX.HASHCODE.LABEL` becomes `LABEL` 4. `IDENTIFYING_NAMESPACE.Sequence_Item_INDEX.HASHCODE.LABEL` becomes `LABEL`

Parameters:

proxyLabel - Label to be unscoped

hasSequenceName - Whether the sequence has a name

Returns:

unscoped label