collections_mod::c_get_iterator Interface Reference

Private Member Functions
type(iterator_type) function	list_get_iterator (specificlist)
	Retrieves an iterator representation of the list, ready to access the first element. More...
type(iterator_type) function	map_get_iterator (specificmap)
	Retrieves an iterator representation of the map, ready to access the first element. More...
type(iterator_type) function	hashmap_get_iterator (specificmap)
	Retrieves an iterator representation of the hashmap, ready to access the first element. More...
type(iterator_type) function	hashset_get_iterator (specificset)
	Retrieves an iterator representation of the hashset, ready to access the first element. More...
type(iterator_type) function	stack_get_iterator (specificstack)
	Retrieves an iterator representation of the stack, ready to access the first element. More...
type(iterator_type) function	queue_get_iterator (specificqueue)
	Retrieves an iterator representation of the queue, ready to access the first element. More...

Detailed Description

Definition at line 581 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_get_iterator()

type(iterator_type) function collections_mod::c_get_iterator::hashmap_get_iterator ( type(hashmap_type), intent(inout)  specificmap )

private

Retrieves an iterator representation of the hashmap, ready to access the first element.

Parameters

specificmap

Specific collection to base this iterator on

Returns

The iterator ready to access the first element

Definition at line 1255 of file collections.F90.

    type(hashmap_type), intent(inout) :: specificmap
 
    integer :: i
 
    hashmap_get_iterator%next_item=>null()
    if (associated(specificmap%map_ds)) then
      hashmap_get_iterator%hash_structure=>specificmap%map_ds
 
      do i=1, size(specificmap%map_ds)
        if (specificmap%map_ds(i)%size .gt. 0) then
          hashmap_get_iterator%next_item=>specificmap%map_ds(i)%head
          exit
        end if
      end do
      hashmap_get_iterator%hash_ptr=i+1
    end if

hashset_get_iterator()

type(iterator_type) function collections_mod::c_get_iterator::hashset_get_iterator ( type(hashset_type), intent(inout)  specificset )

private

Retrieves an iterator representation of the hashset, ready to access the first element.

Parameters

specificset

Specific collection to base this iterator on

Returns

The iterator ready to access the first element

Definition at line 1933 of file collections.F90.

    type(hashset_type), intent(inout) :: specificset
 
    integer :: i
 
    hashset_get_iterator%next_item=>null()
    if (associated(specificset%set_ds)) then
      hashset_get_iterator%hash_structure=>specificset%set_ds
 
      do i=1, size(specificset%set_ds)
        if (specificset%set_ds(i)%size .gt. 0) then
          hashset_get_iterator%next_item=>specificset%set_ds(i)%head
          exit
        end if
      end do
      hashset_get_iterator%hash_ptr=i+1
    end if

list_get_iterator()

type(iterator_type) function collections_mod::c_get_iterator::list_get_iterator ( type(list_type), intent(inout)  specificlist )

private

Retrieves an iterator representation of the list, ready to access the first element.

Parameters

specificlist

Specific collection to base this iterator on

Returns

The iterator ready to access the first element

Definition at line 2768 of file collections.F90.

    type(list_type), intent(inout) :: specificlist
 
    list_get_iterator%next_item=>specificlist%head
    list_get_iterator%hash_structure=>null()
    list_get_iterator%hash_ptr=0

map_get_iterator()

type(iterator_type) function collections_mod::c_get_iterator::map_get_iterator ( type(map_type), intent(inout)  specificmap )

private

Retrieves an iterator representation of the map, ready to access the first element.

Parameters

specificmap

Specific collection to base this iterator on

Returns

The iterator ready to access the first element

Definition at line 627 of file collections.F90.

    type(map_type), intent(inout) :: specificmap
 
    map_get_iterator%next_item=>specificmap%map_ds%head
    map_get_iterator%hash_structure=>null()
    map_get_iterator%hash_ptr=0

queue_get_iterator()

type(iterator_type) function collections_mod::c_get_iterator::queue_get_iterator ( type(queue_type), intent(inout)  specificqueue )

private

Retrieves an iterator representation of the queue, ready to access the first element.

Parameters

specificqueue

Specific collection to base this iterator on

Returns

The iterator ready to access the first element

Definition at line 2472 of file collections.F90.

    type(queue_type), intent(inout) :: specificqueue
 
    queue_get_iterator%next_item=>specificqueue%queue_ds%head
    queue_get_iterator%hash_structure=>null()
    queue_get_iterator%hash_ptr=0

stack_get_iterator()

type(iterator_type) function collections_mod::c_get_iterator::stack_get_iterator ( type(stack_type), intent(inout)  specificstack )

private

Retrieves an iterator representation of the stack, ready to access the first element.

Parameters

specificstack

Specific collection to base this iterator on

Returns

The iterator ready to access the first element

Definition at line 2176 of file collections.F90.

    type(stack_type), intent(inout) :: specificstack
 
    stack_get_iterator%next_item=>specificstack%stack_ds%head
    stack_get_iterator%hash_structure=>null()
    stack_get_iterator%hash_ptr=0

---

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

• model_core/src/utils/collections.F90