collections_mod::c_generic_entry_at Interface Reference

Retrieves a map entry at a specific index or null if index > map elements. This is more efficient than calling key at and then value at (or get with the key) as only requires one search for both the key and value. More...

Private Member Functions
logical function	map_generic_entry_at (specificmap, i, key, val)
	Retrieves the entry at a specific map index or null if index > map elements. More...
logical function	hashmap_generic_entry_at (specificmap, i, key, val)
	Retrieves the entry at a specific map index or null if index > map elements. More...

Detailed Description

Retrieves a map entry at a specific index or null if index > map elements. This is more efficient than calling key at and then value at (or get with the key) as only requires one search for both the key and value.

This has a time complexity of O(n)

Parameters

collection	The specific map involved
index	The index to get value from
key	The associated key
value	Generic pointer to corresponding value

Definition at line 519 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_generic_entry_at()

logical function collections_mod::c_generic_entry_at::hashmap_generic_entry_at ( type(hashmap_type), intent(inout)  specificmap, integer, intent(in)  i, character(len=*), intent(out)  key, class(*), intent(out), pointer  val  )

private

Retrieves the entry at a specific map index or null if index > map elements.

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

Parameters

specificmap	The specific map involved
i	Index to get value from
key	The associated key
value	Generic pointer to corresponding value

Definition at line 1640 of file collections.F90.

    type(hashmap_type), intent(inout) :: specificmap
    integer, intent(in) :: i
    character(len=*), intent(out) :: key
    class(*), pointer, intent(out) :: val
 
    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)
        val=>raw_map_node%value
        key=raw_map_node%key          
      end select
      hashmap_generic_entry_at=.true.
      return
    end if
    val=>null()
    hashmap_generic_entry_at=.false.

map_generic_entry_at()

logical function collections_mod::c_generic_entry_at::map_generic_entry_at ( type(map_type), intent(inout)  specificmap, integer, intent(in)  i, character(len=*), intent(out)  key, class(*), intent(out), pointer  val  )

private

Retrieves the entry at a specific map index or null if index > map elements.

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

Parameters

specificmap	The specific map involved
i	Index to get value from
key	The associated key
value	Generic pointer to corresponding value

Definition at line 999 of file collections.F90.

    type(map_type), intent(inout) :: specificmap
    integer, intent(in) :: i
    character(len=*), intent(out) :: key
    class(*), pointer, intent(out) :: val
 
    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)
          val=>raw_map_node%value
          key=raw_map_node%key          
        end select
        map_generic_entry_at=.true.
        return
      end if
    end if
    val=>null()
    map_generic_entry_at=.false.

---

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

• model_core/src/utils/collections.F90