collections_mod::c_size Interface Reference

Returns the number of elements in the collection. More...

Private Member Functions
integer function	list_size (specificlist)
	Returns the number of elements in a list. More...
integer function	stack_size (specificstack)
	Returns the number of elements held on the stack. More...
integer function	queue_size (specificqueue)
	Returns the number of elements held in a queue. More...
integer function	map_size (specificmap)
	Returns the number of elements in the map. More...
integer function	hashmap_size (specificmap)
	Returns the number of elements in the hashmap. More...
integer function	hashset_size (specificset)
	Returns the number of elements in a list. More...

Detailed Description

Returns the number of elements in the collection.

This has a time complexity of O(1)

Parameters

collection

The specific list, queue, stack or map involved

Returns

Number of elements in the collection

Definition at line 428 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_size()

integer function collections_mod::c_size::hashmap_size ( type(hashmap_type), intent(inout)  specificmap )

private

Returns the number of elements in the hashmap.

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

Parameters

specificmap

The specific hashmap involved

Returns

Number of key-value pairs held in the map

Definition at line 1869 of file collections.F90.

    type(hashmap_type), intent(inout) :: specificmap
 
    hashmap_size=specificmap%size

hashset_size()

integer function collections_mod::c_size::hashset_size ( type(hashset_type), intent(in)  specificset )

private

Returns the number of elements in a list.

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

Parameters

specificlist

The specific list involved

Returns

Number of list elements

Definition at line 2151 of file collections.F90.

    type(hashset_type), intent(in) :: specificset
 
    hashset_size = specificset%size

list_size()

integer function collections_mod::c_size::list_size ( type(list_type), intent(in)  specificlist )

private

Returns the number of elements in a list.

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

Parameters

specificlist

The specific list involved

Returns

Number of list elements

Definition at line 3175 of file collections.F90.

    type(list_type), intent(in) :: specificlist
 
    list_size = specificlist%size

map_size()

integer function collections_mod::c_size::map_size ( type(map_type), intent(inout)  specificmap )

private

Returns the number of elements in the map.

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

Parameters

specificmap

The specific map involved

Returns

Number of key-value pairs held in the map

Definition at line 1198 of file collections.F90.

    type(map_type), intent(inout) :: specificmap
 
    map_size = list_size(specificmap%map_ds)

queue_size()

integer function collections_mod::c_size::queue_size ( type(queue_type), intent(inout)  specificqueue )

private

Returns the number of elements held in a queue.

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

Parameters

specificqueue

The specific queue involved

Returns

Number of elements in the queue

Definition at line 2736 of file collections.F90.

    type(queue_type), intent(inout) :: specificqueue
 
    queue_size = list_size(specificqueue%queue_ds)

stack_size()

integer function collections_mod::c_size::stack_size ( type(stack_type), intent(inout)  specificstack )

private

Returns the number of elements held on the stack.

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

Parameters

specificstack

The specific stack involved

Returns

Number of stack elements

Definition at line 2440 of file collections.F90.

    type(stack_type), intent(inout) :: specificstack
 
    stack_size = list_size(specificstack%stack_ds)

---

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

• model_core/src/utils/collections.F90