BoxConstraintHandler Class Reference

Constraint handler for box regions. More...

#include <ObjectiveFunction.h>

Inheritance diagram for BoxConstraintHandler:

List of all members.

Public Member Functions
	BoxConstraintHandler (unsigned int dim, double lower, double upper)
	Constructor.
	BoxConstraintHandler (unsigned int dim, double lower, double upper, unsigned int exception, double exceptionLower, double exceptionUpper)
	Constructor.
	BoxConstraintHandler (unsigned int dim, double lower, double upper, unsigned int exception1, double exception1Lower, double exception1Upper, unsigned int exception2, double exception2Lower, double exception2Upper)
	BoxConstraintHandler (const std::vector< double > &lower, const std::vector< double > &upper)
	Constructor.
	~BoxConstraintHandler ()
	Destructor.
bool	isFeasible (double *const &point) const
	checks whether the point is inside the box
bool	closestFeasible (double *&point) const
	returns the closest feasible point in the box
unsigned int	dimension () const
	access to the search space dimension
double	lowerBound (unsigned int index) const
	access to the box bounds
double	upperBound (unsigned int index) const
	access to the box bounds
Protected Attributes
unsigned int	m_dimension
	dimension of the search space
std::vector< double >	m_lower
	component wise lower bounds
std::vector< double >	m_upper
	component wise upper bounds

---

Detailed Description

Constraint handler for box regions.

Most simple non-trivial ConstraintHandler: The feasible region is an axis parallel box.

This class should be used as a base class for more complicated feasible regions with known bounding box.

Definition at line 87 of file ObjectiveFunction.h.

---

Constructor & Destructor Documentation

BoxConstraintHandler::BoxConstraintHandler	(	unsigned int	dim,
		double	lower,
		double	upper
	)

Constructor.

Parameters:

	dim	number of coordinates
	lower	lower bound for all coordinates
	upper	upper bound for all coordinates

Definition at line 48 of file ObjectiveFunction.cpp.

References m_dimension, m_lower, and m_upper.

BoxConstraintHandler::BoxConstraintHandler	(	unsigned int	dim,
		double	lower,
		double	upper,
		unsigned int	exception,
		double	exceptionLower,
		double	exceptionUpper
	)

Constructor.

Parameters:

	dim	number of coordinates
	lower	lower bound for all coordinates
	upper	upper bound for all coordinates
	exception	coordinate index with different bounds
	exceptionLower	lower bound for the exception coordinate
	exceptionUpper	upper bound for the exception coordinate

Definition at line 61 of file ObjectiveFunction.cpp.

References m_dimension, m_lower, and m_upper.

BoxConstraintHandler::BoxConstraintHandler	(	unsigned int	dim,
		double	lower,
		double	upper,
		unsigned int	exception1,
		double	exception1Lower,
		double	exception1Upper,
		unsigned int	exception2,
		double	exception2Lower,
		double	exception2Upper
	)

Parameters:

	dim	number of coordinates
	lower	lower bound for all coordinates
	upper	upper bound for all coordinates
	exception1	first coordinate index with different bounds
	exception1Lower	lower bound for the first exception coordinate
	exception1Upper	upper bound for the first exception coordinate
	exception2	second coordinate index with different bounds
	exception2Lower	lower bound for the second exception coordinate
	exception2Upper	upper bound for the second exception coordinate

Definition at line 76 of file ObjectiveFunction.cpp.

References m_dimension, m_lower, and m_upper.

BoxConstraintHandler::BoxConstraintHandler	(	const std::vector< double > &	lower,
		const std::vector< double > &	upper
	)

Constructor.

Parameters:

	dim	number of coordinates
	lower	component wise lower bound
	upper	component wise upper bound

Definition at line 93 of file ObjectiveFunction.cpp.

References m_dimension, m_lower, and m_upper.

BoxConstraintHandler::~BoxConstraintHandler

(

)

Destructor.

Definition at line 101 of file ObjectiveFunction.cpp.

---

Member Function Documentation

bool BoxConstraintHandler::closestFeasible

(

double *&

point

)

const

returns the closest feasible point in the box

Definition at line 113 of file ObjectiveFunction.cpp.

References m_dimension, m_lower, and m_upper.

unsigned int BoxConstraintHandler::dimension

(

)

const [inline]

access to the search space dimension

Definition at line 136 of file ObjectiveFunction.h.

References m_dimension.

Referenced by ObjectiveFunctionVS< double >::ProposeStartingPoint().

bool BoxConstraintHandler::isFeasible

(

double *const &

point

)

const

checks whether the point is inside the box

Definition at line 106 of file ObjectiveFunction.cpp.

References m_upper.

Referenced by ObjectiveFunctionVS< double >::ProposeStartingPoint().

double BoxConstraintHandler::lowerBound

(

unsigned int

index

)

const [inline]

access to the box bounds

Definition at line 139 of file ObjectiveFunction.h.

References m_lower.

Referenced by ObjectiveFunctionVS< double >::ProposeStartingPoint().

double BoxConstraintHandler::upperBound

(

unsigned int

index

)

const [inline]

access to the box bounds

Definition at line 142 of file ObjectiveFunction.h.

References m_upper.

Referenced by ObjectiveFunctionVS< double >::ProposeStartingPoint().

---

Member Data Documentation

unsigned int BoxConstraintHandler::m_dimension [protected]

dimension of the search space

Definition at line 146 of file ObjectiveFunction.h.

Referenced by BoxConstraintHandler(), closestFeasible(), and dimension().

std::vector<double> BoxConstraintHandler::m_lower [protected]

component wise lower bounds

Definition at line 149 of file ObjectiveFunction.h.

Referenced by BoxConstraintHandler(), closestFeasible(), and lowerBound().

std::vector<double> BoxConstraintHandler::m_upper [protected]

component wise upper bounds

Definition at line 152 of file ObjectiveFunction.h.

Referenced by BoxConstraintHandler(), closestFeasible(), isFeasible(), and upperBound().

---

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

• ObjectiveFunction.h
• ObjectiveFunction.cpp