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
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* 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 unitvector.h
* @brief Sparse vector \f$e_i\f$.
*/
#ifndef _UNITVECTORBASE_H_
#define _UNITVECTORBASE_H_
#include <assert.h>
#include "soplex/spxdefines.h"
#include "soplex/svectorbase.h"
namespace soplex
{
/**@brief Sparse vector \f$e_i\f$.
@ingroup Algebra
A UnitVectorBase is an SVectorBase that can take only one nonzero value with
value 1 but arbitrary index.
\todo Several SVectorBase modification methods are still accessible for UnitVector.
They might be used to change the vector.
\todo UnitVectorBase memory management must be changed when SVectorBase is redesigned.
*/
template < class R >
class UnitVectorBase : public SVectorBase<R>
{
private:
//------------------------------------
/**@name Data */
///@{
typename SVectorBase<R>::Element themem; ///< memory for sparse vector entry
///@}
using SVectorBase<R>::mem;
using SVectorBase<R>::size;
using SVectorBase<R>::max;
public:
//------------------------------------
/**@name Access */
///@{
/// returns value = 1
/**\pre \c n must be 0.
*/
/* ARGSUSED n */
R value(int n) const
{
assert(n == 0);
return 1;
}
///@}
//------------------------------------
/**@name Constructors / destructors */
///@{
/// construct \c i 'th unit vector.
explicit
UnitVectorBase<R>(int i = 0)
: SVectorBase<R>(1, &themem)
{
// coverity[callee_ptr_arith]
SVectorBase<R>::add(i, 1.0);
assert(isConsistent());
}
/// copy constructor
UnitVectorBase<R>(const UnitVectorBase<R>& rhs)
: SVectorBase<R>(1, &themem)
{
themem = rhs.themem;
this->set_size(1);
assert(isConsistent());
}
/// assignment
UnitVectorBase<R>& operator=(const UnitVectorBase<R>& rhs)
{
if(this != &rhs)
{
themem = rhs.themem;
this->set_size(1);
assert(isConsistent());
}
return *this;
}
/// destructor
~UnitVectorBase<R>()
{}
///@}
//------------------------------------
/**@name Miscellaneous */
///@{
/// consistency check
bool isConsistent() const
{
#ifdef ENABLE_CONSISTENCY_CHECKS
if(mem() != &themem)
return MSGinconsistent("UnitVectorBase");
if(size() != 1)
return MSGinconsistent("UnitVectorBase");
if(max() != 1)
return MSGinconsistent("UnitVectorBase");
return SVectorBase<R>::isConsistent();
#else
return true;
#endif
}
///@}
};
} // namespace soplex
#endif // _UNITVECTORBASE_H_