OpenCMISS-Iron Internal API Documentation
linkedlist_routines Module Reference

Only for integer data type for now. More...

Data Types

type  linkedlist
 
interface  linkedlist_add
 
type  linkedlistitem
 

Functions/Subroutines

subroutine linkedlist_add_data (list, data, ERR, ERROR,)
 initialises or adds a piece of data to list More...
 
subroutine linkedlist_add_list (list, addlist, ERR, ERROR,)
 adds all data from one list to another More...
 
subroutine, public linkedlist_remove_first (list, data, ERR, ERROR,)
 removes the first item from list and returns its value in data More...
 
subroutine, public linkedlist_remove_last (list, data, ERR, ERROR,)
 removes the first item from list and returns its value in data More...
 
subroutine, public linkedlist_destroy (list, ERR, ERROR,)
 will delete and deallocate all items More...
 
logical function, public linkedlist_is_empty (list)
 returns true if the list is empty More...
 
subroutine, public linkedlist_to_array (list, array, ERR, ERROR,)
 copies out the data to an allocatable array More...
 

Detailed Description

Only for integer data type for now.

Function/Subroutine Documentation

subroutine linkedlist_routines::linkedlist_add_data ( type(linkedlist), intent(inout)  list,
integer(intg), intent(in)  data,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

initialises or adds a piece of data to list

Definition at line 43 of file linkedlist_routines.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by linkedlist_add_list().

subroutine linkedlist_routines::linkedlist_add_list ( type(linkedlist), intent(inout)  list,
type(linkedlist), intent(in)  addlist,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

adds all data from one list to another

Definition at line 77 of file linkedlist_routines.f90.

References base_routines::exits(), linkedlist_add_data(), and linkedlist_is_empty().

subroutine, public linkedlist_routines::linkedlist_destroy ( type(linkedlist), intent(inout)  list,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

will delete and deallocate all items

Definition at line 175 of file linkedlist_routines.f90.

logical function, public linkedlist_routines::linkedlist_is_empty ( type(linkedlist), intent(in)  list)

returns true if the list is empty

Definition at line 205 of file linkedlist_routines.f90.

Referenced by linkedlist_add_list(), and linkedlist_to_array().

subroutine, public linkedlist_routines::linkedlist_remove_first ( type(linkedlist), intent(inout)  list,
integer(intg), intent(out)  data,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

removes the first item from list and returns its value in data

Definition at line 107 of file linkedlist_routines.f90.

subroutine, public linkedlist_routines::linkedlist_remove_last ( type(linkedlist), intent(inout)  list,
integer(intg), intent(out)  data,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

removes the first item from list and returns its value in data

Definition at line 134 of file linkedlist_routines.f90.

subroutine, public linkedlist_routines::linkedlist_to_array ( type(linkedlist), intent(in)  list,
integer(intg), dimension(:), intent(out), allocatable  array,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

copies out the data to an allocatable array

Definition at line 217 of file linkedlist_routines.f90.

References linkedlist_is_empty().