stlvecintmodule Module Reference

Data Types
type	stlvecint

Functions/Subroutines
subroutine	init (this, capacity)
subroutine	push_back (this, newValue)
subroutine	push_back_unique (this, newValue)
subroutine	pop (this)
subroutine	add_array (this, array)
subroutine	add_array_unique (this, array)
integer(i4b) function	at (this, idx)
integer(i4b) function	at_safe (this, idx)
subroutine	set (this, idx, value)
subroutine	clear (this)
subroutine	shrink_to_fit (this)
subroutine	destroy (this)
subroutine	expand (this)
logical(lgp) function	contains (this, val)
integer(i4b) function	get_index (this, val)
	Return index of first occurrence,. More...
integer(i4b) function, dimension(:), allocatable	get_values (this)

Variables
integer(i4b), parameter	defaultinitialcapacity = 4

Function/Subroutine Documentation

add_array()

subroutine stlvecintmodule::add_array ( class(stlvecint), intent(inout)  this, integer(i4b), dimension(:), pointer  array  )

private

Definition at line 88 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
    integer(I4B), dimension(:), pointer :: array
    ! local
    integer(I4B) :: i
 
    do i = 1, size(array)
      call this%push_back(array(i))
    end do
 

add_array_unique()

subroutine stlvecintmodule::add_array_unique ( class(stlvecint), intent(inout)  this, integer(i4b), dimension(:), pointer  array  )

private

Definition at line 100 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
    integer(I4B), dimension(:), pointer :: array
    ! local
    integer(I4B) :: i
 
    do i = 1, size(array)
      if (.not. this%contains(array(i))) then
        call this%push_back(array(i))
      end if
    end do
 

at()

integer(i4b) function stlvecintmodule::at ( class(stlvecint), intent(in)  this, integer(i4b), intent(in)  idx  )

private

Definition at line 114 of file STLVecInt.f90.

    class(STLVecInt), intent(in) :: this
    integer(I4B), intent(in) :: idx
    integer(I4B) :: value
 
    value = this%values(idx)
 

at_safe()

integer(i4b) function stlvecintmodule::at_safe ( class(stlvecint), intent(inout)  this, integer(i4b), intent(in)  idx  )

private

Definition at line 123 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
    integer(I4B), intent(in) :: idx
    integer(I4B) :: value
 
    if (idx > this%size) then
      write (*, *) 'STLVecInt exception: access out of bounds, index ', idx, &
        ' exceeds actual size (', this%size, ')'
      call ustop()
    end if
    value = this%at(idx)
 

Here is the call graph for this function:

clear()

subroutine stlvecintmodule::clear ( class(stlvecint), intent(inout)  this )

private

Definition at line 146 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
 
    ! really, this is all there is to it...
    this%size = 0
 

contains()

logical(lgp) function stlvecintmodule::contains ( class(stlvecint), intent(inout)  this, integer(i4b)  val  )

private

Definition at line 210 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
    integer(I4B) :: val
    logical(LGP) :: res
    ! local
    integer(I4B) :: i
 
    res = .false.
    do i = 1, this%size
      if (this%at(i) == val) then
        res = .true.
        return
      end if
    end do
 

destroy()

subroutine stlvecintmodule::destroy ( class(stlvecint), intent(inout)  this )

private

Definition at line 182 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
 
    if (allocated(this%values)) then
      deallocate (this%values)
      this%size = 0
      this%capacity = 0
    else
      write (*, *) 'STLVecInt exception: cannot delete an unallocated array'
      call ustop()
    end if
 

Here is the call graph for this function:

Here is the caller graph for this function:

expand()

subroutine stlvecintmodule::expand ( class(stlvecint), intent(inout)  this )

private

Definition at line 198 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
    integer(I4B) :: increment
 
    ! expansion strategy
    increment = this%capacity / 2 + 1
    call expandarray(this%values, increment)
    this%capacity = this%capacity + increment
 

get_index()

integer(i4b) function stlvecintmodule::get_index ( class(stlvecint), intent(inout)  this, integer(i4b)  val  )

private

Definition at line 229 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
    integer(I4B) :: val
    integer(I4B) :: idx
    ! local
    integer(I4B) :: i
 
    idx = -1
    do i = 1, this%size
      if (this%at(i) == val) then
        idx = i
        return
      end if
    end do
 

get_values()

integer(i4b) function, dimension(:), allocatable stlvecintmodule::get_values ( class(stlvecint), intent(in)  this )

private

Definition at line 246 of file STLVecInt.f90.

    class(STLVecInt), intent(in) :: this
    integer(I4B), dimension(:), allocatable :: values
 
    values = this%values(1:this%size)
 

init()

subroutine stlvecintmodule::init ( class(stlvecint), intent(inout)  this, integer(i4b), intent(in), optional  capacity  )

private

Definition at line 38 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
    integer(I4B), intent(in), optional :: capacity ! the initial capacity, when given
 
    if (present(capacity)) then
      this%capacity = capacity
    else
      this%capacity = defaultinitialcapacity
    end if
 
    allocate (this%values(this%capacity))
    this%size = 0
 

pop()

subroutine stlvecintmodule::pop ( class(stlvecint), intent(inout)  this )

private

Definition at line 76 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
 
    if (this%size > 0) then
      this%size = this%size - 1
    else
      write (*, *) 'STLVecInt exception: cannot pop from an empty array'
      call ustop()
    end if
 

Here is the call graph for this function:

push_back()

subroutine stlvecintmodule::push_back ( class(stlvecint), intent(inout)  this, integer(i4b)  newValue  )

private

Definition at line 53 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
    integer(I4B) :: newValue
    ! check capacity
    if (this%size + 1 > this%capacity) then
      call this%expand()
    end if
 
    this%size = this%size + 1
    this%values(this%size) = newvalue
 

push_back_unique()

subroutine stlvecintmodule::push_back_unique ( class(stlvecint), intent(inout)  this, integer(i4b)  newValue  )

private

Definition at line 66 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
    integer(I4B) :: newValue
 
    if (.not. this%contains(newvalue)) then
      call this%push_back(newvalue)
    end if
 

set()

subroutine stlvecintmodule::set ( class(stlvecint), intent(inout)  this, integer(i4b), intent(in)  idx, integer(i4b)  value  )

private

Definition at line 137 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
    integer(I4B), intent(in) :: idx
    integer(I4B) :: value
 
    this%values(idx) = value
 

shrink_to_fit()

subroutine stlvecintmodule::shrink_to_fit ( class(stlvecint), intent(inout)  this )

private

Definition at line 154 of file STLVecInt.f90.

    class(STLVecInt), intent(inout) :: this
    ! local
    integer(I4B), allocatable :: tempValues(:)
    integer(I4B) :: i, newSize
 
    if (this%size == this%capacity) then
      return
    end if
 
    ! store temp
    newsize = this%size
    allocate (tempvalues(newsize))
    do i = 1, newsize
      tempvalues(i) = this%values(i)
    end do
 
    ! reinit
    call this%destroy()
    call this%init(newsize)
 
    ! copy back
    do i = 1, newsize
      call this%push_back(tempvalues(i))
    end do
 

Variable Documentation

defaultinitialcapacity

integer(i4b), parameter stlvecintmodule::defaultinitialcapacity = 4

private

Definition at line 9 of file STLVecInt.f90.

  integer(I4B), parameter :: defaultInitialCapacity = 4