Loading...
Searching...
No Matches
roboptim::Problem< F, CLIST > Class Template Reference

#include <roboptim/core/problem.hh>

Public Types

typedef detail::list_converter< CLIST >::type constraintsList_t
 Constraints types list.
 
typedef F function_t
 Function type.
 
typedef detail::shared_ptr_variant< constraintsList_t >::type constraint_t
 Constraint's type.
 
typedef function_t::value_type value_type
 Import function's value_type type.
 
typedef function_t::vector_t vector_t
 Vector type.
 
typedef function_t::argument_t argument_t
 Argument type.
 
typedef function_t::size_type size_type
 Size type.
 
typedef std::vector< constraint_t > constraints_t
 Constraints are represented as a vector of constraints.
 
typedef boost::optional< argument_t > startingPoint_t
 Optional vector defines a starting point.
 
typedef function_t::interval_t interval_t
 Interval type (e.g. for bounds).
 
typedef function_t::intervals_t intervals_t
 Intervals type.
 
typedef std::vector< value_type > scaling_t
 Scaling vector.
 
typedef scaling_t scales_t ROBOPTIM_CORE_DEPRECATED
 Scaling vector (deprecated typedef)
 
typedef function_t::names_t names_t
 Vector of names (e.g. for arguments).
 
typedef std::vector< intervals_t > intervalsVect_t
 Vector of interval vectors.
 
typedef std::vector< scaling_t > scalingVect_t
 Vector of scaling vectors.
 
typedef scalingVect_t scalesVect_t ROBOPTIM_CORE_DEPRECATED
 Vector of scaling vectors (deprecated typedef).
 

Public Member Functions

std::ostream & print (std::ostream &o) const
 Display the problem on the specified output stream.
 
Constructors and destructors.
 Problem (const function_t &cost)
 
 Problem (const Problem< F, CLIST > &pb)
 Copy constructor.
 
template<typename F_, typename CLIST_>
 Problem (const Problem< F_, CLIST_ > &pb)
 Copy constructor (convert from another class of problem).
 
virtual ~Problem ()
 Virtual destructor.
 
Cost function.
const function_t & function () const
 Retrieve cost function.
 
intervals_t & argumentBounds ()
 Retrieve arguments bounds.
 
const intervals_t & argumentBounds () const
 Retrieve arguments bounds.
 
scaling_t & argumentScaling ()
 Retrieve arguments scaling.
 
const scaling_t & argumentScaling () const
 Retrieve arguments scaling.
 
scales_t & argumentScales () ROBOPTIM_CORE_DEPRECATED
 Retrieve arguments scaling (deprecated version).
 
const scales_t & argumentScales () const ROBOPTIM_CORE_DEPRECATED
 Retrieve arguments scaling (deprecated version).
 
names_t & argumentNames ()
 Retrieve arguments names.
 
const names_t & argumentNames () const
 Retrieve arguments names.
 
Constraints.
const constraints_t & constraints () const
 Retrieve constraints.
 
template<typename C>
void addConstraint (boost::shared_ptr< C > constraint, interval_t interval, value_type scale=1.)
 Add a constraint to the problem.
 
template<typename C>
void addConstraint (boost::shared_ptr< C > constraint, intervals_t intervals, scaling_t scaling)
 Add a constraint to the problem.
 
const intervalsVect_t & boundsVector () const
 Retrieve constraints bounds vector.
 
const scalingVect_t & scalingVector () const
 Retrieve constraints scaling vector.
 
const scalesVect_t & scalesVector () const ROBOPTIM_CORE_DEPRECATED
 Retrieve constraints scaling vector (deprecated version).
 
Starting point (initial guess).
startingPoint_t & startingPoint ()
 Set the initial guess.
 
const startingPoint_t & startingPoint () const
 Get the initial guess.
 

Friends

template<typename F_, typename CLIST_>
class Problem
 

Detailed Description

template<typename F, typename CLIST>
class roboptim::Problem< F, CLIST >
Examples
problem-cc.cc.