collections_mod::c_get_generic Interface Reference

Gets a specific generic element out of the list, stack, queue or map with the corresponding key. More...

Private Member Functions
class(*) function, pointer	list_get_generic (specificlist, i)
	Retrieves the element at index i from the list or null if index < list size. More...
class(*) function, pointer	stack_get_generic (specificstack, i)
	Gets a specific element from the stack at index specified or null if the index > stack size. More...
class(*) function, pointer	queue_get_generic (specificqueue, i)
	Returns a specific queue element at an index or null if index > queue size. More...
class(*) function, pointer	map_get_generic (specificmap, key)
	Gets a specific element out of the map with the corresponding key. More...
class(*) function, pointer	hashmap_get_generic (specificmap, key)
	Gets a specific element out of the hashmap with the corresponding key. More...
class(*) function, pointer	mapentry_get_generic (mapentry_item)
	Retrieves the generic value from a map entry. More...

Detailed Description

Gets a specific generic element out of the list, stack, queue or map with the corresponding key.

This has a time complexity of O(n)

Parameters

collection	The specific list, stack, queue or map involved
key	String look up key

Returns

Generic pointer to the value associated with the key or null if none exists

Definition at line 367 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_get_generic()

class(*) function, pointer collections_mod::c_get_generic::hashmap_get_generic ( type(hashmap_type), intent(inout)  specificmap, character(len=*), intent(in)  key  )

private

Gets a specific element out of the hashmap with the corresponding key.

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

Parameters

specificmap	The specific hashmap involved
key	Look up key

Returns

Pointer to the generic value associated with the key or null if none exists

Definition at line 1774 of file collections.F90.

    type(hashmap_type), intent(inout) :: specificmap
    character(len=*), intent(in) :: key
    class(*), pointer :: hashmap_get_generic, raw_map_node
 
    raw_map_node=>hashmap_getnode(specificmap, key)
    if (associated(raw_map_node)) then
      select type (raw_map_node)
      type is (mapnode_type)
        hashmap_get_generic=>raw_map_node%value
      end select
      return
    end if
    hashmap_get_generic=>null()

list_get_generic()

class(*) function, pointer collections_mod::c_get_generic::list_get_generic ( type(list_type), intent(inout)  specificlist, integer, intent(in)  i  )

private

Retrieves the element at index i from the list or null if index < list size.

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

Parameters

specificlist	The specific list involved
i	Index to look up

Returns

Pointer to the generic data in the list

Definition at line 3117 of file collections.F90.

    type(list_type), intent(inout) :: specificlist
    integer, intent(in) :: i
    class(*), pointer :: list_get_generic
 
    integer :: j
    type(listnode_type), pointer :: node
 
    j=1
    if (specificlist%size .lt. i) then
      list_get_generic => null()
      return
    end if
    node => specificlist%head
    do while(j .lt. i)
      if (.not. associated(node)) exit
      node => node%next
      j=j+1
    end do
    list_get_generic => node%data

map_get_generic()

class(*) function, pointer collections_mod::c_get_generic::map_get_generic ( type(map_type), intent(inout)  specificmap, character(len=*), intent(in)  key  )

private

Gets a specific element out of the map with the corresponding key.

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

Parameters

specificmap	The specific map involved
key	Look up key

Returns

Pointer to the generic value associated with the key or null if none exists

Definition at line 1136 of file collections.F90.

    type(map_type), intent(inout) :: specificmap
    character(len=*), intent(in) :: key
    class(*), pointer :: map_get_generic, raw_map_node
 
    raw_map_node=>map_getnode(specificmap, key)
    if (associated(raw_map_node)) then
      select type (raw_map_node)
      type is (mapnode_type)
        map_get_generic => raw_map_node%value
      end select
      return
    end if
    map_get_generic => null()

mapentry_get_generic()

class(*) function, pointer collections_mod::c_get_generic::mapentry_get_generic ( type(mapentry_type), intent(in)  mapentry_item )

private

Retrieves the generic value from a map entry.

Parameters

mapentry_item

The map entry to retrieve the generic value from

Definition at line 3379 of file collections.F90.

    type(mapentry_type), intent(in) :: mapentry_item
    class(*), pointer :: mapentry_get_generic
    
    mapentry_get_generic=>mapentry_item%value

queue_get_generic()

class(*) function, pointer collections_mod::c_get_generic::queue_get_generic ( type(queue_type), intent(inout)  specificqueue, integer, intent(in)  i  )

private

Returns a specific queue element at an index or null if index > queue size.

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

Parameters

specificqueue	The specific queue involved
i	The index to look up

Returns

Pointer to the generic queue element at i or null if the index does not exist

Definition at line 2723 of file collections.F90.

    type(queue_type), intent(inout) :: specificqueue
    integer, intent(in) :: i
    class(*), pointer :: queue_get_generic
 
    queue_get_generic=>list_get_generic(specificqueue%queue_ds, i)

stack_get_generic()

class(*) function, pointer collections_mod::c_get_generic::stack_get_generic ( type(stack_type), intent(inout)  specificstack, integer, intent(in)  i  )

private

Gets a specific element from the stack at index specified or null if the index > stack size.

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

Parameters

specificstack	The specific stack involved
i	The index to retrieve the element at

Returns

Pointer to the generic data

Definition at line 2427 of file collections.F90.

    type(stack_type), intent(inout) :: specificstack
    integer, intent(in) :: i
    class(*), pointer :: stack_get_generic
 
    stack_get_generic=>list_get_generic(specificstack%stack_ds, i)

---

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

• model_core/src/utils/collections.F90