OpenCMISS-Iron Internal API Documentation
lists Module Reference

Implements lists of base types. More...

Data Types

interface  list_createfinish
 
interface  list_createstart
 
interface  list_datadimensionset
 
interface  list_datatypeset
 
interface  list_detach_and_destroy
 Detaches the list values from a list and returns them as a pointer to a array of base type before destroying the list. More...
 
interface  list_detachanddestroy
 Detaches the list values from a list and returns them as a pointer to a array of base type before destroying the list. More...
 
interface  list_initialsizeset
 
interface  list_item_add
 Adds an item to the end of a list. More...
 
interface  list_item_get
 Returns an item in a list at a specififed position. More...
 
interface  list_item_in_list
 Determines if an item is in a list and returns the position of the item. More...
 
interface  list_item_set
 Sets an item in the list. More...
 
interface  list_itemadd
 Adds an item to the end of a list. More...
 
interface  list_itemdelete
 
interface  list_itemget
 Returns an item in a list at a specififed position. More...
 
interface  list_iteminlist
 Determines if an item is in a list and returns the position of the item. More...
 
interface  list_itemset
 Sets an item in the list. More...
 
interface  list_itersection
 Calculates the intersection of two arrays. More...
 
interface  list_keydimensionset
 
interface  list_mutableset
 
interface  list_numberofitemsget
 
interface  list_removeduplicates
 
interface  list_search
 Searches a list for a given value and returns the position in the list if the value exists. More...
 
interface  list_search_linear
 Searches a list using the linear search method. More...
 
interface  list_searchlinear
 Searches a list using the linear search method. More...
 
interface  list_sort
 Sorts a list into ascending order. More...
 
interface  list_sort_bubble
 Sorts a list into assending order using the bubble sort method. More...
 
interface  list_sort_heap
 Sorts a list into assending order using the heap sort method. More...
 
interface  list_sort_shell
 Sorts a list into either assending or descending order using the shell sort method. More...
 
interface  list_sortbubble
 Sorts a list into assending order using the bubble sort method. More...
 
interface  list_sortheap
 Sorts a list into assending order using the heap sort method. More...
 
interface  list_sortshell
 Sorts a list into either assending or descending order using the shell sort method. More...
 
interface  list_subset_of
 Checks whether an array is a subset of another array. More...
 
interface  list_subsetof
 Checks whether an array is a subset of another array. More...
 

Functions/Subroutines

subroutine, public list_create_finish (LIST, ERR, ERROR,)
 Finishes the creation of a list created with LIST_CREATE_START. More...
 
subroutine, public list_create_start (LIST, ERR, ERROR,)
 Starts the creation of a list and returns a pointer to the created list. More...
 
subroutine, public list_data_dimension_set (LIST, DATA_DIMENSION, ERR, ERROR,)
 Sets/changes the data dimension for a list. More...
 
subroutine, public list_mutable_set (LIST, MUTABLE, ERR, ERROR,)
 Sets/changes the data dimension for a list. More...
 
subroutine, public list_data_type_set (LIST, DATA_TYPE, ERR, ERROR,)
 Sets/changes the data type for a list. More...
 
subroutine, public list_destroy (LIST, ERR, ERROR,)
 Destroys a list. More...
 
subroutine list_finalise (LIST, ERR, ERROR,)
 Finalises a list and deallocates all memory. More...
 
subroutine, public list_appendlist (list, appendedList, err, error,)
 Appends a list to the end of this list. More...
 
subroutine, public list_clearitems (list, err, error,)
 Clears all the items from a list. More...
 
subroutine list_initialise (LIST, ERR, ERROR,)
 Initialises a list and all its components. More...
 
subroutine, public list_initial_size_set (LIST, INITIAL_SIZE, ERR, ERROR,)
 Sets/changes the initial size for a list. More...
 
subroutine list_item_add_intg1 (LIST, ITEM, ERR, ERROR,)
 Adds an item to the end of an integer list of data dimension 1. More...
 
subroutine list_item_add_intg2 (LIST, ITEM, ERR, ERROR,)
 Adds an item to the end of an integer list of data dimension > 1. More...
 
subroutine list_item_add_sp1 (LIST, ITEM, ERR, ERROR,)
 Adds an item to the end of a single precision real list of data dimension 1. More...
 
subroutine list_item_add_sp2 (LIST, ITEM, ERR, ERROR,)
 Adds an item to the end of a single precision real list of data dimension > 1. More...
 
subroutine list_item_add_dp1 (LIST, ITEM, ERR, ERROR,)
 Adds an item to the end of a double precision real list of data dimension 1. More...
 
subroutine list_item_add_dp2 (LIST, ITEM, ERR, ERROR,)
 Adds an item to the end of a double precision real list of data dimension > 1. More...
 
subroutine list_item_set_intg1 (LIST, LIST_ITEM, ITEM, ERR, ERROR,)
 Sets an item in an integer list of data dimension 1. More...
 
subroutine list_item_set_intg2 (LIST, LIST_ITEM, ITEM, ERR, ERROR,)
 Set an item in an integer list of data dimension > 1. More...
 
subroutine list_item_set_sp1 (LIST, LIST_ITEM, ITEM, ERR, ERROR,)
 Sets an item in a single precision real list of data dimension 1. More...
 
subroutine list_item_set_sp2 (LIST, LIST_ITEM, ITEM, ERR, ERROR,)
 Sets an item in a single precision real list of data dimension > 1. More...
 
subroutine list_item_set_dp1 (LIST, LIST_ITEM, ITEM, ERR, ERROR,)
 Sets an item in a double precision real list of data dimension 1. More...
 
subroutine list_item_set_dp2 (LIST, LIST_ITEM, ITEM, ERR, ERROR,)
 Sets an item in a double precision real list of data dimension > 1. More...
 
subroutine list_item_get_intg1 (LIST, LIST_ITEM, ITEM, ERR, ERROR,)
 Returns the ITEM in a list at position LIST_ITEM in the given integer LIST. More...
 
subroutine list_item_get_intg2 (LIST, LIST_ITEM, ITEM, ERR, ERROR,)
 Returns the ITEM in a list at position LIST_ITEM in the given integer LIST. More...
 
subroutine list_item_get_sp1 (LIST, LIST_ITEM, ITEM, ERR, ERROR,)
 Returns the ITEM in a list at position LIST_ITEM in the given single precision LIST. More...
 
subroutine list_item_get_sp2 (LIST, LIST_ITEM, ITEM, ERR, ERROR,)
 Returns the ITEM in a list at position LIST_ITEM in the given single precision LIST. More...
 
