Ipopt Documentation  
 
Loading...
Searching...
No Matches
Ipopt::PiecewisePenalty Class Reference

Class for the Piecewise Penalty. More...

#include <IpPiecewisePenalty.hpp>

Public Member Functions

void Clear ()
 Delete all Piecewise Penalty entries.
 
void Print (const Journalist &jnlst)
 Print current Piecewise Penalty entries.
 
Constructors/Destructors
 PiecewisePenalty (Index dim)
 Default Constructor.
 
 ~PiecewisePenalty ()
 Destructor.
 
bool IsPiecewisePenaltyListEmpty ()
 
void InitPiecewisePenaltyList (Number pen_r, Number barrier_obj, Number infeasi)
 
bool Acceptable (Number Fzconst, Number Fzlin)
 Check acceptability of given coordinates with respect to the Piecewise Penalty.
 
Number BiggestBarr ()
 Get the value of the biggest barrier function so far.
 
void UpdateEntry (Number barrier_obj, Number infeasi)
 Update Piecewise Penalty entry for given coordinates.
 
void AddEntry (Number pen_r, Number barrier_obj, Number infeasi)
 Add a entry to the list.
 
void ResetList (Number pen_r, Number barrier_obj, Number infeasi)
 Clear and reset the piecewise penalty list.
 

Private Member Functions

Default Compiler Generated Methods

(Hidden to avoid implicit creation/calling).

These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.

 PiecewisePenalty ()
 Default Constructor.
 
 PiecewisePenalty (const PiecewisePenalty &)
 Copy Constructor.
 
void operator= (const PiecewisePenalty &)
 Default Assignment Operator.
 

Private Attributes

Index dim_
 Dimension of the Piecewise Penalty (number of coordinates per entry)
 
Number min_piece_penalty_
 The min penalty value for the piecewise penalty list.
 
Index max_piece_number_
 The max number of the break points in the piecewise penalty list.
 
std::vector< PiecewisePenEntryPiecewisePenalty_list_
 vector storing the Piecewise Penalty entries
 

Detailed Description

Class for the Piecewise Penalty.

This class contains all Piecewise Penalty entries. The entries are stored as the corner point, including the margin.

Definition at line 36 of file IpPiecewisePenalty.hpp.

Constructor & Destructor Documentation

◆ PiecewisePenalty() [1/3]

Ipopt::PiecewisePenalty::PiecewisePenalty ( Index  dim)

Default Constructor.

◆ ~PiecewisePenalty()

Ipopt::PiecewisePenalty::~PiecewisePenalty ( )
inline

Destructor.

Definition at line 45 of file IpPiecewisePenalty.hpp.

◆ PiecewisePenalty() [2/3]

Ipopt::PiecewisePenalty::PiecewisePenalty ( )
private

Default Constructor.

◆ PiecewisePenalty() [3/3]

Ipopt::PiecewisePenalty::PiecewisePenalty ( const PiecewisePenalty )
private

Copy Constructor.

Member Function Documentation

◆ IsPiecewisePenaltyListEmpty()

bool Ipopt::PiecewisePenalty::IsPiecewisePenaltyListEmpty ( )
inline

Definition at line 54 of file IpPiecewisePenalty.hpp.

◆ InitPiecewisePenaltyList()

void Ipopt::PiecewisePenalty::InitPiecewisePenaltyList ( Number  pen_r,
Number  barrier_obj,
Number  infeasi 
)
inline

Definition at line 59 of file IpPiecewisePenalty.hpp.

◆ Acceptable()

bool Ipopt::PiecewisePenalty::Acceptable ( Number  Fzconst,
Number  Fzlin 
)

Check acceptability of given coordinates with respect to the Piecewise Penalty.

Returns
true, if pair is acceptable

◆ BiggestBarr()

Number Ipopt::PiecewisePenalty::BiggestBarr ( )

Get the value of the biggest barrier function so far.

◆ UpdateEntry()

void Ipopt::PiecewisePenalty::UpdateEntry ( Number  barrier_obj,
Number  infeasi 
)

Update Piecewise Penalty entry for given coordinates.

◆ AddEntry()

void Ipopt::PiecewisePenalty::AddEntry ( Number  pen_r,
Number  barrier_obj,
Number  infeasi 
)
inline

Add a entry to the list.

Definition at line 86 of file IpPiecewisePenalty.hpp.

◆ ResetList()

void Ipopt::PiecewisePenalty::ResetList ( Number  pen_r,
Number  barrier_obj,
Number  infeasi 
)
inline

Clear and reset the piecewise penalty list.

Definition at line 107 of file IpPiecewisePenalty.hpp.

◆ Clear()

void Ipopt::PiecewisePenalty::Clear ( )
inline

Delete all Piecewise Penalty entries.

Definition at line 120 of file IpPiecewisePenalty.hpp.

◆ Print()

void Ipopt::PiecewisePenalty::Print ( const Journalist jnlst)

Print current Piecewise Penalty entries.

◆ operator=()

void Ipopt::PiecewisePenalty::operator= ( const PiecewisePenalty )
private

Default Assignment Operator.

Member Data Documentation

◆ dim_

Index Ipopt::PiecewisePenalty::dim_
private

Dimension of the Piecewise Penalty (number of coordinates per entry)

Definition at line 155 of file IpPiecewisePenalty.hpp.

◆ min_piece_penalty_

Number Ipopt::PiecewisePenalty::min_piece_penalty_
private

The min penalty value for the piecewise penalty list.

Definition at line 158 of file IpPiecewisePenalty.hpp.

◆ max_piece_number_

Index Ipopt::PiecewisePenalty::max_piece_number_
private

The max number of the break points in the piecewise penalty list.

Definition at line 161 of file IpPiecewisePenalty.hpp.

◆ PiecewisePenalty_list_

std::vector<PiecewisePenEntry> Ipopt::PiecewisePenalty::PiecewisePenalty_list_
private

vector storing the Piecewise Penalty entries

Definition at line 164 of file IpPiecewisePenalty.hpp.


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