Package nl.tudelft.simulation.dsol.eventlists

Class EventListPriorityQueue<T extends Number & Comparable<T>>

java.lang.Object

nl.tudelft.simulation.dsol.eventlists.EventListPriorityQueue<T>

Type Parameters:

T - the type of simulation time, e.g. SimTimeCalendarLong or Double or DoubleUnit.

All Implemented Interfaces:

Serializable, Iterable<SimEventInterface<T>>, EventListInterface<T>

public class EventListPriorityQueue<T extends Number & Comparable<T>>
extends Object
implements EventListInterface<T>

A RedBlackTree implementation of the eventlistInterface. This implementation is based on Java's TreeSet.

Copyright (c) 2002-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://simulation.tudelft.nl. The DSOL project is distributed under a three-clause BSD-style license, which can be found at https://https://simulation.tudelft.nl/dsol/docs/latest/license.html.

Since:

1.5

Author:

Peter Jacobs

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
EventListPriorityQueue()	Constructs a new RedBlackTree.

Method Summary

Modifier and Type	Method	Description
void	add(SimEventInterface<T> event)	Add an event to the event list.
void	clear()	Clear the event list.
boolean	contains(SimEventInterface<T> event)	Return whether this event list contains the given event.
SimEventInterface<T>	first()	Returns the first event (lowest time / priority) of the event list.
boolean	isEmpty()	Return whether the event list is empty.
Iterator<SimEventInterface<T>>	iterator()	Provide an iterator to loop over the event list.
boolean	remove(SimEventInterface<T> event)	Remove the given event from the event list.
SimEventInterface<T>	removeFirst()	Returns and removes the first event (lowest time / priority) of the event list.
int	size()	Return the number of events on the event list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

EventListPriorityQueue

public EventListPriorityQueue()

Constructs a new RedBlackTree.

Method Details

removeFirst

public SimEventInterface<T> removeFirst()

Returns and removes the first event (lowest time / priority) of the event list. The method returns null when the event list is empty.

Specified by:

removeFirst in interface EventListInterface<T extends Number & Comparable<T>>

Returns:

SimEventInterface<T>; the first element in this event list before removal, or null when the list is empty

first

public SimEventInterface<T> first()

Returns the first event (lowest time / priority) of the event list. The method returns null when the event list is empty.

Specified by:

first in interface EventListInterface<T extends Number & Comparable<T>>

Returns:

SimEventInterface<T>; the first element currently in this event list, or null when the list is empty

add

public void add(SimEventInterface<T> event)

Add an event to the event list.

Specified by:

add in interface EventListInterface<T extends Number & Comparable<T>>

Parameters:

event - SimEventInterface<T>; the event to add

contains

public boolean contains(SimEventInterface<T> event)

Return whether this event list contains the given event.

Specified by:

contains in interface EventListInterface<T extends Number & Comparable<T>>

Parameters:

event - SimEventInterface<T>; the event to search for

Returns:

boolean; whether the event list contains the given event

clear

public void clear()

Clear the event list.

Specified by:

clear in interface EventListInterface<T extends Number & Comparable<T>>

isEmpty

public boolean isEmpty()

Return whether the event list is empty.

Specified by:

isEmpty in interface EventListInterface<T extends Number & Comparable<T>>

Returns:

boolean; whether the event list is empty

iterator

public Iterator<SimEventInterface<T>> iterator()

Provide an iterator to loop over the event list.

Specified by:

iterator in interface EventListInterface<T extends Number & Comparable<T>>

Specified by:

iterator in interface Iterable<T extends Number & Comparable<T>>

Returns:

Iterator<SimEventInterface<T>>; an iterator to loop over the event list

remove

public boolean remove(SimEventInterface<T> event)

Remove the given event from the event list.

Specified by:

remove in interface EventListInterface<T extends Number & Comparable<T>>

Parameters:

event - SimEventInterface<T>; the event to remove

Returns:

boolean to indicate success of the removal operation

size

public int size()

Return the number of events on the event list.

Specified by:

size in interface EventListInterface<T extends Number & Comparable<T>>

Returns:

int; the number of events on the event list