Merge pull request #1368 from e10harvey/issue1344

Restructure docs

docs/conf.py

@@ -18,11 +18,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Kokkos Kernels'
-copyright = '2021, Evan Harvey'
-author = 'Evan Harvey'
+copyright = '2022, Kokkos Development Team'
+author = 'Kokkos Team'
 
 # The full version, including alpha/beta/rc tags
-release = 'v3.4.1'
+release = 'latest'
 
 
 # -- General configuration ---------------------------------------------------

docs/developer/apidocs.rst

@@ -0,0 +1,14 @@
+Source Code Documentation
+=========================
+
+The source documentation is extracted from the C++ files using Doxygen.
+
+.. toctree::
+   :maxdepth: 4
+
+   apidocs/blas1
+   apidocs/blas2
+   apidocs/blas3
+   apidocs/sparse
+   apidocs/batched_dense
+   apidocs/batched_sparse

docs/developer/apidocs/batched_dense.rst

@@ -0,0 +1,257 @@
+BATCHED -- KokkosKernels batched functor-level interfaces
+=========================================================
+
+innerlu
+-------
+CodeCleanup-TODO: Move Decl file to dense/impl/KokkosBatched_InnerLU_Internal.hpp
+
+applypivot
+----------
+.. doxygenstruct:: KokkosBatched::TeamVectorApplyPivot
+    :members:
+
+qr_withcolumnpivoting
+---------------------
+.. doxygenstruct:: KokkosBatched::TeamVectorQR_WithColumnPivoting
+    :members:
+
+addradial
+---------
+.. doxygenstruct:: KokkosBatched::SerialAddRadial
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamAddRadial
+    :members:
+
+householder
+-----------
+.. doxygenstruct:: KokkosBatched::SerialHouseholder
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorHouseholder
+    :members:
+
+set
+---
+.. doxygenstruct:: KokkosBatched::SerialSet
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamSet
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorSet
+    :members:
+
+scale
+-----
+.. doxygenstruct:: KokkosBatched::SerialScale
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamScale
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorScale
+    :members:
+
+setidentity
+-----------
+.. doxygenstruct:: KokkosBatched::SerialSetIdentity
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamSetIdentity
+    :members:
+.. doxygenstruct:: KokkosBatched::SetIdentity
+    :members:
+
+applyhouseholder
+----------------
+.. doxygenstruct:: KokkosBatched::SerialApplyHouseholder
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorApplyHouseholder
+    :members:
+
+innermultipledotproduct
+-----------------------
+CodeCleanup-TODO: Move Decl file to dense/impl/KokkosBatched_InnerMultipleDotProduct_Internal.hpp
+
+lu
+--
+.. doxygenstruct:: KokkosBatched::SerialLU
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamLU
+    :members:
+.. doxygenstruct:: KokkosBatched::LU
+    :members:
+
+solveutv
+--------
+.. doxygenstruct:: KokkosBatched::TeamVectorSolveUTV
+    :members:
+
+utv
+---
+.. doxygenstruct:: KokkosBatched::TeamVectorUTV
+    :members:
+
+inverselu
+---------
+CodeCleanup-TODO: Move Decl file to dense/impl/KokkosBatched_InverseLU_Internal.hpp
+
+svd
+---
+.. doxygenstruct:: KokkosBatched::SerialSVD
+    :members:
+
+eigendecomposition
+------------------
+.. doxygenstruct:: KokkosBatched::SerialEigendecomposition
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorEigendecomposition
+    :members:
+
+trtri
+-----
+.. doxygenstruct:: KokkosBatched::SerialTrtri
+    :members:
+
+qr
+--
+.. doxygenstruct:: KokkosBatched::SerialQR
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamQR
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorQR
+    :members:
+.. doxygenstruct:: KokkosBatched::QR
+    :members:
+
+trmm
+----
+.. doxygenstruct:: KokkosBatched::SerialTrmm
+    :members:
+
+trsm
+----
+.. doxygenstruct:: KokkosBatched::SerialTrsm
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamTrsm
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorTrsm
+    :members:
+.. doxygenstruct:: KokkosBatched::Trsm
+    :members:
+
+innergemmfixa
+-------------
+CodeCleanup-TODO: Move Decl file to dense/impl/KokkosBatched_InnerGemmFixA_Internal.hpp
+
+innergemmfixb
+-------------
+CodeCleanup-TODO: Move Decl file to dense/impl/KokkosBatched_InnerGemmFixB_Internal.hpp
+
+innergemmfixc
+-------------
+CodeCleanup-TODO: Move Decl file to dense/impl/KokkosBatched_InnerGemmFixC_Internal.hpp
+
+applyq
+------
+.. doxygenstruct:: KokkosBatched::SerialApplyQ
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamApplyQ
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorApplyQ
+    :members:
+.. doxygenstruct:: KokkosBatched::ApplyQ
+    :members:
+
+copy
+----
+.. doxygenstruct:: KokkosBatched::SerialCopy
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamCopy
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorCopy
+    :members:
+.. doxygenstruct:: KokkosBatched::Copy
+    :members:
+
+innertrsm
+---------
+CodeCleanup-TODO: Move Decl file to dense/impl/KokkosBatched_InnerTrsm_Internal.hpp
+
+solvelu
+-------
+.. doxygenstruct:: KokkosBatched::SerialSolveLU
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamSolveLU
+    :members:
+.. doxygenstruct:: KokkosBatched::SolveLU
+    :members:
+
+xpay
+----
+.. doxygenstruct:: KokkosBatched::SerialXpay
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamXpay
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorXpay
+    :members:
+
+axpy
+----
+.. doxygenstruct:: KokkosBatched::SerialAxpy
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamAxpy
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorAxpy
+    :members:
+
+gemv
+----
+.. doxygenstruct:: KokkosBatched::SerialGemv
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamGemv
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorGemv
+    :members:
+.. doxygenstruct:: KokkosBatched::Gemv
+    :members:
+
+dot
+---
+.. doxygenstruct:: KokkosBatched::SerialDot
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamDot
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorDot
+    :members:
+
+hadamardproduct
+---------------
+.. doxygenstruct:: KokkosBatched::SerialHadamardProduct
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamHadamardProduct
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorHadamardProduct
+    :members:
+.. doxygenstruct:: KokkosBatched::HadamardProduct
+    :members:
+
+vector
+------
+CodeCleanup-TODO: Move Decl file to dense/impl/
+
+trsv
+----
+.. doxygenstruct:: KokkosBatched::SerialTrsv
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamTrsv
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorTrsv
+    :members:
+.. doxygenstruct:: KokkosBatched::Trsv
+    :members:
+
+gemm
+----
+.. doxygenstruct:: KokkosBatched::SerialGemm
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamGemm
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorGemm
+    :members:
+.. doxygenstruct:: KokkosBatched::Gemm
+    :members:

