Public Member Functions | List of all members
Atan Class Reference
Basic Data Structures -- used mainly internally or by the user to call interface functions

Implements the scalar inverse tangens operator (arctan) within the symbolic operators family. More...

#include <atan.hpp>

Inheritance diagram for Atan:
Inheritance graph
[legend]

Public Member Functions

 Atan ()
 
 Atan (Operator *_argument)
 
 Atan (const Atan &arg)
 
virtual Operator * clone () const
 
virtual returnValue evaluate (EvaluationBase *x)
 
virtual returnValue initDerivative ()
 
Atan & operator= (const Atan &arg)
 
virtual Operator * substitute (int index, const Operator *sub)
 
 ~Atan ()
 
- Public Member Functions inherited from UnaryOperator
virtual returnValue AD_backward (int dim, VariableType *varType, int *component, Operator *seed, Operator **df, int &nNewIS, TreeProjection ***newIS)
 
virtual returnValue AD_backward (int number, double seed, double *df)
 
virtual returnValue AD_backward2 (int number, double seed1, double seed2, double *df, double *ddf)
 
virtual Operator * AD_forward (int dim, VariableType *varType, int *component, Operator **seed, int &nNewIS, TreeProjection ***newIS)
 
virtual returnValue AD_forward (int number, double *seed, double *df)
 
virtual returnValue AD_forward (int number, double *x, double *seed, double *f, double *df)
 
virtual returnValue AD_forward2 (int number, double *seed1, double *seed2, double *df, double *ddf)
 
virtual returnValue AD_symmetric (int dim, VariableType *varType, int *component, Operator *l, Operator **S, int dimS, Operator **dfS, Operator **ldf, Operator **H, int &nNewLIS, TreeProjection ***newLIS, int &nNewSIS, TreeProjection ***newSIS, int &nNewHIS, TreeProjection ***newHIS)
 
virtual returnValue clearBuffer ()
 
Operator * differentiate (int index)
 
virtual returnValue enumerateVariables (SymbolicIndexList *indexList)
 
virtual returnValue evaluate (int number, double *x, double *result)
 
virtual CurvatureType getCurvature ()
 
virtual MonotonicityType getMonotonicity ()
 
virtual OperatorName getName ()
 
virtual BooleanType isDependingOn (VariableType var) const
 
virtual BooleanType isDependingOn (int dim, VariableType *varType, int *component, BooleanType *implicit_dep)
 
virtual BooleanType isLinearIn (int dim, VariableType *varType, int *component, BooleanType *implicit_dep)
 
virtual NeutralElement isOneOrZero () const
 
virtual BooleanType isPolynomialIn (int dim, VariableType *varType, int *component, BooleanType *implicit_dep)
 
virtual BooleanType isRationalIn (int dim, VariableType *varType, int *component, BooleanType *implicit_dep)
 
virtual BooleanType isSymbolic () const
 
virtual BooleanType isVariable (VariableType &varType, int &component) const
 
virtual returnValue loadIndices (SymbolicIndexList *indexList)
 
UnaryOperator & operator= (const UnaryOperator &arg)
 
virtual std::ostream & print (std::ostream &stream) const
 
virtual returnValue setCurvature (CurvatureType curvature_)
 
virtual returnValue setMonotonicity (MonotonicityType monotonicity_)
 
 UnaryOperator ()
 
 UnaryOperator (Operator *_argument)
 
 UnaryOperator (const UnaryOperator &arg)
 
virtual ~UnaryOperator ()
 
- Public Member Functions inherited from SmoothOperator
virtual TreeProjection * cloneTreeProjection () const
 
virtual int getGlobalIndex () const
 
virtual double getValue () const
 
virtual BooleanType isSmooth () const
 
Expression operator* (const double &arg) const
 
Expression operator* (const DVector &arg) const
 
Expression operator* (const DMatrix &arg) const
 
Expression operator* (const Operator &arg) const
 
Expression operator* (const Expression &arg) const
 
Operator & operator*= (const double &arg)
 
Operator & operator*= (const DVector &arg)
 
Operator & operator*= (const DMatrix &arg)
 
Operator & operator*= (const Expression &arg)
 
Expression operator+ (const double &arg) const
 
Expression operator+ (const DVector &arg) const
 
Expression operator+ (const DMatrix &arg) const
 
Expression operator+ (const Operator &arg) const
 
Expression operator+ (const Expression &arg) const
 
