PaGMO  1.1.5
Public Member Functions | Protected Member Functions | Protected Attributes | Friends
pagmo::problem::base_meta Class Reference

Meta=problems base class. More...

#include <base_meta.h>

Inheritance diagram for pagmo::problem::base_meta:
Inheritance graph
[legend]

Public Member Functions

 base_meta (const base &p=ackley(1), int n=1, int ni=0, int nf=1, int nc=0, int nic=0, const std::vector< double > &c_tol=std::vector< double >())
 Constructor.
 
 base_meta (const base_meta &p)
 Copy constructor.
 
- Public Member Functions inherited from pagmo::problem::base
 base (int, int=0, int=1, int=0, int=0, const double &=0)
 Constructor from global dimension, integer dimension, fitness dimension, global constraints dimension, inequality constraints dimension and constraints tolerance. More...
 
 base (int, int, int, int, int, const std::vector< double > &)
 Constructor from global dimension, integer dimension, fitness dimension, global constraints dimension, inequality constraints dimension and constraints tolerance. More...
 
 base (const double &, const double &, int, int=0, int=1, int=0, int=0, const double &=0)
 Constructor from values for lower and upper bounds, global dimension, integer dimension, fitness dimension, global constraints dimension, inequality constraints dimension and constraints tolerance. More...
 
 base (const decision_vector &, const decision_vector &, int=0, int=1, int=0, int=0, const double &=0)
 Constructor from upper/lower bounds, integer dimension, fitness dimension, global constraints dimension, inequality constraints dimension and constraints tolerance. More...
 
template<std::size_t N>
 base (const double(&v1)[N], const double(&v2)[N], int ni=0, int nf=1, int nc=0, int nic=0, const double &c_tol=0)
 Constructor from raw arrays, integer dimension, fitness dimension, global constraints dimension, inequality constraints dimension and constraints tolerance. More...
 
template<class Iterator1 , class Iterator2 >
 base (Iterator1 start1, Iterator1 end1, Iterator2 start2, Iterator2 end2, int ni=0, int nf=1, int nc=0, int nic=0, const double &c_tol=0)
 Constructor from iterators, integer dimension, fitness dimension, global constraints dimension, inequality constraints dimension and constraints tolerance. More...
 
virtual ~base ()
 Trivial destructor. More...
 
virtual base_ptr clone () const =0
 Clone method. More...
 
std::string human_readable () const
 Return human readable representation of the problem. More...
 
virtual std::string human_readable_extra () const
 Extra information in human readable format. More...
 
bool operator== (const base &) const
 Equality operator. More...
 
bool operator!= (const base &) const
 Inequality operator. More...
 
bool is_compatible (const base &) const
 Compatibility operator. More...
 
bool compare_x (const decision_vector &, const decision_vector &) const
 Compare decision vectors. More...
 
bool verify_x (const decision_vector &) const
 Verify compatibility of decision vector x with problem. More...
 
bool compare_fc (const fitness_vector &, const constraint_vector &, const fitness_vector &, const constraint_vector &) const
 Simultaneous fitness-constraint comparison. More...
 
virtual void pre_evolution (population &) const
 Pre-evolution hook. More...
 
virtual void post_evolution (population &) const
 Post-evolution hook. More...
 
virtual void set_sparsity (int &lenG, std::vector< int > &iGfun, std::vector< int > &jGvar) const
 Sets the sparsity pattern of the gradient. More...
 
const decision_vectorget_lb () const
 Lower bounds getter. More...
 
const decision_vectorget_ub () const
 Upper bounds getter. More...
 
void set_bounds (const decision_vector &, const decision_vector &)
 Bounds setter from pagmo::decision_vector. More...
 
template<class Iterator1 , class Iterator2 >
void set_bounds (Iterator1 start1, Iterator1 end1, Iterator2 start2, Iterator2 end2)
 Bounds setter from iterators. More...
 
template<std::size_t N>
void set_bounds (const double(&v1)[N], const double(&v2)[N])
 Bounds setter from raw arrays. More...
 
void set_bounds (const double &, const double &)
 Set bounds to specified values. More...
 
void set_bounds (int, const double &, const double &)
 Set bounds to specified values. More...
 
