UserAction.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_USERACTION_H
#define MYRAMATH_ITERATIVE_USERACTION_H

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

namespace myra {
namespace detail {

// Implementation detail.
template<class UserClass> class UserAction : public ActionBase<typename UserClass::Number>
  {
  public:

    // Reflect the Number type, it must be present as a typedef on the user's class.
    typedef typename UserClass::Number Number;
    typedef CMatrixRange<Number> X;
    typedef MatrixRange<Number> B;      

    // Constructor, requires a copy constructible UserClass.
    UserAction(const UserClass& in_u)
      : u(in_u) { }

  protected:
  
    // Size inspector.
    virtual std::pair<int,int> size() const
      { return u.size(); }

    // Assigns b = U*x.
    virtual void multiply(const X& x, const B& b) const
      { u.multiply(x,b); }

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

    // Virtual copy constructor.
    virtual ActionBase<Number>* clone() const
      { return new UserAction<UserClass>(u); }
    
  private:
  
    // Deep copy of user's class.
    UserClass u;
    
  };

} // namespace detail

template<class UserClass> Action<typename UserClass::Number>  make_UserAction(const UserClass& u)
  { return detail::UserAction<UserClass>(u); }

} // namespace myra

#endif