bounds.h
Go to the documentation of this file.
1 /******************************************************************************
2 Copyright (c) 2017, Alexander W Winkler. All rights reserved.
3 
4 Redistribution and use in source and binary forms, with or without
5 modification, are permitted provided that the following conditions are met:
6 
7 * Redistributions of source code must retain the above copyright notice, this
8  list of conditions and the following disclaimer.
9 
10 * Redistributions in binary form must reproduce the above copyright notice,
11  this list of conditions and the following disclaimer in the documentation
12  and/or other materials provided with the distribution.
13 
14 * Neither the name of the copyright holder nor the names of its
15  contributors may be used to endorse or promote products derived from
16  this software without specific prior written permission.
17 
18 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 ******************************************************************************/
29 
30 #ifndef IFOPT_INCLUDE_OPT_BOUNDS_H_
31 #define IFOPT_INCLUDE_OPT_BOUNDS_H_
32 
33 namespace ifopt {
34 
38 struct Bounds {
42  Bounds(double lower = 0.0, double upper = 0.0)
43  {
44  lower_ = lower;
45  upper_ = upper;
46  }
47 
48  double lower_;
49  double upper_;
50 
51  void operator+=(double scalar)
52  {
53  lower_ += scalar;
54  upper_ += scalar;
55  }
56 
57  void operator-=(double scalar)
58  {
59  lower_ -= scalar;
60  upper_ -= scalar;
61  }
62 };
63 
64 // settings this as signals infinity for IPOPT/SNOPT solvers
65 static const double inf = 1.0e20;
66 
67 static const Bounds NoBound = Bounds(-inf, +inf);
68 static const Bounds BoundZero = Bounds( 0.0, 0.0);
69 static const Bounds BoundGreaterZero = Bounds( 0.0, +inf);
70 static const Bounds BoundSmallerZero = Bounds(-inf, 0.0);
71 
72 } // namespace opt
73 
74 #endif /* IFOPT_INCLUDE_OPT_BOUNDS_H_ */
ifopt::BoundGreaterZero
static const Bounds BoundGreaterZero
Definition: bounds.h:96
ifopt::Bounds
Upper and lower bound for optimization variables and constraints.
Definition: bounds.h:65
ifopt::Bounds::Bounds
Bounds(double lower=0.0, double upper=0.0)
Creates a bound between lower and upper.
Definition: bounds.h:96
ifopt::Bounds::upper_
double upper_
Definition: bounds.h:103
ifopt::Bounds::operator-=
void operator-=(double scalar)
Definition: bounds.h:111
ifopt::Bounds::lower_
double lower_
Definition: bounds.h:102
ifopt
common namespace for all elements in this library.
Definition: bounds.h:33
ifopt::Bounds::operator+=
void operator+=(double scalar)
Definition: bounds.h:105
ifopt::BoundZero
static const Bounds BoundZero
Definition: bounds.h:95
ifopt::BoundSmallerZero
static const Bounds BoundSmallerZero
Definition: bounds.h:97
ifopt::NoBound
static const Bounds NoBound
Definition: bounds.h:94
ifopt::inf
static const double inf
Definition: bounds.h:92


ifopt
Author(s): Alexander W. Winkler
autogenerated on Thu Sep 15 2022 02:14:55