collections_mod::c_insert_generic Interface Reference

Inserts a generic element into the list or places at the end if the index > list size. More...

Private Member Functions
subroutine	list_insert_generic (specificlist, data, i, memory_allocation_automatic)
	Inserts an element into the list or places at the end if the index > list size. More...

Detailed Description

Inserts a generic element into the list or places at the end if the index > list size.

This has a time complexity of O(n)

Parameters

collection	The specific list involved
data	Pointer to the generic data to insert
index	The list index to insert to
memory_allocation_automatic	Whether the collections API should manage the freeing of memory

Definition at line 251 of file collections.F90.

Member Function/Subroutine Documentation

list_insert_generic()

subroutine collections_mod::c_insert_generic::list_insert_generic ( type(list_type), intent(inout)  specificlist, class(*), intent(in), pointer  data, integer, intent(in)  i, logical, intent(in)  memory_allocation_automatic  )

private

Inserts an element into the list or places at the end if the index > list size.

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

Parameters

specificlist	The specific list involved
data	Pointer to the generic data to insert
i	The list index to insert to

Definition at line 2849 of file collections.F90.

    type(list_type), intent(inout) :: specificlist
    integer, intent(in) :: i
    class(*), pointer, intent(in) :: data
    logical, intent(in) :: memory_allocation_automatic
 
    integer ::j
    type(listnode_type), pointer :: newnode, node
 
    allocate(newnode)
    newnode%data => data
 
    j=1
    node => specificlist%head
    if (associated(node)) then
      do while(j .lt. i)
        if (.not. associated(node%next)) exit
        node => node%next
        j=j+1
      end do
      if (j .eq. i) then
        ! Insert node
        newnode%next => node
        newnode%prev => node%prev
        newnode%memory_allocation_automatic=memory_allocation_automatic
        if (associated(node%prev)) node%prev%next=>newnode
        node%prev => newnode
        if (associated(node, target=specificlist%head)) specificlist%head=>newnode
      else
        ! Ran out of list nodes so add this one onto the end
        newnode%prev=>specificlist%tail
        if (associated(specificlist%tail)) then
          specificlist%tail%next => newnode
        end if
        specificlist%tail => newnode
 
        if (associated(specificlist%head) .eqv. .false.) then
          specificlist%head=>newnode
        end if
      end if
    else
      ! No current list data so set up the list with this node
      specificlist%head => newnode
      specificlist%tail => newnode
    end if
    specificlist%size=specificlist%size+1

---

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

• model_core/src/utils/collections.F90