ptrhashtablemodule Module Reference

Data Types
type	ptrhashtabletype
	HashTable that stores void pointer items. More...

Functions/Subroutines
class(iteratortype) function, allocatable	iterator (this)
	An iterator used to iterate through the HashTable. More...
subroutine	add (this, key, val)
	Add a void pointer to the HashTable. More...
class(*) function, pointer	get (this, key)
	Get a void pointer from the HashTable using a key. More...
logical function	contains (this, key)
	Boolean indicating if an item exists in the hashtable. More...
integer(i4b) function	count (this)
	The nummer of items in the HashTable. More...
subroutine	clear (this)
	Clears the HashTable. More...
integer(i4b) function	compute_hash (key)
	Compute the hash of a key. More...

Variables
integer(i4b), parameter, private	hash_size = 4993
integer(i4b), parameter, private	multiplier = 31
integer(i4b), parameter, public	bucket_size = 1000

Function/Subroutine Documentation

add()

subroutine ptrhashtablemodule::add ( class(ptrhashtabletype), target  this, character(len=*), intent(in)  key, class(*), intent(in), pointer  val  )

private

Parameters

[in]	key	key of the item to be added
[in]	val	value to be added

Definition at line 48 of file PtrHashTable.f90.

    class(PtrHashTableType), target :: this
    character(len=*), intent(in) :: key !< key of the item to be added
    class(*), pointer, intent(in) :: val !< value to be added
    ! -- local
    type(KeyValueListType), pointer :: bucket !< bucket the key points to
    integer(I4B) :: hash !< hashed value of the key
 
    if (this%contains(key)) then
      call store_warning( &
        "Already existing variable being added to the HashTable -"//key)
    end if
 
    hash = compute_hash(key)
 
    bucket => this%buckets(hash)
    call bucket%add(key, val)
    this%cnt = this%cnt + 1

Here is the call graph for this function:

clear()

subroutine ptrhashtablemodule::clear ( class(ptrhashtabletype), target  this )

private

Loops over all the buckets and clears them.

Definition at line 113 of file PtrHashTable.f90.

    class(PtrHashTableType), target :: this
    ! -- local
    type(KeyValueListType), pointer :: bucket
    integer(I4B) :: bucket_index
 
    do bucket_index = 1, bucket_size
      bucket => this%buckets(bucket_index)
      call bucket%clear()
    end do
 
    this%cnt = 0

compute_hash()

integer(i4b) function ptrhashtablemodule::compute_hash ( character(len=*), intent(in)  key )

private

The hash produced will be in the interval 1 - BUCKET_SIZE

Parameters

[in]

key

the key

Returns

the hash

Definition at line 131 of file PtrHashTable.f90.

    character(len=*), intent(in) :: key !< the key
    integer(I4B) :: hash !< the hash
    ! -- local
    integer(I4B) :: i !< character index of the key
 
    hash = 0
    do i = 1, len_trim(key)
      hash = modulo(multiplier * hash + ichar(key(i:i)), hash_size)
    end do
    hash = 1 + modulo(hash, bucket_size)
 

Here is the caller graph for this function:

contains()

logical function ptrhashtablemodule::contains ( class(ptrhashtabletype), target  this, character(len=*), intent(in)  key  )

private

Parameters

[in]

key

key of the item to retrieve

Returns

item found

Definition at line 89 of file PtrHashTable.f90.

    class(PtrHashTableType), target :: this
    character(len=*), intent(in) :: key !< key of the item to retrieve
    logical :: res !< item found
 
    ! -- local
    res = associated(this%get(key))
 

count()

integer(i4b) function ptrhashtablemodule::count ( class(ptrhashtabletype)  this )

private

Definition at line 102 of file PtrHashTable.f90.

    class(PtrHashTableType) :: this
    integer(I4B) :: val
 
    val = this%cnt

get()

class(*) function, pointer ptrhashtablemodule::get ( class(ptrhashtabletype), target  this, character(len=*), intent(in)  key  )

private

Parameters

[in]

key

key of the item to retrieve

Returns

item associated with the key

Definition at line 71 of file PtrHashTable.f90.

    class(PtrHashTableType), target :: this
    character(len=*), intent(in) :: key !< key of the item to retrieve
    class(*), pointer :: val !< item associated with the key
    ! -- local
    type(KeyValueListType), pointer :: bucket !< bucket the key points to
    integer(I4B) :: hash !< hashed value of the key
 
    hash = compute_hash(key)
 
    bucket => this%buckets(hash)
    val => bucket%get(key)
 

Here is the call graph for this function:

iterator()

class(iteratortype) function, allocatable ptrhashtablemodule::iterator ( class(ptrhashtabletype), target  this )

private

Definition at line 38 of file PtrHashTable.f90.

    class(PtrHashTableType), target :: this
    class(IteratorType), allocatable :: itr
 
    itr = ptrhashtableiteratortype(this%buckets)

Variable Documentation

bucket_size

integer(i4b), parameter, public ptrhashtablemodule::bucket_size = 1000

Definition at line 15 of file PtrHashTable.f90.

  integer(I4B), parameter, public :: BUCKET_SIZE = 1000

hash_size

integer(i4b), parameter, private ptrhashtablemodule::hash_size = 4993

private

Definition at line 13 of file PtrHashTable.f90.

  integer(I4B), parameter, private :: HASH_SIZE = 4993

multiplier

integer(i4b), parameter, private ptrhashtablemodule::multiplier = 31

private

Definition at line 14 of file PtrHashTable.f90.

  integer(I4B), parameter, private :: MULTIPLIER = 31