gov.usgs.earthquake.nshmp.tree

Interface LogicTree<T>

All Superinterfaces:

Iterable<Branch<T>>

public interface LogicTree<T>
extends Iterable<Branch<T>>

Logic tree interface that supports the iteration and sampling of individual branches.

Author:

Brandon Clayton

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LogicTree.Builder<T> A logic tree builder.

Method Summary

Modifier and Type	Method and Description
static <T> LogicTree.Builder<T>	builder() Return a new logic tree builder.
Branch<T>	sample(double probability) Return a logic tree branch corresponding to the supplied probability.
List<Branch<T>>	sample(double[] probabilities) Return an immutable list of logic tree branches corresponding to the supplied probabilities.
static <T> gov.usgs.earthquake.nshmp.tree.SingleBranchTree<T>	singleBranch(String id, T value) Return a new SingleBranchTree.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

sample

Branch<T> sample(double probability)

Return a logic tree branch corresponding to the supplied probability.

Note: this method does not check that 0.0 ≤ p < 1.0.

Parameters:

probability - in the range [0..1)

sample

List<Branch<T>> sample(double[] probabilities)

Return an immutable list of logic tree branches corresponding to the supplied probabilities.

Note: this method does not check that each 0.0 ≤ p < 1.0.

Parameters:

probabilities - in the range [0..1)

singleBranch

static <T> gov.usgs.earthquake.nshmp.tree.SingleBranchTree<T> singleBranch(String id,
                                                                           T value)

Return a new SingleBranchTree.

Parameters:

id - the branch identifier

value - the branch value

builder

static <T> LogicTree.Builder<T> builder()

Return a new logic tree builder.