org.eclipse.epsilon.erl

Interface IErlModuleAtomBatches<D extends RuleAtom<?>>

Type Parameters:

D - The type of Rule-element pair.

All Superinterfaces:

IEolModule, IErlModule, IModule, ModuleElement

All Known Implementing Classes:

EgxModuleParallelGenerationRuleAtoms, EvlModuleParallelAtoms, EvlModuleParallelConstraintAtoms, EvlModuleParallelContextAtoms

public interface IErlModuleAtomBatches<D extends RuleAtom<?>>
extends IErlModule

Interface for rule-based languages with deterministically ordered jobs which can be split into independent units of execution.

Since:

1.6

Author:

Sina Madani

Method Summary

Modifier and Type	Method and Description
List<? extends D>	getAllJobs() The atomic units of work.
default List<JobBatch>	getBatchJobs(int batchSize) Splits the job list (as returned from getAllJobs() into the specified number of batches.

Methods inherited from interface org.eclipse.epsilon.erl.IErlModule

getContext, getDeclaredPost, getDeclaredPre, getPost, getPre

Methods inherited from interface org.eclipse.epsilon.eol.IEolModule

configure, execute, getCompilationContext, getConfigurationProperties, getDeclaredModelDeclarations, getDeclaredOperations, getImports, getMain, getModelDelcarations, getOperations, getParentModule, getParseProblems, getPostOperationStatements, parse, setContext, setParentModule

Methods inherited from interface org.eclipse.epsilon.common.module.IModule

compile, createAst, getSourceUri, parse, parse, parse, parse, parse

Methods inherited from interface org.eclipse.epsilon.common.module.ModuleElement

build, getChildren, getFile, getModule, getParent, getRegion, getUri, setModule, setParent, setRegion, setUri

Method Detail

getAllJobs

List<? extends D> getAllJobs()
                      throws EolRuntimeException

The atomic units of work.

Returns:

A deterministically ordered List of executable rule-element pairs.

Throws:

EolRuntimeException - If any problems are encountered when retrieving the jobs.

getBatchJobs

default List<JobBatch> getBatchJobs(int batchSize)
                             throws EolRuntimeException

Splits the job list (as returned from getAllJobs() into the specified number of batches.

Parameters:

batchSize - This is interpreted as the size of batches, i.e. the distance between start and end indices.

Returns:

The list of start and end indices in order.

Throws:

EolRuntimeException

See Also:

JobBatch#getBatches(int, int)}.