subroutine list_item_get_dp1 (LIST, LIST_ITEM, ITEM, ERR, ERROR,)
 Returns the ITEM in a list at position LIST_ITEM in the given double precision LIST. More...
 
subroutine list_item_get_dp2 (LIST, LIST_ITEM, ITEM, ERR, ERROR,)
 Returns the ITEM in a list at position LIST_ITEM in the given double precision LIST. More...
 
subroutine list_item_in_list_intg1 (LIST, ITEM, LIST_ITEM, ERR, ERROR,)
 Determines if ITEM is in the given integer LIST. If it is LIST_ITEM is the index in the list. If not LIST_ITEM is 0. More...
 
subroutine list_item_in_list_intg2 (LIST, ITEM, LIST_ITEM, ERR, ERROR,)
 Determines if ITEM is in the given integer LIST. If it is LIST_ITEM is the index in the list. If not LIST_ITEM is 0. More...
 
subroutine list_item_in_list_sp1 (LIST, ITEM, LIST_ITEM, ERR, ERROR,)
 Determines if ITEM is in the given single precision real LIST. If it is LIST_ITEM is the index in the list. If not LIST_ITEM is 0. More...
 
subroutine list_item_in_list_sp2 (LIST, ITEM, LIST_ITEM, ERR, ERROR,)
 Determines if ITEM is in the given single precision real LIST. If it is LIST_ITEM is the index in the list. If not LIST_ITEM is 0. More...
 
subroutine list_item_in_list_dp1 (LIST, ITEM, LIST_ITEM, ERR, ERROR,)
 Determines if ITEM is in the given double precision real LIST. If it is LIST_ITEM is the index in the list. If not LIST_ITEM is 0. More...
 
subroutine list_item_in_list_dp2 (LIST, ITEM, LIST_ITEM, ERR, ERROR,)
 Determines if ITEM is in the given double precision real LIST. If it is LIST_ITEM is the index in the list. If not LIST_ITEM is 0. More...
 
subroutine, public list_item_delete (LIST, LIST_ITEM, ERR, ERROR,)
 Deletes the item given by the LIST_ITEM index from the given list. More...
 
subroutine, public list_key_dimension_set (LIST, KEY_DIMENSION, ERR, ERROR,)
 Sets/changes the key dimension (i.e., the dimension for searching and sorting) for a list. More...
 
subroutine, public list_number_of_items_get (LIST, NUMBER_OF_ITEMS, ERR, ERROR,)
 Gets the current number of items in a list. More...
 
subroutine list_detach_and_destroy_intg1 (LIST, NUMBER_IN_LIST, LIST_VALUES, ERR, ERROR,)
 Detaches the list values from an integer list of data dimension 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory. More...
 
subroutine list_detach_and_destroy_intg2 (LIST, NUMBER_IN_LIST, LIST_VALUES, ERR, ERROR,)
 Detaches the list values from an integer list of data dimension > 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory. More...
 
subroutine list_detach_and_destroy_sp1 (LIST, NUMBER_IN_LIST, LIST_VALUES, ERR, ERROR,)
 Detaches the list values from a single precision real list of data dimension 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory. More...
 
subroutine list_detach_and_destroy_sp2 (LIST, NUMBER_IN_LIST, LIST_VALUES, ERR, ERROR,)
 Detaches the list values from a single precision real list of data dimension > 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory. More...
 
subroutine list_detach_and_destroy_dp1 (LIST, NUMBER_IN_LIST, LIST_VALUES, ERR, ERROR,)
 Detaches the list values from a double precision real list of data dimension 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory. More...
 
subroutine list_detach_and_destroy_dp2 (LIST, NUMBER_IN_LIST, LIST_VALUES, ERR, ERROR,)
 Detaches the list values from a double precision real list of data dimension > 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory. More...
 
subroutine, public list_remove_duplicates (LIST, ERR, ERROR,)
 Removes duplicate entries from a list. A side effect of this is that the list is sorted. More...
 
subroutine list_search_intg_array (A, VALUE, POSITION, ERR, ERROR,)
 Searches an integer array list A for VALUE. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero. More...
 
subroutine list_search_c_int_array (A, VALUE, POSITION, ERR, ERROR,)
 Searches an integer array list A for VALUE. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero. More...
 
subroutine list_search_sp_array (A, VALUE, POSITION, ERR, ERROR,)
 Searches a single precision real array list A for VALUE. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero. More...
 
subroutine list_search_dp_array (A, VALUE, POSITION, ERR, ERROR,)
 Searches a double precision real array list A for VALUE. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero. More...
 
subroutine list_search_linear_intg_array (A, VALUE, POSITION, ERR, ERROR,)
 Searches an integer array list A for VALUE using the linear search method. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero. More...
 
subroutine list_search_linear_c_int_array (A, VALUE, POSITION, ERR, ERROR,)
 Searches an integer array list A for VALUE using the linear search method. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero. More...
 
subroutine list_search_linear_sp_array (A, VALUE, POSITION, ERR, ERROR,)
 Searches a single precision real array list A for VALUE using the linear search method. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero. More...
 
subroutine list_search_linear_dp_array (A, VALUE, POSITION, ERR, ERROR,)
 Searches a double precision real array list A for VALUE using the linear search method. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero. More...
 
subroutine list_sort_list (LIST, ERR, ERROR,)
 Sorts a list of into ascending order. More...
 
subroutine list_sort_intg1_array (A, ERR, ERROR,)
 Sorts an integer array list of data dimension 1 into ascending order. More...
 
subroutine list_sort_intg2_array (A, KEY_DIMENSION, ERR, ERROR,)
 Sorts an integer array list of data dimension > 1 into ascending order. More...
 
subroutine list_sort_c_int1_array (A, ERR, ERROR,)
 Sorts an integer array list of data dimension 1 into ascending order. More...
 
subroutine list_sort_c_int2_array (A, KEY_DIMENSION, ERR, ERROR,)
 Sorts an integer array list of data dimension > 1 into ascending order. More...
 
subroutine list_sort_sp1_array (A, ERR, ERROR,)
 Sorts an single precision array list of data dimension 1 into ascending order. More...
 
subroutine list_sort_sp2_array (A, KEY_DIMENSION, ERR, ERROR,)
 Sorts an single precision array list of data dimension > 1 into ascending order. More...
 
subroutine list_sort_dp1_array (A, ERR, ERROR,)
 Sorts an double precision array list of data dimension 1 into ascending order. More...
 
