roboptim::ResultAnalyzer< T >::QueryData Struct Reference

Interface for checks. More...

#include <roboptim/core/result-analyzer.hh>

Inheritance diagram for roboptim::ResultAnalyzer< T >::QueryData:

Public Member Functions
bool	operator_bool () const
	Evaluate the query. More...
virtual bool	isValid () const =0
	Whether the input data is valid w.r.t. that query. More...
virtual std::ostream &	print (std::ostream &o) const =0
	Print method. More...

Friends
std::ostream &	operator<< (std::ostream &o, const QueryData &d)
	Override operator<< to display data. More...

Detailed Description

template<typename T>
struct roboptim::ResultAnalyzer< T >::QueryData

Interface for checks.

Note: we use the safe-bool idiom, which is deprecated in C++11.

Member Function Documentation

template<typename T>

virtual bool roboptim::ResultAnalyzer< T >::QueryData::isValid ( ) const

pure virtual

Whether the input data is valid w.r.t. that query.

Implemented in roboptim::ResultAnalyzer< T >::NullGradientData, roboptim::ResultAnalyzer< T >::KKTData, and roboptim::ResultAnalyzer< T >::LICQData.

Referenced by roboptim::ResultAnalyzer< T >::QueryData::operator_bool().

template<typename T >

bool roboptim::ResultAnalyzer< T >::QueryData::operator_bool

(

)

const

Evaluate the query.

References roboptim::ResultAnalyzer< T >::QueryData::isValid().

template<typename T>

virtual std::ostream& roboptim::ResultAnalyzer< T >::QueryData::print ( std::ostream &  o ) const

pure virtual

Print method.

Implemented in roboptim::ResultAnalyzer< T >::NullGradientData, roboptim::ResultAnalyzer< T >::KKTData, and roboptim::ResultAnalyzer< T >::LICQData.

Friends And Related Function Documentation

template<typename T>

std::ostream& operator<< ( std::ostream &  o, const QueryData &  d  )

friend

Override operator<< to display data.

Parameters

o	output stream.
d	data.

Returns

output stream.