collections_mod::c_pop_integer Interface Reference

Pops an integer element off the stack or queue. More...

Private Member Functions
integer function	stack_pop_int (specificstack)
	Pops an element off the stack (LIFO) More...
integer function	queue_pop_int (specificqueue)
	Pops the queue element off the head of the queue (FIFO) More...

Detailed Description

Pops an integer element off the stack or queue.

This has a time complexity of O(1)

Parameters

collection

The specific stack or queue involved

Returns

Integer element which has been popped off the collection or raises and error if none is found

Definition at line 167 of file collections.F90.

Member Function/Subroutine Documentation

queue_pop_int()

integer function collections_mod::c_pop_integer::queue_pop_int ( type(queue_type), intent(inout)  specificqueue )

private

Pops the queue element off the head of the queue (FIFO)

Do not call directly from external module, this is called via the appropriate interface

Parameters

specificqueue

The specific queue involved

Returns

Integer element at head of the queue or raises an error if there is none

Definition at line 2559 of file collections.F90.

    type(queue_type), intent(inout) :: specificqueue
    integer :: queue_pop_int
 
    class(*), pointer :: generic
 
    generic=>queue_pop_generic(specificqueue)
    if (.not. associated(generic)) call log_log(log_error, "Can not pop integer from queue")
    queue_pop_int=conv_to_integer(generic, .false.)

stack_pop_int()

integer function collections_mod::c_pop_integer::stack_pop_int ( type(stack_type), intent(inout)  specificstack )

private

Pops an element off the stack (LIFO)

Do not call directly from external module, this is called via the appropriate interface

Parameters

specificstack

The specific stack involved

Returns

Integer data of the last element added to the stack or raises an error if none is found

Definition at line 2263 of file collections.F90.

    type(stack_type), intent(inout) :: specificstack
    integer :: stack_pop_int
 
    class(*), pointer :: generic
 
    generic=>stack_pop_generic(specificstack)
    if (.not. associated(generic)) call log_log(log_error, "Can not pop integer from stack")
    stack_pop_int=conv_to_integer(generic, .false.)

---

The documentation for this interface was generated from the following file:

• model_core/src/utils/collections.F90