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.
void	AddEntry (std::vector< Number > vals, Index iteration)
	Add filter entry for given coordinates.
void	Clear ()
	Delete all filter entries.
void	Print (const Journalist &jnlst)
	Print current filter entries.
Constructors/Destructors
	Filter (Index dim)
	Default Constructor.
	~Filter ()
	Destructor.
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.
	Filter (const Filter &)
	Copy Constructor.
void	operator= (const Filter &)
	Default Assignment Operator.

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

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 ( )

inline

Destructor.

Definition at line 144 of file IpFilter.hpp.

Filter() [2/3]

Ipopt::Filter::Filter ( )

private

Default Constructor.

Filter() [3/3]

Ipopt::Filter::Filter ( const Filter &  )

private

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.

Returns

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

inline

Definition at line 172 of file IpFilter.hpp.

AddEntry() [2/2]

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

inline

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 &  )

private

Default Assignment Operator.

Member Data Documentation

dim_

Index Ipopt::Filter::dim_

private

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_

mutableprivate

List storing the filter entries.

Definition at line 234 of file IpFilter.hpp.

---

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

• src/Algorithm/IpFilter.hpp