io.improbable.keanu.algorithms.particlefiltering

Class ParticleFilterBuilder

java.lang.Object

io.improbable.keanu.algorithms.particlefiltering.ParticleFilterBuilder

public class ParticleFilterBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ParticleFilterBuilder(java.util.Collection<? extends Vertex> vertices)

Method Summary

Modifier and Type	Method and Description
ParticleFilter	build()
ParticleFilterBuilder	withNumParticles(int numParticles)
ParticleFilterBuilder	withRandom(KeanuRandom random)
ParticleFilterBuilder	withResamplingCycles(int resamplingCycles)
ParticleFilterBuilder	withResamplingProportion(double resamplingProportion)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleFilterBuilder

public ParticleFilterBuilder(java.util.Collection<? extends Vertex> vertices)

Parameters:

vertices - the vertices of a Bayesian network to find probable values for

Method Detail

withNumParticles

public ParticleFilterBuilder withNumParticles(int numParticles)

Parameters:

numParticles - the number of particles to generate (a larger number will yield better results but is more computationally expensive)

Returns:

this

withResamplingCycles

public ParticleFilterBuilder withResamplingCycles(int resamplingCycles)

Parameters:

resamplingCycles - the number of times low probability particles are culled and high probability particles are replicated each time the subgraph under consideration is expanded

Returns:

this

withResamplingProportion

public ParticleFilterBuilder withResamplingProportion(double resamplingProportion)

Parameters:

resamplingProportion - the proportion of particles to cull (e.g. the 25% of least probably particles could be culled)

Returns:

this

withRandom

public ParticleFilterBuilder withRandom(KeanuRandom random)

Parameters:

random - A KeanuRandom used for stochastic parts of algorithm

Returns:

this

build

public ParticleFilter build()