Further doxugen changes.
psblas3-type-indexed
Salvatore Filippone 13 years ago
parent 312bf60b01
commit ec5a08da4e

@ -201,6 +201,7 @@ module psb_base_mat_mod
end type psb_base_sparse_mat end type psb_base_sparse_mat
!> Function: psb_base_get_nz_row !> Function: psb_base_get_nz_row
!! \memberof psb_base_sparse_mat
!! Interface for the get_nz_row method. Equivalent to: !! Interface for the get_nz_row method. Equivalent to:
!! count(A(idx,:)/=0) !! count(A(idx,:)/=0)
!! \param idx The line we are interested in. !! \param idx The line we are interested in.
@ -216,6 +217,7 @@ module psb_base_mat_mod
! !
!> Function: psb_base_get_nzeros !> Function: psb_base_get_nzeros
!! \memberof psb_base_sparse_mat
!! Interface for the get_nzeros method. Equivalent to: !! Interface for the get_nzeros method. Equivalent to:
!! count(A(:,:)/=0) !! count(A(:,:)/=0)
! !
@ -228,6 +230,7 @@ module psb_base_mat_mod
end interface end interface
!> Function get_size !> Function get_size
!! \memberof psb_base_sparse_mat
!! how many items can A hold with !! how many items can A hold with
!! its current space allocation? !! its current space allocation?
!! (as opposed to how many are !! (as opposed to how many are
@ -243,6 +246,7 @@ module psb_base_mat_mod
! !
!> Function reinit: transition state from ASB to UPDATE !> Function reinit: transition state from ASB to UPDATE
!! \memberof psb_base_sparse_mat
!! \param clear [true] explicitly zero out coefficients. !! \param clear [true] explicitly zero out coefficients.
! !
interface interface
@ -256,6 +260,7 @@ module psb_base_mat_mod
! !
!> Function !> Function
!! \memberof psb_base_sparse_mat
!! print on file in Matrix Market format. !! print on file in Matrix Market format.
!! \param iout the output unit !! \param iout the output unit
!! \param iv(:) [none] renumber both row and column indices !! \param iv(:) [none] renumber both row and column indices
@ -277,6 +282,7 @@ module psb_base_mat_mod
! !
!> Function getptn: !> Function getptn:
!! \memberof psb_base_sparse_mat
!! \brief Get the pattern. !! \brief Get the pattern.
!! !!
!! !!
@ -319,6 +325,7 @@ module psb_base_mat_mod
! !
!> Function get_neigh: !> Function get_neigh:
!! \memberof psb_base_sparse_mat
!! \brief Get the neighbours. !! \brief Get the neighbours.
!! !!
!! !!
@ -346,6 +353,7 @@ module psb_base_mat_mod
! !
! !
!> Function allocate_mnnz !> Function allocate_mnnz
!! \memberof psb_base_sparse_mat
!! \brief Three-parameters version of allocate !! \brief Three-parameters version of allocate
!! !!
!! \param m number of rows !! \param m number of rows
@ -365,6 +373,7 @@ module psb_base_mat_mod
! !
! !
!> Function reallocate_nz !> Function reallocate_nz
!! \memberof psb_base_sparse_mat
!! \brief One--parameters version of (re)allocate !! \brief One--parameters version of (re)allocate
!! !!
!! \param nz number of nonzeros to allocate for !! \param nz number of nonzeros to allocate for
@ -379,6 +388,7 @@ module psb_base_mat_mod
! !
!> Function free !> Function free
!! \memberof psb_base_sparse_mat
!! \brief destructor !! \brief destructor
! !
interface interface
@ -390,6 +400,7 @@ module psb_base_mat_mod
! !
!> Function trim !> Function trim
!! \memberof psb_base_sparse_mat
!! \brief Memory trim !! \brief Memory trim
!! Make sure the memory allocation of the sparse matrix is as tight as !! Make sure the memory allocation of the sparse matrix is as tight as
!! possible given the actual number of nonzeros it contains. !! possible given the actual number of nonzeros it contains.
@ -407,6 +418,7 @@ contains
! !
!> Function free !> Function free
!! \memberof psb_base_sparse_mat
!! \brief Memory occupation in byes !! \brief Memory occupation in byes
! !
function psb_base_sizeof(a) result(res) function psb_base_sizeof(a) result(res)
@ -418,6 +430,7 @@ contains
! !
!> Function get_fmt !> Function get_fmt
!! \memberof psb_base_sparse_mat
!! \brief return a short descriptive name (e.g. COO CSR etc.) !! \brief return a short descriptive name (e.g. COO CSR etc.)
! !
function psb_base_get_fmt() result(res) function psb_base_get_fmt() result(res)

@ -1564,14 +1564,14 @@ MSCGEN_PATH =
# inheritance and usage relations if the target is undocumented # inheritance and usage relations if the target is undocumented
# or is not a class. # or is not a class.
HIDE_UNDOC_RELATIONS = YES HIDE_UNDOC_RELATIONS =
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz, a graph visualization # available from the path. This tool is part of Graphviz, a graph visualization
# toolkit from AT&T and Lucent Bell Labs. The other options in this section # toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default) # have no effect if this option is set to NO (the default)
HAVE_DOT = NO HAVE_DOT = YES
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
# allowed to run in parallel. When set to 0 (the default) doxygen will # allowed to run in parallel. When set to 0 (the default) doxygen will

Loading…
Cancel
Save