dart
Public Member Functions | List of all members
dart::optimization::NullFunction Class Reference

NullFunction is a constant-zero Function. More...

#include <Function.hpp>

Inheritance diagram for dart::optimization::NullFunction:
Inheritance graph
[legend]
Collaboration diagram for dart::optimization::NullFunction:
Collaboration graph
[legend]

Public Member Functions

 NullFunction (const std::string &_name="null_function")
 Constructor.
 
 ~NullFunction () override
 Destructor.
 
double eval (const Eigen::VectorXd &) override
 eval() will always return exactly zero
 
void evalGradient (const Eigen::VectorXd &_x, Eigen::Map< Eigen::VectorXd > _grad) override
 evalGradient will always set _grad to a zero vector that matches the dimensionality of _x
 
void evalHessian (const Eigen::VectorXd &_x, Eigen::Map< Eigen::VectorXd, Eigen::RowMajor > _Hess) override
 evalHessian() will always set _Hess to a zero matrix that matches the dimensionality of _x
 
- Public Member Functions inherited from dart::optimization::Function
 Function (const std::string &_name="function")
 Constructor.
 
virtual ~Function ()
 Destructor.
 
virtual void setName (const std::string &newName)
 Sets the name of this Function.
 
const std::string & getName () const
 Returns the name of this Function.
 
void evalGradient (const Eigen::VectorXd &_x, Eigen::VectorXd &_grad)
 Evaluates and return the objective function at the point x. More...
 

Additional Inherited Members

- Protected Attributes inherited from dart::optimization::Function
std::string mName
 Name of this function.
 

Detailed Description

NullFunction is a constant-zero Function.


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