org.javades.jqueues.r5.util.predictor

Interface SimQueueEventPredictor<Q extends SimQueue>

Type Parameters:

Q - The type of SimQueues supported.

All Known Subinterfaces:

SimQueuePredictor<Q>

All Known Implementing Classes:

AbstractSimQueuePredictor, AbstractSimQueuePredictor_Composite, AbstractSimQueuePredictor_Composite_Enc, AbstractSimQueuePredictor_Composite_LocalStart, SimQueuePredictor_ALIMIT, SimQueuePredictor_CTandem2, SimQueuePredictor_CUPS, SimQueuePredictor_DELAY, SimQueuePredictor_DLIMIT, SimQueuePredictor_DROP, SimQueuePredictor_Enc, SimQueuePredictor_EncHS, SimQueuePredictor_EncJL, SimQueuePredictor_EncTL, SimQueuePredictor_FB_v, SimQueuePredictor_FCFS, SimQueuePredictor_FCFS_B, SimQueuePredictor_FCFS_B_c, SimQueuePredictor_FCFS_c, SimQueuePredictor_GATE, SimQueuePredictor_HOL, SimQueuePredictor_HOL_PS, SimQueuePredictor_IC, SimQueuePredictor_IS, SimQueuePredictor_IS_CST, SimQueuePredictor_LCFS, SimQueuePredictor_LCFS_B, SimQueuePredictor_LeakyBucket, SimQueuePredictor_LJF, SimQueuePredictor_NoBuffer_c, SimQueuePredictor_P_LCFS, SimQueuePredictor_Pattern, SimQueuePredictor_PQ, SimQueuePredictor_Preemptive, SimQueuePredictor_PS, SimQueuePredictor_SINK, SimQueuePredictor_SJF, SimQueuePredictor_SocPS, SimQueuePredictor_SRTF, SimQueuePredictor_SUR, SimQueuePredictor_Tandem, SimQueuePredictor_WUR, SimQueuePredictor_ZERO

public interface SimQueueEventPredictor<Q extends SimQueue>

An object capable of predicting the behavior of one or more SimQueues under external and internal events.

Author:

Jan de Jongh, TNO

Copyright (C) 2005-2017 Jan de Jongh, TNO

This file is covered by the LICENSE file in the root of this project.

See Also:

SimQueuePredictor

Method Summary

Modifier and Type	Method and Description
default SimQueueState<SimJob,Q>	createQueueState(Q queue, boolean isROEL) Creates a suitable SimQueueState object for this predictor and given queue.
default WorkloadSchedule_SQ_SV_ROEL_U	createWorkloadSchedule_SQ_SV_ROEL_U(Q queue, Set<SimJQEvent> workloadEvents) Creates and prepares a suitable WorkloadSchedule_SQ_SV_ROEL_U object for this predictor and given queue, for a given set of workload events.
default WorkloadSchedule_SQ_SV	createWorkloadSchedule_SQ_SV(Q queue, Map<Double,Set<SimJQEvent>> workloadEventsMap) Creates and prepares a suitable WorkloadSchedule_SQ_SV object for this predictor and given queue, for a given map of event times onto workload events.
void	doQueueEvents_SQ_SV_ROEL_U(Q queue, SimQueueState<SimJob,Q> queueState, Set<SimEntitySimpleEventType.Member> queueEventTypes, Set<JobQueueVisitLog<SimJob,Q>> visitLogsSet) Process the next event(s) at a queue with given state.
void	doWorkloadEvents_SQ_SV_ROEL_U(Q queue, WorkloadSchedule_SQ_SV_ROEL_U workloadSchedule, SimQueueState<SimJob,Q> queueState, Set<SimEntitySimpleEventType.Member> workloadEventTypes, Set<JobQueueVisitLog<SimJob,Q>> visitLogsSet) Process the next event(s) from given WorkloadSchedule at a queue with given state.
default void	doWorkloadEvents_SQ_SV(Q queue, WorkloadSchedule_SQ_SV workloadSchedule, SimQueueState queueState, Set<JobQueueVisitLog<SimJob,Q>> visitLogsSet) Process the next event(s) from given WorkloadSchedule at a queue with given state under IOEL.
double	getNextQueueEventTimeBeyond(Q queue, SimQueueState<SimJob,Q> queueState, Set<SimEntitySimpleEventType.Member> queueEventTypes) Returns the time and types of the next event(s) scheduled strictly beyond the time at (the state object of) a specific queue.
void	updateToTime(Q queue, SimQueueState queueState, double newTime) Updates the queue state to a new time, without processing any events.

Method Detail

createWorkloadSchedule_SQ_SV_ROEL_U

default WorkloadSchedule_SQ_SV_ROEL_U createWorkloadSchedule_SQ_SV_ROEL_U(Q queue,
                                                                          Set<SimJQEvent> workloadEvents)
                                                                   throws WorkloadScheduleException

