collections_mod::c_put_generic Interface Reference

Puts a generic key-value pair into the map. More...

Private Member Functions
subroutine	map_put_generic (specificmap, key, data, memory_allocation_automatic)
	Puts a specific key-value pair into the map. More...
subroutine	hashmap_put_generic (specificmap, key, data, memory_allocation_automatic)
	Puts a specific key-value pair into the hashmap. More...

Detailed Description

Puts a generic key-value pair into the map.

If the key is not already held in the map then the key-value pair will be added, otherwise the existing key-value pair will be modified to hold this updated value (keys must be unique) This has a time complexity of O(n) due to key look up

Parameters

collection	The specific map involved
key	The key to place in the map
value	Pointer to the generic data value to place in the map
memory_allocation_automatic	Whether the collections API should manage the freeing of memory

Definition at line 305 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_put_generic()

subroutine collections_mod::c_put_generic::hashmap_put_generic ( type(hashmap_type), intent(inout)  specificmap, character(len=*), intent(in)  key, class(*), intent(in), pointer  data, logical, intent(in)  memory_allocation_automatic  )

private

Puts a specific key-value pair into the hashmap.

If the key is not already held in the hashmap then the key-value pair will be added, otherwise the existing key-value pair will be modified to hold this updated value (keys must be unique). This uses a hashing function for performance Do not call directly from external module, this is called via the appropriate interface

Parameters

specificmap	The specific map involved
key	The key to place in the map
data	Pointer to the generic data value to place in the map
memory_allocation_automatic	Whether the collections API should manage the freeing of memory

Definition at line 1364 of file collections.F90.

    type(hashmap_type), intent(inout) :: specificmap
    class(*), pointer, intent(in) :: data
    character(len=*), intent(in) :: key
    logical, intent(in) :: memory_allocation_automatic
 
    class(*), pointer :: raw_map_node, generic_map_node
    type(mapnode_type), pointer :: newmapnode
 
    if (.not. associated(specificmap%map_ds)) allocate(specificmap%map_ds(hash_size))
 
    ! Test to see if key already exists in the map
    raw_map_node=>hashmap_getnode(specificmap, key)
 
    if (associated(raw_map_node)) then
      select type(raw_map_node)
      type is (mapnode_type)
        raw_map_node%value=>data
      end select
    else
      allocate(newmapnode)
      newmapnode%value=>data
      newmapnode%key=key
      newmapnode%memory_allocation_automatic=memory_allocation_automatic
      ! Clone and deallocate the newmapnode - this keeps GNU happy with passing the correct pointer and Cray
      ! doesn't link the generic pointer just pointing to the data structure hence we clone it
      allocate(generic_map_node, source=newmapnode)
      deallocate(newmapnode)
      call list_add_generic(specificmap%map_ds(get_hashkey(key)), generic_map_node, .false.)
      specificmap%size=specificmap%size+1
    end if

map_put_generic()

subroutine collections_mod::c_put_generic::map_put_generic ( type(map_type), intent(inout)  specificmap, character(len=*), intent(in)  key, class(*), intent(in), pointer  data, logical, intent(in)  memory_allocation_automatic  )

private

Puts a specific key-value pair into the map.

If the key is not already held in the map then the key-value pair will be added, otherwise the existing key-value pair will be modified to hold this updated value (keys must be unique) Do not call directly from external module, this is called via the appropriate interface

Parameters

specificmap	The specific map involved
key	The key to place in the map
data	Pointer to the generic data value to place in the map
memory_allocation_automatic	Whether the collections API should manage the freeing of memory

Definition at line 725 of file collections.F90.

    type(map_type), intent(inout) :: specificmap
    class(*), pointer, intent(in) :: data
    character(len=*), intent(in) :: key
    logical, intent(in) :: memory_allocation_automatic
 
    class(*), pointer :: raw_map_node, generic_map_node
    type(mapnode_type), pointer :: newmapnode
 
    ! Test to see if key already exists in the map
    raw_map_node=>map_getnode(specificmap, key)
 
    if (associated(raw_map_node)) then
      select type(raw_map_node)
      type is (mapnode_type)
        raw_map_node%value => data
      end select
    else
      allocate(newmapnode)
      newmapnode%value => data
      newmapnode%key = key
      newmapnode%memory_allocation_automatic=memory_allocation_automatic
      ! Clone and deallocate the newmapnode - this keeps GNU happy with passing the correct pointer and Cray
      ! doesn't link the generic pointer just pointing to the data structure hence we clone it
      allocate(generic_map_node, source=newmapnode)
      deallocate(newmapnode)
      call list_add_generic(specificmap%map_ds, generic_map_node, .false.)
    end if

---

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

• model_core/src/utils/collections.F90