void set_lb (const decision_vector &)
 Set lower bounds from pagmo::decision_vector. More...
 
void set_lb (int, const double &)
 Set specific lower bound to value. More...
 
void set_lb (const double &)
 Set all lower bounds to value. More...
 
template<class Iterator >
void set_lb (Iterator start, Iterator end)
 Lower bounds setter from iterators. More...
 
template<std::size_t N>
void set_lb (const double(&v)[N])
 Lower bounds setter from raw array. More...
 
void set_ub (const decision_vector &)
 Set upper bounds from pagmo::decision_vector. More...
 
void set_ub (int, const double &)
 Set specific upper bound to value. More...
 
void set_ub (const double &)
 Set all upper bounds to value. More...
 
template<class Iterator >
void set_ub (Iterator start, Iterator end)
 Upper bounds setter from iterators. More...
 
template<std::size_t N>
void set_ub (const double(&v)[N])
 Upper bounds setter from raw array. More...
 
unsigned int get_fevals () const
 Return number of function evaluations. More...
 
unsigned int get_cevals () const
 Return number of constraints function evaluations. More...
 
size_type get_dimension () const
 Return global dimension. More...
 
size_type get_i_dimension () const
 Return integer dimension. More...
 
f_size_type get_f_dimension () const
 Return fitness dimension. More...
 
c_size_type get_c_dimension () const
 Return global constraints dimension. More...
 
c_size_type get_ic_dimension () const
 Return inequality constraints dimension. More...
 
const std::vector< double > & get_c_tol () const
 Return constraints tolerance. More...
 
double get_diameter () const
 Get the diameter of the problem. More...
 
virtual std::string get_name () const
 Get problem's name. More...
 
constraint_vector compute_constraints (const decision_vector &) const
 Compute constraints and return constraint vector. More...
 
void compute_constraints (constraint_vector &, const decision_vector &) const
 Compute constraints and write them into contraint vector. More...
 
bool compare_constraints (const constraint_vector &, const constraint_vector &) const
 Compare constraint vectors. More...
 
bool test_constraint (const constraint_vector &, const c_size_type &) const
 Test i-th constraint of c (using tolerance information). More...
 
bool feasibility_x (const decision_vector &) const
 Test feasibility of decision vector. More...
 
bool feasibility_c (const constraint_vector &) const
 Test feasibility of constraint vector. More...
 
fitness_vector objfun (const decision_vector &) const
 Return fitness of pagmo::decision_vector. More...
 
void objfun (fitness_vector &, const decision_vector &) const
 Write fitness of pagmo::decision_vector into pagmo::fitness_vector. More...
 
bool compare_fitness (const fitness_vector &, const fitness_vector &) const
 Compare fitness vectors. More...
 
void reset_caches () const
 Reset internal caches. More...
 
const std::vector< constraint_vector > & get_best_c (void) const
 Get the best known constraint vector. More...
 
const std::vector< decision_vector > & get_best_x (void) const
 Get the best known decision vector. More...
 
const std::vector< fitness_vector > & get_best_f (void) const
 Get the best known fitness vector. More...
 
void set_best_x (const std::vector< decision_vector > &)
 Sets the best known decision vectors. More...
 

Protected Member Functions

bool compare_fitness_impl (const fitness_vector &f1, const fitness_vector &f2) const
 Implementation of fitness vectors comparison. More...
 
bool compare_constraints_impl (const constraint_vector &c1, const constraint_vector &c2) const
 Implementation of constraint vector comparison. More...
 
bool compare_fc_impl (const fitness_vector &f1, const constraint_vector &c1, const fitness_vector &f2, const constraint_vector &c2) const
 Implementation of simultaneous fitness-constraint comparison. More...
 
- Protected Member Functions inherited from pagmo::problem::base
virtual bool equality_operator_extra (const base &) const
 Extra requirements for equality. More...
 
void estimate_sparsity (const decision_vector &, int &lenG, std::vector< int > &iGfun, std::vector< int > &jGvar) const
 Heuristics to estimate the sparsity pattern of the problem. More...
 
void estimate_sparsity (int &lenG, std::vector< int > &iGfun, std::vector< int > &jGvar) const
 Heuristics to estimate the sparsity pattern of the problem. More...
 
