RefineAction.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_ITERATIVE_REFINEACTION_H
#define MYRAMATH_ITERATIVE_REFINEACTION_H

#include <myramath/utility/Number.h>

#include <myramath/dense/MatrixRange.h>

#include <myramath/iterative/Action.h>
#include <myramath/iterative/ActionBase.h>

namespace myra {
namespace detail {

// Adapts anything with a method of the form .refine(X,side,op) into an Action.
template<class Solver> class RefineAction : public ActionBase<typename ReflectNumber<Solver>::type>
  {
  public:

    // Useful typedefs.
    typedef typename ReflectNumber<Solver>::type Number;
    typedef CMatrixRange<Number> X;
    typedef MatrixRange<Number> B;
  
    // Constructor, requires reference to a Solver instance.
    RefineAction(const Solver& in_solver, char in_op) 
      : solver(&in_solver), op(in_op) { }

  protected:

    // Size inspector.
    virtual std::pair<int,int> size() const
      { int N = solver->size(); return std::pair<int,int>(N,N); }

    // Assign B = refine(X)
    virtual void multiply(const X& x, const B& b) const
      { b.assign(x); solver->refine(b,'L',op); }

    // Note, the other multiply(x,b,alpha,beta) just uses ActionBase's implementation.

    // Virtual copy constructor.
    virtual ActionBase<Number>* clone() const
      { return new RefineAction<Solver>(*solver,op); }

  private:
  
    // Underlying solver.
    const Solver* solver;

    // op modifier, if any.
    char op;

  };

} // namespace detail

template<class Solver> Action<typename ReflectNumber<Solver>::type> make_RefineAction(const Solver& solver, char op = 'N')
  { return detail::RefineAction<Solver>(solver,op); }

} // namespace myra

#endif