scsolver::numeric::nlp::Penalty Class Reference

#include <penalty.hxx>

Inheritance diagram for scsolver::numeric::nlp::Penalty:

[legend]

Collaboration diagram for scsolver::numeric::nlp::Penalty:

[legend]

List of all members.

Public Member Functions
	Penalty ()
	Penalty (const Penalty &r)
virtual	~Penalty ()
virtual double	eval ()
virtual const ::std::string	getFuncString () const
void	initFromModel (Model *pModel)
void	setConstraintFactor (double factor)
Private Attributes
::std::auto_ptr < PenaltyImpl >	mpImpl

---

Detailed Description

Definition at line 39 of file penalty.hxx.

---

Constructor & Destructor Documentation

scsolver::numeric::nlp::Penalty::Penalty

(

)

Definition at line 64 of file penalty.cxx.

scsolver::numeric::nlp::Penalty::Penalty

(

const Penalty &

r

)

Definition at line 70 of file penalty.cxx.

scsolver::numeric::nlp::Penalty::~Penalty

(

)

[virtual]

Definition at line 76 of file penalty.cxx.

---

Member Function Documentation

double scsolver::numeric::nlp::Penalty::eval

(

)

[virtual]

Definition at line 80 of file penalty.cxx.

const string scsolver::numeric::nlp::Penalty::getFuncString

(

)

const [virtual]

Return a display-friendly function string.

Implements scsolver::numeric::BaseFuncObj.

Definition at line 85 of file penalty.cxx.

void scsolver::numeric::nlp::Penalty::initFromModel

(

Model *

pModel

)

Initialize the penalty function from a non-linear model. It takes the objective function and the constraint conditions from the passed model instance.

Parameters:

pModel

non-linear model instance

Definition at line 91 of file penalty.cxx.

References scsolver::numeric::nlp::Model::getAllConstraints(), scsolver::numeric::nlp::Model::getFuncObject(), and mpImpl.

void scsolver::numeric::nlp::Penalty::setConstraintFactor

(

double

factor

)

Set the factor that multiplies the constraint terms when converting the constrained model into an unconstrained one.

Parameters:

factor

value that multiplies the constraint terms. All constraint terms are multiplied by this value. It's not possible to set different factors for different constraint terms.

Definition at line 98 of file penalty.cxx.

References mpImpl.

---

Member Data Documentation

::std::auto_ptr<PenaltyImpl> scsolver::numeric::nlp::Penalty::mpImpl [private]

Definition at line 70 of file penalty.hxx.

Referenced by initFromModel(), and setConstraintFactor().

---

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

• source/inc/numeric/penalty.hxx
• source/numeric/penalty.cxx

---