collections_mod::c_string_at Interface Reference

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

Private Member Functions
character(len=string_length) function	map_string_at (specificmap, i)
	Retrieves the string value held at the specific map index. More...
character(len=string_length) function	hashmap_string_at (specificmap, i)
	Retrieves the value held at the specific hashmap index. 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 string 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

String value or raises an error if none is found

Definition at line 487 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_string_at()

character(len=string_length) function collections_mod::c_string_at::hashmap_string_at ( type(hashmap_type), intent(inout)  specificmap, integer, intent(in)  i  )

private

Retrieves the value held at the specific hashmap index. 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

String value or raises an error if none is found

Definition at line 1464 of file collections.F90.

    type(hashmap_type), intent(inout) :: specificmap
    integer, intent(in) :: i
    character(len=STRING_LENGTH) :: hashmap_string_at
 
    class(*), pointer :: generic
 
    generic=>hashmap_generic_at(specificmap, i)
    if (.not. associated(generic)) call log_log(log_error, "Can not find string at "//trim(conv_to_string(i)))
    hashmap_string_at=conv_to_string(generic, .false., string_length)

map_string_at()

character(len=string_length) function collections_mod::c_string_at::map_string_at ( type(map_type), intent(inout)  specificmap, integer, intent(in)  i  )

private

Retrieves the string value held at the specific map index.

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

String value or raises an error if none is found

Definition at line 823 of file collections.F90.

    type(map_type), intent(inout) :: specificmap
    integer, intent(in) :: i
    character(len=STRING_LENGTH) :: map_string_at
 
    class(*), pointer :: generic
 
    generic=>map_generic_at(specificmap, i)
    if (.not. associated(generic)) call log_log(log_error, "Can not find string at "//trim(conv_to_string(i)))
    map_string_at=conv_to_string(generic, .false., string_length)

---

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

• model_core/src/utils/collections.F90