subroutine list_sort_dp2_array (A, KEY_DIMENSION, ERR, ERROR,)
 Sorts an double precision array list of data dimension > 1 into ascending order. More...
 
subroutine list_sort_bubble_intg1_array (A, ERR, ERROR,)
 BUBBLE_SORT_INTG performs a bubble sort on an integer array of data dimension 1 list. More...
 
subroutine list_sort_bubble_intg2_array (A, KEY_DIMENSION, ERR, ERROR,)
 BUBBLE_SORT_INTG performs a bubble sort on an integer array of data dimension > 1 list. More...
 
subroutine list_sort_bubble_c_int1_array (A, ERR, ERROR,)
 BUBBLE_SORT_C_INT performs a bubble sort on an integer array of data dimension 1 list. More...
 
subroutine list_sort_bubble_c_int2_array (A, KEY_DIMENSION, ERR, ERROR,)
 BUBBLE_SORT_C_INT performs a bubble sort on an integer array of data dimension > 1 list. More...
 
subroutine list_sort_bubble_sp1_array (A, ERR, ERROR,)
 BUBBLE_SORT_SP performs a bubble sort on a single precision array of data dimension 1 list. More...
 
subroutine list_sort_bubble_sp2_array (A, KEY_DIMENSION, ERR, ERROR,)
 BUBBLE_SORT_SP performs a bubble sort on a single precision array of data dimension > 1 list. More...
 
subroutine list_sort_bubble_dp1_array (A, ERR, ERROR,)
 BUBBLE_SORT_DP performs a bubble sort on a double precision of data dimension 1 list. More...
 
subroutine list_sort_bubble_dp2_array (A, KEY_DIMENSION, ERR, ERROR,)
 BUBBLE_SORT_DP performs a bubble sort on a double precision of data dimension > 1 list. More...
 
subroutine list_sort_heap_intg1_array (A, ERR, ERROR,)
 Sorts an integer array of data dimension 1 list into assending order using the heap sort method. More...
 
subroutine list_sort_heap_intg2_array (A, KEY_DIMENSION, ERR, ERROR,)
 Sorts an integer array of data dimension > 1 list into assending order using the heap sort method. More...
 
subroutine list_sort_heap_c_int1_array (A, ERR, ERROR,)
 Sorts an integer array of data dimension 1 list into assending order using the heap sort method. More...
 
subroutine list_sort_heap_c_int2_array (A, KEY_DIMENSION, ERR, ERROR,)
 Sorts an integer array of data dimension > 1 list into assending order using the heap sort method. More...
 
subroutine list_sort_heap_sp1_array (A, ERR, ERROR,)
 Sorts a real single precision array of data dimension 1 list into assending order using the heap sort method. More...
 
subroutine list_sort_heap_sp2_array (A, KEY_DIMENSION, ERR, ERROR,)
 Sorts a real single precision array of data dimension > 1 list into assending order using the heap sort method. More...
 
subroutine list_sort_heap_dp1_array (A, ERR, ERROR,)
 Sorts a real double precision array of data dimension 1 list into assending order using the heap sort method. More...
 
subroutine list_sort_heap_dp2_array (A, KEY_DIMENSION, ERR, ERROR,)
 Sorts a real double precision array of data dimension > 1 list into assending order using the heap sort method. More...
 
subroutine list_sort_shell_intg1_array (A, ERR, ERROR,)
 Sorts an integer array of data dimension 1 list into either assending or descending order using the shell sort method. More...
 
subroutine list_sort_shell_intg2_array (A, KEY_DIMENSION, ERR, ERROR,)
 Sorts an integer array of data dimension > 1 list into either assending or descending order using the shell sort method. More...
 
subroutine list_sort_shell_c_int1_array (A, ERR, ERROR,)
 Sorts an integer array of data dimension 1 list into either assending or descending order using the shell sort method. More...
 
subroutine list_sort_shell_c_int2_array (A, KEY_DIMENSION, ERR, ERROR,)
 Sorts an integer array of data dimension > 1 list into either assending or descending order using the shell sort method. More...
 
subroutine list_sort_shell_sp1_array (A, ERR, ERROR,)
 Sorts a real single precision array of data dimension 1 list into either assending or descending order using the shell sort method. More...
 
subroutine list_sort_shell_sp2_array (A, KEY_DIMENSION, ERR, ERROR,)
 Sorts a real single precision array of data dimension > 1 list into either assending or descending order using the shell sort method. More...
 
subroutine list_sort_shell_dp1_array (A, ERR, ERROR,)
 Sorts a real double precision array of data dimension 1 list into either assending or descending order using the shell sort method. More...
 
subroutine list_sort_shell_dp2_array (A, KEY_DIMENSION, ERR, ERROR,)
 Sorts a real double precision array of data dimension 2 list into either assending or descending order using the shell sort method. More...
 
subroutine list_intersection_intg_array (A, B, C, ERR, ERROR,)
 Finds the intersection of two sets (arrays), leaving the original arrays intact. More...
 
subroutine list_intersection_c_int_array (A, B, C, ERR, ERROR,)
 Finds the intersection of two sets (arrays), leaving the original arrays intact. More...
 
subroutine lists_subset_of_intg_array (A, B, SUBSET, ERR, ERROR,)
 Finds out whether array A is a subset of array B. More...
 
subroutine lists_subset_of_c_int_array (A, B, SUBSET, ERR, ERROR,)
 Finds out whether array A is a subset of array B. More...
 

Variables

integer(intg), parameter, public list_intg_type =INTEGER_TYPE
 Integer data type for a list. More...
 
integer(intg), parameter, public list_sp_type =SINGLE_REAL_TYPE
 Single precision real data type for a list. More...
 
integer(intg), parameter, public list_dp_type =DOUBLE_REAL_TYPE
 Double precision real data type for a list. More...
 
integer(intg), parameter list_unsorted_type =1
 Unsorted list type. More...
 
integer(intg), parameter list_sort_ascending_type =2
 Ascending order for sort. More...
 
integer(intg), parameter list_sort_descending_type =3
 Descending order for sort. More...
 
integer(intg), parameter list_bubble_sort_method =1
 Bubble sort method. More...
 
integer(intg), parameter list_shell_sort_method =2
 Shell sort method. More...
 
integer(intg), parameter list_heap_sort_method =3
 Heap sort method. More...
 

Detailed Description

Implements lists of base types.

Function/Subroutine Documentation

subroutine, public lists::list_appendlist ( type(list_type), intent(inout), pointer  list,
type(list_type), intent(in), pointer  appendedList,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)

Appends a list to the end of this list.

