collections_mod::c_remove Interface Reference

Removes a specific element from the list or map. More...

Private Member Functions
subroutine	list_remove (specificlist, i)
	Removes an element from the list at a specific index. More...
subroutine	map_remove (specificmap, key)
	Removes a specific key-value pair from the map. More...
subroutine	hashmap_remove (specificmap, key)
	Removes a specific key-value pair from the hashmap. More...
subroutine	hashset_remove (specificset, key)
	Removes a string from the hashset. More...

Detailed Description

Removes a specific element from the list or map.

This has a time complexity of O(n)

Parameters

collection	The specific list or map involved
identifier	In the cast of a list the index to remove or for a map the key (of the key-value pair) to remove

Definition at line 419 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_remove()

subroutine collections_mod::c_remove::hashmap_remove ( type(hashmap_type), intent(inout)  specificmap, character(len=*), intent(in)  key  )

private

Removes a specific key-value pair from the hashmap.

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

Parameters

specificmap	The specific hashmap involved
key	Key of the key-value pair to remove from the map

Definition at line 1667 of file collections.F90.

    type(hashmap_type), intent(inout) :: specificmap
    character(len=*), intent(in) :: key
 
    integer :: key_location
    class(*), pointer :: raw_map_node
 
    raw_map_node=>hashmap_getnode(specificmap, key, key_location)
    
    if (key_location .gt. 0) then
      select type (raw_map_node)
      type is (mapnode_type)
        if (raw_map_node%memory_allocation_automatic) then
          if (associated(raw_map_node%value)) deallocate(raw_map_node%value)
        end if
        deallocate(raw_map_node)
      end select
      call list_remove(specificmap%map_ds(get_hashkey(key)), key_location)      
      specificmap%size=specificmap%size-1
    end if

hashset_remove()

subroutine collections_mod::c_remove::hashset_remove ( type(hashset_type), intent(inout)  specificset, character(len=*), intent(in)  key  )

private

Removes a string from the hashset.

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

Parameters

specificset	The specific ste involved
key	The string key to remove

Definition at line 1987 of file collections.F90.

    type(hashset_type), intent(inout) :: specificset
    character(len=*), intent(in) :: key
 
    integer :: location, hash
 
    call hashset_getlocation(specificset, key, hash, location)
    if (hash .gt. 0 .and. location .gt. 0) then
      call list_remove(specificset%set_ds(hash), location)
      specificset%size=specificset%size-1
    end if

list_remove()

subroutine collections_mod::c_remove::list_remove ( type(list_type), intent(inout)  specificlist, integer, intent(in)  i  )

private

Removes an element from the list at a specific index.

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

Parameters

specificlist	The specific list involved
i	Index to remove from

Definition at line 2992 of file collections.F90.

    type(list_type), intent(inout) :: specificlist
    integer, intent(in) :: i
 
    integer ::j
    type(listnode_type), pointer :: node
 
    j=1
    if (i .le. specificlist%size) then
      node => specificlist%head
      do while(j .lt. i)
        if (.not. associated(node)) exit
        node => node%next
        j=j+1
      end do
      if (associated(node)) then
        if (associated(node%prev)) node%prev%next => node%next
        if (associated(node%next)) node%next%prev => node%prev
        if (associated(node, target=specificlist%head)) specificlist%head => node%next
        if (associated(node, target=specificlist%tail)) specificlist%tail => node%prev
        if (node%memory_allocation_automatic) then
          if (associated(node%data)) deallocate(node%data)
        end if
        deallocate(node)
        specificlist%size = specificlist%size - 1
      end if
    end if

map_remove()

subroutine collections_mod::c_remove::map_remove ( type(map_type), intent(inout)  specificmap, character(len=*), intent(in)  key  )

private

Removes a specific key-value pair from the map.

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

Parameters

specificmap	The specific map involved
key	Key of the key-value pair to remove from the map

Definition at line 1030 of file collections.F90.

    type(map_type), intent(inout) :: specificmap
    character(len=*), intent(in) :: key
 
    integer :: key_location
    class(*), pointer :: raw_map_node
 
    raw_map_node=>map_getnode(specificmap, key, key_location)
 
    if (key_location .gt. 0) then
      select type (raw_map_node)
      type is (mapnode_type)
        if (raw_map_node%memory_allocation_automatic) then
          if (associated(raw_map_node%value)) deallocate(raw_map_node%value)
        end if
        deallocate(raw_map_node)
      end select
      call list_remove(specificmap%map_ds, key_location)      
    end if

---

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

• model_core/src/utils/collections.F90