Operator & operator+= (const double &arg)
 
Operator & operator+= (const DVector &arg)
 
Operator & operator+= (const DMatrix &arg)
 
Operator & operator+= (const Expression &arg)
 
Expression operator- (const double &arg) const
 
Expression operator- (const DVector &arg) const
 
Expression operator- (const DMatrix &arg) const
 
Expression operator- (const Operator &arg) const
 
Expression operator- (const Expression &arg) const
 
Expression operator- () const
 
Operator & operator-= (const double &arg)
 
Operator & operator-= (const DVector &arg)
 
Operator & operator-= (const DMatrix &arg)
 
Operator & operator-= (const Expression &arg)
 
Expression operator/ (const double &arg) const
 
Expression operator/ (const Operator &arg) const
 
Expression operator/ (const Expression &arg) const
 
Operator & operator/= (const double &arg)
 
Operator & operator/= (const Expression &arg)
 
ConstraintComponent operator<= (const double &ub) const
 
ConstraintComponent operator<= (const DVector &ub) const
 
ConstraintComponent operator<= (const VariablesGrid &ub) const
 
virtual Operator & operator= (const double &arg)
 
virtual Operator & operator= (const DVector &arg)
 
virtual Operator & operator= (const DMatrix &arg)
 
virtual Operator & operator= (const Expression &arg)
 
virtual Operator & operator= (const Operator &arg)
 
ConstraintComponent operator== (const double &b) const
 
ConstraintComponent operator== (const DVector &b) const
 
ConstraintComponent operator== (const VariablesGrid &b) const
 
ConstraintComponent operator>= (const double &lb) const
 
ConstraintComponent operator>= (const DVector &lb) const
 
ConstraintComponent operator>= (const VariablesGrid &lb) const
 
virtual Operator * passArgument () const
 
 SmoothOperator ()
 
virtual ~SmoothOperator ()
 
- Public Member Functions inherited from Operator
virtual BooleanType isTrivial () const
 
virtual Operator * myAdd (Operator *a, Operator *b)
 
virtual Operator * myLogarithm (Operator *a)
 
virtual Operator * myPower (Operator *a, Operator *b)
 
virtual Operator * myPowerInt (Operator *a, int b)
 
virtual Operator * myProd (Operator *a, Operator *b)
 
virtual Operator * mySubtract (Operator *a, Operator *b)
 
 Operator ()
 
Expression operator* (const double &arg) const
 
Expression operator* (const DVector &arg) const
 
Expression operator* (const DMatrix &arg) const
 
Expression operator* (const Operator &arg) const
 
Expression operator* (const Expression &arg) const
 
Operator & operator*= (const double &arg)
 
Operator & operator*= (const DVector &arg)
 
Operator & operator*= (const DMatrix &arg)
 
Operator & operator*= (const Expression &arg)
 
Expression operator+ (const double &arg) const
 
Expression operator+ (const DVector &arg) const
 
Expression operator+ (const DMatrix &arg) const
 
Expression operator+ (const Operator &arg) const
 
Expression operator+ (const Expression &arg) const
 
Operator & operator+= (const double &arg)
 
Operator & operator+= (const DVector &arg)
 
Operator & operator+= (const DMatrix &arg)
 
Operator & operator+= (const Expression &arg)
 
Expression operator- (const double &arg) const
 
Expression operator- (const DVector &arg) const
 
Expression operator- (const DMatrix &arg) const
 
Expression operator- (const Operator &arg) const
 
Expression operator- (const Expression &arg) const
 
Expression operator- () const
 
Operator & operator-= (const double &arg)
 
Operator & operator-= (const DVector &arg)
 
Operator & operator-= (const DMatrix &arg)
 
Operator & operator-= (const Expression &arg)
 
Expression operator/ (const double &arg) const
 
Expression operator/ (const Operator &arg) const
 
Expression operator/ (const Expression &arg) const
 
Operator & operator/= (const double &arg)
 
Operator & operator/= (const Expression &arg)
 
ConstraintComponent operator<= (const double &ub) const
 
ConstraintComponent operator<= (const DVector &ub) const
 
ConstraintComponent operator<= (const VariablesGrid &ub) const
 
ConstraintComponent operator== (const double &b) const
 
ConstraintComponent operator== (const DVector &b) const
 
ConstraintComponent operator== (const VariablesGrid &b) const
 
ConstraintComponent operator>= (const double &lb) const
 