Creates and prepares a suitable WorkloadSchedule_SQ_SV_ROEL_U object for this predictor and given queue, for a given set of workload events.

The initial time must be set to Double.NaN.

Implementations must prepare the required maps from the WorkloadSchedule_SQ_SV_ROEL_U at construction.

The default implementation returns a new DefaultWorkloadSchedule_SQ_SV_ROEL_U.

Parameters:

queue - The queue, non-null.

workloadEvents - The workload events, may be null or empty.

Returns:

A new suitable WorkloadSchedule_SQ_SV_ROEL_U object for this predictor and given queue.

Throws:

WorkloadScheduleException - If the workload is invalid or ambiguous (for instance).

createWorkloadSchedule_SQ_SV

default WorkloadSchedule_SQ_SV createWorkloadSchedule_SQ_SV(Q queue,
                                                            Map<Double,Set<SimJQEvent>> workloadEventsMap)
                                                     throws WorkloadScheduleException

Creates and prepares a suitable WorkloadSchedule_SQ_SV object for this predictor and given queue, for a given map of event times onto workload events.

The initial time must be set to Double.NaN.

Implementations must prepare the required maps from the WorkloadSchedule_SQ_SV at construction.

The default implementation returns a new DefaultWorkloadSchedule_SQ_SV.

Parameters:

queue - The queue, non-null.

workloadEventsMap - The workload events, may be null or empty.

Returns:

A new suitable WorkloadSchedule_SQ_SV object for this predictor and given queue.

Throws:

WorkloadScheduleException - If the workload is invalid (for instance).

createQueueState

default SimQueueState<SimJob,Q> createQueueState(Q queue,
                                                 boolean isROEL)

Creates a suitable SimQueueState object for this predictor and given queue.

The initial time must be set to Double.NaN.

Parameters:

queue - The queue, non-null.

isROEL - Whether or not the event list used is a Random-Order Event List.

Returns:

A new suitable SimQueueState object for this predictor and given queue.

Throws:

IllegalArgumentException - If queue == null.

UnsupportedOperationException - If isROEL == true, because the default implementation does not support non-ROEL event lists.

getNextQueueEventTimeBeyond

double getNextQueueEventTimeBeyond(Q queue,
                                   SimQueueState<SimJob,Q> queueState,
                                   Set<SimEntitySimpleEventType.Member> queueEventTypes)
                            throws SimQueuePredictionException

Returns the time and types of the next event(s) scheduled strictly beyond the time at (the state object of) a specific queue.

The time from which to search must be taken from SimQueueState.getTime(), and equals Double.NaN after initialization.

Parameters:

queue - The queue, non-null.

queueState - The queue-state, non-null.

queueEventTypes - A non-null set to store the (possible multiple) event types; it must be cleared upon entry.

Returns:

The time of the next event, or Double.NaN if no such event exists.

Throws:

IllegalArgumentException - If any of the input arguments is null.

SimQueuePredictionException - If the result cannot be computed, e.g., due to invalid input or schedule ambiguities.

See Also:

SimJQSimpleEventType.START, SimJQSimpleEventType.DEPARTURE

updateToTime

void updateToTime(Q queue,
                  SimQueueState queueState,
                  double newTime)

Updates the queue state to a new time, without processing any events.

Implementations must at least set the time on the queue state. Beware that the old time on the queue state may equal its initial value Double.NaN.

Parameters:

queue - The queue, non-null.

queueState - The queue-state, non-null.

newTime - The new time.

Throws:

IllegalArgumentException - If the queue or queue state is null, the new time is in the past, or the new time equals Double.NaN.

See Also:

SimQueueState.setTime(double)

doWorkloadEvents_SQ_SV_ROEL_U

void doWorkloadEvents_SQ_SV_ROEL_U(Q queue,
                                   WorkloadSchedule_SQ_SV_ROEL_U workloadSchedule,
                                   SimQueueState<SimJob,Q> queueState,
                                   Set<SimEntitySimpleEventType.Member> workloadEventTypes,
                                   Set<JobQueueVisitLog<SimJob,Q>> visitLogsSet)
                            throws SimQueuePredictionException,
                                   WorkloadScheduleException

Process the next event(s) from given WorkloadSchedule at a queue with given state.

The scheduled time and the types of the next events must be known beforehand, e.g., through WorkloadSchedule.getNextEventTimeBeyond(org.javades.jqueues.r5.entity.jq.queue.SimQueue, double, java.util.Set<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member>). The scheduled time has already been set on the SimQueueState object, and the object has been updated upto that time. The time on the queue state must not be changed.

Implementations must update the queue state and (if applicable) add suitable entries to the visit logs.

Implementations must not modify the workload schedule.

Parameters:

queue - The queue, non-null.

workloadSchedule - The workload schedule, non-null.

