Kernel.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_MULTIFRONTAL_ZCHOLESKY_KERNEL_H
#define MYRAMATH_MULTIFRONTAL_ZCHOLESKY_KERNEL_H

#include <myramath/utility/Number.h>

#include <myramath/io/Streams.h>
#include <myramath/io/ReaderWriter.h>

#include <myramath/dense/LowerMatrixRange.h>
#include <myramath/dense/potrf.h>
#include <myramath/dense/trsm.h>
#include <myramath/dense/detail/nwork.h>

#include <stdint.h>

namespace myra {

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

template<class Precision> class MYRAMATH_EXPORT ZCholeskyKernel
  {
  public:

    // Useful typedef.
    typedef std::complex<Precision> Number;

    explicit ZCholeskyKernel() 
      { }
  
    explicit ZCholeskyKernel(LowerMatrixRange<Number>& A) : L(A) 
      { }

    explicit ZCholeskyKernel(LowerMatrixRange<Number>& A, InputStream& in) : L(A) 
      { }

    void write(OutputStream& out) const 
      { }

    uint64_t factor()
      { return potrf_nwork(L); }

    //    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 MatrixRange<Number>& B, char side, char op) const
      { return trsm_nwork(side,op,L,B); }

    std::pair<int,int> inertia() const
      { return std::pair<int,int>(size(),0); }
      
    int size() const
      { return L.size(); }
  
  private:

    // Points to underlying data.
    LowerMatrixRange<Number> L;
  };

template<class Precision> class ReflectNumber< ZCholeskyKernel<Precision> >
  { public: typedef std::complex<Precision> type; };

} // namespace myra

#endif