Purple::PlaneCylinder Class Reference

Inheritance diagram for Purple::PlaneCylinder:

List of all members.

Public Member Functions
	PlaneCylinder (void)
virtual	~PlaneCylinder (void)
double	getPenalty (void)
void	setPenalty (double)
double	getError (Vector< double >)
double	getEvaluation (Vector< double >)
void	print (Vector< double >)
Private Attributes
double	penalty

---

Detailed Description

This class represents the objective function for the plane-cylinder problem.

See also:

ObjectiveFunction.

Definition at line 26 of file PlaneCylinder.h.

---

Constructor & Destructor Documentation

Purple::PlaneCylinder::PlaneCylinder

(

void

)

General constructor. It creates a plane-cylinder objective function object. It also initializes all the rest of class members to their default values:

• Number of variables = 2.
• Lower bound = -5.12,...,-5.12.
• Upper bound = 5.12,...,5.12.
• Penalty = 100.

Definition at line 34 of file PlaneCylinder.cpp.

Purple::PlaneCylinder::~PlaneCylinder

(

void

)

[virtual]

Destructor.

Definition at line 54 of file PlaneCylinder.cpp.

---

Member Function Documentation

double Purple::PlaneCylinder::getPenalty

(

void

)

This method returns the penalty term ratio to be used in the plane-cylinder problem

See also:

getError(Vector<double>)

getEvaluation(Vector<double>)

Definition at line 70 of file PlaneCylinder.cpp.

void Purple::PlaneCylinder::setPenalty

(

double

newPenalty

)

This method sets a new penalty term ratio to be used in the plane-cylinder problem

Parameters:

newPenalty,:

New penalty term ratio.

See also:

getError(Vector<double>)

getEvaluation(Vector<double>)

Definition at line 84 of file PlaneCylinder.cpp.

double Purple::PlaneCylinder::getError

(

Vector< double >

argument

)

This method returns the error made in the constraint by a given argument.

Parameters:

argument,:

argument.

See also:

getEvaluation(Vector<double>)

Definition at line 98 of file PlaneCylinder.cpp.

double Purple::PlaneCylinder::getEvaluation

(

Vector< double >

argument

)

[virtual]

This method returns the plane-cylinder function evaluation for a given argument.

Parameters:

argument,:

Objective function argument.

Implements Purple::ObjectiveFunction.

Definition at line 125 of file PlaneCylinder.cpp.

void Purple::PlaneCylinder::print

(

Vector< double >

argument

)

[virtual]

This method prints to the screen the error made in the constraint by a given argument during the optimization process.

Parameters:

argument,:

argument.

See also:

getError(Vector<double>)

Reimplemented from Purple::ObjectiveFunction.

Definition at line 162 of file PlaneCylinder.cpp.

---

Member Data Documentation

double Purple::PlaneCylinder::penalty [private]

Penalty term ratio.

Definition at line 33 of file PlaneCylinder.h.

---