shark::BoxConstraintHandler< Vector > Class Template Reference

#include <shark/ObjectiveFunctions/BoxConstraintHandler.h>

Inheritance diagram for shark::BoxConstraintHandler< Vector >:

Public Member Functions
	BoxConstraintHandler (Vector const &lower, Vector const &upper)
	BoxConstraintHandler (std::size_t dim, double lower, double upper)
	BoxConstraintHandler ()
std::size_t	dimensions () const
bool	isFeasible (Vector const &point) const
	Returns true if the point is in the feasible Region. More...
void	closestFeasible (Vector &point) const
virtual void	generateRandomPoint (random::rng_type &rng, Vector &startingPoint) const
	If supported, generates a random point inside the feasible region. More...
void	setBounds (Vector const &lower, Vector const &upper)
	Sets lower and upper bounds of the box. More...
void	setBounds (std::size_t dimension, double lower, double upper)
	Sets lower and upper bounds of the box. More...
Vector const &	lower () const
	Returns the lower bound of the box. More...
Vector const &	upper () const
	Returns the upper bound of the box. More...
Public Member Functions inherited from shark::AbstractConstraintHandler< Vector >
const Features &	features () const
virtual void	updateFeatures ()
virtual	~AbstractConstraintHandler ()
bool	canProvideClosestFeasible () const
	Returns whether this function can calculate the closest feasible to an infeasible point. More...
bool	isBoxConstrained () const
	Returns whether this function is an instance of BoxConstraintHandler. More...
bool	canGenerateRandomPoint () const
	Returns whether this function is an instance of BoxConstraintHandler. More...

Additional Inherited Members
Public Types inherited from shark::AbstractConstraintHandler< Vector >
enum	Feature
typedef TypedFlags< Feature >	Features
typedef TypedFeatureNotAvailableException< Feature >	FeatureNotAvailableException
Protected Attributes inherited from shark::AbstractConstraintHandler< Vector >
Features	m_features

Detailed Description

template<class Vector>
class shark::BoxConstraintHandler< Vector >

Definition at line 42 of file BoxConstraintHandler.h.

Constructor & Destructor Documentation

BoxConstraintHandler() [1/3]

template<class Vector>

shark::BoxConstraintHandler< Vector >::BoxConstraintHandler ( Vector const &  lower, Vector const &  upper  )

inline

Definition at line 44 of file BoxConstraintHandler.h.

BoxConstraintHandler() [2/3]

template<class Vector>

shark::BoxConstraintHandler< Vector >::BoxConstraintHandler ( std::size_t  dim, double  lower, double  upper  )

inline

Definition at line 52 of file BoxConstraintHandler.h.

BoxConstraintHandler() [3/3]

template<class Vector>

shark::BoxConstraintHandler< Vector >::BoxConstraintHandler ( )

inline

Definition at line 60 of file BoxConstraintHandler.h.

Member Function Documentation

closestFeasible()

template<class Vector>

void shark::BoxConstraintHandler< Vector >::closestFeasible ( Vector &  point ) const

inlinevirtual

Reimplemented from shark::AbstractConstraintHandler< Vector >.

Definition at line 79 of file BoxConstraintHandler.h.

dimensions()

template<class Vector>

std::size_t shark::BoxConstraintHandler< Vector >::dimensions ( ) const

inline

Definition at line 67 of file BoxConstraintHandler.h.

Referenced by shark::BoxConstraintHandler< SearchPointType >::closestFeasible(), shark::BoxConstraintHandler< SearchPointType >::generateRandomPoint(), shark::BoxConstraintHandler< SearchPointType >::isFeasible(), shark::GSP::numberOfVariables(), shark::LZ9::numberOfVariables(), shark::ZDT3::numberOfVariables(), shark::DTLZ3::numberOfVariables(), shark::DTLZ4::numberOfVariables(), shark::LZ3::numberOfVariables(), shark::LZ4::numberOfVariables(), shark::LZ5::numberOfVariables(), shark::LZ6::numberOfVariables(), shark::LZ7::numberOfVariables(), shark::DTLZ5::numberOfVariables(), shark::DTLZ2::numberOfVariables(), shark::DTLZ6::numberOfVariables(), shark::DTLZ7::numberOfVariables(), shark::LZ1::numberOfVariables(), shark::LZ8::numberOfVariables(), shark::LZ2::numberOfVariables(), shark::Fonseca::numberOfVariables(), shark::ZDT2::numberOfVariables(), shark::IHR1::numberOfVariables(), shark::IHR3::numberOfVariables(), shark::IHR4::numberOfVariables(), shark::ZDT6::numberOfVariables(), shark::ZDT1::numberOfVariables(), shark::IHR2::numberOfVariables(), shark::DTLZ1::numberOfVariables(), shark::ZDT4::numberOfVariables(), and shark::IHR6::numberOfVariables().

