Logarithm Class Reference

Implements the scalar logarithm operator within the symbolic operators family. More...

#include <logarithm.hpp>

Inheritance diagram for Logarithm:

List of all members.

Public Member Functions
virtual Operator *	clone () const
virtual returnValue	evaluate (EvaluationBase *x)
virtual CurvatureType	getCurvature ()
virtual returnValue	initDerivative ()
	Logarithm ()
	Logarithm (Operator *_argument)
	Logarithm (const Logarithm &arg)
Logarithm &	operator= (const Logarithm &arg)
virtual Operator *	substitute (int index, const Operator *sub)
	~Logarithm ()

---

Detailed Description

Implements the scalar logarithm operator within the symbolic operators family.

The class Log implements the scalar logarithm operator within the symbolic operators family.

Author:

Boris Houska, Hans Joachim Ferreau

Definition at line 55 of file logarithm.hpp.

---

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO Logarithm::Logarithm

(

)

Default constructor.

Definition at line 51 of file logarithm.cpp.

Logarithm::Logarithm

(

Operator *

_argument

)

Default constructor.

Definition at line 62 of file logarithm.cpp.

Logarithm::Logarithm

(

const Logarithm &

arg

)

Copy constructor (deep copy).

Definition at line 73 of file logarithm.cpp.

Logarithm::~Logarithm

(

)

Default destructor.

Definition at line 84 of file logarithm.cpp.

---

Member Function Documentation

Operator * Logarithm::clone

(

)

const [virtual]

Provides a deep copy of the expression.

Returns:

a clone of the expression.

Implements UnaryOperator.

Definition at line 111 of file logarithm.cpp.

returnValue Logarithm::evaluate

(

EvaluationBase *

x

)

[virtual]

Evaluates the expression (templated version)

Implements UnaryOperator.

Definition at line 97 of file logarithm.cpp.

CurvatureType Logarithm::getCurvature

(

)

[virtual]

Returns the curvature of the expression

Returns:

CT_CONSTANT
CT_AFFINE
CT_CONVEX
CT_CONCAVE

Reimplemented from UnaryOperator.

Definition at line 117 of file logarithm.cpp.

returnValue Logarithm::initDerivative

(

)

[virtual]

Reimplemented from Operator.

Definition at line 130 of file logarithm.cpp.

Logarithm & Logarithm::operator=

(

const Logarithm &

arg

)

Assignment Operator (deep copy).

Definition at line 89 of file logarithm.cpp.

Operator * Logarithm::substitute	(	int	index,
		const Operator *	sub
	)		[virtual]

Substitutes var(index) with the expression sub.

Returns:

The substituted expression.

Parameters:

index	subst. index
sub	the substitution

Implements UnaryOperator.

Definition at line 105 of file logarithm.cpp.

---

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

• logarithm.hpp
• logarithm.cpp