Ipopt::FilterEntry Class Reference

Class for one filter entry. More...

#include <IpFilter.hpp>

Public Member Functions
bool	Acceptable (std::vector< Number > vals) const
	Check acceptability of pair (phi,theta) with respect to this filter entry.
bool	Dominated (std::vector< Number > vals) const
	Check if this entry is dominated by given coordinates.
Constructors/Destructors
	FilterEntry (const std::vector< Number > &vals, Index iter)
	Constructor with the two components and the current iteration count.
	~FilterEntry ()
	Destructor.
Accessor functions
Number	val (Index i) const
Index	iter () const

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.
	FilterEntry ()
	Default Constructor.
	FilterEntry (const FilterEntry &)
	Copy Constructor.
void	operator= (const FilterEntry &)
	Default Assignment Operator.

Private Attributes
std::vector< Number >	vals_
	values defining the coordinates of the entry
const Index	iter_
	iteration number in which this entry was added to filter

Detailed Description

Class for one filter entry.

Definition at line 19 of file IpFilter.hpp.

Constructor & Destructor Documentation

FilterEntry() [1/3]

Ipopt::FilterEntry::FilterEntry	(	const std::vector< Number > &	vals,
		Index	iter
	)

Constructor with the two components and the current iteration count.

~FilterEntry()

Ipopt::FilterEntry::~FilterEntry

(

)

Destructor.

FilterEntry() [2/3]

Ipopt::FilterEntry::FilterEntry ( )

private

Default Constructor.

FilterEntry() [3/3]

Ipopt::FilterEntry::FilterEntry ( const FilterEntry &  )

private

Copy Constructor.

Member Function Documentation

Acceptable()

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

inline

Check acceptability of pair (phi,theta) with respect to this filter entry.

Returns

true, if pair is acceptable

Definition at line 39 of file IpFilter.hpp.

Dominated()

bool Ipopt::FilterEntry::Dominated ( std::vector< Number >  vals ) const

inline

Check if this entry is dominated by given coordinates.

Returns

true, if this entry is dominated

Definition at line 64 of file IpFilter.hpp.

val()

Number Ipopt::FilterEntry::val ( Index  i ) const

inline

Definition at line 86 of file IpFilter.hpp.

iter()

Index Ipopt::FilterEntry::iter ( ) const

inline

Definition at line 92 of file IpFilter.hpp.

operator=()

void Ipopt::FilterEntry::operator= ( const FilterEntry &  )

private

Default Assignment Operator.

Member Data Documentation

vals_

std::vector<Number> Ipopt::FilterEntry::vals_

private

values defining the coordinates of the entry

Definition at line 123 of file IpFilter.hpp.

iter_

const Index Ipopt::FilterEntry::iter_

private

iteration number in which this entry was added to filter

Definition at line 125 of file IpFilter.hpp.

---

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

• src/Algorithm/IpFilter.hpp