collections_mod::c_key_at Interface Reference

Retrieves the key currently being held at a specific index in the map or "" if the index > map elements. More...

Private Member Functions
character(len=string_length) function	map_key_at (specificmap, i)
	Retrieves the key currently being held at a specific index in the map or "" if the index > map elements. More...
character(len=string_length) function	hashmap_key_at (specificmap, i)
	Retrieves the key currently being held at a specific index in the hashmap or "" if the index > map elements. Note that this is an expensive operation has it has to potentially process all internal hashed lists so avoid if can. More...

Detailed Description

Retrieves the key currently being held at a specific index in the map or "" if the index > map elements.

This has a time complexity of O(n)

Parameters

collection	The specific map involved
index	The index to retrieve the key from

Returns

The key string

Definition at line 457 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_key_at()

character(len=string_length) function collections_mod::c_key_at::hashmap_key_at ( type(hashmap_type), intent(inout)  specificmap, integer, intent(in)  i  )

private

Retrieves the key currently being held at a specific index in the hashmap or "" if the index > map elements. Note that this is an expensive operation has it has to potentially process all internal hashed lists so avoid if can.

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

Parameters

specificmap	The specific hashmap involved
i	The index to retrieve the key from

Returns

The key string

Definition at line 1420 of file collections.F90.

    type(hashmap_type), intent(inout) :: specificmap
    integer, intent(in) :: i
 
    class(*), pointer :: raw_map_node    
 
    raw_map_node=>hashmap_getnode_atindex(specificmap, i)
    if (associated(raw_map_node)) then
      select type(raw_map_node)
      type is(mapnode_type)
        hashmap_key_at = raw_map_node%key
      end select
      return
    else
      hashmap_key_at=""
    end if

map_key_at()

character(len=string_length) function collections_mod::c_key_at::map_key_at ( type(map_type), intent(inout)  specificmap, integer, intent(in)  i  )

private

Retrieves the key currently being held at a specific index in the map or "" if the index > map elements.

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

Parameters

specificmap	The specific map involved
i	The index to retrieve the key from

Returns

The key string

Definition at line 778 of file collections.F90.

    type(map_type), intent(inout) :: specificmap
    integer, intent(in) :: i
 
    class(*), pointer :: raw_map_node
    integer :: the_map_size
 
    the_map_size = map_size(specificmap)
    if (i .le. the_map_size) then
      raw_map_node=>list_get_generic(specificmap%map_ds, i)
      if (associated(raw_map_node)) then
        select type(raw_map_node)
        type is(mapnode_type)
          map_key_at = raw_map_node%key
        end select
        return
      end if
    end if
    map_key_at=""

---

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

• model_core/src/utils/collections.F90