Action.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_ACTION_H
#define MYRAMATH_ITERATIVE_ACTION_H

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

#include <utility>

namespace myra {

// Forward declarations.
template<class Number> class Vector;
template<class Number> class CVectorRange;
template<class Number> class VectorRange;
template<class Number> class Matrix;
template<class Number> class CMatrixRange;
template<class Number> class MatrixRange;
namespace detail { template<class Number> class ActionBase; }
template<class Number> class Action;

// Contains/erases an underlying polymorphic ActionBase.
template<class Number> class MYRAMATH_EXPORT Action
  {
  public:

    // ------------------------------------ Value semantics.

    Action();

    Action(const detail::ActionBase<Number>& that);

    Action(const Action<Number>& that);

    void swap(Action<Number>& that);

    Action<Number>& operator= (Action<Number> that);

   ~Action(); 

    // ------------------------------------ Action API.

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

    void multiply(const CMatrixRange<Number>& X, const MatrixRange<Number>& B, Number alpha, Number beta) const;
    
    void multiply(const CMatrixRange<Number>& X, const MatrixRange<Number>& B) const;

    // This matrix-vector multiply delegates to the corresponding matrix-matrix multiply.
    void multiply(const CVectorRange<Number>& x, const VectorRange<Number>& b, Number alpha, Number beta) const;

    // This matrix-vector multiply delegates to the corresponding matrix-matrix multiply.
    void multiply(const CVectorRange<Number>& x, const VectorRange<Number>& b) const;

    Matrix<Number> make_Matrix() const;

  private:

    // Underlying polymorphic instance, an ActionBase.
    detail::ActionBase<Number>* base;
    
  };

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

MYRAMATH_EXPORT Matrix<NumberS> operator * (const Action<NumberS>& A, const CMatrixRange<NumberS>& X);
MYRAMATH_EXPORT Matrix<NumberD> operator * (const Action<NumberD>& A, const CMatrixRange<NumberD>& X);
MYRAMATH_EXPORT Matrix<NumberC> operator * (const Action<NumberC>& A, const CMatrixRange<NumberC>& X);
MYRAMATH_EXPORT Matrix<NumberZ> operator * (const Action<NumberZ>& A, const CMatrixRange<NumberZ>& X);

MYRAMATH_EXPORT Vector<NumberS> operator * (const Action<NumberS>& A, const CVectorRange<NumberS>& x);
MYRAMATH_EXPORT Vector<NumberD> operator * (const Action<NumberD>& A, const CVectorRange<NumberD>& x);
MYRAMATH_EXPORT Vector<NumberC> operator * (const Action<NumberC>& A, const CVectorRange<NumberC>& x);
MYRAMATH_EXPORT Vector<NumberZ> operator * (const Action<NumberZ>& A, const CVectorRange<NumberZ>& x);

} // namespace myra

#endif