LUSolver.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_LUSOLVER_H
#define MYRAMATH_DENSE_LUSOLVER_H

#include <myramath/MYRAMATH_EXPORT.h>
#include <myramath/utility/Number.h>

#include <myramath/dense/Matrix.h>

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

namespace myra {

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

template<class Number> class MYRAMATH_EXPORT LUSolver
  {
  public:

    // Useful typedef.
    typedef MatrixRange<Number> Range;

    explicit LUSolver(const Matrix<Number>& in_A);

#ifdef MYRAMATH_ENABLE_CPP11
    explicit LUSolver(Matrix<Number>&& in_A);     
#endif

    explicit LUSolver(Matrix<Number>& A);

    explicit LUSolver(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 = 'L', char op = 'N') const;

    // Implementation detail of solve(). Note that P is baked into L
    uint64_t solveL(const Range& B, char side, char op) const;

    // Implementation detail of solve().
    uint64_t solveU(const Range& B, char side, char op) const;

    int size() const;

  private:

    // Storage for L and U - must be square.
    Matrix<Number> A;

    // Pivoting metadata - encodes row swaps.
    std::vector<int> swaps;
  };

template<class Number> class ReflectNumber <LUSolver<Number> >
  { public: typedef Number type; };

} // namespace

#endif