module psb_d_ell_mat_mod

  use psb_d_base_mat_mod

  type, extends(psb_d_base_sparse_mat) :: psb_d_ell_sparse_mat
    !
    ! ITPACK/ELL format, extended.
    ! Based on M. Heroux "A proposal for a sparse BLAS toolkit".
    !  IRN is our addition, should help in transferring to/from
    !  other formats (should come in handy for GPUs). 
    ! Notes:
    !  1. JA holds the column indices, padded with the row index.
    !  2. VAL holds the coefficients, padded with zeros
    !  3. IDIAG hold the position of the diagonal element
    !     or 0 if it is not there, but is only relevant for
    !     triangular matrices. In particular, a unit triangular matrix
    !     will have IDIAG==0.
    !  4. IRN holds the actual number of nonzeros stored in each row
    !  5. Within a row, the indices are sorted for use of SV. 
    !     
    
    integer, allocatable :: irn(:), ja(:,:), idiag(:)
    real(psb_dpk_), allocatable :: val(:,:)

  contains
    procedure, pass(a) :: get_size     => d_ell_get_size
    procedure, pass(a) :: get_nzeros   => d_ell_get_nzeros
    procedure, nopass  :: get_fmt      => d_ell_get_fmt
    procedure, pass(a) :: sizeof       => d_ell_sizeof
    procedure, pass(a) :: d_csmm       => psb_d_ell_csmm
    procedure, pass(a) :: d_csmv       => psb_d_ell_csmv
    procedure, pass(a) :: d_inner_cssm => psb_d_ell_cssm
    procedure, pass(a) :: d_inner_cssv => psb_d_ell_cssv
    procedure, pass(a) :: d_scals      => psb_d_ell_scals
    procedure, pass(a) :: d_scal       => psb_d_ell_scal
    procedure, pass(a) :: csnmi        => psb_d_ell_csnmi
    procedure, pass(a) :: csnm1        => psb_d_ell_csnm1
    procedure, pass(a) :: rowsum       => psb_d_ell_rowsum
    procedure, pass(a) :: arwsum       => psb_d_ell_arwsum
    procedure, pass(a) :: colsum       => psb_d_ell_colsum
    procedure, pass(a) :: aclsum       => psb_d_ell_aclsum
    procedure, pass(a) :: reallocate_nz => psb_d_ell_reallocate_nz
    procedure, pass(a) :: allocate_mnnz => psb_d_ell_allocate_mnnz
    procedure, pass(a) :: cp_to_coo    => psb_d_cp_ell_to_coo
    procedure, pass(a) :: cp_from_coo  => psb_d_cp_ell_from_coo
    procedure, pass(a) :: cp_to_fmt    => psb_d_cp_ell_to_fmt
    procedure, pass(a) :: cp_from_fmt  => psb_d_cp_ell_from_fmt
    procedure, pass(a) :: mv_to_coo    => psb_d_mv_ell_to_coo
    procedure, pass(a) :: mv_from_coo  => psb_d_mv_ell_from_coo
    procedure, pass(a) :: mv_to_fmt    => psb_d_mv_ell_to_fmt
    procedure, pass(a) :: mv_from_fmt  => psb_d_mv_ell_from_fmt
    procedure, pass(a) :: csput        => psb_d_ell_csput
    procedure, pass(a) :: get_diag     => psb_d_ell_get_diag
    procedure, pass(a) :: csgetptn     => psb_d_ell_csgetptn
    procedure, pass(a) :: d_csgetrow   => psb_d_ell_csgetrow
    procedure, pass(a) :: get_nz_row   => d_ell_get_nz_row
    procedure, pass(a) :: reinit       => psb_d_ell_reinit
    procedure, pass(a) :: trim         => psb_d_ell_trim
    procedure, pass(a) :: print        => psb_d_ell_print
    procedure, pass(a) :: free         => d_ell_free
    procedure, pass(a) :: mold         => psb_d_ell_mold
    procedure, pass(a) :: psb_d_ell_cp_from
    generic, public    :: cp_from => psb_d_ell_cp_from
    procedure, pass(a) :: psb_d_ell_mv_from
    generic, public    :: mv_from => psb_d_ell_mv_from

  end type psb_d_ell_sparse_mat

  private :: d_ell_get_nzeros, d_ell_free,  d_ell_get_fmt, &
       & d_ell_get_size, d_ell_sizeof, d_ell_get_nz_row

  interface
    subroutine  psb_d_ell_reallocate_nz(nz,a) 
      import :: psb_d_ell_sparse_mat
      integer, intent(in) :: nz
      class(psb_d_ell_sparse_mat), intent(inout) :: a
    end subroutine psb_d_ell_reallocate_nz
  end interface
  
  interface 
    subroutine psb_d_ell_reinit(a,clear)
      import :: psb_d_ell_sparse_mat
      class(psb_d_ell_sparse_mat), intent(inout) :: a   
      logical, intent(in), optional :: clear
    end subroutine psb_d_ell_reinit
  end interface
  
  interface
    subroutine  psb_d_ell_trim(a)
      import :: psb_d_ell_sparse_mat
      class(psb_d_ell_sparse_mat), intent(inout) :: a
    end subroutine psb_d_ell_trim
  end interface
  
  interface 
    subroutine psb_d_ell_mold(a,b,info) 
      import :: psb_d_ell_sparse_mat, psb_d_base_sparse_mat, psb_long_int_k_
      class(psb_d_ell_sparse_mat), intent(in)               :: a
      class(psb_d_base_sparse_mat), intent(out), allocatable :: b
      integer, intent(out)                                 :: info
    end subroutine psb_d_ell_mold
  end interface

  interface
    subroutine  psb_d_ell_allocate_mnnz(m,n,a,nz) 
      import :: psb_d_ell_sparse_mat
      integer, intent(in) :: m,n
      class(psb_d_ell_sparse_mat), intent(inout) :: a
      integer, intent(in), optional :: nz
    end subroutine psb_d_ell_allocate_mnnz
  end interface
  
  interface
    subroutine psb_d_ell_print(iout,a,iv,eirs,eics,head,ivr,ivc)
      import :: psb_d_ell_sparse_mat
      integer, intent(in)               :: iout
      class(psb_d_ell_sparse_mat), intent(in) :: a   
      integer, intent(in), optional     :: iv(:)
      integer, intent(in), optional     :: eirs,eics
      character(len=*), optional        :: head
      integer, intent(in), optional     :: ivr(:), ivc(:)
    end subroutine psb_d_ell_print
  end interface
  
  interface 
    subroutine psb_d_cp_ell_to_coo(a,b,info) 
      import :: psb_d_coo_sparse_mat, psb_d_ell_sparse_mat
      class(psb_d_ell_sparse_mat), intent(in) :: a
      class(psb_d_coo_sparse_mat), intent(inout) :: b
      integer, intent(out)            :: info
    end subroutine psb_d_cp_ell_to_coo
  end interface
  
  interface 
    subroutine psb_d_cp_ell_from_coo(a,b,info) 
      import :: psb_d_ell_sparse_mat, psb_d_coo_sparse_mat
      class(psb_d_ell_sparse_mat), intent(inout) :: a
      class(psb_d_coo_sparse_mat), intent(in)    :: b
      integer, intent(out)                        :: info
    end subroutine psb_d_cp_ell_from_coo
  end interface
  
  interface 
    subroutine psb_d_cp_ell_to_fmt(a,b,info) 
      import :: psb_d_ell_sparse_mat, psb_d_base_sparse_mat
      class(psb_d_ell_sparse_mat), intent(in)   :: a
      class(psb_d_base_sparse_mat), intent(inout) :: b
      integer, intent(out)                       :: info
    end subroutine psb_d_cp_ell_to_fmt
  end interface
  
  interface 
    subroutine psb_d_cp_ell_from_fmt(a,b,info) 
      import :: psb_d_ell_sparse_mat, psb_d_base_sparse_mat
      class(psb_d_ell_sparse_mat), intent(inout) :: a
      class(psb_d_base_sparse_mat), intent(in)   :: b
      integer, intent(out)                        :: info
    end subroutine psb_d_cp_ell_from_fmt
  end interface
  
  interface 
    subroutine psb_d_mv_ell_to_coo(a,b,info) 
      import :: psb_d_ell_sparse_mat, psb_d_coo_sparse_mat
      class(psb_d_ell_sparse_mat), intent(inout) :: a
      class(psb_d_coo_sparse_mat), intent(inout)   :: b
      integer, intent(out)            :: info
    end subroutine psb_d_mv_ell_to_coo
  end interface
  
  interface 
    subroutine psb_d_mv_ell_from_coo(a,b,info) 
      import :: psb_d_ell_sparse_mat, psb_d_coo_sparse_mat
      class(psb_d_ell_sparse_mat), intent(inout) :: a
      class(psb_d_coo_sparse_mat), intent(inout) :: b
      integer, intent(out)                        :: info
    end subroutine psb_d_mv_ell_from_coo
  end interface
  
  interface 
    subroutine psb_d_mv_ell_to_fmt(a,b,info) 
      import :: psb_d_ell_sparse_mat, psb_d_base_sparse_mat
      class(psb_d_ell_sparse_mat), intent(inout) :: a
      class(psb_d_base_sparse_mat), intent(inout)  :: b
      integer, intent(out)                        :: info
    end subroutine psb_d_mv_ell_to_fmt
  end interface
  
  interface 
    subroutine psb_d_mv_ell_from_fmt(a,b,info) 
      import :: psb_d_ell_sparse_mat, psb_d_base_sparse_mat
      class(psb_d_ell_sparse_mat), intent(inout)  :: a
      class(psb_d_base_sparse_mat), intent(inout) :: b
      integer, intent(out)                         :: info
    end subroutine psb_d_mv_ell_from_fmt
  end interface
  
  interface 
    subroutine psb_d_ell_cp_from(a,b)
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(inout) :: a
      type(psb_d_ell_sparse_mat), intent(in)   :: b
    end subroutine psb_d_ell_cp_from
  end interface
  
  interface 
    subroutine psb_d_ell_mv_from(a,b)
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(inout)  :: a
      type(psb_d_ell_sparse_mat), intent(inout) :: b
    end subroutine psb_d_ell_mv_from
  end interface
  
  
  interface 
    subroutine psb_d_ell_csput(nz,ia,ja,val,a,imin,imax,jmin,jmax,info,gtl) 
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(inout) :: a
      real(psb_dpk_), intent(in)      :: val(:)
      integer, intent(in)             :: nz,ia(:), ja(:),&
           &  imin,imax,jmin,jmax
      integer, intent(out)            :: info
      integer, intent(in), optional   :: gtl(:)
    end subroutine psb_d_ell_csput
  end interface
  
  interface 
    subroutine psb_d_ell_csgetptn(imin,imax,a,nz,ia,ja,info,&
         & jmin,jmax,iren,append,nzin,rscale,cscale)
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(in) :: a
      integer, intent(in)                  :: imin,imax
      integer, intent(out)                 :: nz
      integer, allocatable, intent(inout)  :: ia(:), ja(:)
      integer,intent(out)                  :: info
      logical, intent(in), optional        :: append
      integer, intent(in), optional        :: iren(:)
      integer, intent(in), optional        :: jmin,jmax, nzin
      logical, intent(in), optional        :: rscale,cscale
    end subroutine psb_d_ell_csgetptn
  end interface
  
  interface 
    subroutine psb_d_ell_csgetrow(imin,imax,a,nz,ia,ja,val,info,&
         & jmin,jmax,iren,append,nzin,rscale,cscale)
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(in) :: a
      integer, intent(in)                  :: imin,imax
      integer, intent(out)                 :: nz
      integer, allocatable, intent(inout)  :: ia(:), ja(:)
      real(psb_dpk_), allocatable,  intent(inout)    :: val(:)
      integer,intent(out)                  :: info
      logical, intent(in), optional        :: append
      integer, intent(in), optional        :: iren(:)
      integer, intent(in), optional        :: jmin,jmax, nzin
      logical, intent(in), optional        :: rscale,cscale
    end subroutine psb_d_ell_csgetrow
  end interface

  interface 
    subroutine psb_d_ell_csgetblk(imin,imax,a,b,info,&
       & jmin,jmax,iren,append,rscale,cscale)
      import :: psb_d_ell_sparse_mat, psb_dpk_, psb_d_coo_sparse_mat
      class(psb_d_ell_sparse_mat), intent(in) :: a
      class(psb_d_coo_sparse_mat), intent(inout) :: b
      integer, intent(in)                  :: imin,imax
      integer,intent(out)                  :: info
      logical, intent(in), optional        :: append
      integer, intent(in), optional        :: iren(:)
      integer, intent(in), optional        :: jmin,jmax
      logical, intent(in), optional        :: rscale,cscale
    end subroutine psb_d_ell_csgetblk
  end interface
    
  interface 
    subroutine psb_d_ell_cssv(alpha,a,x,beta,y,info,trans) 
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(in) :: a
      real(psb_dpk_), intent(in)          :: alpha, beta, x(:)
      real(psb_dpk_), intent(inout)       :: y(:)
      integer, intent(out)                :: info
      character, optional, intent(in)     :: trans
    end subroutine psb_d_ell_cssv
    subroutine psb_d_ell_cssm(alpha,a,x,beta,y,info,trans) 
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(in) :: a
      real(psb_dpk_), intent(in)          :: alpha, beta, x(:,:)
      real(psb_dpk_), intent(inout)       :: y(:,:)
      integer, intent(out)                :: info
      character, optional, intent(in)     :: trans
    end subroutine psb_d_ell_cssm
  end interface
  
  interface 
    subroutine psb_d_ell_csmv(alpha,a,x,beta,y,info,trans) 
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(in) :: a
      real(psb_dpk_), intent(in)          :: alpha, beta, x(:)
      real(psb_dpk_), intent(inout)       :: y(:)
      integer, intent(out)                :: info
      character, optional, intent(in)     :: trans
    end subroutine psb_d_ell_csmv
    subroutine psb_d_ell_csmm(alpha,a,x,beta,y,info,trans) 
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(in) :: a
      real(psb_dpk_), intent(in)          :: alpha, beta, x(:,:)
      real(psb_dpk_), intent(inout)       :: y(:,:)
      integer, intent(out)                :: info
      character, optional, intent(in)     :: trans
    end subroutine psb_d_ell_csmm
  end interface
  
  
  interface 
    function psb_d_ell_csnmi(a) result(res)
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(in) :: a
      real(psb_dpk_)         :: res
    end function psb_d_ell_csnmi
  end interface
  
  interface 
    function psb_d_ell_csnm1(a) result(res)
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(in) :: a
      real(psb_dpk_)         :: res
    end function psb_d_ell_csnm1
  end interface

  interface 
    subroutine psb_d_ell_rowsum(d,a) 
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(in) :: a
      real(psb_dpk_), intent(out)              :: d(:)
    end subroutine psb_d_ell_rowsum
  end interface

  interface 
    subroutine psb_d_ell_arwsum(d,a) 
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(in) :: a
      real(psb_dpk_), intent(out)              :: d(:)
    end subroutine psb_d_ell_arwsum
  end interface
  
  interface 
    subroutine psb_d_ell_colsum(d,a) 
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(in) :: a
      real(psb_dpk_), intent(out)              :: d(:)
    end subroutine psb_d_ell_colsum
  end interface

  interface 
    subroutine psb_d_ell_aclsum(d,a) 
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(in) :: a
      real(psb_dpk_), intent(out)              :: d(:)
    end subroutine psb_d_ell_aclsum
  end interface
    
  interface 
    subroutine psb_d_ell_get_diag(a,d,info) 
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(in) :: a
      real(psb_dpk_), intent(out)     :: d(:)
      integer, intent(out)            :: info
    end subroutine psb_d_ell_get_diag
  end interface
  
  interface 
    subroutine psb_d_ell_scal(d,a,info) 
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(inout) :: a
      real(psb_dpk_), intent(in)      :: d(:)
      integer, intent(out)            :: info
    end subroutine psb_d_ell_scal
  end interface
  
  interface
    subroutine psb_d_ell_scals(d,a,info) 
      import :: psb_d_ell_sparse_mat, psb_dpk_
      class(psb_d_ell_sparse_mat), intent(inout) :: a
      real(psb_dpk_), intent(in)      :: d
      integer, intent(out)            :: info
    end subroutine psb_d_ell_scals
  end interface
  


