collections_mod::c_generic_at Interface Reference

Retrieves the generic value held at the specific map index or null if index > map elements. More...

Private Member Functions
class(*) function, pointer	map_generic_at (specificmap, i)
	Retrieves the generic value held at the specific map index or null if index > map elements. More...
class(*) function, pointer	hashmap_generic_at (specificmap, i)
	Retrieves the value held at the specific hashmap index or null if 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 generic value held at the specific map index or null if index > map elements.

This has a time complexity of O(n)

Parameters

collection	The specific map involved
index	The index to get value from

Returns

Generic pointer to the value

Definition at line 467 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_generic_at()

class(*) function, pointer collections_mod::c_generic_at::hashmap_generic_at ( type(hashmap_type), intent(inout)  specificmap, integer, intent(in)  i  )

private

Retrieves the value held at the specific hashmap index or null if 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	Index to get value from

Returns

Pointer to the generic value

Definition at line 1528 of file collections.F90.

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

map_generic_at()

class(*) function, pointer collections_mod::c_generic_at::map_generic_at ( type(map_type), intent(inout)  specificmap, integer, intent(in)  i  )

private

Retrieves the generic value held at the 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

Returns

Pointer to the generic value

Definition at line 884 of file collections.F90.

    type(map_type), intent(inout) :: specificmap
    integer, intent(in) :: i
 
    class(*), pointer :: raw_map_node, map_generic_at
    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_generic_at => raw_map_node%value
        end select
        return
      end if
    end if
    map_generic_at=>null()

---

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

• model_core/src/utils/collections.F90