Ipopt  3.12.11
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
Ipopt::DependentResult< T > Class Template Reference

Templated class which stores one entry for the CachedResult class. More...

#include <IpCachedResults.hpp>

+ Inheritance diagram for Ipopt::DependentResult< T >:

Public Member Functions

bool DependentsIdentical (const std::vector< const TaggedObject * > &dependents, const std::vector< Number > &scalar_dependents) const
 This method returns true if the dependencies provided to this function are identical to the ones stored with the DependentResult. More...
 
void DebugPrint () const
 Print information about this DependentResults. More...
 
Constructor, Destructors
 DependentResult (const T &result, const std::vector< const TaggedObject * > &dependents, const std::vector< Number > &scalar_dependents)
 Constructor, given all information about the result. More...
 
 ~DependentResult ()
 Destructor. More...
 
Accessor method.
bool IsStale () const
 This returns true, if the DependentResult is no longer valid. More...
 
void Invalidate ()
 Invalidates the cached result. More...
 
const T & GetResult () const
 Returns the cached result. More...
 
- Public Member Functions inherited from Ipopt::Observer
 Observer ()
 Default Constructor. More...
 
virtual ~Observer ()
 Default destructor. More...
 

Protected Member Functions

virtual void RecieveNotification (NotifyType notify_type, const Subject *subject)
 This method is overloading the pure virtual method from the Observer base class. More...
 
- Protected Member Functions inherited from Ipopt::Observer
void RequestAttach (NotifyType notify_type, const Subject *subject)
 Derived classes should call this method to request an "Attach" to a Subject. More...
 
void RequestDetach (NotifyType notify_type, const Subject *subject)
 Derived classes should call this method to request a "Detach" to a Subject. More...
 

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.

 DependentResult ()
 Default Constructor. More...
 
 DependentResult (const DependentResult &)
 Copy Constructor. More...
 
void operator= (const DependentResult &)
 Overloaded Equals Operator. More...
 

Private Attributes

bool stale_
 Flag indicating, if the cached result is still valid. More...
 
const T result_
 The value of the dependent results. More...
 
std::vector< TaggedObject::Tagdependent_tags_
 Dependencies in form of TaggedObjects. More...
 
std::vector< Numberscalar_dependents_
 Dependencies in form a Numbers. More...
 

Additional Inherited Members

- Public Types inherited from Ipopt::Observer
enum  NotifyType { NT_All, NT_BeingDestroyed, NT_Changed }
 Enumeration specifying the type of notification. More...
 

Detailed Description

template<class T>
class Ipopt::DependentResult< T >

Templated class which stores one entry for the CachedResult class.

It stores the result (of type T), together with its dependencies (vector of TaggedObjects and vector of Numbers). It also stores a priority.

Definition at line 31 of file IpCachedResults.hpp.

Constructor & Destructor Documentation

template<class T>
Ipopt::DependentResult< T >::DependentResult ( const T &  result,
const std::vector< const TaggedObject * > &  dependents,
const std::vector< Number > &  scalar_dependents 
)

Constructor, given all information about the result.

Definition at line 348 of file IpCachedResults.hpp.

template<class T >
Ipopt::DependentResult< T >::~DependentResult ( )

Destructor.

Definition at line 381 of file IpCachedResults.hpp.

template<class T>
Ipopt::DependentResult< T >::DependentResult ( )
private

Default Constructor.

template<class T>
Ipopt::DependentResult< T >::DependentResult ( const DependentResult< T > &  )
private

Copy Constructor.

Member Function Documentation

template<class T >
bool Ipopt::DependentResult< T >::IsStale ( ) const

This returns true, if the DependentResult is no longer valid.

Definition at line 393 of file IpCachedResults.hpp.

template<class T >
void Ipopt::DependentResult< T >::Invalidate ( )

Invalidates the cached result.

Definition at line 399 of file IpCachedResults.hpp.

template<class T >
const T & Ipopt::DependentResult< T >::GetResult ( ) const

Returns the cached result.

Definition at line 456 of file IpCachedResults.hpp.

template<class T >
bool Ipopt::DependentResult< T >::DependentsIdentical ( const std::vector< const TaggedObject * > &  dependents,
const std::vector< Number > &  scalar_dependents 
) const

This method returns true if the dependencies provided to this function are identical to the ones stored with the DependentResult.

Definition at line 419 of file IpCachedResults.hpp.

template<class T >
void Ipopt::DependentResult< T >::DebugPrint ( ) const

Print information about this DependentResults.

Definition at line 467 of file IpCachedResults.hpp.

template<class T >
void Ipopt::DependentResult< T >::RecieveNotification ( NotifyType  notify_type,
const Subject subject 
)
protectedvirtual

This method is overloading the pure virtual method from the Observer base class.

This method is called when a Subject registered for this Observer sends a notification. In this particular case, if this method is called with notify_type==NT_Changed or NT_BeingDeleted, then this results is marked as stale.

Implements Ipopt::Observer.

Definition at line 405 of file IpCachedResults.hpp.

template<class T>
void Ipopt::DependentResult< T >::operator= ( const DependentResult< T > &  )
private

Overloaded Equals Operator.

Member Data Documentation

template<class T>
bool Ipopt::DependentResult< T >::stale_
private

Flag indicating, if the cached result is still valid.

A result becomes invalid, if the RecieveNotification method is called with NT_Changed

Definition at line 330 of file IpCachedResults.hpp.

template<class T>
const T Ipopt::DependentResult< T >::result_
private

The value of the dependent results.

Definition at line 332 of file IpCachedResults.hpp.

template<class T>
std::vector<TaggedObject::Tag> Ipopt::DependentResult< T >::dependent_tags_
private

Dependencies in form of TaggedObjects.

Definition at line 334 of file IpCachedResults.hpp.

template<class T>
std::vector<Number> Ipopt::DependentResult< T >::scalar_dependents_
private

Dependencies in form a Numbers.

Definition at line 336 of file IpCachedResults.hpp.


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