1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* This file is part of the class library */
/* SoPlex --- the Sequential object-oriented simPlex. */
/* */
/* Copyright 1996-2022 Zuse Institute Berlin */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* */
/* You should have received a copy of the Apache-2.0 license */
/* along with SoPlex; see the file LICENSE. If not email to soplex@zib.de. */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**@file lpcolbase.h
* @brief LP column.
*/
#ifndef _LPCOLBASE_H_
#define _LPCOLBASE_H_
#include <assert.h>
#include "soplex/spxdefines.h"
#include "soplex/basevectors.h"
namespace soplex
{
/**@brief LP column.
* @ingroup Algo
*
* Class LPColBase provides a datatype for storing the column of an LP a the form similar to
* \f[
* \begin{array}{rl}
* \hbox{max} & c^T x \\
* \hbox{s.t.} & Ax \le b \\
* & l \le x \le u
* \end{array}
* \f]
* Hence, an LPColBase consists of an objective value, a column DSVector and an upper and lower bound to the corresponding
* variable, which may include \f$\pm\infty\f$. However, it depends on the LP code to use, what values are actually
* treated as \f$\infty\f$.
*/
template < class R >
class LPColBase
{
template < class S > friend class LPColBase;
private:
// ------------------------------------------------------------------------------------------------------------------
/**@name Data */
///@{
R up; ///< upper bound
R low; ///< lower bound
R object; ///< objective value
DSVectorBase<R> vec; ///< the column vector
///@}
public:
// ------------------------------------------------------------------------------------------------------------------
/**@name Construction / destruction */
///@{
/// Default constructor.
/** Construct LPColBase with a column vector ready for taking \p defDim nonzeros.
*/
explicit LPColBase<R>(int defDim = 0)
: up(R(infinity)), low(0), object(0), vec(defDim)
{
assert(isConsistent());
}
/// Initializing constructor.
/* Construct LPColBase with the given objective value \p obj, a column %vector \p vec, upper bound \p upper and
* lower bound \p lower.
*/
LPColBase<R>(const R& p_obj, const SVectorBase<R>& p_vector, const R& p_upper, const R& p_lower)
: up(p_upper), low(p_lower), object(p_obj), vec(p_vector)
{
assert(isConsistent());
}
/// Assignment operator.
LPColBase<R>& operator=(const LPColBase<R>& old)
{
if(this != &old)
{
up = old.up;
low = old.low;
object = old.object;
vec = old.vec;
}
assert(isConsistent());
}
/// Copy constructor.
LPColBase<R>(const LPColBase<R>& old)
: up(old.up), low(old.low), object(old.object), vec(old.vec)
{
assert(isConsistent());
}
/// Copy constructor.
template < class S >
LPColBase<R>(const LPColBase<S>& old)
: up(old.up), low(old.low), object(old.object), vec(old.vec)
{
assert(isConsistent());
}
/// Destructor.
~LPColBase()
{}
///@}
// ------------------------------------------------------------------------------------------------------------------
/**@name Access / modification */
///@{
/// Gets objective value.
R obj() const
{
return object;
}
/// Sets objective value.
void setObj(const R& p_object)
{
object = p_object;
}
/// Gets upper bound.
R upper() const
{
return up;
}
/// Sets upper bound.
void setUpper(const R& p_up)
{
up = p_up;
}
/// Gets lower bound.
R lower() const
{
return low;
}
/// Sets lower bound.
void setLower(const R& p_low)
{
low = p_low;
}
/// Gets constraint column vector.
const SVectorBase<R>& colVector() const
{
return vec;
}
/// Sets constraint column vector.
void setColVector(const SVectorBase<R>& p_vec)
{
vec = p_vec;
}
///@}
// ------------------------------------------------------------------------------------------------------------------
/**@name Consistency check */
///@{
/// Checks consistency.
bool isConsistent() const
{
#ifdef ENABLE_CONSISTENCY_CHECKS
return vec.isConsistent();
#else
return true;
#endif
}
///@}
};
} // namespace soplex
#endif // _LPCOLBASE_H_