SparseCholeskyFactorisation.hxx

// Copyright (C) 2010 Marc Duruflé
//
// This file is part of the linear-algebra library Seldon,
// http://seldon.sourceforge.net/.
//
// Seldon is free software; you can redistribute it and/or modify it under the
// terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 2.1 of the License, or (at your option)
// any later version.
//
// Seldon 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 Lesser General Public License for
// more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Seldon. If not, see http://www.gnu.org/licenses/.
 
 
#ifndef SELDON_FILE_SPARSE_CHOLESKY_FACTORISATION_HXX
 
 
namespace Seldon
{
 
  template<class T>
  class SparseCholeskySolver
  {
  protected :
    int print_level;
    int type_ordering;
    IVect permutation;
    int type_solver;
    int n;
    Matrix<T, Symmetric, ArrayRowSymSparse> mat_sym;
    Vector<T> xtmp;
    VirtualSparseDirectSolver<T>* solver;
    
  public :
    // Available solvers.
    enum {SELDON_SOLVER, CHOLMOD, PASTIX};
 
    SparseCholeskySolver();
 
    void HideMessages();
    void ShowMessages();
    void ShowFullHistory();
 
    void Clear();
 
    int GetM() const;
    int GetN() const;
    size_t GetMemorySize() const;
 
    int GetTypeOrdering() const;
    void SetPermutation(const IVect&);
    void SelectOrdering(int);
 
    void SelectDirectSolver(int);
    int GetDirectSolver();
    
    void InitSolver();
 
    template<class Prop, class Storage, class Allocator>
    void Factorize(Matrix<T, Prop, Storage, Allocator>& A,
                   bool keep_matrix = false);
 
    template<class T1>
    void Solve(const SeldonTranspose& TransA, Vector<T1>& x, bool assemble = true);
 
    template<class T1>
    void Mlt(const SeldonTranspose& TransA, Vector<T1>& x, bool assemble = true);
    
  };
 
 
  template<class T, class Prop, class Allocator>
  void GetCholesky(Matrix<T, Prop, ArrayRowSymSparse, Allocator>& A,
                   int print_level = 0);
 
  template<class T0, class Prop, class Allocator0,
           class T1, class Storage, class Allocator1>
  void SolveCholesky(const SeldonTranspose& TransA,
                     const Matrix<T0, Prop, ArrayRowSymSparse, Allocator0>& A,
                     Vector<T1, Storage, Allocator1>& x);
 
  template<class T0, class Prop, class Alloc0,
           class T1, class Storage, class Allocator1>
  void SolveCholesky(const SeldonTranspose& TransA,
                     const Matrix<T0, Prop, RowSymSparse, Alloc0>& A,
                     Vector<T1, Storage, Allocator1>& X);
  
  template<class T0, class Prop, class Allocator0,
           class T1, class Storage, class Allocator1>
  void MltCholesky(const SeldonTranspose& TransA,
                   const Matrix<T0, Prop, ArrayRowSymSparse, Allocator0>& A,
                   Vector<T1, Storage, Allocator1>& x);
  
  template<class T0, class Prop, class Allocator0,
           class T1, class Storage, class Allocator1>
  void MltCholesky(const SeldonTranspose& TransA,
                   const Matrix<T0, Prop, RowSymSparse, Allocator0>& A,
                   Vector<T1, Storage, Allocator1>& x);
 
} // namespace Seldon.
 
 
#define SELDON_FILE_SPARSE_CHOLESKY_FACTORISATION_HXX
#endif