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  */
#define BEGIN_NAMESPACE_QPOASES
Definition: Types.hpp:107
real_t initialFarBounds
Definition: Options.hpp:145
int_t dropEqConPriority
Definition: Options.hpp:161
#define END_NAMESPACE_QPOASES
Definition: Types.hpp:110
Options()
Definition: Options.cpp:50
int_t enableDriftCorrection
Definition: Options.hpp:130
~Options()
Definition: Options.cpp:68
real_t epsDen
Definition: Options.hpp:139
BooleanType enableInertiaCorrection
Definition: Options.hpp:157
returnValue setToDefault()
Definition: Options.cpp:91
int int_t
Definition: Types.hpp:180
BooleanType enableFarBounds
Definition: Options.hpp:125
real_t epsLITests
Definition: Options.hpp:153
real_t epsFlipping
Definition: Options.hpp:148
returnValue copy(const Options &rhs)
Definition: Options.cpp:510
int_t numRegularisationSteps
Definition: Options.hpp:149
BooleanType enableFullLITests
Definition: Options.hpp:128
real_t boundRelaxation
Definition: Options.hpp:137
BooleanType enableEqualities
Definition: Options.hpp:132
SubjectToStatus
Definition: Types.hpp:272
BooleanType enableRamping
Definition: Options.hpp:124
real_t initialRamping
Definition: Options.hpp:143
real_t epsRegularisation
Definition: Options.hpp:150
real_t maxDualJump
Definition: Options.hpp:141
BooleanType enableFlippingBounds
Definition: Options.hpp:126
returnValue setToFast()
Definition: Options.cpp:224
real_t epsNum
Definition: Options.hpp:138
PrintLevel printLevel
Definition: Options.hpp:122
int_t numRefinementSteps
Definition: Options.hpp:151
Manages all user-specified options for solving QPs.
Definition: Options.hpp:56
int_t dropIneqConPriority
Definition: Options.hpp:162
Options & operator=(const Options &rhs)
Definition: Options.cpp:76
int_t enableCholeskyRefactorisation
Definition: Options.hpp:131
returnValue
Defines all symbols for global return values.
Definition: MessageHandling.hpp:64
int_t dropBoundPriority
Definition: Options.hpp:160
BooleanType enableRegularisation
Definition: Options.hpp:127
real_t boundTolerance
Definition: Options.hpp:135
real_t terminationTolerance
Definition: Options.hpp:134
real_t epsIterRef
Definition: Options.hpp:152
returnValue setToMPC()
Definition: Options.cpp:191
BooleanType enableNZCTests
Definition: Options.hpp:129
returnValue print() const
Definition: Options.cpp:375
PrintLevel
Definition: Types.hpp:212
returnValue setToReliable()
Definition: Options.cpp:171
real_t epsNZCTests
Definition: Options.hpp:154
real_t finalRamping
Definition: Options.hpp:144
real_t rcondSMin
Definition: Options.hpp:156
real_t growFarBounds
Definition: Options.hpp:146
SubjectToStatus initialStatusBounds
Definition: Options.hpp:147
BooleanType
Definition: Types.hpp:203
BooleanType enableDropInfeasibles
Definition: Options.hpp:159
BEGIN_NAMESPACE_QPOASES typedef double real_t
Definition: Types.hpp:171
real_t maxPrimalJump
Definition: Options.hpp:140
returnValue ensureConsistency()
Definition: Options.cpp:234