| Procedure | Location | Procedure Type | Description |
|---|---|---|---|
| array_extend | ordered_mod | Subroutine | Adds the elements of an array to this object. |
| array_list_append | array_list_mod | Subroutine | Adds the provided item to the end of the list. |
| array_list_clear | array_list_mod | Subroutine | Removes all items from this list, but does not change its container type. |
| array_list_concat | array_list_mod | Function | Join this list with an ordered object, returning the result. The contents of the returned object are ordered such that applying pop until it is empty would return items in the same order as calling pop until the list is empty and then until the second object is empty. |
| array_list_contents_type | array_list_mod | Function | Returns a container with the dynamic type of the contents of this list. |
| array_list_delete_multiple | array_list_mod | Subroutine | Removes the elements at the positions specified by the indices in
the array |
| array_list_delete_single | array_list_mod | Subroutine | Removes the element at the specified position in the list, moving all succeeding items back by one position. Crashes if the element has not been set. |
| array_list_delete_slice | array_list_mod | Subroutine | Removes the element within the specified slice of the list, moving all succeeding items back by the number of items deleted. The slice contains the element at the start index to the end index, inclusive. Crashes if part of the slice has not been set. |
| array_list_filter | array_list_mod | Function | Returns a new list containing only those items held in this list which pass the provided test. |
| array_list_foreach | array_list_mod | Subroutine | Performs the specified action on each item in the list, in place. |
| array_list_get | array_list_mod | Function | Returns the item at the specified location in the list. Returns an unallocated container if that location has not been set. |
| array_list_get_index | array_list_mod | Function | Returns the index of the first occurrence of the item in the list. If there are no occurrences, then returns -1. |
| array_list_get_indices | array_list_mod | Function | Returns an array containing the indices of all occurrences of the item in the list. If there are no occurrences, then returns an unallocated array. |
| array_list_get_last_index | array_list_mod | Function | Returns the index of the last occurrence of the item in the list. If there are no occurrences, then returns -1. |
| array_list_has | array_list_mod | Function | Indicates whether there are any copies of the specified item present in the list. |
| array_list_insert | array_list_mod | Subroutine | Places the provided item into the list at the position specified, moving all succeeding items forward by one. The position must be one which is already filled or the length of the list plus one. |
| array_list_iter | array_list_mod | Function | Returns an iterator containing the contents of this list as they were at the time this method was called. |
| array_list_max | array_list_mod | Function | Returns the largest item contained in the list, as determined using the provided comparison function. |
| array_list_min | array_list_mod | Function | Returns the smallest item contained in the list, as determined using the provided comparison function. |
| array_list_nearest | array_list_mod | Function | Returns the value contained in the list for which the subtraction
function returns the smallest absolute real number when comparing
with the specified |
| array_list_peek | array_list_mod | Function | Returns the item at the end of the list, without removing it. |
| array_list_peekleft | array_list_mod | Function | Returns the item at the start of the list. |
| array_list_pop | array_list_mod | Function | Removes the item at the end of the list and returns it. |
| array_list_popleft | array_list_mod | Function | Removes the item at the start of the list and returns it. |
| array_list_push | array_list_mod | Subroutine | Adds an item to the beginning of the list. |
| array_list_remove | array_list_mod | Subroutine | Remove the first occurrence of the specified item from the list, moving all succeeding items back by one position. No action is taken if the item is not present. |
| array_list_remove_all | array_list_mod | Subroutine | Remove all occurrences of the specified item from the list, moving all succeeding items back in position. No action is taken if the item is not present. |
| array_list_remove_last | array_list_mod | Subroutine | Remove the last occurrence of the specified item from the list, moving all succeeding items back by one position. No action is taken if the item is not present. |
| array_list_set_multiple | array_list_mod | Subroutine | Places the values of the provided array of items in the locations specified by the corresponding indices in the in the array of elements. |
| array_list_set_single | array_list_mod | Subroutine | Places the value of the provided element in the specified location in the array. Crashes if this element is not already defined. |
| array_list_size | array_list_mod | Function | Returns the number of items in the list |
| array_list_slice | array_list_mod | Function | Returns an array_list instance containing all items in this list within the specified slice, inclusive. Crashes if one of the indices is outside of the list's bounds. |
| array_list_sort | array_list_mod | Subroutine | Sorts the list, in place, so that all items are in ascending order according the the provided comparison function. |
| array_list_sum | array_list_mod | Function | Returns a container representing the sum of all items contained in the list. This sum is calculated by repeatedly applying the addition procedure to the list's contents. |
| array_list_to_array | array_list_mod | Function | Returns copies of all items held in this list, stored within an array of container objects. |
| assign_container | abstract_container_mod | Subroutine | Transfers the contents of the container to another variable.
If the other variable is another container of the same type
then the contents will be transferred. If the other variable is
the same type as the contents of the container (as determined
by the typeguard routine provided for that
concrete type extension) then it will be given the value held by
the container. Otherwise, an error message will be printed and
the program stopped. If compiled with |
| character_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| complex16_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| complex4_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| complex8_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| complex_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| constructor | iterator_mod | Function | Creates an iterator from an array of containers containing the data to be returned upon iteration. The data is returned starting with the first element of the array and ending with the last. |
| contents | abstract_container_mod | Function | Returns the contents, encoded as a character array, of the container. |
| contents_type | iterator_mod | Function | Returns a container with the dynamic type of that used to hold the contents of this iterator |
| get_contents | node_mod | Function | An accessor returning a container object storing the value placed in the node. If the contents have not been set then an unallocated container is returned. |
| get_next | linked_node_mod | Function | Returns a pointer to the node which this ones points to, i.e. the next node in the chain. If this node does not point at another one, then a null pointer is returned. |
| get_prev | bidir_node_mod | Function | Returns a pointer to the previous node in the chain. If this node does not point at a previous one one, then a null pointer is returned. |
| has_contents | node_mod | Function | Returns whether or not a values has been assigned to the node. |
| has_next | iterator_mod | Function | Returns |
| has_next | linked_node_mod | Function | Returns whether or not this node points at another one, forming a chain. |
| has_prev | bidir_node_mod | Function | Returns whether or not this node points to a previous one, forming a chain in the backwards direction. |
| int1_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| int2_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| int4_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| int8_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| int_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| is_equal | abstract_container_mod | Function | Checks whether two containers are of the same type and are storing the same contents. |
| is_filled | abstract_container_mod | Function | Returns |
| iterator | iterator_mod | Interface | |
| iterator_extend | ordered_mod | Subroutine | Adds the contents of an iterable object to this data structure. |
| logical_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| next | iterator_mod | Function | Returns the next item stored in the iterator. If there are no more items present then an empty container is returned. If there are no contents stored in this iterator then it returns an unallocated container. |
| queue_is_fifo | queue_mod | Function | Returns |
| real16_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| real4_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| real8_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| real_guard | container_mod | Function | Transfers the container's contents to the variable on the left hand side of the equals sign if it is of the correct type. |
| reset | iterator_mod | Subroutine | Resets the position of the iterator to the start, so it is as though the next routine has never been called. |
| set | abstract_container_mod | Subroutine | Sets the contents of the storage array to value passed. The type
of the variable provided must be the same as the container
variable is designed to accept (as determined by the
concrete type implementation of the typeguard
method in the extension) or be of the same type of container.
Otherwise an error message will be printed and the program will
exit. If |
| set_contents | node_mod | Subroutine | Places a new value into storage within the node. This value must already be heald within an allocatable container. The actual argument will be deallocated after the subroutine call, as its allocation is moved to the contents of the node. |
| set_next | linked_node_mod | Subroutine | Sets the node which this one points to (i.e. sets the next node in
the chain). If this node already points to another one, the
pointer will, by default, be nullified. This may result in a
memory leak. Optionally, by setting |
| set_prev | bidir_node_mod | Subroutine | Sets the pointer to the previous node in the chain. If this node
already points to a previous one, the pointer will, by default, be
nullified. This may result in a memory leak. Optionally, by
setting |
| unset_contents | node_mod | Subroutine | Deallocates the value stored within the node. |
| unset_next | linked_node_mod | Subroutine | Unsets the pointer to the next node in the chain, severing it.
By default, the pointer is only nullified. This may result in a
memory leak. Optionally, by setting |
| unset_prev | bidir_node_mod | Subroutine | Unsets the pointer to the previous node in the chain, severing it.
By default, the pointer is only nullified. This may result in a
memory leak. Optionally, by setting |