Drake
Cost Class Reference

Provides an abstract base for all costs. More...

#include <drake/solvers/cost.h>

Inheritance diagram for Cost:
[legend]
Collaboration diagram for Cost:
[legend]

Public Member Functions

Does not allow copy, move, or assignment
 Cost (const Cost &)=delete
 
Costoperator= (const Cost &)=delete
 
 Cost (Cost &&)=delete
 
Costoperator= (Cost &&)=delete
 
- Public Member Functions inherited from EvaluatorBase
virtual ~EvaluatorBase ()
 
void Eval (const Eigen::Ref< const Eigen::VectorXd > &x, Eigen::VectorXd &y) const
 Evaluates the expression with a scalar type of double. More...
 
void Eval (const Eigen::Ref< const AutoDiffVecXd > &x, AutoDiffVecXd &y) const
 Evaluates the expression with a scalar type of AutoDiffXd. More...
 
void set_description (const std::string &description)
 Set a human-friendly description for the evaluator. More...
 
const std::string & get_description () const
 Getter for a human-friendly description for the evaluator. More...
 
int num_vars () const
 Getter for the number of variables, namely the number of rows in x, as used in Eval(x, y). More...
 
int num_outputs () const
 Getter for the number of outputs, namely the number of rows in y, as used in Eval(x, y). More...
 
 EvaluatorBase (const EvaluatorBase &)=delete
 
EvaluatorBaseoperator= (const EvaluatorBase &)=delete
 
 EvaluatorBase (EvaluatorBase &&)=delete
 
EvaluatorBaseoperator= (EvaluatorBase &&)=delete
 

Protected Member Functions

 Cost (int num_vars, const std::string &description="")
 Constructs a cost evaluator. More...
 
- Protected Member Functions inherited from EvaluatorBase
 EvaluatorBase (int num_outputs, int num_vars, const std::string &description="")
 Constructs a evaluator. More...
 
virtual void DoEval (const Eigen::Ref< const Eigen::VectorXd > &x, Eigen::VectorXd &y) const =0
 Implements expression evaluation for scalar type double. More...
 
virtual void DoEval (const Eigen::Ref< const AutoDiffVecXd > &x, AutoDiffVecXd &y) const =0
 Implements expression evaluation for scalar type AutoDiffXd. More...
 

Detailed Description

Provides an abstract base for all costs.

Constructor & Destructor Documentation

Cost ( const Cost )
delete
Cost ( Cost &&  )
delete
Cost ( int  num_vars,
const std::string &  description = "" 
)
inlineexplicitprotected

Constructs a cost evaluator.

Parameters
num_varsNumber of input variables.
descriptionHuman-friendly description.

Member Function Documentation

Cost& operator= ( const Cost )
delete
Cost& operator= ( Cost &&  )
delete

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