MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
MoochoPack::TangentialStepWithInequStd_Step Class Reference

Solves the reduced QP subproblem with bounds and/or general inequalities. More...

#include <MoochoPack_TangentialStepWithInequStd_Step.hpp>

Inheritance diagram for MoochoPack::TangentialStepWithInequStd_Step:
Inheritance graph
[legend]

Public Types

enum  EQPTesting
 

Public Member Functions

 STANDARD_COMPOSITION_MEMBERS (QPSolverRelaxed, qp_solver)
 QP solver. More...
 
 STANDARD_COMPOSITION_MEMBERS (QPSolverRelaxedTester, qp_tester)
 QP solver tester. More...
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (value_type, warm_start_frac)
 Set the ratio of the number of inequality constraints in the active-set of the last two calls before a warm start is attempted. More...
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (EQPTesting, qp_testing)
 Set how and if the QP solution is tested. More...
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, primal_feasible_point_error)
 Determine if a QPFailure exception is thrown if the QP solver returns PRIMAL_FEASIBLE_POINT. More...
 
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, dual_feasible_point_error)
 Determine if a QPFailure exception is thrown if the QP solver returns DUAl_FEASIBLE_POINT. More...
 
 TangentialStepWithInequStd_Step (const qp_solver_ptr_t &qp_solver, const qp_tester_ptr_t &qp_tester, value_type warm_start_frac=0.8, EQPTesting qp_testing=QP_TEST_DEFAULT, bool primal_feasible_point_error=true, bool dual_feasible_point_error=true)
 Construct and initialize. More...
 

Overridden from AlgorithmStep

bool do_step (Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
 
void print_step (const Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss, std::ostream &out, const std::string &leading_str) const
 

Detailed Description

Solves the reduced QP subproblem with bounds and/or general inequalities.

ToDo: Finish documentation.

Definition at line 63 of file MoochoPack_TangentialStepWithInequStd_Step.hpp.

Member Enumeration Documentation

Constructor & Destructor Documentation

MoochoPack::TangentialStepWithInequStd_Step::TangentialStepWithInequStd_Step ( const qp_solver_ptr_t &  qp_solver,
const qp_tester_ptr_t &  qp_tester,
value_type  warm_start_frac = 0.8,
EQPTesting  qp_testing = QP_TEST_DEFAULT,
bool  primal_feasible_point_error = true,
bool  dual_feasible_point_error = true 
)

Construct and initialize.

Definition at line 69 of file MoochoPack_TangentialStepWithInequStd_Step.cpp.

Member Function Documentation

MoochoPack::TangentialStepWithInequStd_Step::STANDARD_COMPOSITION_MEMBERS ( QPSolverRelaxed  ,
qp_solver   
)

QP solver.

MoochoPack::TangentialStepWithInequStd_Step::STANDARD_COMPOSITION_MEMBERS ( QPSolverRelaxedTester  ,
qp_tester   
)

QP solver tester.

MoochoPack::TangentialStepWithInequStd_Step::STANDARD_MEMBER_COMPOSITION_MEMBERS ( value_type  ,
warm_start_frac   
)

Set the ratio of the number of inequality constraints in the active-set of the last two calls before a warm start is attempted.

MoochoPack::TangentialStepWithInequStd_Step::STANDARD_MEMBER_COMPOSITION_MEMBERS ( EQPTesting  ,
qp_testing   
)

Set how and if the QP solution is tested.

ToDo: Finish documentation.

MoochoPack::TangentialStepWithInequStd_Step::STANDARD_MEMBER_COMPOSITION_MEMBERS ( bool  ,
primal_feasible_point_error   
)

Determine if a QPFailure exception is thrown if the QP solver returns PRIMAL_FEASIBLE_POINT.

MoochoPack::TangentialStepWithInequStd_Step::STANDARD_MEMBER_COMPOSITION_MEMBERS ( bool  ,
dual_feasible_point_error   
)

Determine if a QPFailure exception is thrown if the QP solver returns DUAl_FEASIBLE_POINT.

bool MoochoPack::TangentialStepWithInequStd_Step::do_step ( Algorithm algo,
poss_type  step_poss,
IterationPack::EDoStepType  type,
poss_type  assoc_step_poss 
)
void MoochoPack::TangentialStepWithInequStd_Step::print_step ( const Algorithm algo,
poss_type  step_poss,
IterationPack::EDoStepType  type,
poss_type  assoc_step_poss,
std::ostream &  out,
const std::string &  leading_str 
) const

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