io.improbable.keanu.templating.loop

Class LoopBuilder

java.lang.Object

io.improbable.keanu.templating.loop.LoopBuilder

public class LoopBuilder
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LoopBuilder.LoopBuilder2

Method Summary

Modifier and Type	Method and Description
LoopBuilder	doNotThrowWhenMaxCountIsReached() An optional method to override the default behaviour If the maximum loop count is exceeded, it will log a warning instead of throwing
LoopBuilder.LoopBuilder2	iterateWhile(java.util.function.Function<SequenceItem,BooleanVertex> conditionFunction) A mandatory method to specify the condition
LoopBuilder.LoopBuilder2	iterateWhile(java.util.function.Supplier<BooleanVertex> conditionSupplier) A mandatory method to specify the condition
LoopBuilder	mapping(VertexLabel proxyLabel, VertexLabel proxysParentLabel) An optional method to add custom mappings
LoopBuilder	withMaxIterations(int maxCount) An optional method to override the default value

Methods inherited from class java.lang.Object

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

Method Detail

withMaxIterations

public LoopBuilder withMaxIterations(int maxCount)

An optional method to override the default value

Parameters:

maxCount - the max number of times the loop can run

Returns:

self

doNotThrowWhenMaxCountIsReached

public LoopBuilder doNotThrowWhenMaxCountIsReached()

An optional method to override the default behaviour If the maximum loop count is exceeded, it will log a warning instead of throwing

Returns:

self

mapping

public LoopBuilder mapping(VertexLabel proxyLabel,
                           VertexLabel proxysParentLabel)

An optional method to add custom mappings

Parameters:

proxyLabel - the label assigned to the ProxyVertex in frame t

proxysParentLabel - the label assigned to a Vertex in frame t-1 which will become the ProxyVertex's parent

Returns:

self

iterateWhile

public LoopBuilder.LoopBuilder2 iterateWhile(java.util.function.Supplier<BooleanVertex> conditionSupplier)

A mandatory method to specify the condition

Parameters:

conditionSupplier - a lambda that creates and returns a new BooleanVertex

Returns:

the next stage builder

iterateWhile

public LoopBuilder.LoopBuilder2 iterateWhile(java.util.function.Function<SequenceItem,BooleanVertex> conditionFunction)

A mandatory method to specify the condition

Parameters:

conditionFunction - a lambda that takes the current SequenceItem and creates and returns a new BooleanVertex

Returns:

the next stage builder