ConstraintComponent operator>= (const DVector &lb) const
 
ConstraintComponent operator>= (const VariablesGrid &lb) const
 
virtual ~Operator ()
 

Additional Inherited Members

- Public Attributes inherited from SmoothOperator
int nCount
 
- Public Attributes inherited from Operator
int nCount
 
- Protected Member Functions inherited from UnaryOperator
returnValue ADbackwardProtected (int dim, VariableType *varType, int *component, Operator *seed, Operator **df, int &nNewIS, TreeProjection ***newIS)
 
Operator * ADforwardProtected (int dim, VariableType *varType, int *component, Operator **seed, int &nNewIS, TreeProjection ***newIS)
 
returnValue ADsymmetricProtected (int dim, VariableType *varType, int *component, Operator *l, Operator **S, int dimS, Operator **dfS, Operator **ldf, Operator **H, int &nNewLIS, TreeProjection ***newLIS, int &nNewSIS, TreeProjection ***newSIS, int &nNewHIS, TreeProjection ***newHIS)
 
virtual returnValue setVariableExportName (const VariableType &_type, const std::vector< std::string > &_name)
 
- Protected Member Functions inherited from Operator
returnValue ADsymCommon (Operator *a, TreeProjection &da, TreeProjection &dda, int dim, VariableType *varType, int *component, Operator *l, Operator **S, int dimS, Operator **dfS, Operator **ldf, Operator **H, int &nNewLIS, TreeProjection ***newLIS, int &nNewSIS, TreeProjection ***newSIS, int &nNewHIS, TreeProjection ***newHIS)
 
returnValue ADsymCommon2 (Operator *a, Operator *b, TreeProjection &dx, TreeProjection &dy, TreeProjection &dxx, TreeProjection &dxy, TreeProjection &dyy, int dim, VariableType *varType, int *component, Operator *l, Operator **S, int dimS, Operator **dfS, Operator **ldf, Operator **H, int &nNewLIS, TreeProjection ***newLIS, int &nNewSIS, TreeProjection ***newSIS, int &nNewHIS, TreeProjection ***newHIS)
 
virtual TreeProjection * convert2TreeProjection (Operator *a) const
 
- Protected Attributes inherited from UnaryOperator
Operator * argument
 
double * argument_result
 
int bufferSize
 
std::string cName
 
CurvatureType curvature
 
Operator * dargument
 
double * dargument_result
 
double(* ddfcn )(double)
 
Operator * derivative
 
Operator * derivative2
 
double(* dfcn )(double)
 
double(* fcn )(double)
 
MonotonicityType monotonicity
 
OperatorName operatorName
 
- Protected Attributes inherited from Operator
BooleanType initialized
 

Detailed Description

Implements the scalar inverse tangens operator (arctan) within the symbolic operators family.

The class Atan implements the scalar inverse tanges operator (arctan) within the symbolic operators family.

Author
Boris Houska, Hans Joachim Ferreau

Definition at line 55 of file atan.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO Atan::Atan ( )

Default constructor.

Definition at line 52 of file atan.cpp.

Atan::Atan ( Operator *  _argument)

Default constructor.

Definition at line 63 of file atan.cpp.

Atan::Atan ( const Atan &  arg)

Copy constructor (deep copy).

Definition at line 74 of file atan.cpp.

Atan::~Atan ( )

Default destructor.

Definition at line 85 of file atan.cpp.

Member Function Documentation

Operator * Atan::clone ( ) const
virtual

Provides a deep copy of the expression.

Returns
a clone of the expression.

Implements UnaryOperator.

Definition at line 111 of file atan.cpp.

returnValue Atan::evaluate ( EvaluationBase *  x)
virtual

Evaluates the expression (templated version)

Implements UnaryOperator.

Definition at line 98 of file atan.cpp.

returnValue Atan::initDerivative ( )
virtual

Reimplemented from Operator.

Definition at line 116 of file atan.cpp.

Atan & Atan::operator= ( const Atan &  arg)

Assignment Operator (deep copy).

Definition at line 90 of file atan.cpp.

Operator * Atan::substitute ( int  index,
const Operator *  sub 
)
virtual

Substitutes var(index) with the expression sub.

Returns
The substituted expression.
Parameters
indexsubst. index
subthe substitution

Implements UnaryOperator.

Definition at line 105 of file atan.cpp.

The documentation for this class was generated from the following files:

acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:22