// @HEADER // ***************************************************************************** // Sacado Package // // Copyright 2006 NTESS and the Sacado contributors. // SPDX-License-Identifier: LGPL-2.1-or-later // ***************************************************************************** // @HEADER #ifndef SACADO_ELRFAD_GENERALFADEXPR_HPP #define SACADO_ELRFAD_GENERALFADEXPR_HPP #include "Sacado_ELRFad_GeneralFad.hpp" namespace Sacado { namespace ELRFad { //! GeneralFad expression template specialization /*! * This template class represents a simple GeneralFad expression and * mixes-in the GeneralFad interface and the expression template * interface. */ template class Expr< GeneralFad > : public GeneralFad { public: //! Typename of values typedef typename GeneralFad::value_type value_type; //! Typename of scalar's (which may be different from value_type) typedef typename GeneralFad::scalar_type scalar_type; //! Typename of base-expressions typedef typename BaseExpr< GeneralFad >::type base_expr_type; //! Number of arguments static const int num_args = 1; //! Is expression linear static const bool is_linear = true; //! Default constructor SACADO_INLINE_FUNCTION Expr() : GeneralFad() {} //! Constructor with supplied value \c x /*! * Initializes value to \c x and derivative array is empty */ template SACADO_INLINE_FUNCTION Expr(const S & x, SACADO_ENABLE_VALUE_CTOR_DECL) : GeneralFad(x) {} //! Constructor with size \c sz and value \c x /*! * Initializes value to \c x and derivative array 0 of length \c sz */ SACADO_INLINE_FUNCTION Expr(const int sz, const T & x, const DerivInit zero_out = InitDerivArray) : GeneralFad(sz,x,zero_out) {} //! Constructor with size \c sz, index \c i, and value \c x /*! * Initializes value to \c x and derivative array of length \c sz * as row \c i of the identity matrix, i.e., sets derivative component * \c i to 1 and all other's to zero. */ SACADO_INLINE_FUNCTION Expr(const int sz, const int i, const T & x) : GeneralFad(sz,i,x) {} //! Constructor with supplied storage \c s SACADO_INLINE_FUNCTION Expr(const Storage& s) : GeneralFad(s) {} //! Copy constructor SACADO_INLINE_FUNCTION Expr(const Expr& x) : GeneralFad(static_cast&>(x)) {} //! Copy constructor from any Expression object template SACADO_INLINE_FUNCTION Expr(const Expr& x, SACADO_ENABLE_EXPR_CTOR_DECL) : GeneralFad(x) {} //! Destructor SACADO_INLINE_FUNCTION ~Expr() {} //! Return partials w.r.t. arguments SACADO_INLINE_FUNCTION void computePartials(const T& bar, value_type partials[]) const { partials[0] = bar; } //! Return tangent component \c i of arguments SACADO_INLINE_FUNCTION void getTangents(int i, value_type dots[]) const { if (isize()) dots[0] = this->fastAccessDx(i); else dots[0] = 0.0; } //! Return whether argument is active template SACADO_INLINE_FUNCTION bool isActive() const { return this->size() > 0; } //! Return whether argument is active SACADO_INLINE_FUNCTION bool isActive2(int j) const { return this->size() > 0; } //! Return whether expression is linear SACADO_INLINE_FUNCTION bool isLinear() const { return true; } //! Return tangent component \c i of argument \c Arg template SACADO_INLINE_FUNCTION const T& getTangent(int i) const { return this->fastAccessDx(i); } //! Get dx array SACADO_INLINE_FUNCTION const value_type* getDx(int j) const { return this->dx(); } SACADO_INLINE_FUNCTION int numActiveArgs() const { return this->size() > 0 ? 1 : 0; } //! Return partials w.r.t. arguments SACADO_INLINE_FUNCTION void computeActivePartials(const T& bar, value_type *partials) const { if (this->size() > 0) partials[0] = bar; } }; // class Expr } // namespace ELRFad } // namespace Sacado #include "Sacado_ELRFad_Ops.hpp" #endif // SACADO_ELRFAD_GENERALFADEXPR_HPP