repicea.simulation.covariateproviders.plotlevel

Interface StochasticInformationProvider<Realization>

public interface StochasticInformationProvider<Realization>

The StochasticInformationProvider interface provides basic information about the simulation mode.

Method Summary

Modifier and Type	Method and Description
default int	getNumberRealizations() This method returns the number of realizations to be made.
Realization	getRealization(int realizationID) This method returns the realization.
java.util.List<java.lang.Integer>	getRealizationIds() Returns the ids of the different realizations
boolean	isStochastic() This method returns true if the instance is running in stochastic mode or false it is in deterministic mode.

Method Detail

getNumberRealizations

default int getNumberRealizations()

This method returns the number of realizations to be made.

Returns:

an integer

getRealizationIds

java.util.List<java.lang.Integer> getRealizationIds()

Returns the ids of the different realizations

Returns:

a List of Integer

isStochastic

boolean isStochastic()

This method returns true if the instance is running in stochastic mode or false it is in deterministic mode.

Returns:

a boolean

getRealization

Realization getRealization(int realizationID)

This method returns the realization.

Parameters:

realizationID - the id of the realization

Returns:

an instance whose class is defined by the Realization parameter