psmile_multimap.F90

Go to the documentation of this file.

!-----------------------------------------------------------------------
! Copyright 2010, DKRZ, Hamburg, Germany.
! All rights reserved. Use is subject to OASIS4 license terms.
!-----------------------------------------------------------------------
!
! !DESCRIPTION:
!
! Module psmile_multimap contains a data structure which is similar to
! the associative container class multimap of the c++ stl
! (http://www.cplusplus.com/reference/stl/multimap/). It uses integer
! keys and values.
!
!
! !REVISION HISTORY:
!
!   Date      Programmer   Description
! ----------  ----------   -----------
! 28.10.10    M. Hanke     created
!
!----------------------------------------------------------------------
!
!  $Id: psmile_multimap.F90 2751 2010-11-19 13:53:28Z hanke $
!  $Author: hanke $
!
!----------------------------------------------------------------------

! whoever forgot to add the import statement to Fortran 90 was *****
module psmile_multimap_fortran_90_is_no_good
   type key_type
      integer, pointer :: values (:)
   end type key_type

   type multimap
      type(key_type), pointer :: keys(:)
   end type multimap
end module psmile_multimap_fortran_90_is_no_good

module psmile_multimap

   use psmile_multimap_fortran_90_is_no_good
 
   implicit none

   interface

      subroutine init_multimap (this)
         use psmile_multimap_fortran_90_is_no_good
         type(multimap), intent(inout) :: this
      end subroutine init_multimap

      subroutine free_multimap (this)
         use psmile_multimap_fortran_90_is_no_good
         type(multimap), intent(inout) :: this
         integer :: i
      end subroutine free_multimap

      subroutine add_pair (this, key, value)
         use psmile_multimap_fortran_90_is_no_good
         type(multimap), intent(inout) :: this
         integer, intent(in) :: key, value
         type(key_type), pointer :: temp_keys(:)
      end subroutine add_pair

      integer function get_num_values (this, key)
         use psmile_multimap_fortran_90_is_no_good
         type(multimap), intent(inout) :: this
         integer, intent(in) :: key
      end function get_num_values

      function get_values(this, key, num_values)
         use psmile_multimap_fortran_90_is_no_good
         type(multimap), intent(inout) :: this
         integer, intent(in) :: key, num_values
         integer :: get_values(num_values)
      end function get_values

      integer function get_value(this, key, value_idx)
         use psmile_multimap_fortran_90_is_no_good
         type(multimap), intent(inout) :: this
         integer, intent(in) :: key, value_idx
      end function

      subroutine init_keys (keys)
         use psmile_multimap_fortran_90_is_no_good
         type(key_type), intent(inout) :: keys(:)
      end subroutine

      subroutine rm_key (this, key)
         use psmile_multimap_fortran_90_is_no_good
         type(multimap), intent(inout) :: this
         integer, intent(in) :: key
      end subroutine

      logical function is_valid_key(this, key)
         use psmile_multimap_fortran_90_is_no_good
         type(multimap), intent(in) :: this
         integer, intent(in) :: key
      end function

      integer function get_num_valid_keys (this)
         use psmile_multimap_fortran_90_is_no_good
         type(multimap), intent(in) :: this
      end function get_num_valid_keys

   end interface

end module psmile_multimap