UnaryFunctionExpression.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_EXPRESSION_UNARYFUNCTIONEXPRESSION_H
#define MYRAMATH_EXPRESSION_UNARYFUNCTIONEXPRESSION_H

#include <myramath/expression/ExpressionBase.h>
#include <myramath/expression/Index2string.h>

#include <myramath/utility/eprintf.h>

namespace myra {
namespace detail {

// Implementation detail for composing Expression's using unary functions, think f(A)
template<class Function,int Arity> class UnaryFunctionExpression : public ExpressionBase<Arity,typename Function::Output>
  {
  public:

    // Reflect types from underlying Function.
    typedef typename Function::Input Input;
    typedef typename Function::Output Output;

    // Constructor, requires Function f and input Expression A.
    UnaryFunctionExpression(const Function& in_f, const Expression<Arity,Input>& in_A)
      : f(in_f), A(in_A) { }

  protected:

    // Size inspector.
    virtual Index<Arity> size() const
      { return A.size(); }
  
    // Given an Index i, returns f(A(i))
    virtual Output evaluate(Index<Arity> i) const
      { return f.evaluate( A.evaluate(i) ); }

    // Virtual copy constructor.
    virtual ExpressionBase<Arity,Output>* clone() const
      { return new UnaryFunctionExpression<Function,Arity>(f,A); }

  private:

    // Underlying Function instance.
    Function f;
    
    // Underlying input Expression.
    Expression<Arity,Input> A;

  };

// Helper factory function, returns f(A).
template<class Function, int Arity>
UnaryFunctionExpression<Function,Arity>
make_UnaryFunctionExpression(const Function& f, const Expression<Arity,typename Function::Input>& A)
  { return UnaryFunctionExpression<Function,Arity>(f,A); }

} // namespace detail

} // namespace myra

#endif