collections_mod::c_logical_entry_at Interface Reference

Retrieves a map entry at a specific index. This is more efficient than calling key at and then value at (or get with the key) as only requires one search for both the key and value. More...

Private Member Functions
logical function	map_logical_entry_at (specificmap, i, key, logical_val)
	Retrieves the entry at a specific map index or null if index > map elements. More...
logical function	hashmap_logical_entry_at (specificmap, i, key, logical_val)
	Retrieves the entry at a specific map index. More...

Detailed Description

Retrieves a map entry at a specific index. This is more efficient than calling key at and then value at (or get with the key) as only requires one search for both the key and value.

This has a time complexity of O(n)

Parameters

collection	The specific map involved
index	The index to get value from
key	The associated key
value	Logical value or raises an error if none is found

Definition at line 567 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_logical_entry_at()

logical function collections_mod::c_logical_entry_at::hashmap_logical_entry_at ( type(hashmap_type), intent(inout)  specificmap, integer, intent(in)  i, character(len=*), intent(out)  key, logical, intent(out)  logical_val  )

private

Retrieves the entry at a 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
key	The associated key
value	Logical value or raises an error if none is found

Definition at line 1621 of file collections.F90.

    type(hashmap_type), intent(inout) :: specificmap
    integer, intent(in) :: i
    character(len=*), intent(out) :: key
    logical, intent(out) :: logical_val

    class(*), pointer :: generic

    hashmap_logical_entry_at=hashmap_generic_entry_at(specificmap, i, key, generic)
    if (.not. associated(generic)) call log_log(log_error, "Can not find logical entry with key '"//trim(key)//"'")
    logical_val=conv_to_logical(generic, .false.)

map_logical_entry_at()

logical function collections_mod::c_logical_entry_at::map_logical_entry_at ( type(map_type), intent(inout)  specificmap, integer, intent(in)  i, character(len=*), intent(out)  key, logical, intent(out)  logical_val  )

private

Retrieves the entry at a 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
key	The associated key
value	Logical value or raises an error if none is found

Definition at line 980 of file collections.F90.

    type(map_type), intent(inout) :: specificmap
    integer, intent(in) :: i
    character(len=*), intent(out) :: key
    logical, intent(out) :: logical_val

    class(*), pointer :: generic

    map_logical_entry_at=map_generic_entry_at(specificmap, i, key, generic)
    if (.not. associated(generic)) call log_log(log_error, "Can not find logical entry with key '"//trim(key)//"'")
    logical_val=conv_to_logical(generic, .false.)

---

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

• /nfs/a277/earlcd/dev/monc/svn-git/monc/model_core/src/utils/collections.F90