docs/developer/apidocs/batched_sparse.rst

@@ -0,0 +1,43 @@
+SPARSE BATCHED -- KokkosKernels sparse batched functor-level interfaces
+=======================================================================
+
+cg
+--
+.. doxygenstruct:: KokkosBatched::CG
+    :members:
+
+crsmatrix
+---------
+.. doxygenclass:: KokkosBatched::CrsMatrix
+    :members:
+
+gmres
+-----
+.. doxygenstruct:: KokkosBatched::GMRES
+    :members:
+
+identity
+--------
+.. doxygenclass:: KokkosBatched::Identity
+    :members:
+
+jacobiprec
+----------
+.. doxygenclass:: KokkosBatched::JacobiPrec
+    :members:
+
+krylovhandle
+------------
+.. doxygenclass:: KokkosBatched::KrylovHandle
+    :members:
+
+spmv
+----
+.. doxygenstruct:: KokkosBatched::SerialSpmv
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamSpmv
+    :members:
+.. doxygenstruct:: KokkosBatched::TeamVectorSpmv
+    :members:
+.. doxygenstruct:: KokkosBatched::Spmv
+    :members:

docs/developer/apidocs/blas1.rst

@@ -0,0 +1,55 @@
+BLAS1 -- KokkosKernels blas1 interfaces
+=======================================
+
+axpby
+-----
+.. doxygenfunction:: KokkosBlas::axpby
+
+dot
+---
+.. doxygenfunction:: KokkosBlas::dot(const RV &, const XMV &, const YMV &, typename std::enable_if<Kokkos::is_view<RV>::value, int>::type = 0)
+.. doxygenfunction:: KokkosBlas::dot(const XVector &, const YVector &)
+
+fill
+----
+.. doxygenfunction:: KokkosBlas::fill
+
+mult
+----
+.. doxygenfunction:: KokkosBlas::mult
+
+nrm1
+----
+.. doxygenfunction:: KokkosBlas::nrm1(const RV &, const XMV &, typename std::enable_if<Kokkos::is_view<RV>::value, int>::type = 0)
+.. doxygenfunction:: KokkosBlas::nrm1(const XVector &)
+
+nrm2
+----
+.. doxygenfunction:: KokkosBlas::nrm2(const RV &R, const XMV &X, typename std::enable_if<Kokkos::is_view<RV>::value, int>::type = 0)
+.. doxygenfunction:: KokkosBlas::nrm2(const XVector &x)
+
+nrm2w
+-----
+.. doxygenfunction:: KokkosBlas::nrm2w(const RV &R, const XMV &X, const XMV &W, typename std::enable_if<Kokkos::is_view<RV>::value, int>::type = 0)
+.. doxygenfunction:: KokkosBlas::nrm2w(const XVector &x, const XVector &w)
+
+nrminf
+------
+.. doxygenfunction:: KokkosBlas::nrminf(const RV &R, const XMV &X, typename std::enable_if<Kokkos::is_view<RV>::value, int>::type = 0)
+.. doxygenfunction:: KokkosBlas::nrminf(const XVector &x)
+
+reciprocal
+----------
+.. doxygenfunction:: KokkosBlas::reciprocal
+
+scal
+----
+.. doxygenfunction:: KokkosBlas::scal
+
+sum
+---
+.. doxygenfunction:: KokkosBlas::sum(const RV &R, const XMV &X, typename std::enable_if<Kokkos::is_view<RV>::value, int>::type = 0)
+
+update
+------
+.. doxygenfunction:: KokkosBlas::update

docs/developer/apidocs/blas2.rst

@@ -0,0 +1,7 @@
+BLAS2 -- KokkosKernels blas2 interfaces
+=======================================
+
+gemv
+----
+.. doxygenfunction:: KokkosBlas::gemv(const char trans[], typename AViewType::const_value_type &alpha, const AViewType &A, const XViewType &x, typename YViewType::const_value_type &beta, const YViewType &y)
+.. doxygenfunction:: KokkosBlas::gemv(const typename AViewType::execution_space &space, const char trans[], typename AViewType::const_value_type &alpha, const AViewType &A, const XViewType &x, typename YViewType::const_value_type &beta, const YViewType &y)