generateRandomPoint()

template<class Vector>

virtual void shark::BoxConstraintHandler< Vector >::generateRandomPoint ( random::rng_type &  rng, Vector &  startingPoint  ) const

inlinevirtual

If supported, generates a random point inside the feasible region.

Parameters

rng	The random number generator used for generating the point
startingPoint	The proposed point

Reimplemented from shark::AbstractConstraintHandler< Vector >.

Definition at line 87 of file BoxConstraintHandler.h.

isFeasible()

template<class Vector>

bool shark::BoxConstraintHandler< Vector >::isFeasible ( Vector const &  ) const

inlinevirtual

Returns true if the point is in the feasible Region.

This function must be implemented by a ConstraintHandler

Implements shark::AbstractConstraintHandler< Vector >.

Definition at line 71 of file BoxConstraintHandler.h.

lower()

template<class Vector>

Vector const& shark::BoxConstraintHandler< Vector >::lower ( ) const

inline

Returns the lower bound of the box.

Definition at line 107 of file BoxConstraintHandler.h.

Referenced by shark::SMSEMOA::init(), shark::IndicatorBasedRealCodedNSGAII< NSGA3Indicator >::init(), and shark::BoxConstraintHandler< SearchPointType >::setBounds().

setBounds() [1/2]

template<class Vector>

void shark::BoxConstraintHandler< Vector >::setBounds ( Vector const &  lower, Vector const &  upper  )

inline

Sets lower and upper bounds of the box.

Definition at line 96 of file BoxConstraintHandler.h.

Referenced by shark::GSP::setNumberOfVariables(), shark::LZ9::setNumberOfVariables(), shark::ZDT3::setNumberOfVariables(), shark::Fonseca::setNumberOfVariables(), shark::DTLZ3::setNumberOfVariables(), shark::LZ3::setNumberOfVariables(), shark::DTLZ4::setNumberOfVariables(), shark::LZ4::setNumberOfVariables(), shark::LZ7::setNumberOfVariables(), shark::LZ6::setNumberOfVariables(), shark::LZ5::setNumberOfVariables(), shark::IHR4::setNumberOfVariables(), shark::IHR1::setNumberOfVariables(), shark::DTLZ5::setNumberOfVariables(), shark::LZ1::setNumberOfVariables(), shark::DTLZ2::setNumberOfVariables(), shark::IHR3::setNumberOfVariables(), shark::DTLZ6::setNumberOfVariables(), shark::DTLZ7::setNumberOfVariables(), shark::LZ8::setNumberOfVariables(), shark::LZ2::setNumberOfVariables(), shark::IHR2::setNumberOfVariables(), shark::DTLZ1::setNumberOfVariables(), shark::ZDT2::setNumberOfVariables(), shark::ZDT6::setNumberOfVariables(), shark::ZDT1::setNumberOfVariables(), shark::IHR6::setNumberOfVariables(), and shark::ZDT4::setNumberOfVariables().

setBounds() [2/2]

template<class Vector>

void shark::BoxConstraintHandler< Vector >::setBounds ( std::size_t  dimension, double  lower, double  upper  )

inline

Sets lower and upper bounds of the box.

Definition at line 102 of file BoxConstraintHandler.h.

upper()

template<class Vector>

Vector const& shark::BoxConstraintHandler< Vector >::upper ( ) const

inline

Returns the upper bound of the box.

Definition at line 111 of file BoxConstraintHandler.h.

Referenced by shark::BoxConstraintHandler< SearchPointType >::setBounds().

---

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

• include/shark/ObjectiveFunctions/BoxConstraintHandler.h