ConcatenateAction.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_CONCATENATEACTION_H
#define MYRAMATH_ITERATIVE_CONCATENATEACTION_H

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

#include <myramath/dense/intRange.h>

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

namespace myra {
namespace detail {

// Forward declarations.
template<class Number> class ConcatenateAction;

template<class Number> class ConcatenateAction : public detail::ActionBase<Number>
  {
  public:

    // Useful typedefs.
    typedef CMatrixRange<Number> X;
    typedef MatrixRange<Number> B;

    ConcatenateAction(const intCRange& in_iblocks, const intCRange& in_jblocks);

    void insert(int i, int j, const Action<Number>& A);

    const Action<Number>& at(int i, int j) const;

  protected:

    // Size inspector, returns size(op(A))
    virtual std::pair<int,int> size() const;

    // Assigns B = alpha*A*X + beta*B. 
    virtual void multiply(const X& x, const B& b, Number alpha, Number beta) const;

    // Assigns B = A*X.
    virtual void multiply(const X& x, const B& b) const;

    // Virtual copy constructor.
    virtual ActionBase<Number>* clone() const;

  private:

    // Block/stride vectors along I and J axes.
    std::vector<int> iblocks;
    std::vector<int> jblocks;
    std::vector<int> istrides;
    std::vector<int> jstrides;

    // Internal contents, a 2D arrangement of Action's
    typedef Array2<Action<Number> > Actions;
    Actions actions;
    
  };

} // namespace detail

// Note, there's no make_ConcatenateAction() helper function, which would be
// of little use because the container API would be erasured-away by Action. 
// Instead, refer to horzcat(), vertcat() and bothcat() to make these Action's.

} // namespace myra

#endif