SSJ API Documentation
Stochastic Simulation in Java
Loading...
Searching...
No Matches
umontreal.ssj.mcqmctools.anova.Replicator Class Reference

Replicator class. More...

Inheritance diagram for umontreal.ssj.mcqmctools.anova.Replicator:
umontreal.ssj.mcqmctools.anova.RandomIntegrator umontreal.ssj.mcqmctools.anova.Integrator

Public Member Functions

 Replicator (int nReplicates, RandomIntegrator integrator)
 Creates a replicator that samples nReplicates replicates using integrator.
RandomIntegrator getIntegrator ()
 Returns the internal integrator.
int getNumReplicates ()
 Returns the number of replicates.
int getNumPoints ()
 Returns the number of points (or simulations) per sample integral.
int getTotalSimulations ()
 Returns the total number of times the model is simulated per call to an integrate() method: the number of replications multiplied by the number of points.
void setStream (RandomStream stream)
 Use stream as the source of randomness.
RandomStream getStream ()
 Returns the currently used random stream.
void integrate (MonteCarloModelDouble model, Tally statValue)
 Integrates a model by means of simulation.
double integrate (MonteCarloModelDouble model)
 Shorthand to integrate without having to pass a Tally object.
void integrate (MonteCarloModel< double[]> model, ListOfTallies<? extends Tally > stat)
 Integrates a model by means of simulation.
void integrate (MonteCarloModel< double[]> model, double[] values)
 Shorthand to integrate without having to pass a ListOfTallies object.

Detailed Description

Replicator class.

Replicates mutliple samples of an integral computed by an internal random integrator.

Definition at line 14 of file Replicator.java.

Constructor & Destructor Documentation

◆ Replicator()

umontreal.ssj.mcqmctools.anova.Replicator.Replicator ( int nReplicates,
RandomIntegrator integrator )

Creates a replicator that samples nReplicates replicates using integrator.

Definition at line 28 of file Replicator.java.

Member Function Documentation

◆ getIntegrator()

RandomIntegrator umontreal.ssj.mcqmctools.anova.Replicator.getIntegrator ( )

Returns the internal integrator.

Definition at line 37 of file Replicator.java.

◆ getNumPoints()

int umontreal.ssj.mcqmctools.anova.Replicator.getNumPoints ( )

Returns the number of points (or simulations) per sample integral.

Implements umontreal.ssj.mcqmctools.anova.Integrator.

Definition at line 53 of file Replicator.java.

◆ getNumReplicates()

int umontreal.ssj.mcqmctools.anova.Replicator.getNumReplicates ( )

Returns the number of replicates.

Definition at line 45 of file Replicator.java.

◆ getStream()

RandomStream umontreal.ssj.mcqmctools.anova.Replicator.getStream ( )

Returns the currently used random stream.

May be null.

Implements umontreal.ssj.mcqmctools.anova.RandomIntegrator.

Definition at line 81 of file Replicator.java.

◆ getTotalSimulations()

int umontreal.ssj.mcqmctools.anova.Replicator.getTotalSimulations ( )

Returns the total number of times the model is simulated per call to an integrate() method: the number of replications multiplied by the number of points.

Implements umontreal.ssj.mcqmctools.anova.Integrator.

Definition at line 63 of file Replicator.java.

◆ integrate() [1/4]

void umontreal.ssj.mcqmctools.anova.Replicator.integrate ( MonteCarloModel< double[]> model,
double[] values )

Shorthand to integrate without having to pass a ListOfTallies object.

Implements umontreal.ssj.mcqmctools.anova.Integrator.

Definition at line 132 of file Replicator.java.

◆ integrate() [2/4]

void umontreal.ssj.mcqmctools.anova.Replicator.integrate ( MonteCarloModel< double[]> model,
ListOfTallies<? extends Tally > stat )

Integrates a model by means of simulation.

The output values are added to the statistical collector stat.

Implements umontreal.ssj.mcqmctools.anova.Integrator.

Definition at line 116 of file Replicator.java.

◆ integrate() [3/4]

double umontreal.ssj.mcqmctools.anova.Replicator.integrate ( MonteCarloModelDouble model)

Shorthand to integrate without having to pass a Tally object.

Implements umontreal.ssj.mcqmctools.anova.Integrator.

Definition at line 101 of file Replicator.java.

◆ integrate() [4/4]

void umontreal.ssj.mcqmctools.anova.Replicator.integrate ( MonteCarloModelDouble model,
Tally statValue )

Integrates a model by means of simulation.

The output values are added to the statistical collector statValue.

Implements umontreal.ssj.mcqmctools.anova.Integrator.

Definition at line 91 of file Replicator.java.

◆ setStream()

void umontreal.ssj.mcqmctools.anova.Replicator.setStream ( RandomStream stream)

Use stream as the source of randomness.

Sets the random stream of the point set randomization to stream.

Implements umontreal.ssj.mcqmctools.anova.RandomIntegrator.

Definition at line 73 of file Replicator.java.


The documentation for this class was generated from the following file: