MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches

A generic heterogeneous doubly-linked list. More...

Collaboration diagram for listmodule::listtype:
Collaboration graph

Public Member Functions

procedure, public iterator (this)
procedure, public add (this, objptr)
 Append the given item to the list.
procedure, public clear (this, destroy)
 Deallocate all items in list.
procedure, public count (this)
 Return number of nodes in list.
procedure, public containsobject (this, obj, isequal)
 Determine whether the list contains the given object.
procedure, public deallocatebackward (this, fromnode)
 Deallocate fromNode and all previous nodes, and reassign firstNode.
procedure, public getindex (this, obj)
 Get the index of the given item in the list.
procedure, public getnextitem (this)
 Get the next item in the list.
procedure, public getpreviousitem (this)
 Get the previous item in the list.
generic, public getitem (this, indx)
 Get a pointer to the item at the given index.
generic, public getitem (this)
 Get a pointer to the item at the current node.
procedure, public insertafter (this, objptr, indx)
 Insert the given item after the given index.
procedure, public insertbefore (this, objptr, targetnode)
 Insert the given item before the given node.
procedure, public reset (this)
 Reset the list's current node pointer and index.
generic, public removenode (this, i, destroyvalue)
 Remove the node at the given index, optionally destroying its value.
generic, public removenode (this, node, destroyvalue)
 Remove the given node, optionally destroying its value.

Public Attributes

type(listnodetype), pointer, public firstnode => null()
character(len=20), public name = ' '

Private Member Functions

procedure, private next (this)
 Move the list's current node pointer and index one node forwards.
procedure, private previous (this)
 Move the list's current node pointer and index one node backwards.
procedure, private get_current_item (this)
 Get a pointer to the item at the current node.
procedure, private get_item_by_index (this, indx)
 Get a pointer to the item at the given index.
procedure, private get_node_by_index (this, indx)
 Get the node at the given index.
procedure, private remove_node_by_index (this, i, destroyvalue)
 Remove the node at the given index, optionally destroying its value.
procedure, private remove_this_node (this, node, destroyvalue)
 Remove the given node, optionally destroying its value.

Private Attributes

type(listnodetype), pointer, private lastnode => null()
type(listnodetype), pointer, private currentnode => null()
integer(i4b), private currentnodeindex = 0
integer(i4b), private nodecount = 0

Detailed Description

Definition at line 14 of file List.f90.

Member Function/Subroutine Documentation

◆ add()

procedure, public listmodule::listtype::add ( class(listtype), intent(inout) this,
class(*), intent(inout), pointer objptr )

Definition at line 26 of file List.f90.

◆ clear()

procedure, public listmodule::listtype::clear ( class(listtype) this,
logical, intent(in), optional destroy )

Definition at line 27 of file List.f90.

◆ containsobject()

procedure, public listmodule::listtype::containsobject ( class(listtype), intent(inout) this,
class(*), pointer obj,
procedure(isequaliface), intent(in), optional, pointer isequal )

Definition at line 29 of file List.f90.

◆ count()

procedure, public listmodule::listtype::count ( class(listtype) this)

Definition at line 28 of file List.f90.

◆ deallocatebackward()

procedure, public listmodule::listtype::deallocatebackward ( class(listtype), intent(inout), target this,
type(listnodetype), intent(inout), pointer fromnode )

Definition at line 30 of file List.f90.

◆ get_current_item()

procedure, private listmodule::listtype::get_current_item ( class(listtype), intent(inout), target this)
private

Definition at line 42 of file List.f90.

◆ get_item_by_index()

procedure, private listmodule::listtype::get_item_by_index ( class(listtype), intent(inout) this,
integer(i4b), intent(in) indx )
private

Definition at line 43 of file List.f90.

◆ get_node_by_index()

procedure, private listmodule::listtype::get_node_by_index ( class(listtype), intent(inout) this,
integer(i4b), intent(in) indx )
private

