collections_mod::c_get_real Interface Reference

Gets a specific double precision real element out of the list, stack, queue or map with the corresponding key. More...

Private Member Functions
real(kind=default_precision) function	list_get_real (specificlist, i)
	Retrieves the element at index i from the list. Converts between precision and from int. More...
real(kind=default_precision) function	stack_get_real (specificstack, i)
	Gets a specific element from the stack at index specified. Converts between precision and from int. More...
real(kind=default_precision) function	queue_get_real (specificqueue, i)
	Returns a specific queue element at an index. Converts between precision and from int. More...
real(kind=default_precision) function	map_get_real (specificmap, key)
	Gets a specific element out of the map with the corresponding key. This converts between precision and from ints. More...
real(kind=default_precision) function	hashmap_get_real (specificmap, key)
	Gets a specific element out of the hashmap with the corresponding key. Converts between precision and from int. More...
real(kind=default_precision) function	mapentry_get_real (mapentry_item)
	Retrieves the double precision real value from a map entry. More...

Detailed Description

Gets a specific double precision real element out of the list, stack, queue or map with the corresponding key.

This has a time complexity of O(n)

Parameters

collection	The specific list, stack, queue or map involved
key	String look up key

Returns

Double precision real value associated with the key or raises an error if none exists

Definition at line 399 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_get_real()

real(kind=default_precision) function collections_mod::c_get_real::hashmap_get_real ( type(hashmap_type), intent(inout)  specificmap, character(len=*), intent(in)  key  )

private

Gets a specific element out of the hashmap with the corresponding key. Converts between precision and from int.

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

Parameters

specificmap	The specific hashmap involved
key	Look up key

Returns

Double precision real value associated with the key or raises an error if none is found

Definition at line 1732 of file collections.F90.

    type(hashmap_type), intent(inout) :: specificmap
    character(len=*), intent(in) :: key
    real(kind=DEFAULT_PRECISION) :: hashmap_get_real

    class(*), pointer :: generic

    generic=>hashmap_get_generic(specificmap, key)
    if (.not. associated(generic)) call log_log(log_error, "Can not find real entry with key '"//trim(key)//"'")
    select type(vr=>generic)
    type is (real(kind=default_precision))
      hashmap_get_real=vr
    type is (real)
      hashmap_get_real=conv_single_real_to_double(vr)
    type is (integer)  
      hashmap_get_real=conv_single_real_to_double(conv_to_real(vr))
    end select

list_get_real()

real(kind=default_precision) function collections_mod::c_get_real::list_get_real ( type(list_type), intent(inout)  specificlist, integer, intent(in)  i  )

private

Retrieves the element at index i from the list. Converts between precision and from int.

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

Parameters

specificlist	The specific list involved
i	Index to look up

Returns

Double precision real data in the list or raises an error if none is found

Definition at line 3075 of file collections.F90.

    type(list_type), intent(inout) :: specificlist
    integer, intent(in) :: i
    real(kind=DEFAULT_PRECISION) :: list_get_real

    class(*), pointer :: generic

    generic=>list_get_generic(specificlist, i)
    if (.not. associated(generic)) call log_log(log_error, "Can not get real from list at index "//trim(conv_to_string(i)))
    select type(vr=>generic)
    type is (real(kind=default_precision))
      list_get_real=vr
    type is (real)
      list_get_real=conv_single_real_to_double(vr)
    type is (integer)  
      list_get_real=conv_single_real_to_double(conv_to_real(vr))
    end select

map_get_real()

real(kind=default_precision) function collections_mod::c_get_real::map_get_real ( type(map_type), intent(inout)  specificmap, character(len=*), intent(in)  key  )

private

Gets a specific element out of the map with the corresponding key. This converts between precision and from ints.

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

Parameters

specificmap	The specific map involved
key	Look up key

Returns

Real value associated with the key or raises an error if none is found

Definition at line 1094 of file collections.F90.

    type(map_type), intent(inout) :: specificmap
    character(len=*), intent(in) :: key
    real(kind=DEFAULT_PRECISION) :: map_get_real

    class(*), pointer :: generic

    generic=>map_get_generic(specificmap, key)
    if (.not. associated(generic)) call log_log(log_error, "Can not find real entry with key '"//trim(key)//"'")
    select type(vr=>generic)
    type is (real(kind=default_precision))
      map_get_real=vr
    type is (real)
      map_get_real=conv_single_real_to_double(vr)
    type is (integer)  
      map_get_real=conv_single_real_to_double(conv_to_real(vr))
    end select

mapentry_get_real()

real(kind=default_precision) function collections_mod::c_get_real::mapentry_get_real ( type(mapentry_type), intent(in)  mapentry_item )

private

Retrieves the double precision real value from a map entry.

Parameters

mapentry_item

The map entry to retrieve the double precision real value from (auto converts from single/ints)

Definition at line 3347 of file collections.F90.

    type(mapentry_type), intent(in) :: mapentry_item
    real(kind=DEFAULT_PRECISION) :: mapentry_get_real

    class(*), pointer :: generic

    generic=>mapentry_item%value
    if (.not. associated(generic)) call log_log(log_error, "Can not get real from map entry")
    select type(vr=>generic)
    type is (real(kind=default_precision))
      mapentry_get_real=vr
    type is (real)
      mapentry_get_real=conv_single_real_to_double(vr)
    type is (integer)  
      mapentry_get_real=conv_single_real_to_double(conv_to_real(vr))
    end select

queue_get_real()

real(kind=default_precision) function collections_mod::c_get_real::queue_get_real ( type(queue_type), intent(inout)  specificqueue, integer, intent(in)  i  )

private

Returns a specific queue element at an index. Converts between precision and from int.

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

Parameters

specificqueue	The specific queue involved
i	The index to look up

Returns

Double precision real element at i or raises an error if none is found

Definition at line 2681 of file collections.F90.

    type(queue_type), intent(inout) :: specificqueue
    integer, intent(in) :: i
    real(kind=DEFAULT_PRECISION) :: queue_get_real

    class(*), pointer :: generic

    generic=>queue_get_generic(specificqueue, i)
    if (.not. associated(generic)) call log_log(log_error, "Can not get real from queue at index "//trim(conv_to_string(i)))
    select type(vr=>generic)
    type is (real(kind=default_precision))
      queue_get_real=vr
    type is (real)
      queue_get_real=conv_single_real_to_double(vr)
    type is (integer)  
      queue_get_real=conv_single_real_to_double(conv_to_real(vr))
    end select

stack_get_real()

real(kind=default_precision) function collections_mod::c_get_real::stack_get_real ( type(stack_type), intent(inout)  specificstack, integer, intent(in)  i  )

private

Gets a specific element from the stack at index specified. Converts between precision and from int.

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

Parameters

specificstack	The specific stack involved
i	The index to retrieve the element at

Returns

Double precision real data or raises an error if none is found

Definition at line 2385 of file collections.F90.

    type(stack_type), intent(inout) :: specificstack
    integer, intent(in) :: i
    real(kind=DEFAULT_PRECISION) :: stack_get_real

    class(*), pointer :: generic

    generic=>stack_get_generic(specificstack, i)
    if (.not. associated(generic)) call log_log(log_error, "Can not get real from stack at index "//trim(conv_to_string(i)))
    select type(vr=>generic)
    type is (real(kind=default_precision))
      stack_get_real=vr
    type is (real)
      stack_get_real=conv_single_real_to_double(vr)
    type is (integer)  
      stack_get_real=conv_single_real_to_double(conv_to_real(vr))
    end select

---

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