Parameters
[in,out]listA pointer to the list
[in]appendedlistThe list to append
[out]errThe error code
[out]errorThe error string

Definition at line 680 of file lists.f90.

References base_routines::enters(), base_routines::exits(), list_dp_type, list_intg_type, and list_sp_type.

subroutine, public lists::list_clearitems ( type(list_type), intent(inout), pointer  list,
integer(intg), intent(out)  err,
type(varying_string), intent(out)  error 
)

Clears all the items from a list.

Parameters
[in,out]listA pointer to the list
[out]errThe error code
[out]errorThe error string

Definition at line 790 of file lists.f90.

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

subroutine, public lists::list_create_finish ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
subroutine, public lists::list_create_start ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Starts the creation of a list and returns a pointer to the created list.

See also
LISTS::LIST_CREATE_FINISH.
Parameters
[in,out]listOn exit, pointer to the list to create. Must not be associated on entry.
[out]errThe error code.
[out]errorThe error string.

Definition at line 486 of file lists.f90.

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

Referenced by domain_mappings::domain_mappings_local_from_global_calculate(), equations_matrices_routines::equationsmatrix_structurecalculate(), fieldml_util_routines::fieldml_io_initialise(), equations_matrices_routines::jacobianmatrix_structurecalculate(), solver_mapping_routines::solver_mapping_calculate(), solver_mapping_routines::solver_mapping_equations_set_add(), and solver_mapping_routines::solvermapping_createvaluescacheinitialise().

subroutine, public lists::list_data_dimension_set ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  DATA_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets/changes the data dimension for a list.

Parameters
[in]listA pointer to the list
[in]data_dimensionThe data dimension of the list to set
[out]errThe error code
[out]errorThe error string

Definition at line 509 of file lists.f90.

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

Referenced by solver_mapping_routines::solver_mapping_calculate(), solver_mapping_routines::solver_mapping_equations_set_add(), and solver_mapping_routines::solvermapping_createvaluescacheinitialise().

subroutine, public lists::list_data_type_set ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  DATA_TYPE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
subroutine, public lists::list_destroy ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
subroutine lists::list_detach_and_destroy_dp1 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  NUMBER_IN_LIST,
real(dp), dimension(:), intent(inout), allocatable  LIST_VALUES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Detaches the list values from a double precision real list of data dimension 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory.

Parameters
[in,out]listThe pointer to the list
[out]number_in_listOn exit, the number in the list that has been detached.
[in,out]list_valuesOn exit, the detached list. Must not be associated on entry.
[out]errThe error code
[out]errorThe error string

Definition at line 2541 of file lists.f90.

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

subroutine lists::list_detach_and_destroy_dp2 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  NUMBER_IN_LIST,
real(dp), dimension(:,:), intent(inout), allocatable  LIST_VALUES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Detaches the list values from a double precision real list of data dimension > 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory.

Parameters
[in,out]listThe pointer to the list
[out]number_in_listOn exit, the number in the list that has been detached.
[in,out]list_valuesOn exit, the detached list. Must not be allocated on entry.
[out]errThe error code
[out]errorThe error string

Definition at line 2596 of file lists.f90.

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

subroutine lists::list_detach_and_destroy_intg1 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  NUMBER_IN_LIST,
integer(intg), dimension(:), intent(inout), allocatable  LIST_VALUES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Detaches the list values from an integer list of data dimension 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory.

Parameters
[in,out]listThe pointer to the list
[out]number_in_listOn exit, the number in the list that has been detached.
[in,out]list_valuesOn exit, the detached list. Must not be allocated on entry.
[out]errThe error code
[out]errorThe error string

Definition at line 2324 of file lists.f90.

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

subroutine lists::list_detach_and_destroy_intg2 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  NUMBER_IN_LIST,
integer(intg), dimension(:,:), intent(inout), allocatable  LIST_VALUES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Detaches the list values from an integer list of data dimension > 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory.

Parameters
[in,out]listThe pointer to the list
[out]number_in_listOn exit, the number in the list that has been detached.
[in,out]list_valuesOn exit, the detached list. Must not be allocated on entry.
[out]errThe error code
[out]errorThe error string

Definition at line 2379 of file lists.f90.

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

subroutine lists::list_detach_and_destroy_sp1 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  NUMBER_IN_LIST,
real(sp), dimension(:), intent(inout), allocatable  LIST_VALUES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Detaches the list values from a single precision real list of data dimension 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory.

Parameters
[in,out]listThe pointer to the list
[out]number_in_listOn exit, the number in the list that has been detached.
[in,out]list_valuesOn exit, the detached list. Must not be allocated on entry.
[out]errThe error code
[out]errorThe error string

Definition at line 2433 of file lists.f90.

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

subroutine lists::list_detach_and_destroy_sp2 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  NUMBER_IN_LIST,
real(sp), dimension(:,:), intent(inout), allocatable  LIST_VALUES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Detaches the list values from a single precision real list of data dimension > 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory.

Parameters
[in,out]listThe pointer to the list
[out]number_in_listOn exit, the number in the list that has been detached.
[in,out]list_valuesOn exit, the detached list. Must not be allocated on entry.
[out]errThe error code
[out]errorThe error string

Definition at line 2487 of file lists.f90.

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

subroutine lists::list_finalise ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises a list and deallocates all memory.

Parameters
[in,out]listA pointer to the list to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 649 of file lists.f90.

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

Referenced by list_create_finish(), list_destroy(), list_detach_and_destroy_dp1(), list_detach_and_destroy_dp2(), list_detach_and_destroy_intg1(), list_detach_and_destroy_intg2(), list_detach_and_destroy_sp1(), list_detach_and_destroy_sp2(), and list_initialise().

subroutine, public lists::list_initial_size_set ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  INITIAL_SIZE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets/changes the initial size for a list.

Parameters
[in]listA pointer to the list
[in]initial_sizeThe initial size of the list to set. Must be greater than zero.
[out]errThe error code
[out]errorThe error string

Definition at line 863 of file lists.f90.

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

Referenced by domain_mappings::domain_mappings_local_from_global_calculate(), equations_matrices_routines::equationsmatrix_structurecalculate(), equations_matrices_routines::jacobianmatrix_structurecalculate(), and solver_mapping_routines::solver_mapping_calculate().

subroutine lists::list_initialise ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialises a list and all its components.

Parameters
[in,out]listA pointer to the list to initialise. Must not be associated on entry.
[out]errThe error code
[out]errorThe error string

Definition at line 822 of file lists.f90.

