ZLDLTSolver.h

Go to the documentation of this file.

// ========================================================================= //
// This file is part of MyraMath, copyright (c) 2014-2019 by Ryan A Chilton  //
// and distributed by MyraCore, LLC. See LICENSE.txt for license terms.      //
// ========================================================================= //

#ifndef MYRAMATH_DENSE_ZLDLTSOLVER_H
#define MYRAMATH_DENSE_ZLDLTSOLVER_H

#include <myramath/utility/Number.h>
#include <myramath/dense/LowerMatrix.h>
#include <myramath/dense/PivotMatrix.h>

#include <utility>
#include <vector>
#include <stdint.h> // for uint64_t

namespace myra {

// Forward declarations.
class InputStream;
class OutputStream;
template<class Number> class MatrixRange;

template<class Precision> class MYRAMATH_EXPORT ZLDLTSolver
  {
  public:

    // Useful typedefs.
    typedef std::complex<Precision> Number;
    typedef MatrixRange<Number> Range;
    
    explicit ZLDLTSolver(const LowerMatrix<Number>& A);

#ifdef MYRAMATH_ENABLE_CPP11
    explicit ZLDLTSolver(LowerMatrix<Number>&& A);
#endif

    explicit ZLDLTSolver(LowerMatrix<Number>& A);

    explicit ZLDLTSolver(InputStream& in);
    
    void write(OutputStream& out) const;
    
    //    side  = Solve by A from the 'L'eft or from the 'R'ight?
    //    op    = Apply an operation to A? ('T'ranspose, 'H'ermitian, 'C'onjugate or 'N'othing)
    void solve(const Range& B, char side, char op) const;

    //    side  = Solve by L from the 'L'eft or from the 'R'ight?
    //    op    = Apply an operation to L? ('T'ranspose, 'H'ermitian, 'C'onjugate or 'N'othing)
    uint64_t solveL(const Range& B, char side, char op) const;

    void solveD(const Range& B, char side) const;

    std::pair<int,int> inertia() const;

    int size() const;
    
  private:

    // Implementation details for factorization.
    void constructor_detail();
    
    // Holds number data L.
    LowerMatrix<Number> L;

    // For applying permutation P.
    std::vector<int> P_swaps;

    // For applying permutation Q.
    std::vector<int> Q_swaps;

    // For applying pivot rotations R.
    PivotMatrix<Number> R;

    // Encodes inertia.
    int n_plus;
    int n_minus;

  };

template<class Precision> class ReflectNumber <ZLDLTSolver<Precision> >
  { public: typedef typename ZLDLTSolver<Precision>::Number type; };

} // namespace

#endif