matrix.h

/*
 *  OGF/Graphite: Geometry and Graphics Programming Library + Utilities
 *  Copyright (C) 2000 Bruno Levy
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *  If you modify this software, you should include a notice giving the
 *  name of the person performing the modification, the date of modification,
 *  and the reason for such modification.
 *
 *  Contact: Bruno Levy
 *
 *     levy@loria.fr
 *
 *     ISA Project
 *     LORIA, INRIA Lorraine,
 *     Campus Scientifique, BP 239
 *     54506 VANDOEUVRE LES NANCY CEDEX
 *     FRANCE
 *
 *  Note that the GNU General Public License does not permit incorporating
 *  the Software into proprietary programs.
 */
 
#ifndef H_OGF_SCENE_GRAPH_NL_MATRIX_H
#define H_OGF_SCENE_GRAPH_NL_MATRIX_H
 
#include <OGF/scene_graph/common/common.h>
#include <OGF/gom/types/object.h>
 
struct NLMatrixStruct;
typedef NLMatrixStruct* NLMatrix;
 
namespace OGF {
    namespace NL {
 
        class Vector;
 
        gom_class SCENE_GRAPH_API Matrix : public Object {
          public:
 
            enum Format { Dynamic, CRS, Factorized };
 
            enum Factorization { SuperLU, SuperLU_perm, SuperLU_sym, Cholmod };
 
            enum IterativeSolver { CG, GMRES, BiCGSTAB };
 
            enum Preconditioner { None, Jacobi, SSOR};
 
            Matrix(index_t m, index_t n);
 
             ~Matrix() override;
 
          gom_properties:
            index_t get_m() const;
 
            index_t get_n() const;
 
            Format get_format() const;
 
          gom_slots:
 
            void add_coefficient(index_t i, index_t j, double a);
 
 
            void add_coefficients(
                const Vector* I, const Vector* J, const Vector* A,
                bool ignore_OOB = false
            );
 
            void add_coefficients_to_diagonal(const Vector* A);
 
            void mult(const Vector* x, Vector* y) const;
 
            void compress();
 
            Matrix* factorize(Factorization factorization) const;
 
            void solve_iterative(
                const Vector* b, Vector* x,
                IterativeSolver solver = BiCGSTAB,
                Preconditioner precond = None,
                index_t max_iter=1000, double eps = 1e-3
            );
 
            void solve_direct(
                const Vector* b, Vector* x,
                Factorization factorization = SuperLU_perm
            );
 
            void solve_symmetric(
                const Vector* b, Vector* x,
                bool direct_solver = false
            );
 
          public:
             NLMatrix implementation() const {
                return impl_;
            }
 
          protected:
 
            Matrix(NLMatrix impl) : impl_(impl) {
            }
 
          private:
            NLMatrix impl_;
        };
 
    }
}
 
#endif