collections_mod::c_contains Interface Reference

Determines whether or not a map contains a specific key. More...

Private Member Functions
logical function	map_contains_key (specificmap, key)
	Determines whether or not a map contains a specific key. More...
logical function	hashmap_contains_key (specificmap, key)
	Determines whether or not a hashmap contains a specific key. More...
logical function	hashset_contains (specificset, key)
	Determines wheter the hashset contains a specific key or not. More...

Detailed Description

Determines whether or not a map contains a specific key.

This has a time complexity of O(n)

Parameters

collection	The specific map involved
key	The key we are looking up

Returns

Whether the map contains the key

Definition at line 447 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_contains_key()

logical function collections_mod::c_contains::hashmap_contains_key ( type(hashmap_type), intent(inout)  specificmap, character(len=*), intent(in)  key  )

private

Determines whether or not a hashmap contains a specific key.

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

Parameters

specificmap	The specific map involved
key	The key we are looking up

Returns

Whether the map contains the key

Definition at line 1403 of file collections.F90.

    type(hashmap_type), intent(inout) :: specificmap
    character(len=*), intent(in) :: key
 
    class(*), pointer :: raw_map_node
 
    raw_map_node=>hashmap_getnode(specificmap, key)
    hashmap_contains_key=associated(raw_map_node)

hashset_contains()

logical function collections_mod::c_contains::hashset_contains ( type(hashset_type), intent(inout)  specificset, character(len=*), intent(in)  key  )

private

Determines wheter the hashset contains a specific key or not.

Parameters

specificset	The specific set involved
key	The string key to test for

Returns

Whether the hashset contains this key or not

Definition at line 2005 of file collections.F90.

    type(hashset_type), intent(inout) :: specificset
    character(len=*), intent(in) :: key
 
    integer :: hash, key_location
 
    call hashset_getlocation(specificset, key, hash, key_location)
    hashset_contains= (hash .gt. 0 .and. key_location .gt. 0)

map_contains_key()

logical function collections_mod::c_contains::map_contains_key ( type(map_type), intent(inout)  specificmap, character(len=*), intent(in)  key  )

private

Determines whether or not a map contains a specific key.

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

Parameters

specificmap	The specific map involved
key	The key we are looking up

Returns

Whether the map contains the key

Definition at line 761 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)
    map_contains_key = key_location .gt. 0

---

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

• model_core/src/utils/collections.F90