Performance index of optimal control problems. More...

#include <performance_index.hpp>

Public Member Functions
PerformanceIndex &	operator+= (const PerformanceIndex &other)
	Overload the operator. More...

PerformanceIndex	operator+ (const PerformanceIndex &other) const
	Overload the operator. More...

void	setZero ()
	Sets the all member variables zero. More...

bool	isApprox (const PerformanceIndex &other) const
	Checks the equivalence of two PerformanceIndex. More...

void	disp (std::ostream &os) const
	Displays the performance index onto a ostream. More...

Public Attributes
double	cost = 0.0
	Cost value. More...

double	cost_barrier = 0.0
	Cost value of slack barrier function. More...

double	primal_feasibility = 0.0
	Primal feasiblity. More...

double	dual_feasibility = 0.0
	Dual feasiblity. More...

double	kkt_error = 0.0
	KKT error. More...

Friends
std::ostream &	operator<< (std::ostream &os, const PerformanceIndex &kkt_residual)

Detailed Description

Performance index of optimal control problems.

Member Function Documentation

◆ disp()

void robotoc::PerformanceIndex::disp ( std::ostream & os ) const

Displays the performance index onto a ostream.

◆ isApprox()

bool robotoc::PerformanceIndex::isApprox ( const PerformanceIndex & other ) const

Checks the equivalence of two PerformanceIndex.

Parameters

[in] other Other object.

Returns: true if this and other is same. false otherwise.

◆ operator+()

PerformanceIndex robotoc::PerformanceIndex::operator+ ( const PerformanceIndex & other ) const

Overload the operator.

◆ operator+=()

PerformanceIndex & robotoc::PerformanceIndex::operator+= ( const PerformanceIndex & other )

Overload the operator.

◆ setZero()

void robotoc::PerformanceIndex::setZero ( )

Sets the all member variables zero.

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const PerformanceIndex &	kkt_residual
	)

friend

Member Data Documentation

◆ cost

double robotoc::PerformanceIndex::cost = 0.0

Cost value.

◆ cost_barrier

double robotoc::PerformanceIndex::cost_barrier = 0.0

Cost value of slack barrier function.

◆ dual_feasibility

double robotoc::PerformanceIndex::dual_feasibility = 0.0

Dual feasiblity.

◆ kkt_error

double robotoc::PerformanceIndex::kkt_error = 0.0

KKT error.

◆ primal_feasibility

double robotoc::PerformanceIndex::primal_feasibility = 0.0

Primal feasiblity.

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

/github/workspace/include/robotoc/core/performance_index.hpp

Public Member Functions

Public Attributes

Friends