virtual void compute_constraints_impl (constraint_vector &, const decision_vector &) const
 Implementation of constraint computation. More...
 
virtual void objfun_impl (fitness_vector &f, const decision_vector &x) const =0
 Objective function implementation. More...
 

Protected Attributes

base_ptr m_original_problem
 Smart pointer to the original problem instance.
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Public Types inherited from pagmo::problem::base
typedef decision_vector::size_type size_type
 Problem's size type: the same as pagmo::decision_vector's size type.
 
typedef fitness_vector::size_type f_size_type
 Fitness' size type: the same as pagmo::fitness_vector's size type.
 
typedef constraint_vector::size_type c_size_type
 Constraints' size type: the same as pagmo::constraint_vector's size type.
 
- Static Public Attributes inherited from pagmo::problem::base
static const std::size_t cache_capacity = 5
 Capacity of the internal caches.
 

Detailed Description

Meta=problems base class.

All meta-problems can inherit directly from this class. The virtual functions to compare fitness and constraints vectors are thus passed to the meta-problem. The copy constructor is also implemented as to provide a deep copy of the object.

NOTE: The original problem can also have the virtual function compare_fitness_impl implemented the meta-problem will make use of it. The custom implementation, in this case, is expected to work for generic dimensions of the fitness vector as metaproblems may transform this dimension at will.

Author
Dario Izzo (dario,izzo@.nosp@m.gmai.nosp@m.l.com)

Definition at line 50 of file base_meta.h.

Member Function Documentation

bool pagmo::problem::base_meta::compare_constraints_impl ( const constraint_vector c1,
const constraint_vector c2 
) const
inlineprotectedvirtual

Implementation of constraint vector comparison.

Return true if c1 is a strictly better constraint vector than c2, false otherwise. Default implementation will return true under the following conditions, tested in order:

  • c1 satisfies more constraints than c2,
  • c1 and c2 satisfy the same number of constraints and the L2 norm of the constraint mismatches for c1 is smaller than for c2.

Otherwise, false will be returned.

Parameters
[in]c1first pagmo::constraint_vector to compare.
[in]c2second pagmo::constraint_vector to compare.
Returns
true if c1 is a better constraint vector than c2, false otherwise.

Reimplemented from pagmo::problem::base.

Definition at line 66 of file base_meta.h.

bool pagmo::problem::base_meta::compare_fc_impl ( const fitness_vector f1,
const constraint_vector c1,
const fitness_vector f2,
const constraint_vector c2 
) const
inlineprotectedvirtual

Implementation of simultaneous fitness-constraint comparison.

This function combines the information of two fitness/constraint vector pairs in order to establish which of the two pairs if strictly better than the other. Return value will be true if the first pair is strictly better than the second pair, false otherwise.

Default implementation will return true if one of these conditions, tested in this order, holds:

  • c1 is feasible, c2 is not;
  • both c1 and c2 are not feasible and compare_constraints_impl(c1,c2) returns true;
  • both c1 and c2 are feasible and compare_fitness_impl(f1,f2) returns true.

Otherwise, false will be returned.

Parameters
[in]f1first pagmo::fitness_vector.
[in]c1first pagmo::constraint_vector.
[in]f2second pagmo::fitness_vector.
[in]c2second pagmo::constraint_vector.
Returns
true if first fitness/constraint vector pair is strictly better than the second one, false otherwise.

Reimplemented from pagmo::problem::base.

Definition at line 68 of file base_meta.h.

bool pagmo::problem::base_meta::compare_fitness_impl ( const fitness_vector v_f1,
const fitness_vector v_f2 
) const
inlineprotectedvirtual

Implementation of fitness vectors comparison.

Return true if v_f1 Pareto dominate v_f2, false otherwise. This default implementation will assume minimisation for each one of the v_f components I.e., each pair of corresponding elements in v_f1 and v_f2 is compared: if all elements in v_f1 are less or equal to the corresponding element in v_f2, true will be returned. Otherwise, false will be returned.

Parameters
[in]v_f1first fitness vector.
[in]v_f2second fitness vector.
Returns
true if v_f1 is dominating v_f2, false otherwise.

Reimplemented from pagmo::problem::base.

Definition at line 62 of file base_meta.h.


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