Definition at line 44 of file List.f90.

◆ getindex()

procedure, public listmodule::listtype::getindex ( class(listtype), intent(inout), target this,
class(*), pointer obj )

Definition at line 31 of file List.f90.

◆ getitem() [1/2]

generic, public listmodule::listtype::getitem ( class(listtype), intent(inout), target this)

Definition at line 34 of file List.f90.

◆ getitem() [2/2]

generic, public listmodule::listtype::getitem ( class(listtype), intent(inout) this,
integer(i4b), intent(in) indx )

Definition at line 34 of file List.f90.

Here is the call graph for this function:

◆ getnextitem()

procedure, public listmodule::listtype::getnextitem ( class(listtype), intent(inout), target this)

Definition at line 32 of file List.f90.

◆ getpreviousitem()

procedure, public listmodule::listtype::getpreviousitem ( class(listtype), intent(inout), target this)

Definition at line 33 of file List.f90.

◆ insertafter()

procedure, public listmodule::listtype::insertafter ( class(listtype), intent(inout) this,
class(*), intent(inout), pointer objptr,
integer(i4b), intent(in) indx )

Definition at line 35 of file List.f90.

◆ insertbefore()

procedure, public listmodule::listtype::insertbefore ( class(listtype), intent(inout) this,
class(*), intent(inout), pointer objptr,
type(listnodetype), intent(inout), pointer targetnode )

Definition at line 36 of file List.f90.

◆ iterator()

procedure, public listmodule::listtype::iterator ( class(listtype) this)

Definition at line 25 of file List.f90.

◆ next()

procedure, private listmodule::listtype::next ( class(listtype), intent(inout), target this)
private

Definition at line 37 of file List.f90.

◆ previous()

procedure, private listmodule::listtype::previous ( class(listtype), intent(inout), target this)
private

Definition at line 38 of file List.f90.

◆ remove_node_by_index()

procedure, private listmodule::listtype::remove_node_by_index ( class(listtype), intent(inout) this,
integer(i4b), intent(in) i,
logical, intent(in) destroyvalue )
private

Definition at line 45 of file List.f90.

◆ remove_this_node()

procedure, private listmodule::listtype::remove_this_node ( class(listtype), intent(inout) this,
type(listnodetype), intent(inout), pointer node,
logical, intent(in) destroyvalue )
private

Definition at line 46 of file List.f90.

◆ removenode() [1/2]

generic, public listmodule::listtype::removenode ( class(listtype), intent(inout) this,
integer(i4b), intent(in) i,
logical, intent(in) destroyvalue )

Definition at line 40 of file List.f90.

Here is the call graph for this function:

◆ removenode() [2/2]

generic, public listmodule::listtype::removenode ( class(listtype), intent(inout) this,
type(listnodetype), intent(inout), pointer node,
logical, intent(in) destroyvalue )

Definition at line 40 of file List.f90.

◆ reset()

procedure, public listmodule::listtype::reset ( class(listtype), intent(inout), target this)

Definition at line 39 of file List.f90.

Member Data Documentation

◆ currentnode

type(listnodetype), pointer, private listmodule::listtype::currentnode => null()
private

Definition at line 20 of file List.f90.

◆ currentnodeindex

integer(i4b), private listmodule::listtype::currentnodeindex = 0
private

Definition at line 21 of file List.f90.

◆ firstnode

type(listnodetype), pointer, public listmodule::listtype::firstnode => null()

Definition at line 16 of file List.f90.

◆ lastnode

type(listnodetype), pointer, private listmodule::listtype::lastnode => null()
private

Definition at line 19 of file List.f90.

◆ name

character(len=20), public listmodule::listtype::name = ' '

Definition at line 17 of file List.f90.

◆ nodecount

integer(i4b), private listmodule::listtype::nodecount = 0
private

Definition at line 22 of file List.f90.


The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Utilities/List.f90