queueState - The queue-state, non-null.

workloadEventTypes - The (pre-calculated) types of the next workload event(s).

visitLogsSet - The visit logs, non-null.

Throws:

IllegalArgumentException - If any of the mandatory input arguments is null.

SimQueuePredictionException - If the result cannot be computed, e.g., due to invalid input or schedule ambiguities.

WorkloadScheduleException - If the workload is invalid (e.g., containing ambiguities).

See Also:

WorkloadSchedule.getNextEventTimeBeyond(org.javades.jqueues.r5.entity.jq.queue.SimQueue, double, java.util.Set<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member>), updateToTime(Q, org.javades.jqueues.r5.util.predictor.state.SimQueueState, double), SimQueueState.setTime(double)

doWorkloadEvents_SQ_SV

default void doWorkloadEvents_SQ_SV(Q queue,
                                    WorkloadSchedule_SQ_SV workloadSchedule,
                                    SimQueueState queueState,
                                    Set<JobQueueVisitLog<SimJob,Q>> visitLogsSet)
                             throws SimQueuePredictionException,
                                    WorkloadScheduleException

Process the next event(s) from given WorkloadSchedule at a queue with given state under IOEL.

The scheduled time and the types of the next events must be known beforehand, e.g., through WorkloadSchedule.getNextEventTimeBeyond(org.javades.jqueues.r5.entity.jq.queue.SimQueue, double, java.util.Set<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member>). The scheduled time has already been set on the SimQueueState object, and the object has been updated upto that time. The time on the queue state must not be changed.

Implementations must update the queue state and (if applicable) add suitable entries to the visit logs.

The default implementation creates a workload schedule for each individual event through createWorkloadSchedule_SQ_SV_ROEL_U(Q, java.util.Set<org.javades.jqueues.r5.entity.jq.SimJQEvent>) and has it processed through doWorkloadEvents_SQ_SV_ROEL_U(Q, org.javades.jqueues.r5.util.predictor.workload.WorkloadSchedule_SQ_SV_ROEL_U, org.javades.jqueues.r5.util.predictor.state.SimQueueState<org.javades.jqueues.r5.entity.jq.job.SimJob, Q>, java.util.Set<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member>, java.util.Set<org.javades.jqueues.r5.entity.jq.job.visitslogging.JobQueueVisitLog<org.javades.jqueues.r5.entity.jq.job.SimJob, Q>>).

Implementations must not modify the workload schedule.

Parameters:

queue - The queue, non-null.

workloadSchedule - The workload schedule, non-null.

queueState - The queue-state, non-null.

visitLogsSet - The visit logs, non-null.

Throws:

IllegalArgumentException - If any of the mandatory input arguments is null.

SimQueuePredictionException - If the result cannot be computed, e.g., due to invalid input or schedule ambiguities.

WorkloadScheduleException - If the workload is invalid (e.g., containing ambiguities).

See Also:

WorkloadSchedule.getNextEventTimeBeyond(org.javades.jqueues.r5.entity.jq.queue.SimQueue, double, java.util.Set<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member>), updateToTime(Q, org.javades.jqueues.r5.util.predictor.state.SimQueueState, double), SimQueueState.setTime(double)

doQueueEvents_SQ_SV_ROEL_U

void doQueueEvents_SQ_SV_ROEL_U(Q queue,
                                SimQueueState<SimJob,Q> queueState,
                                Set<SimEntitySimpleEventType.Member> queueEventTypes,
                                Set<JobQueueVisitLog<SimJob,Q>> visitLogsSet)
                         throws SimQueuePredictionException

Process the next event(s) at a queue with given state.

The scheduled time and the types of the next events must be known beforehand, e.g., through getNextQueueEventTimeBeyond(Q, org.javades.jqueues.r5.util.predictor.state.SimQueueState<org.javades.jqueues.r5.entity.jq.job.SimJob, Q>, java.util.Set<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member>). The scheduled time has already been set on the SimQueueState object, and the object has been updated upto that time. The time on the queue state must not be changed.

Implementations must update the queue state and (if applicable) add suitable entries to the visit logs.

Parameters:

queue - The queue, non-null.

queueState - The queue-state, non-null

queueEventTypes - The (pre-calculated) types of the next workload event(s).

visitLogsSet - The visit logs, non-null.

Throws:

IllegalArgumentException - If any of the mandatory input arguments is null.

SimQueuePredictionException - If the result cannot be computed, e.g., due to invalid input or schedule ambiguities.

See Also:

getNextQueueEventTimeBeyond(Q, org.javades.jqueues.r5.util.predictor.state.SimQueueState<org.javades.jqueues.r5.entity.jq.job.SimJob, Q>, java.util.Set<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member>), updateToTime(Q, org.javades.jqueues.r5.util.predictor.state.SimQueueState, double), SimQueueState.setTime(double)