MOOCHO (Single Doxygen Collection) Version of the Day
Public Types | Public Member Functions | Private Attributes
ConstrainedOptPack::QPSolverStats Class Reference

Class for storing statistics about a run of a (active set?) QP solver. More...

#include <ConstrainedOptPack_QPSolverStats.hpp>

List of all members.

Public Types

enum  { NOT_KNOWN = -1 }
 Set to this value if a statistic is not known. More...
enum  ESolutionType {
  SOLUTION_TYPE_NOT_KNOWN = static_cast<int>(NOT_KNOWN), OPTIMAL_SOLUTION = 0, PRIMAL_FEASIBLE_POINT = 1, DUAL_FEASIBLE_POINT = 2,
  SUBOPTIMAL_POINT = 3
}
 Enumeration for the type of point returned from solve_qp(...). More...
enum  EConvexity { CONVEXITY_NOT_KNOWN = static_cast<int>(NOT_KNOWN), CONVEX = 0, NONCONVEX = 1 }
 Enumeration for the type of projected QP on output. More...

Public Member Functions

 QPSolverStats ()
 Construct all unknowns.
void set_stats (ESolutionType solution_type, EConvexity convexity, int num_qp_iter, int num_adds, int num_drops, bool warm_start, bool infeasible_qp)
 Initialize the statistics.
ESolutionType solution_type () const
 
EConvexity convexity () const
 
int num_qp_iter () const
 
int num_adds () const
 
int num_drop () const
 
int warm_start () const
 
int infeasible_qp () const
 

Private Attributes

ESolutionType solution_type_
EConvexity convexity_
int num_qp_iter_
int num_adds_
int num_drops_
bool warm_start_
bool infeasible_qp_

Detailed Description

Class for storing statistics about a run of a (active set?) QP solver.

Definition at line 38 of file ConstrainedOptPack_QPSolverStats.hpp.


Member Enumeration Documentation

anonymous enum

Set to this value if a statistic is not known.

Enumerator:
NOT_KNOWN 

Definition at line 44 of file ConstrainedOptPack_QPSolverStats.hpp.

Enumeration for the type of point returned from solve_qp(...).

Enumerator:
SOLUTION_TYPE_NOT_KNOWN 
OPTIMAL_SOLUTION 
PRIMAL_FEASIBLE_POINT 
DUAL_FEASIBLE_POINT 
SUBOPTIMAL_POINT 

Definition at line 47 of file ConstrainedOptPack_QPSolverStats.hpp.

Enumeration for the type of projected QP on output.

Enumerator:
CONVEXITY_NOT_KNOWN 
CONVEX 
NONCONVEX 

Definition at line 55 of file ConstrainedOptPack_QPSolverStats.hpp.


Constructor & Destructor Documentation

ConstrainedOptPack::QPSolverStats::QPSolverStats ( ) [inline]

Construct all unknowns.

Definition at line 64 of file ConstrainedOptPack_QPSolverStats.hpp.


Member Function Documentation

void ConstrainedOptPack::QPSolverStats::set_stats ( ESolutionType  solution_type,
EConvexity  convexity,
int  num_qp_iter,
int  num_adds,
int  num_drops,
bool  warm_start,
bool  infeasible_qp 
) [inline]

Initialize the statistics.

Definition at line 72 of file ConstrainedOptPack_QPSolverStats.hpp.

ESolutionType ConstrainedOptPack::QPSolverStats::solution_type ( ) const [inline]

Definition at line 86 of file ConstrainedOptPack_QPSolverStats.hpp.

EConvexity ConstrainedOptPack::QPSolverStats::convexity ( ) const [inline]

Definition at line 91 of file ConstrainedOptPack_QPSolverStats.hpp.

int ConstrainedOptPack::QPSolverStats::num_qp_iter ( ) const [inline]

Definition at line 96 of file ConstrainedOptPack_QPSolverStats.hpp.

int ConstrainedOptPack::QPSolverStats::num_adds ( ) const [inline]

Definition at line 101 of file ConstrainedOptPack_QPSolverStats.hpp.

int ConstrainedOptPack::QPSolverStats::num_drop ( ) const [inline]

Definition at line 106 of file ConstrainedOptPack_QPSolverStats.hpp.

int ConstrainedOptPack::QPSolverStats::warm_start ( ) const [inline]

Definition at line 111 of file ConstrainedOptPack_QPSolverStats.hpp.

int ConstrainedOptPack::QPSolverStats::infeasible_qp ( ) const [inline]

Definition at line 116 of file ConstrainedOptPack_QPSolverStats.hpp.


Member Data Documentation

Definition at line 122 of file ConstrainedOptPack_QPSolverStats.hpp.

Definition at line 123 of file ConstrainedOptPack_QPSolverStats.hpp.

Definition at line 124 of file ConstrainedOptPack_QPSolverStats.hpp.

Definition at line 125 of file ConstrainedOptPack_QPSolverStats.hpp.

Definition at line 126 of file ConstrainedOptPack_QPSolverStats.hpp.

Definition at line 127 of file ConstrainedOptPack_QPSolverStats.hpp.

Definition at line 128 of file ConstrainedOptPack_QPSolverStats.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines