Writtin documentation for CG method.

#pragma once

#include "LinearSolver.h"

#include <TNL/Solvers/Linear/LinearSolver.h>

namespace TNL {

   namespace Solvers {

      namespace Linear {

/**

 * \brief Iterative solver of linear systems based on the conjugate gradient method.

 *

 * This solver can be used only for positive-definite linear systems.

 *

 * See [Wikipedia](https://en.wikipedia.org/wiki/Conjugate_gradient_method) for more details.

 *

 * \tparam Matrix is type of matrix describing the linear system.

 */

template< typename Matrix >

class CG

: public LinearSolver< Matrix >

{

   using Base = LinearSolver< Matrix >;

   using VectorType = typename Traits< Matrix >::VectorType;

   public:

      /**

       * \brief Floating point type used for computations.

       */

      using RealType = typename Base::RealType;

      /**

       * \brief Device where the solver will run on and auxillary data will alloacted on.

       *

       * See \ref Devices::Host or \ref Devices::Cuda.

       */

      using DeviceType = typename Base::DeviceType;

      /**

       * \brief Type for indexing.

       */

      using IndexType = typename Base::IndexType;

      /**

       * \brief Type for vector view.

       */

      using VectorViewType = typename Base::VectorViewType;

      /**

       * \brief Type for constant vector view.

       */

      using ConstVectorViewType = typename Base::ConstVectorViewType;

   using VectorType = typename Traits< Matrix >::VectorType;

      /**

       * \brief Method for solving of a linear system.

       *

       * See \ref LinearSolver::solve for more details.

       *

       * \param b vector with the right-hand side of the linear system.

       * \param x vector for the solution of the linear system.

       * \return true if the solver converged.

       * \return false if the solver did not converge.

       */

      bool solve( ConstVectorViewType b, VectorViewType x ) override;

   protected:

   } // namespace Solvers

} // namespace TNL

#include "CG.hpp"

#include <TNL/Solvers/Linear/CG.hpp>