Ipopt Documentation  
Ipopt::Filter Class Reference

Class for the filter. More...

#include <IpFilter.hpp>

Public Member Functions

bool Acceptable (std::vector< Number > vals) const
 Check acceptability of given coordinates with respect to the filter. More...
void AddEntry (std::vector< Number > vals, Index iteration)
 Add filter entry for given coordinates. More...
void Clear ()
 Delete all filter entries. More...
void Print (const Journalist &jnlst)
 Print current filter entries. More...
 Filter (Index dim)
 Default Constructor. More...
 ~Filter ()
 Destructor. More...
Wrappers for 2-dimensional filter.
bool Acceptable (Number val1, Number val2) const
void AddEntry (Number val1, Number val2, Index iteration)

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.

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

Private Attributes

Index dim_
 Dimension of the filter (number of coordinates per entry) More...
std::list< FilterEntry * > filter_list_
 List storing the filter entries. More...

Detailed Description

Class for the filter.

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

Definition at line 134 of file IpFilter.hpp.

Constructor & Destructor Documentation

◆ Filter() [1/3]

Ipopt::Filter::Filter ( Index  dim)

Default Constructor.

◆ ~Filter()

Ipopt::Filter::~Filter ( )


Definition at line 144 of file IpFilter.hpp.

◆ Filter() [2/3]

Ipopt::Filter::Filter ( )

Default Constructor.

◆ Filter() [3/3]

Ipopt::Filter::Filter ( const Filter )

Copy Constructor.

Member Function Documentation

◆ Acceptable() [1/2]

bool Ipopt::Filter::Acceptable ( std::vector< Number vals) const

Check acceptability of given coordinates with respect to the filter.

true, if pair is acceptable

◆ AddEntry() [1/2]

void Ipopt::Filter::AddEntry ( std::vector< Number vals,
Index  iteration 

Add filter entry for given coordinates.

This will also delete all dominated entries in the current filter.

◆ Acceptable() [2/2]

bool Ipopt::Filter::Acceptable ( Number  val1,
Number  val2 
) const

Definition at line 172 of file IpFilter.hpp.

◆ AddEntry() [2/2]

void Ipopt::Filter::AddEntry ( Number  val1,
Number  val2,
Index  iteration 

Definition at line 184 of file IpFilter.hpp.

◆ Clear()

void Ipopt::Filter::Clear ( )

Delete all filter entries.

◆ Print()

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

Print current filter entries.

◆ operator=()

void Ipopt::Filter::operator= ( const Filter )

Default Assignment Operator.

Member Data Documentation

◆ dim_

Index Ipopt::Filter::dim_

Dimension of the filter (number of coordinates per entry)

Definition at line 231 of file IpFilter.hpp.

◆ filter_list_

std::list<FilterEntry*> Ipopt::Filter::filter_list_

List storing the filter entries.

Definition at line 234 of file IpFilter.hpp.

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