contains 

  ! == ===================================
  !
  !
  !
  ! Getters 
  !
  !
  !
  !
  !
  ! == ===================================

  
  function d_ell_sizeof(a) result(res)
    implicit none 
    class(psb_d_ell_sparse_mat), intent(in) :: a
    integer(psb_long_int_k_) :: res
    res = 8 
    res = res + psb_sizeof_dp  * size(a%val)
    res = res + psb_sizeof_int * size(a%irn)
    res = res + psb_sizeof_int * size(a%idiag)
    res = res + psb_sizeof_int * size(a%ja)
      
  end function d_ell_sizeof

  function d_ell_get_fmt() result(res)
    implicit none 
    character(len=5) :: res
    res = 'ELL'
  end function d_ell_get_fmt
  
  function d_ell_get_nzeros(a) result(res)
    implicit none 
    class(psb_d_ell_sparse_mat), intent(in) :: a
    integer :: res
    res = sum(a%irn(1:a%get_nrows()))
  end function d_ell_get_nzeros

  function d_ell_get_size(a) result(res)
    implicit none 
    class(psb_d_ell_sparse_mat), intent(in) :: a
    integer :: res

    res = -1
    
    if (allocated(a%ja)) then 
      if (res >= 0) then 
        res = min(res,size(a%ja))
      else 
        res = size(a%ja)
      end if
    end if
    if (allocated(a%val)) then 
      if (res >= 0) then 
        res = min(res,size(a%val))
      else 
        res = size(a%val)
      end if
    end if

  end function d_ell_get_size



  function  d_ell_get_nz_row(idx,a) result(res)

    implicit none
    
    class(psb_d_ell_sparse_mat), intent(in) :: a
    integer, intent(in)                  :: idx
    integer                              :: res
    
    res = 0 
 
    if ((1<=idx).and.(idx<=a%get_nrows())) then 
      res = a%irn(idx)
    end if
    
  end function d_ell_get_nz_row



  ! == ===================================
  !
  !
  !
  ! Data management
  !
  !
  !
  !
  !
  ! == ===================================  

  subroutine  d_ell_free(a) 
    implicit none 

    class(psb_d_ell_sparse_mat), intent(inout) :: a

    if (allocated(a%idiag)) deallocate(a%idiag)
    if (allocated(a%irn)) deallocate(a%irn)
    if (allocated(a%ja))  deallocate(a%ja)
    if (allocated(a%val)) deallocate(a%val)
    call a%set_null()
    call a%set_nrows(0)
    call a%set_ncols(0)
    
    return

  end subroutine d_ell_free


end module psb_d_ell_mat_mod