io.improbable.keanu.algorithms.mcmc

Interface SamplingAlgorithm

All Known Implementing Classes:

ForwardSampler, MetropolisHastingsSampler

public interface SamplingAlgorithm

Method Summary

Modifier and Type	Method and Description
NetworkSample	sample() Takes a sample with the algorithm and returns the state of the network for that sample.
void	sample(java.util.Map<VariableReference,java.util.List<?>> samples, java.util.List<java.lang.Double> logOfMasterPForEachSample) Takes a sample with the algorithm and saves it in the supplied map (creating a new entry in the list if the Variable already exists).
void	step() Move forward the state of the Sampling Algorithm by a single step but do not return anything.
static java.util.Map<VariableReference,?>	takeSample(java.util.List<? extends Variable> sampleFromVariables)

Method Detail

takeSample

static java.util.Map<VariableReference,?> takeSample(java.util.List<? extends Variable> sampleFromVariables)

step

void step()

Move forward the state of the Sampling Algorithm by a single step but do not return anything.

sample

void sample(java.util.Map<VariableReference,java.util.List<?>> samples,
            java.util.List<java.lang.Double> logOfMasterPForEachSample)

Takes a sample with the algorithm and saves it in the supplied map (creating a new entry in the list if the Variable already exists).

Parameters:

samples - map to store sampled variable values

logOfMasterPForEachSample - list of log of master probability for each sample

sample

NetworkSample sample()

Takes a sample with the algorithm and returns the state of the network for that sample.

Returns:

a network state that represents the current state of the algorithm.