References base_routines::enters(), base_routines::exits(), list_finalise(), list_heap_sort_method, list_intg_type, and list_sort_ascending_type.

Referenced by list_create_start().

subroutine lists::list_intersection_c_int_array ( integer(c_int), dimension(:), intent(in), target  A,
integer(c_int), dimension(:), intent(in), target  B,
integer(c_int), dimension(:), intent(out), allocatable  C,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finds the intersection of two sets (arrays), leaving the original arrays intact.

Parameters
[in]aOne of the two arrays to find the intersection for
[in]bOther array to find the intersection for
[out]cOn exit, contains the list of common elements of the arrays
[out]errThe error code
[out]errorThe error string

Definition at line 4734 of file lists.f90.

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

subroutine lists::list_intersection_intg_array ( integer(intg), dimension(:), intent(in), target  A,
integer(intg), dimension(:), intent(in), target  B,
integer(intg), dimension(:), intent(out), allocatable  C,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finds the intersection of two sets (arrays), leaving the original arrays intact.

Parameters
[in]aOne of the two arrays to find the intersection for
[in]bOther array to find the intersection for
[out]cOn exit, contains the list of common elements of the arrays
[out]errThe error code
[out]errorThe error string

Definition at line 4639 of file lists.f90.

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

subroutine lists::list_item_add_dp1 ( type(list_type), intent(inout), pointer  LIST,
real(dp), intent(in)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Adds an item to the end of a double precision real list of data dimension 1.

Parameters
[in,out]listA pointer to the list
[in]itemThe item to add
[out]errThe error code
[out]errorThe error string

Definition at line 1132 of file lists.f90.

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

subroutine lists::list_item_add_dp2 ( type(list_type), intent(inout), pointer  LIST,
real(dp), dimension(:), intent(in)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Adds an item to the end of a double precision real list of data dimension > 1.

Parameters
[in,out]listA pointer to the list
[in]itemThe item to add
[out]errThe error code
[out]errorThe error string

Definition at line 1189 of file lists.f90.

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

subroutine lists::list_item_add_intg1 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(in)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Adds an item to the end of an integer list of data dimension 1.

Parameters
[in,out]listA pointer to the list
[in]itemThe item to add
[out]errThe error code
[out]errorThe error string

Definition at line 902 of file lists.f90.

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

subroutine lists::list_item_add_intg2 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), dimension(:), intent(in)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Adds an item to the end of an integer list of data dimension > 1.

Parameters
[in,out]listA pointer to the list
[in]itemThe item to add
[out]errThe error code
[out]errorThe error string

Definition at line 959 of file lists.f90.

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

subroutine lists::list_item_add_sp1 ( type(list_type), intent(inout), pointer  LIST,
real(sp), intent(in)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Adds an item to the end of a single precision real list of data dimension 1.

Parameters
[in,out]listA pointer to the list
[in]itemThe item to add
[out]errThe error code
[out]errorThe error string

Definition at line 1018 of file lists.f90.

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

subroutine lists::list_item_add_sp2 ( type(list_type), intent(inout), pointer  LIST,
real(sp), dimension(:), intent(in)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Adds an item to the end of a single precision real list of data dimension > 1.

Parameters
[in,out]listA pointer to the list
[in]itemThe item to add
[out]errThe error code
[out]errorThe error string

Definition at line 1074 of file lists.f90.

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

subroutine, public lists::list_item_delete ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  LIST_ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Deletes the item given by the LIST_ITEM index from the given list.

Parameters
[in]listThe pointer to the list
[in]list_itemThe position in the list to delete.
[out]errThe error code
[out]errorThe error string

Definition at line 2184 of file lists.f90.

References base_routines::enters(), base_routines::exits(), list_dp_type, list_intg_type, and list_sp_type.

subroutine lists::list_item_get_dp1 ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  LIST_ITEM,
real(dp), intent(out)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Returns the ITEM in a list at position LIST_ITEM in the given double precision LIST.

Parameters
[in]listThe pointer to the list
[in]list_itemThe position of the item to get
[out]itemOn exit, the item at the specified position.
[out]errThe error code
[out]errorThe error string.

Definition at line 1800 of file lists.f90.

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

subroutine lists::list_item_get_dp2 ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  LIST_ITEM,
real(dp), dimension(:), intent(out)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Returns the ITEM in a list at position LIST_ITEM in the given double precision LIST.

Parameters
[in]listThe pointer to the list
[in]list_itemThe position of the item to get
[out]itemOn exit, the item at the specified position
[out]errThe error code
[out]errorThe error string.

Definition at line 1853 of file lists.f90.

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

subroutine lists::list_item_get_intg1 ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  LIST_ITEM,
integer(intg), intent(out)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Returns the ITEM in a list at position LIST_ITEM in the given integer LIST.

Parameters
[in]listThe pointer to the list
[in]list_itemThe position of the item to get
[out]itemOn exit, the item at the specified position
[out]errThe error code
[out]errorThe error string.

Definition at line 1586 of file lists.f90.

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

subroutine lists::list_item_get_intg2 ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  LIST_ITEM,
integer(intg), dimension(:), intent(out)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Returns the ITEM in a list at position LIST_ITEM in the given integer LIST.

Parameters
[in]listThe pointer to the list
[in]list_itemThe position of the item to get
[out]itemOn exit, the item at the specified position
[out]errThe error code
[out]errorThe error string.

Definition at line 1639 of file lists.f90.

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

subroutine lists::list_item_get_sp1 ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  LIST_ITEM,
real(sp), intent(out)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Returns the ITEM in a list at position LIST_ITEM in the given single precision LIST.

Parameters
[in]listThe pointer to the list
[in]list_itemThe position of the item to get
[out]itemOn exit, the item at the specified position.
[out]errThe error code
[out]errorThe error string.

Definition at line 1693 of file lists.f90.

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

subroutine lists::list_item_get_sp2 ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  LIST_ITEM,
real(sp), dimension(:), intent(out)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Returns the ITEM in a list at position LIST_ITEM in the given single precision LIST.

Parameters
[in]listThe pointer to the list
[in]list_itemThe position of the item to get
[out]itemOn exit, the item at the specified position
[out]errThe error code
[out]errorThe error string.

Definition at line 1746 of file lists.f90.

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

subroutine lists::list_item_in_list_dp1 ( type(list_type), intent(in), pointer  LIST,
real(dp), intent(in)  ITEM,
integer(intg), intent(out)  LIST_ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Determines if ITEM is in the given double precision real LIST. If it is LIST_ITEM is the index in the list. If not LIST_ITEM is 0.

Parameters
[in]listThe pointer to the list
[in]itemThe item to find.
[out]list_itemOn exit, the position of the item in the list. If the item does not exist then the value of 0 is returned.
[out]errThe error code
[out]errorThe error string

Definition at line 2092 of file lists.f90.

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

subroutine lists::list_item_in_list_dp2 ( type(list_type), intent(in), pointer  LIST,
real(dp), dimension(:), intent(in)  ITEM,
integer(intg), intent(out)  LIST_ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Determines if ITEM is in the given double precision real LIST. If it is LIST_ITEM is the index in the list. If not LIST_ITEM is 0.

Parameters
[in]listThe pointer to the list
[in]itemThe item to find.
[out]list_itemOn exit, the position of the item in the list. If the item does not exist then the value of 0 is returned.
[out]errThe error code
[out]errorThe error string

Definition at line 2138 of file lists.f90.

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

subroutine lists::list_item_in_list_intg1 ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  ITEM,
integer(intg), intent(out)  LIST_ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Determines if ITEM is in the given integer LIST. If it is LIST_ITEM is the index in the list. If not LIST_ITEM is 0.

Parameters
[in]listThe pointer to the list
[in]itemThe item to find.
[out]list_itemOn exit, the position of the item in the list. If the item does not exist then the value of 0 is returned.
[out]errThe error code
[out]errorThe error string.

Definition at line 1907 of file lists.f90.

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

subroutine lists::list_item_in_list_intg2 ( type(list_type), intent(in), pointer  LIST,
integer(intg), dimension(:), intent(in)  ITEM,
integer(intg), intent(out)  LIST_ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Determines if ITEM is in the given integer LIST. If it is LIST_ITEM is the index in the list. If not LIST_ITEM is 0.

Parameters
[in]listThe pointer to the list
[in]itemThe item to find.
[out]list_itemOn exit, the position of the item in the list. If the item does not exist then the value of 0 is returned.
[out]errThe error code
[out]errorThe error string.

Definition at line 1952 of file lists.f90.

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

subroutine lists::list_item_in_list_sp1 ( type(list_type), intent(in), pointer  LIST,
real(sp), intent(in)  ITEM,
integer(intg), intent(out)  LIST_ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Determines if ITEM is in the given single precision real LIST. If it is LIST_ITEM is the index in the list. If not LIST_ITEM is 0.

Parameters
[in]listThe pointer to the list
[in]itemThe item to find.
[out]list_itemOn exit, the position of the item in the list. If the item does not exist then the value of 0 is returned.
[out]errThe error code
[out]errorThe error string

Definition at line 1999 of file lists.f90.

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

subroutine lists::list_item_in_list_sp2 ( type(list_type), intent(in), pointer  LIST,
real(sp), dimension(:), intent(in)  ITEM,
integer(intg), intent(out)  LIST_ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Determines if ITEM is in the given single precision real LIST. If it is LIST_ITEM is the index in the list. If not LIST_ITEM is 0.

Parameters
[in]listThe pointer to the list
[in]itemThe item to find.
[out]list_itemOn exit, the position of the item in the list. If the item does not exist then the value of 0 is returned.
[out]errThe error code
[out]errorThe error string

Definition at line 2045 of file lists.f90.

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

subroutine lists::list_item_set_dp1 ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  LIST_ITEM,
real(dp), intent(in)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sets an item in a double precision real list of data dimension 1.

Parameters
[in]listA pointer to the list
[in]list_itemThe index of the item to set.
[in]itemThe item to set
[out]errThe error code
[out]errorThe error string

Definition at line 1473 of file lists.f90.

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

subroutine lists::list_item_set_dp2 ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  LIST_ITEM,
real(dp), dimension(:), intent(in)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sets an item in a double precision real list of data dimension > 1.

Parameters
[in]listA pointer to the list
[in]list_itemThe index of the item to set.
[in]itemThe item to set
[out]errThe error code
[out]errorThe error string

Definition at line 1529 of file lists.f90.

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

subroutine lists::list_item_set_intg1 ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  LIST_ITEM,
integer(intg), intent(in)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sets an item in an integer list of data dimension 1.

Parameters
[in]listA pointer to the list
[in]list_itemThe index of the item to set
[in]itemThe item to set
[out]errThe error code
[out]errorThe error string

Definition at line 1247 of file lists.f90.

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

subroutine lists::list_item_set_intg2 ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  LIST_ITEM,
integer(intg), dimension(:), intent(in)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Set an item in an integer list of data dimension > 1.

Parameters
[in]listA pointer to the list
[in]list_itemThe index of the item to set
[in]itemThe item to set
[out]errThe error code
[out]errorThe error string

Definition at line 1303 of file lists.f90.

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

subroutine lists::list_item_set_sp1 ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  LIST_ITEM,
real(sp), intent(in)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sets an item in a single precision real list of data dimension 1.

Parameters
[in]listA pointer to the list
[in]list_itemThe index of the item to set
[in]itemThe item to set
[out]errThe error code
[out]errorThe error string

Definition at line 1361 of file lists.f90.

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

subroutine lists::list_item_set_sp2 ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  LIST_ITEM,
real(sp), dimension(:), intent(in)  ITEM,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sets an item in a single precision real list of data dimension > 1.

Parameters
[in]listA pointer to the list
[in]list_itemThe index of the item to set
[in]itemThe item to set
[out]errThe error code
[out]errorThe error string

Definition at line 1416 of file lists.f90.

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

subroutine, public lists::list_key_dimension_set ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets/changes the key dimension (i.e., the dimension for searching and sorting) for a list.

Parameters
[in]listA pointer to the list
[in]key_dimensionThe key dimension to set. Must be greater than zero and <= the data dimension.
[out]errThe error code
[out]errorThe error string

Definition at line 2254 of file lists.f90.

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

Referenced by solver_mapping_routines::solver_mapping_calculate(), solver_mapping_routines::solver_mapping_equations_set_add(), and solver_mapping_routines::solvermapping_createvaluescacheinitialise().

subroutine, public lists::list_mutable_set ( type(list_type), intent(in), pointer  LIST,
logical, intent(in)  MUTABLE,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Sets/changes the data dimension for a list.

Parameters
[in]listA pointer to the list
[in]mutableThe mutability of the list to set
[out]errThe error code
[out]errorThe error string

Definition at line 548 of file lists.f90.

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

Referenced by fieldml_util_routines::fieldml_io_initialise().

subroutine, public lists::list_number_of_items_get ( type(list_type), intent(in), pointer  LIST,
integer(intg), intent(out)  NUMBER_OF_ITEMS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Gets the current number of items in a list.

Parameters
[in]listA pointer to the list
[out]number_of_itemsOn exit, the current number of items in the list
[out]errThe error code
[out]errorThe error string

Definition at line 2290 of file lists.f90.

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

Referenced by equations_matrices_routines::equationsmatrix_structurecalculate(), fieldml_input_routines::fieldml_input_create_mesh_component(), equations_matrices_routines::jacobianmatrix_structurecalculate(), solver_mapping_routines::solvermapping_createvaluescacheeqnvarlistadd(), and solver_mapping_routines::solvermapping_createvaluescacheinterfvarlistadd().

subroutine, public lists::list_remove_duplicates ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Removes duplicate entries from a list. A side effect of this is that the list is sorted.

Parameters
[in,out]listThe pointer to the list
[out]errThe error code
[out]errorThe error string

Definition at line 2648 of file lists.f90.

References base_routines::enters(), base_routines::exits(), list_dp_type, list_intg_type, list_sp_type, constants::zero_tolerance, and constants::zero_tolerance_sp.

Referenced by domain_mappings::domain_mappings_local_from_global_calculate(), equations_matrices_routines::equationsmatrix_structurecalculate(), equations_matrices_routines::jacobianmatrix_structurecalculate(), and solver_mapping_routines::solver_mapping_calculate().

subroutine lists::list_search_c_int_array ( integer(c_int), dimension(:), intent(in)  A,
integer(c_int), intent(in)  VALUE,
integer(intg), intent(out)  POSITION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Searches an integer array list A for VALUE. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero.

Parameters
[in]aThe list to search
[in]valueThe value to search for
[out]positionOn exit, the position of value in the list. If value does not exist in the list the returned position is zero.
[out]errThe error code
[out]errorThe error string

Definition at line 2884 of file lists.f90.

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

subroutine lists::list_search_dp_array ( real(dp), dimension(:), intent(in)  A,
real(dp), intent(in)  VALUE,
integer(intg), intent(out)  POSITION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Searches a double precision real array list A for VALUE. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero.

Parameters
[in]aThe list to search
[in]valueThe value to search for
[out]positionOn exit, the position of value in the list. If value does not exist in the list the returned position is zero.
[out]errThe error code
[out]errorThe error string

Definition at line 2936 of file lists.f90.

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

subroutine lists::list_search_intg_array ( integer(intg), dimension(:), intent(in)  A,
integer(intg), intent(in)  VALUE,
integer(intg), intent(out)  POSITION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Searches an integer array list A for VALUE. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero.

Parameters
[in]aThe list to search
[in]valueThe value to search for
[out]positionOn exit, the position of value in the list. If value does not exist in the list the returned position is zero.
[out]errThe error code
[out]errorThe error string

Definition at line 2858 of file lists.f90.

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

subroutine lists::list_search_linear_c_int_array ( integer(c_int), dimension(:), intent(in)  A,
integer(c_int), intent(in)  VALUE,
integer(intg), intent(out)  POSITION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Searches an integer array list A for VALUE using the linear search method. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero.

Parameters
[in]aThe list to search
[in]valueThe value to search for
[out]positionOn exit, the position of value in the list. If value does not exist in the list the returned position is zero.
[out]errThe error code
[out]errorThe error string

Definition at line 3002 of file lists.f90.

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

subroutine lists::list_search_linear_dp_array ( real(dp), dimension(:), intent(in)  A,
real(dp), intent(in)  VALUE,
integer(intg), intent(out)  POSITION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Searches a double precision real array list A for VALUE using the linear search method. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero.

Parameters
[in]aThe list to search
[in]valueThe value to search for
[out]positionOn exit, the position of value in the list. If value does not exist in the list the returned position is zero.
[out]errThe error code
[out]errorThe error string

Definition at line 3082 of file lists.f90.

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

subroutine lists::list_search_linear_intg_array ( integer(intg), dimension(:), intent(in)  A,
integer(intg), intent(in)  VALUE,
integer(intg), intent(out)  POSITION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Searches an integer array list A for VALUE using the linear search method. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero.

Parameters
[in]aThe list to search
[in]valueThe value to search for
[out]positionOn exit, the position of value in the list. If value does not exist in the list the returned position is zero.
[out]errThe error code
[out]errorThe error string

Definition at line 2962 of file lists.f90.

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

subroutine lists::list_search_linear_sp_array ( real(sp), dimension(:), intent(in)  A,
real(sp), intent(in)  VALUE,
integer(intg), intent(out)  POSITION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Searches a single precision real array list A for VALUE using the linear search method. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero.

Parameters
[in]aThe list to search
[in]valueThe value to search for
[out]positionOn exit, the position of value in the list. If value does not exist in the list the returned position is zero.
[out]errThe error code
[out]errorThe error string

Definition at line 3042 of file lists.f90.

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

subroutine lists::list_search_sp_array ( real(sp), dimension(:), intent(in)  A,
real(sp), intent(in)  VALUE,
integer(intg), intent(out)  POSITION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Searches a single precision real array list A for VALUE. If the search is successful POSITION contains the index of the position of VALUE in the list otherwise POSITION is zero.

Parameters
[in]aThe list to search
[in]valueThe value to search for
[out]positionOn exit, the position of value in the list. If value does not exist in the list the returned position is zero.
[out]errThe error code
[out]errorThe error string

Definition at line 2910 of file lists.f90.

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

subroutine lists::list_sort_bubble_c_int1_array ( integer(c_int), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

BUBBLE_SORT_C_INT performs a bubble sort on an integer array of data dimension 1 list.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 3527 of file lists.f90.

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

subroutine lists::list_sort_bubble_c_int2_array ( integer(c_int), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

BUBBLE_SORT_C_INT performs a bubble sort on an integer array of data dimension > 1 list.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension of A to do the sort on
[out]errThe error code
[out]errorThe error string

Definition at line 3567 of file lists.f90.

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

subroutine lists::list_sort_bubble_dp1_array ( real(dp), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

BUBBLE_SORT_DP performs a bubble sort on a double precision of data dimension 1 list.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 3703 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_bubble_dp2_array ( real(dp), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

BUBBLE_SORT_DP performs a bubble sort on a double precision of data dimension > 1 list.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension of A to do the sort on
[out]errThe error code
[out]errorThe error string

Definition at line 3743 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_bubble_intg1_array ( integer(intg), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

BUBBLE_SORT_INTG performs a bubble sort on an integer array of data dimension 1 list.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 3441 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_bubble_intg2_array ( integer(intg), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

BUBBLE_SORT_INTG performs a bubble sort on an integer array of data dimension > 1 list.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension of A to do the sort on
[out]errThe error code
[out]errorThe error string

Definition at line 3480 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_bubble_sp1_array ( real(sp), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

BUBBLE_SORT_SP performs a bubble sort on a single precision array of data dimension 1 list.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 3615 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_bubble_sp2_array ( real(sp), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

BUBBLE_SORT_SP performs a bubble sort on a single precision array of data dimension > 1 list.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension of A to do the sort on
[out]errThe error code
[out]errorThe error string

Definition at line 3655 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_c_int1_array ( integer(c_int), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an integer array list of data dimension 1 into ascending order.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 3294 of file lists.f90.

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

subroutine lists::list_sort_c_int2_array ( integer(c_int), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an integer array list of data dimension > 1 into ascending order.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension to sort on
[out]errThe error code
[out]errorThe error string

Definition at line 3318 of file lists.f90.

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

subroutine lists::list_sort_dp1_array ( real(dp), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an double precision array list of data dimension 1 into ascending order.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 3392 of file lists.f90.

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

subroutine lists::list_sort_dp2_array ( real(dp), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an double precision array list of data dimension > 1 into ascending order.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension to sort on.
[out]errThe error code
[out]errorThe error string

Definition at line 3416 of file lists.f90.

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

subroutine lists::list_sort_heap_c_int1_array ( integer(c_int), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an integer array of data dimension 1 list into assending order using the heap sort method.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 3911 of file lists.f90.

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

subroutine lists::list_sort_heap_c_int2_array ( integer(c_int), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an integer array of data dimension > 1 list into assending order using the heap sort method.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension of A to do the sort on
[out]errThe error code
[out]errorThe error string

Definition at line 3968 of file lists.f90.

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

subroutine lists::list_sort_heap_dp1_array ( real(dp), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts a real double precision array of data dimension 1 list into assending order using the heap sort method.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 4155 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_heap_dp2_array ( real(dp), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts a real double precision array of data dimension > 1 list into assending order using the heap sort method.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension of A to do the sort on
[out]errThe error code
[out]errorThe error string

Definition at line 4212 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_heap_intg1_array ( integer(intg), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an integer array of data dimension 1 list into assending order using the heap sort method.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 3791 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_heap_intg2_array ( integer(intg), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an integer array of data dimension > 1 list into assending order using the heap sort method.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension of A to do the sort on
[out]errThe error code
[out]errorThe error string

Definition at line 3847 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_heap_sp1_array ( real(sp), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts a real single precision array of data dimension 1 list into assending order using the heap sort method.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 4033 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_heap_sp2_array ( real(sp), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts a real single precision array of data dimension > 1 list into assending order using the heap sort method.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension of A to do the sort on
[out]errThe error code
[out]errorThe error string

Definition at line 4090 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_intg1_array ( integer(intg), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an integer array list of data dimension 1 into ascending order.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 3245 of file lists.f90.

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

subroutine lists::list_sort_intg2_array ( integer(intg), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an integer array list of data dimension > 1 into ascending order.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension to sort on
[out]errThe error code
[out]errorThe error string

Definition at line 3269 of file lists.f90.

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

subroutine lists::list_sort_shell_c_int1_array ( integer(c_int), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an integer array of data dimension 1 list into either assending or descending order using the shell sort method.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 4365 of file lists.f90.

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

subroutine lists::list_sort_shell_c_int2_array ( integer(c_int), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an integer array of data dimension > 1 list into either assending or descending order using the shell sort method.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension of A to do the sort on
[out]errThe error code
[out]errorThe error string

Definition at line 4406 of file lists.f90.

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

subroutine lists::list_sort_shell_dp1_array ( real(dp), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts a real double precision array of data dimension 1 list into either assending or descending order using the shell sort method.

Parameters
[out]errThe error code
[out]errorThe error string

Definition at line 4548 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_shell_dp2_array ( real(dp), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts a real double precision array of data dimension 2 list into either assending or descending order using the shell sort method.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension of A to do the sort on
[out]errThe error code
[out]errorThe error string

Definition at line 4590 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_shell_intg1_array ( integer(intg), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an integer array of data dimension 1 list into either assending or descending order using the shell sort method.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 4277 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_shell_intg2_array ( integer(intg), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an integer array of data dimension > 1 list into either assending or descending order using the shell sort method.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension of A to do the sort on
[out]errThe error code
[out]errorThe error string

Definition at line 4317 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_shell_sp1_array ( real(sp), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts a real single precision array of data dimension 1 list into either assending or descending order using the shell sort method.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 4456 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_shell_sp2_array ( real(sp), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts a real single precision array of data dimension > 1 list into either assending or descending order using the shell sort method.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension of A to do the sort on
[out]errThe error code
[out]errorThe error string

Definition at line 4498 of file lists.f90.

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

Referenced by list_sort_list().

subroutine lists::list_sort_sp1_array ( real(sp), dimension(:), intent(inout)  A,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an single precision array list of data dimension 1 into ascending order.

Parameters
[in,out]aThe list to sort
[out]errThe error code
[out]errorThe error string

Definition at line 3343 of file lists.f90.

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

subroutine lists::list_sort_sp2_array ( real(sp), dimension(:,:), intent(inout)  A,
integer(intg), intent(in)  KEY_DIMENSION,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Sorts an single precision array list of data dimension > 1 into ascending order.

Parameters
[in,out]aThe list to sort
[in]key_dimensionThe key dimension to sort the list on.
[out]errThe error code
[out]errorThe error string

Definition at line 3367 of file lists.f90.

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

subroutine lists::lists_subset_of_c_int_array ( integer(c_int), dimension(:), intent(in)  A,
integer(c_int), dimension(:), intent(in)  B,
logical, intent(out)  SUBSET,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finds out whether array A is a subset of array B.

Parameters
[in]aSupposed subset (to test for)
[in]bSupposed superset
[out]subsetOn exit, TRUE if A is a subset of B
[out]errThe error code
[out]errorThe error string

Definition at line 4913 of file lists.f90.

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

subroutine lists::lists_subset_of_intg_array ( integer(intg), dimension(:), intent(in)  A,
integer(intg), dimension(:), intent(in)  B,
logical, intent(out)  SUBSET,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finds out whether array A is a subset of array B.

Parameters
[in]aSupposed subset (to test for)
[in]bSupposed superset
[out]subsetOn exit, TRUE if A is a subset of B
[out]errThe error code
[out]errorThe error string

Definition at line 4829 of file lists.f90.

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