Creates a priority queue in form of an R6 class, that manages the correct process execution order.
Methods
Method new()
Creates a new metaRangePriorityQueue object. Note: No reason to call this as user. The priority queue is created automatically when a simulation is created.
Usage
metaRangePriorityQueue$new()Examples
# Only for illustration purposes.
pr_queue <- metaRangePriorityQueue$new()
pr_queueMethod execute_next_process()
Executes the next process in the queue. No reason to call this as user. The next process is executed automatically, when the previous process is finished.
Arguments
verbose<logical>Should timing and process information be printed when the process is executed?
Returns
<logical> TRUE if the next process has been executed,
FALSE if not, in which case the queue is empty.
Examples
# Only for illustration purposes.
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$update()
pr_queue$execute_next_process(verbose = TRUE)Method enqueue()
Add a process to the (future) queue.
Users should only use this method if they added a process to the simulation
via the add_process method of the simulation object with the argument
queue = FALSE. Otherwise the process is added to the queue automatically.
Arguments
process<metaRangeProcess>A metaRangeProcess that should be added to the queue.
Examples
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$get_future_queue()Method dequeue()
Remove a process from the (future) queue. Useful to remove a process from the queue if it is no longer needed. E.g. if a species went extinct.
Examples
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$dequeue(pr$get_PID())
pr_queue$get_future_queue()Method sort_future_queue()
Sort the (future) queue based on the execution priority. This method is called automatically when a process is added to the queue. Note: No reason to call this as user.
Examples
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$sort_future_queue()
# at least no errorMethod update()
Update and reset the queue. This method is called automatically at the end of each time step. Note: No reason to call this as user.
Examples
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$update()
pr_queue$get_queue()Method is_empty()
Check if the queue is empty.
Examples
pr_queue <- metaRangePriorityQueue$new()
stopifnot(pr_queue$is_empty())Method get_queue()
Return the current queue.
Examples
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$update()
pr_queue$get_queue()Method get_future_queue()
Return the future queue.
Examples
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$get_future_queue()Method get_current_index()
Get the index of the process that will be executed next.
Examples
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$update()
pr_queue$get_current_index()Method print()
Prints information about the queue to the console.
Examples
pr_queue <- metaRangePriorityQueue$new()
pr_queue$print()Examples
## ------------------------------------------------
## Method `metaRangePriorityQueue$new`
## ------------------------------------------------
# Only for illustration purposes.
pr_queue <- metaRangePriorityQueue$new()
pr_queue
#> Remaining queue (this time step): 0
#> NULL
#> Future queue (next time step): 0
#> NULL
## ------------------------------------------------
## Method `metaRangePriorityQueue$execute_next_process`
## ------------------------------------------------
# Only for illustration purposes.
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$update()
pr_queue$execute_next_process(verbose = TRUE)
#> |- : A
#> test
#> |---- 0.00035 secs
#> [1] TRUE
## ------------------------------------------------
## Method `metaRangePriorityQueue$enqueue`
## ------------------------------------------------
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$get_future_queue()
#> PID-152bbf441-A-
#> 1
## ------------------------------------------------
## Method `metaRangePriorityQueue$dequeue`
## ------------------------------------------------
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$dequeue(pr$get_PID())
pr_queue$get_future_queue()
#> named integer(0)
## ------------------------------------------------
## Method `metaRangePriorityQueue$sort_future_queue`
## ------------------------------------------------
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$sort_future_queue()
# at least no error
## ------------------------------------------------
## Method `metaRangePriorityQueue$update`
## ------------------------------------------------
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$update()
pr_queue$get_queue()
#> PID-15ee2fa2e1-A-
#> 1
## ------------------------------------------------
## Method `metaRangePriorityQueue$is_empty`
## ------------------------------------------------
pr_queue <- metaRangePriorityQueue$new()
stopifnot(pr_queue$is_empty())
## ------------------------------------------------
## Method `metaRangePriorityQueue$get_queue`
## ------------------------------------------------
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$update()
pr_queue$get_queue()
#> PID-12b3432141-A-
#> 1
## ------------------------------------------------
## Method `metaRangePriorityQueue$get_future_queue`
## ------------------------------------------------
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$get_future_queue()
#> PID-15c8b2c961-A-
#> 1
## ------------------------------------------------
## Method `metaRangePriorityQueue$get_current_index`
## ------------------------------------------------
pr_queue <- metaRangePriorityQueue$new()
pr <- metaRangeProcess$new("A", "1", \() {message("test")}, 1, new.env())
pr_queue$enqueue(pr)
pr_queue$update()
pr_queue$get_current_index()
#> [1] 1
## ------------------------------------------------
## Method `metaRangePriorityQueue$print`
## ------------------------------------------------
pr_queue <- metaRangePriorityQueue$new()
pr_queue$print()
#> Remaining queue (this time step): 0
#> NULL
#> Future queue (next time step): 0
#> NULL