tempest/src/solver/GmmxxLinearEquationSolver.h

#ifndef STORM_SOLVER_GMMXXLINEAREQUATIONSOLVER_H_
#define STORM_SOLVER_GMMXXLINEAREQUATIONSOLVER_H_

#include "gmm/gmm_matrix.h"

#include "LinearEquationSolver.h"

namespace storm {
    namespace solver {

        /*!
         * A class that uses the gmm++ library to implement the LinearEquationSolver interface.
         */
        template<typename ValueType>
        class GmmxxLinearEquationSolver : public LinearEquationSolver<ValueType> {
        public:
            // An enumeration specifying the available preconditioners.
            enum class Preconditioner {
                Ilu, Diagonal, None
            };
            
            // An enumeration specifying the available solution methods.
            enum class SolutionMethod {
                Bicgstab, Qmr, Gmres, Jacobi
            };
            
            /*!
             * Constructs a linear equation solver with the given parameters.
             *
             * @param A The matrix defining the coefficients of the linear equation system.
             * @param method The method to use for linear equation solving.
             * @param precision The precision to use for convergence detection.
             * @param maximalNumberOfIterations The maximal number of iterations do perform before iteration is aborted.
             * @param preconditioner The preconditioner to use when solving linear equation systems.
             * @param relative If set, the relative error rather than the absolute error is considered for convergence
             * detection.
             * @param restart An optional argument that specifies after how many iterations restarted methods are
             * supposed to actually to a restart.
             */
            GmmxxLinearEquationSolver(storm::storage::SparseMatrix<ValueType> const& A, SolutionMethod method, double precision, uint_fast64_t maximalNumberOfIterations, Preconditioner preconditioner, bool relative = true, uint_fast64_t restart = 0);
            
            /*!
             * Constructs a linear equation solver with parameters being set according to the settings object.
             *
             * @param A The matrix defining the coefficients of the linear equation system.
             */
            GmmxxLinearEquationSolver(storm::storage::SparseMatrix<ValueType> const& A);
                        
            virtual bool solveEquationSystem(std::vector<ValueType>& x, std::vector<ValueType> const& b, std::vector<ValueType>* multiplyResult = nullptr) const override;
            
            virtual void performMatrixVectorMultiplication(std::vector<ValueType>& x, std::vector<ValueType> const* b, uint_fast64_t n = 1, std::vector<ValueType>* multiplyResult = nullptr) const override;
            
            virtual void setPrecision(double precision) override{
                this->precision = precision;
            }
            
            virtual void setIterations(uint_fast64_t maximalNumberOfIterations) override{
                this->maximalNumberOfIterations = maximalNumberOfIterations;
            }
            
            virtual void setRelative(bool relative) override{
                this->relative = relative;
            }
            
        private:
            /*!
             * Solves the linear equation system A*x = b given by the parameters using the Jacobi method.
             *
             * @param A The matrix specifying the coefficients of the linear equations.
             * @param x The solution vector x. The initial values of x represent a guess of the real values to the
             * solver, but may be set to zero.
             * @param b The right-hand side of the equation system.
             * @return The number of iterations needed until convergence if the solver converged and
             * maximalNumberOfIteration otherwise.
             * @param multiplyResult If non-null, this memory is used as a scratch memory. If given, the length of this
             * vector must be equal to the number of rows of A.
             */
            uint_fast64_t solveLinearEquationSystemWithJacobi(storm::storage::SparseMatrix<ValueType> const& A, std::vector<ValueType>& x, std::vector<ValueType> const& b, std::vector<ValueType>* multiplyResult = nullptr) const;

            /*!
             * Retrieves the string representation of the solution method associated with this solver.
             *
             * @return The string representation of the solution method associated with this solver.
             */
            std::string methodToString() const;
            
            /*!
             * Retrieves the string representation of the preconditioner associated with this solver.
             *
             * @return The string representation of the preconditioner associated with this solver.
             */
            std::string preconditionerToString() const;
            
            // A pointer to the original sparse matrix given to this solver.
            storm::storage::SparseMatrix<ValueType> const* originalA;
            
            // The (gmm++) matrix associated with this equation solver.
            std::unique_ptr<gmm::csr_matrix<ValueType>> gmmxxMatrix;
            
            // The method to use for solving linear equation systems.
            SolutionMethod method;

            // The required precision for the iterative methods.
            double precision;

            // The maximal number of iterations to do before iteration is aborted.
            uint_fast64_t maximalNumberOfIterations;

            // The preconditioner to use when solving the linear equation system.
            Preconditioner preconditioner;

            // Sets whether the relative or absolute error is to be considered for convergence detection. Not that this
            // only applies to the Jacobi method for this solver.
            bool relative;

            // A restart value that determines when restarted methods shall do so.
            uint_fast64_t restart;
        };

    } // namespace solver
} // namespace storm

#endif /* STORM_SOLVER_GMMXXLINEAREQUATIONSOLVER_H_ */