Drake
Cost Class Reference

Stopgap definition that permits Cost to use functionality in Constraint. More...

#include <drake/solvers/cost.h>

Inheritance diagram for Cost:
Collaboration diagram for Cost:

Public Member Functions

 Cost (size_t num_vars)
 
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
template<typename DerivedLB , typename DerivedUB >
 EvaluatorBase (size_t num_constraints, int num_vars, const Eigen::MatrixBase< DerivedLB > &lb, const Eigen::MatrixBase< DerivedUB > &ub)
 
template<typename DerivedLB , typename DerivedUB >
 EvaluatorBase (size_t num_constraints, int num_vars, const Eigen::MatrixBase< DerivedLB > &lb, const Eigen::MatrixBase< DerivedUB > &ub, const std::string &description)
 
virtual ~EvaluatorBase ()
 
void Eval (const Eigen::Ref< const Eigen::VectorXd > &x, Eigen::VectorXd &y) const
 
void Eval (const Eigen::Ref< const AutoDiffVecXd > &x, AutoDiffVecXd &y) const
 
bool CheckSatisfied (const Eigen::Ref< const Eigen::VectorXd > &x, const double tol=1E-6) const
 Return whether this constraint is satisfied by the given value, x. More...
 
bool CheckSatisfied (const Eigen::Ref< const AutoDiffVecXd > &x, const double tol=1E-6) const
 
Eigen::VectorXd const & lower_bound () const
 
Eigen::VectorXd const & upper_bound () const
 
size_t num_constraints () const
 
template<typename Derived >
void UpdateLowerBound (const Eigen::MatrixBase< Derived > &new_lb)
 
template<typename Derived >
void UpdateUpperBound (const Eigen::MatrixBase< Derived > &new_ub)
 
void set_description (const std::string &description)
 
const std::string & get_description () const
 
template<typename DerivedL , typename DerivedU >
void set_bounds (const Eigen::MatrixBase< DerivedL > &lower_bound, const Eigen::MatrixBase< DerivedU > &upper_bound)
 Set the upper and lower bounds of the constraint. More...
 
int num_vars () const
 Getter for the number of variables in the constraint, namely the number of rows in x, as used in Eval(x, y). More...
 
 EvaluatorBase (const EvaluatorBase &)=delete
 
EvaluatorBaseoperator= (const EvaluatorBase &)=delete
 
 EvaluatorBase (EvaluatorBase &&)=delete
 
EvaluatorBaseoperator= (EvaluatorBase &&)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from EvaluatorBase
virtual void DoEval (const Eigen::Ref< const Eigen::VectorXd > &x, Eigen::VectorXd &y) const =0
 
virtual void DoEval (const Eigen::Ref< const AutoDiffVecXd > &x, AutoDiffVecXd &y) const =0
 
virtual bool DoCheckSatisfied (const Eigen::Ref< const Eigen::VectorXd > &x, const double tol) const
 
virtual bool DoCheckSatisfied (const Eigen::Ref< const AutoDiffVecXd > &x, const double tol) const
 
 EvaluatorBase (size_t num_constraints, int num_vars)
 Constructs a constraint which has num_constraints rows, with input variables to Eval a num_vars x 1 vector. More...
 

Detailed Description

Stopgap definition that permits Cost to use functionality in Constraint.

Using an internal implementation permits child costs to inherit directly from cost, thus be convertible to a cost.

Constructor & Destructor Documentation

Cost ( const Cost )
delete
Cost ( Cost &&  )
delete
Cost ( size_t  num_vars)
inlineexplicit

Member Function Documentation

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

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