Home | History | Annotate | Download | only in SparseLU
      1 // This file is part of Eigen, a lightweight C++ template library
      2 // for linear algebra.
      3 //
      4 // Copyright (C) 2012 Dsir Nuentsa-Wakam <desire.nuentsa_wakam (at) inria.fr>
      5 //
      6 // This Source Code Form is subject to the terms of the Mozilla
      7 // Public License v. 2.0. If a copy of the MPL was not distributed
      8 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
      9 #ifndef SPARSELU_IMPL_H
     10 #define SPARSELU_IMPL_H
     11 
     12 namespace Eigen {
     13 namespace internal {
     14 
     15 /** \ingroup SparseLU_Module
     16   * \class SparseLUImpl
     17   * Base class for sparseLU
     18   */
     19 template <typename Scalar, typename Index>
     20 class SparseLUImpl
     21 {
     22   public:
     23     typedef Matrix<Scalar,Dynamic,1> ScalarVector;
     24     typedef Matrix<Index,Dynamic,1> IndexVector;
     25     typedef typename ScalarVector::RealScalar RealScalar;
     26     typedef Ref<Matrix<Scalar,Dynamic,1> > BlockScalarVector;
     27     typedef Ref<Matrix<Index,Dynamic,1> > BlockIndexVector;
     28     typedef LU_GlobalLU_t<IndexVector, ScalarVector> GlobalLU_t;
     29     typedef SparseMatrix<Scalar,ColMajor,Index> MatrixType;
     30 
     31   protected:
     32      template <typename VectorType>
     33      Index expand(VectorType& vec, Index& length, Index nbElts, Index keep_prev, Index& num_expansions);
     34      Index memInit(Index m, Index n, Index annz, Index lwork, Index fillratio, Index panel_size,  GlobalLU_t& glu);
     35      template <typename VectorType>
     36      Index memXpand(VectorType& vec, Index& maxlen, Index nbElts, MemType memtype, Index& num_expansions);
     37      void heap_relax_snode (const Index n, IndexVector& et, const Index relax_columns, IndexVector& descendants, IndexVector& relax_end);
     38      void relax_snode (const Index n, IndexVector& et, const Index relax_columns, IndexVector& descendants, IndexVector& relax_end);
     39      Index snode_dfs(const Index jcol, const Index kcol,const MatrixType& mat,  IndexVector& xprune, IndexVector& marker, GlobalLU_t& glu);
     40      Index snode_bmod (const Index jcol, const Index fsupc, ScalarVector& dense, GlobalLU_t& glu);
     41      Index pivotL(const Index jcol, const RealScalar& diagpivotthresh, IndexVector& perm_r, IndexVector& iperm_c, Index& pivrow, GlobalLU_t& glu);
     42      template <typename Traits>
     43      void dfs_kernel(const Index jj, IndexVector& perm_r,
     44                     Index& nseg, IndexVector& panel_lsub, IndexVector& segrep,
     45                     Ref<IndexVector> repfnz_col, IndexVector& xprune, Ref<IndexVector> marker, IndexVector& parent,
     46                     IndexVector& xplore, GlobalLU_t& glu, Index& nextl_col, Index krow, Traits& traits);
     47      void panel_dfs(const Index m, const Index w, const Index jcol, MatrixType& A, IndexVector& perm_r, Index& nseg, ScalarVector& dense, IndexVector& panel_lsub, IndexVector& segrep, IndexVector& repfnz, IndexVector& xprune, IndexVector& marker, IndexVector& parent, IndexVector& xplore, GlobalLU_t& glu);
     48 
     49      void panel_bmod(const Index m, const Index w, const Index jcol, const Index nseg, ScalarVector& dense, ScalarVector& tempv, IndexVector& segrep, IndexVector& repfnz, GlobalLU_t& glu);
     50      Index column_dfs(const Index m, const Index jcol, IndexVector& perm_r, Index maxsuper, Index& nseg,  BlockIndexVector lsub_col, IndexVector& segrep, BlockIndexVector repfnz, IndexVector& xprune, IndexVector& marker, IndexVector& parent, IndexVector& xplore, GlobalLU_t& glu);
     51      Index column_bmod(const Index jcol, const Index nseg, BlockScalarVector dense, ScalarVector& tempv, BlockIndexVector segrep, BlockIndexVector repfnz, Index fpanelc, GlobalLU_t& glu);
     52      Index copy_to_ucol(const Index jcol, const Index nseg, IndexVector& segrep, BlockIndexVector repfnz ,IndexVector& perm_r, BlockScalarVector dense, GlobalLU_t& glu);
     53      void pruneL(const Index jcol, const IndexVector& perm_r, const Index pivrow, const Index nseg, const IndexVector& segrep, BlockIndexVector repfnz, IndexVector& xprune, GlobalLU_t& glu);
     54      void countnz(const Index n, Index& nnzL, Index& nnzU, GlobalLU_t& glu);
     55      void fixupL(const Index n, const IndexVector& perm_r, GlobalLU_t& glu);
     56 
     57      template<typename , typename >
     58      friend struct column_dfs_traits;
     59 };
     60 
     61 } // end namespace internal
     62 } // namespace Eigen
     63 
     64 #endif
     65