qpOASES  3.2.1
An Implementation of the Online Active Set Strategy
Options.hpp
Go to the documentation of this file.
1 /*
2  * This file is part of qpOASES.
3  *
4  * qpOASES -- An Implementation of the Online Active Set Strategy.
5  * Copyright (C) 2007-2017 by Hans Joachim Ferreau, Andreas Potschka,
6  * Christian Kirches et al. All rights reserved.
7  *
8  * qpOASES is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * qpOASES is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  * See the GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with qpOASES; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  *
22  */
23 
24 
36 #ifndef QPOASES_OPTIONS_HPP
37 #define QPOASES_OPTIONS_HPP
38 
39 
40 #include <qpOASES/Utils.hpp>
41 
42 
44 
45 
56 class Options
57 {
58  /*
59  * PUBLIC MEMBER FUNCTIONS
60  */
61  public:
63  Options( );
64 
66  Options( const Options& rhs
67  );
68 
70  ~Options( );
71 
73  Options& operator=( const Options& rhs
74  );
75 
76 
80 
84 
88 
92 
93 
101 
102 
105  returnValue print( ) const;
106 
107 
108  /*
109  * PROTECTED MEMBER FUNCTIONS
110  */
111  protected:
112 
115  returnValue copy( const Options& rhs
116  );
117 
118  /*
119  * PUBLIC MEMBER VARIABLES
120  */
121  public:
163 };
164 
165 
167 
168 
169 #endif /* QPOASES_OPTIONS_HPP */
170 
171 
172 /*
173  * end of file
174  */
MessageHandling::warningVisibility
VisibilityStatus warningVisibility
Definition: MessageHandling.hpp:429
Options::epsNZCTests
real_t epsNZCTests
Definition: Options.hpp:154
Options::initialStatusBounds
SubjectToStatus initialStatusBounds
Definition: Options.hpp:147
real_t
BEGIN_NAMESPACE_QPOASES typedef double real_t
Definition: Types.hpp:171
Options
Manages all user-specified options for solving QPs.
Definition: Options.hpp:56
Options::operator=
Options & operator=(const Options &rhs)
Definition: Options.cpp:76
Options::epsRegularisation
real_t epsRegularisation
Definition: Options.hpp:150
Options::maxPrimalJump
real_t maxPrimalJump
Definition: Options.hpp:140
MessageHandling::getWarningVisibilityStatus
VisibilityStatus getWarningVisibilityStatus() const
Definition: MessageHandling.ipp:55
Options::maxDualJump
real_t maxDualJump
Definition: Options.hpp:141
END_NAMESPACE_QPOASES
#define END_NAMESPACE_QPOASES
Definition: Types.hpp:110
BooleanType
BooleanType
Definition: Types.hpp:203
Options::print
returnValue print() const
Definition: Options.cpp:375
MessageHandling::outputFile
FILE * outputFile
Definition: MessageHandling.hpp:432
MessageHandling::setInfoVisibilityStatus
void setInfoVisibilityStatus(VisibilityStatus _infoVisibility)
Definition: MessageHandling.ipp:109
BEGIN_NAMESPACE_QPOASES
#define BEGIN_NAMESPACE_QPOASES
Definition: Types.hpp:107
Options::enableDriftCorrection
int_t enableDriftCorrection
Definition: Options.hpp:130
Options::boundTolerance
real_t boundTolerance
Definition: Options.hpp:135
MessageHandling::infoVisibility
VisibilityStatus infoVisibility
Definition: MessageHandling.hpp:430
MessageHandling::getErrorCount
int_t getErrorCount() const
Definition: MessageHandling.ipp:82
Options::epsNum
real_t epsNum
Definition: Options.hpp:138
Options::ensureConsistency
returnValue ensureConsistency()
Definition: Options.cpp:234
Options::copy
returnValue copy(const Options &rhs)
Definition: Options.cpp:510
MessageHandling::getOutputFile
FILE * getOutputFile() const
Definition: MessageHandling.ipp:73
Options::enableFlippingBounds
BooleanType enableFlippingBounds
Definition: Options.hpp:126
Options::numRegularisationSteps
int_t numRegularisationSteps
Definition: Options.hpp:149
Options::printLevel
PrintLevel printLevel
Definition: Options.hpp:122
Options::~Options
~Options()
Definition: Options.cpp:68
Options::epsLITests
real_t epsLITests
Definition: Options.hpp:153
Options::initialRamping
real_t initialRamping
Definition: Options.hpp:143
Options::growFarBounds
real_t growFarBounds
Definition: Options.hpp:146
Options::epsFlipping
real_t epsFlipping
Definition: Options.hpp:148
MessageHandling::errorCount
int_t errorCount
Definition: MessageHandling.hpp:434
SubjectToStatus
SubjectToStatus
Definition: Types.hpp:272
returnValue
returnValue
Defines all symbols for global return values.
Definition: MessageHandling.hpp:64
Options::dropIneqConPriority
int_t dropIneqConPriority
Definition: Options.hpp:162
Options::enableNZCTests
BooleanType enableNZCTests
Definition: Options.hpp:129
Options::setToMPC
returnValue setToMPC()
Definition: Options.cpp:191
Options::enableFullLITests
BooleanType enableFullLITests
Definition: Options.hpp:128
MessageHandling::setErrorCount
returnValue setErrorCount(int_t _errorCount)
Definition: MessageHandling.ipp:127
Utils.hpp
Options::setToFast
returnValue setToFast()
Definition: Options.cpp:224
Options::enableEqualities
BooleanType enableEqualities
Definition: Options.hpp:132
Options::boundRelaxation
real_t boundRelaxation
Definition: Options.hpp:137
RET_INVALID_ARGUMENTS
@ RET_INVALID_ARGUMENTS
Definition: MessageHandling.hpp:71
Options::Options
Options()
Definition: Options.cpp:50
Options::setToDefault
returnValue setToDefault()
Definition: Options.cpp:91
Options::enableRamping
BooleanType enableRamping
Definition: Options.hpp:124
Options::enableInertiaCorrection
BooleanType enableInertiaCorrection
Definition: Options.hpp:157
Options::rcondSMin
real_t rcondSMin
Definition: Options.hpp:156
MessageHandling::setWarningVisibilityStatus
void setWarningVisibilityStatus(VisibilityStatus _warningVisibility)
Definition: MessageHandling.ipp:100
SUCCESSFUL_RETURN
@ SUCCESSFUL_RETURN
Definition: MessageHandling.hpp:68
MessageHandling::errorVisibility
VisibilityStatus errorVisibility
Definition: MessageHandling.hpp:428
Options::epsIterRef
real_t epsIterRef
Definition: Options.hpp:152
Options::dropBoundPriority
int_t dropBoundPriority
Definition: Options.hpp:160
MessageHandling::setOutputFile
void setOutputFile(FILE *_outputFile)
Definition: MessageHandling.ipp:118
Options::initialFarBounds
real_t initialFarBounds
Definition: Options.hpp:145
Options::enableRegularisation
BooleanType enableRegularisation
Definition: Options.hpp:127
Options::terminationTolerance
real_t terminationTolerance
Definition: Options.hpp:134
Options::setToReliable
returnValue setToReliable()
Definition: Options.cpp:171
Options::finalRamping
real_t finalRamping
Definition: Options.hpp:144
Options::epsDen
real_t epsDen
Definition: Options.hpp:139
MessageHandling::getInfoVisibilityStatus
VisibilityStatus getInfoVisibilityStatus() const
Definition: MessageHandling.ipp:64
Options::enableCholeskyRefactorisation
int_t enableCholeskyRefactorisation
Definition: Options.hpp:131
Options::enableFarBounds
BooleanType enableFarBounds
Definition: Options.hpp:125
PrintLevel
PrintLevel
Definition: Types.hpp:212
Options::enableDropInfeasibles
BooleanType enableDropInfeasibles
Definition: Options.hpp:159
MessageHandling::setErrorVisibilityStatus
void setErrorVisibilityStatus(VisibilityStatus _errorVisibility)
Definition: MessageHandling.ipp:91
MessageHandling::getErrorVisibilityStatus
VisibilityStatus getErrorVisibilityStatus() const
Definition: MessageHandling.ipp:46
VisibilityStatus
VisibilityStatus
Definition: Types.hpp:224
Options::dropEqConPriority
int_t dropEqConPriority
Definition: Options.hpp:161
int_t
int int_t
Definition: Types.hpp:180
Options::numRefinementSteps
int_t numRefinementSteps
Definition: Options.hpp:151