Package jsl.simulation
Interface ExperimentGetIfc
-
- All Known Implementing Classes:
Experiment
,Simulation
public interface ExperimentGetIfc
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
getAdvanceNextSubStreamOption()
Gets the reset next substream option.boolean
getAntitheticOption()
Returns whether or not the antithetic option is turned on.int
getCurrentReplicationNumber()
Returns the current number of replications completedlong
getExperimentId()
Returns the id for this objectjava.lang.String
getExperimentName()
Gets the name.boolean
getGarbageCollectAfterReplicationFlag()
Indicates whether or not System.gc() should be called after each replicationdouble
getLengthOfReplication()
Returns the length of the replication as a doubledouble
getLengthOfWarmUp()
Gets the length of the warm up for each replication with this experimentlong
getMaximumAllowedExecutionTimePerReplication()
Returns maximum (real) clock time allocated for the iterative processint
getNumberOfReplications()
Returns the number of replications to runint
getNumberOfStreamAdvancesPriorToRunning()
Returns the number of times that the streams should be advanced prior to running the experimentboolean
getReplicationInitializationOption()
Returns the setting for whether or not each replication will be reinitialized prior to running.boolean
getResetStartStreamOption()
Gets the reset start stream option.boolean
hasMoreReplications()
Checks if the current number of replications that have been executed is less than the number of replications specified.
-
-
-
Method Detail
-
getExperimentName
java.lang.String getExperimentName()
Gets the name.- Returns:
- The name of object.
-
getExperimentId
long getExperimentId()
Returns the id for this object- Returns:
- the id
-
getAdvanceNextSubStreamOption
boolean getAdvanceNextSubStreamOption()
Gets the reset next substream option. The reset next sub stream option This option indicates whether or not the random variables used during the replication within the experiment will be reset to their next substream after running each replication. The default is TRUE. This ensures that the random variables will jump to the next substream within their current stream at the end of a replication. This will cause the random variables in each subsequent replication to start in the same substream in the underlying random number streams if the replication is repeatedly used and the ResetStartStreamOption is set to false (which is the default). Otherwise, this option really has no effect if there is only 1 replication in an experiment. and then jump to the next substream (if this option is on). Having this option true assists in synchronizing the random number draws from one replication to another aiding in the implementation of common random numbers. Each replication within the same experiment is still independent but each replication will start in the same place (across experiments).- Returns:
- true means the option is on
-
getNumberOfStreamAdvancesPriorToRunning
int getNumberOfStreamAdvancesPriorToRunning()
Returns the number of times that the streams should be advanced prior to running the experiment- Returns:
- number of streams to advance
-
getAntitheticOption
boolean getAntitheticOption()
Returns whether or not the antithetic option is turned on. True means that it has been turned on.- Returns:
- true if option is on
-
getCurrentReplicationNumber
int getCurrentReplicationNumber()
Returns the current number of replications completed- Returns:
- the number as a double
-
getGarbageCollectAfterReplicationFlag
boolean getGarbageCollectAfterReplicationFlag()
Indicates whether or not System.gc() should be called after each replication- Returns:
- true if option is on
-
getLengthOfReplication
double getLengthOfReplication()
Returns the length of the replication as a double- Returns:
- the length of the replication
-
getLengthOfWarmUp
double getLengthOfWarmUp()
Gets the length of the warm up for each replication with this experiment- Returns:
- the the length of the warm up
-
getMaximumAllowedExecutionTimePerReplication
long getMaximumAllowedExecutionTimePerReplication()
Returns maximum (real) clock time allocated for the iterative process- Returns:
- the number as long representing milliseconds
-
getNumberOfReplications
int getNumberOfReplications()
Returns the number of replications to run- Returns:
- the number as a double
-
getReplicationInitializationOption
boolean getReplicationInitializationOption()
Returns the setting for whether or not each replication will be reinitialized prior to running.- Returns:
- true means that each replication will be initialized
-
getResetStartStreamOption
boolean getResetStartStreamOption()
Gets the reset start stream option. The reset start stream option This option indicates whether or not the random variables used during the experiment will be reset to their starting stream prior to running the first replication. The default is FALSE. This ensures that the random variable's streams WILL NOT be reset prior to running the experiment. This will cause different experiments or the same experiment run multiple times that use the same random variables (via the same model) to continue within their current stream. Therefore the experiments will be independent when invoked within the same program execution. To get common random number (CRN), run the experiments in different program executions OR set this option to true prior to running the experiment again within the same program invocation.- Returns:
- true means the option is on
-
hasMoreReplications
boolean hasMoreReplications()
Checks if the current number of replications that have been executed is less than the number of replications specified.- Returns:
- true if more
-
-