p3j.simulation.assignments.plugintype
Interface IParamAssignmentGenerator

All Known Implementing Classes:
ExhaustiveAssignmentGenerator, RandomParamAssignmentGenerator

public interface IParamAssignmentGenerator

Interface for all PPPM simulators/analysers, which work on top of the calculation component. There are different ways of analysing and simulating this model, e.g. by Monte-Carlo simulation. Created: August 17, 2008

Author:
Christina Bohk, Roland Ewald

Method Summary
 long assignmentsLeft()
          Retrieves number of possible parameter assignments that is left and can be generated by the assignment generator.
 james.core.util.misc.Pair<Map<ParameterInstance,ParameterAssignment>,List<GeneratorError>> chooseParamAssignments(james.core.math.random.generators.IRandom random)
          This is the main execution method for PPPM simulators/analysers. mapping from each ParameterInstance defined in the ProjectionModel to one ParameterAssignment to be used in the calculation.
 void init(IProjectionModel projection)
          Initializes generator with the projection setup.
 

Method Detail

init

void init(IProjectionModel projection)
Initializes generator with the projection setup.

Parameters:
projection - the projection setup for which a valid (i.e., complete) parameter assignment shall be generated.

chooseParamAssignments

james.core.util.misc.Pair<Map<ParameterInstance,ParameterAssignment>,List<GeneratorError>> chooseParamAssignments(james.core.math.random.generators.IRandom random)
This is the main execution method for PPPM simulators/analysers. mapping from each ParameterInstance defined in the ProjectionModel to one ParameterAssignment to be used in the calculation. Additionally, this method retrieves all GeneratorError objects, which is the error log of the assignment generation process.

Parameters:
random - the random number generator to be used when stochastic approaches are implemented
Returns:
tuple, first element is the mapping from each ParameterInstance defined in the ProjectionModel to one ParameterAssignment to be used, the second element is the error log

assignmentsLeft

long assignmentsLeft()
Retrieves number of possible parameter assignments that is left and can be generated by the assignment generator. If this returns 0, the execution will stop. Note that this is the minimal number, i.e. it may change dynamically over time and may even increase from one call to another.

Returns:
minimum number of assignments that can be generated


Copyright © 2012. All Rights Reserved.