RCholeskySolver.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_RCHOLESKYSOLVER_H
#define MYRAMATH_DENSE_RCHOLESKYSOLVER_H

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

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

namespace myra {

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

template<class Precision> class MYRAMATH_EXPORT RCholeskySolver
  {
  public:
  
    // Useful typedefs.
    typedef MatrixRange<Precision> Range;

    explicit RCholeskySolver(const LowerMatrix<Precision>& A);

#ifdef MYRAMATH_ENABLE_CPP11
    explicit RCholeskySolver(LowerMatrix<Precision>&& A);
#endif

    explicit RCholeskySolver(LowerMatrix<Precision>& A);

    explicit RCholeskySolver(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;

    //    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;

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

    int size() const;
  
  private:

    // Internal contents.
    LowerMatrix<Precision> L;
  };

template<class Precision> class ReflectNumber< RCholeskySolver<Precision> >
  { public: typedef Precision type; };

} // namespace

#endif