GVector.hpp
11.4 KB
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
/***************************************************************************
* GVector.hpp - Vector class *
* ----------------------------------------------------------------------- *
* copyright (C) 2006-2014 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GVector.hpp
* @brief Vector class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GVECTOR_HPP
#define GVECTOR_HPP
/* __ Includes ___________________________________________________________ */
#include <cmath>
#include <string>
#include "GBase.hpp"
#include "GException.hpp"
/***********************************************************************//**
* @class GVector
*
* @brief Vector class
*
* This class implement a double precision floating point vector class that
* is intended to be used for numerical computation (it is not meant to
* replace the std::vector template class).
***************************************************************************/
class GVector : public GBase {
// Friend functions
friend GVector cross(const GVector& a, const GVector& b);
friend double operator*(const GVector& a, const GVector& b);
friend double norm(const GVector& vector);
friend double min(const GVector& vector);
friend double max(const GVector& vector);
friend double sum(const GVector& vector);
friend GVector perm(const GVector& vector, const int *p);
friend GVector iperm(const GVector& vector, const int *p);
friend GVector acos(const GVector& vector);
friend GVector acosh(const GVector& vector);
friend GVector asin(const GVector& vector);
friend GVector asinh(const GVector& vector);
friend GVector atan(const GVector& vector);
friend GVector atanh(const GVector& vector);
friend GVector cos(const GVector& vector);
friend GVector cosh(const GVector& vector);
friend GVector exp(const GVector& vector);
friend GVector abs(const GVector& vector);
friend GVector log(const GVector& vector);
friend GVector log10(const GVector& vector);
friend GVector sin(const GVector& vector);
friend GVector sinh(const GVector& vector);
friend GVector sqrt(const GVector& vector);
friend GVector tan(const GVector& vector);
friend GVector tanh(const GVector& vector);
friend GVector pow(const GVector& vector, const double& power);
public:
// Constructors and destructors
GVector(void);
explicit GVector(const int& num);
explicit GVector(const double& a);
explicit GVector(const double& a, const double& b);
explicit GVector(const double& a, const double& b, const double& c);
GVector(const GVector& vector);
virtual ~GVector(void);
// Vector element access operators
double& operator[](const int& index);
const double& operator[](const int& index) const;
// Vector operators
bool operator==(const GVector& vector) const;
bool operator!=(const GVector& vector) const;
GVector& operator=(const GVector& vector);
GVector& operator+=(const GVector& vector);
GVector& operator-=(const GVector& vector);
GVector& operator=(const double& scalar);
GVector& operator+=(const double& scalar);
GVector& operator-=(const double& scalar);
GVector& operator*=(const double& scalar);
GVector& operator/=(const double& scalar);
GVector operator-(void) const;
// Vector methods
void clear(void);
GVector* clone(void) const;
std::string classname(void) const;
const int& size(void) const;
double& at(const int& index);
const double& at(const int& index) const;
int non_zeros(void) const;
int first_nonzero(void) const;
int last_nonzero(void) const;
GVector slice(const int& start, const int& stop) const;
std::string print(const GChatter& chatter = NORMAL) const;
private:
// Private methods
void init_members(void);
void alloc_members(void);
void copy_members(const GVector& vector);
void free_members(void);
// Private data area
int m_num; //!< Number of elements in vector
double* m_data; //!< Vector array
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GVector").
***************************************************************************/
inline
std::string GVector::classname(void) const
{
return ("GVector");
}
/***********************************************************************//**
* @brief Vector element access operator
*
* @param[in] index Element index [0,...,size()-1]
* @return Reference to vector element.
***************************************************************************/
inline
double& GVector::operator[](const int& index)
{
// Return vector element
return m_data[index];
}
/***********************************************************************//**
* @brief Vector element access operator (const variant)
*
* @param[in] index Element index [0,...,size()-1]
* @return Reference to vector element.
***************************************************************************/
inline
const double& GVector::operator[](const int& index) const
{
// Return vector element
return m_data[index];
}
/***********************************************************************//**
* @brief Return size of vector
*
* @return Size of vector
*
* Returns the number of elements in the vector.
***************************************************************************/
inline
const int& GVector::size() const
{
return m_num;
}
/***********************************************************************//**
* @brief Add two vectors
*
* @param[in] a Vector.
* @param[in] b Vector.
* @return Sum of vectors @p a and @p b.
*
* Returns the sum of vectors @p a and @p b.
***************************************************************************/
inline
GVector operator+(const GVector& a, const GVector& b)
{
GVector result = a;
result += b;
return result;
}
/***********************************************************************//**
* @brief Add scalar to vector
*
* @param[in] vector Vector.
* @param[in] scalar Scalar.
* @return Vector with @p scalar added to all elements.
*
* Returns a vector for which the @p scalar has been added to all elements.
***************************************************************************/
inline
GVector operator+(const GVector& vector, const double& scalar)
{
GVector result = vector;
result += scalar;
return result;
}
/***********************************************************************//**
* @brief Add scalar to vector
*
* @param[in] scalar Scalar.
* @param[in] vector Vector.
* @return Vector with @p scalar added to all elements.
*
* Returns a vector for which the @p scalar has been added to all elements.
***************************************************************************/
inline
GVector operator+(const double& scalar, const GVector& vector)
{
GVector result = vector;
result += scalar;
return result;
}
/***********************************************************************//**
* @brief Subtract vector from vector
*
* @param[in] a Vector.
* @param[in] b Vector.
* @return Difference between vector @p a and @p b.
*
* Returns the difference between vector @p a and @p b.
***************************************************************************/
inline
GVector operator- (const GVector& a, const GVector& b)
{
GVector result = a;
result -= b;
return result;
}
/***********************************************************************//**
* @brief Subtract scalar from vector
*
* @param[in] vector Vector.
* @param[in] scalar Scalar.
* @return Vector with @p scalar subtracted from all elements.
*
* Returns a vector for which the @p scalar has been subtracted from all
* elements.
***************************************************************************/
inline
GVector operator-(const GVector& vector, const double& scalar)
{
GVector result = vector;
result -= scalar;
return result;
}
/***********************************************************************//**
* @brief Subtract vector from scalar
*
* @param[in] scalar Scalar.
* @param[in] vector Vector.
* @return Vector with all elements subtracted from @p scalar.
*
* Returns a vector for which all elements have been subtracted from the
* @p scalar.
***************************************************************************/
inline
GVector operator-(const double& scalar, const GVector& vector)
{
GVector result = -vector;
result += scalar;
return result;
}
/***********************************************************************//**
* @brief Multiply vector by scalar
*
* @param[in] vector Vector.
* @param[in] scalar Scalar.
* @return Vector for which all elements have be multiplied by @p scalar.
*
* Returns a vector for which all elements have be multiplied by @p scalar.
***************************************************************************/
inline
GVector operator*(const GVector& vector, const double& scalar)
{
GVector result = vector;
result *= scalar;
return result;
}
/***********************************************************************//**
* @brief Multiply vector by scalar
*
* @param[in] scalar Scalar.
* @param[in] vector Vector.
* @return Vector for which all elements have be multiplied by @p scalar.
*
* Returns a vector for which all elements have be multiplied by @p scalar.
***************************************************************************/
inline
GVector operator*(const double& scalar, const GVector& vector)
{
GVector result = vector;
result *= scalar;
return result;
}
/***********************************************************************//**
* @brief Divide vector by scalar
*
* @param[in] vector Vector.
* @param[in] scalar Scalar.
* @return Vector for which all elements have be divided by @p scalar.
*
* Returns a vector for which all elements have be divided by @p scalar.
***************************************************************************/
inline
GVector operator/(const GVector& vector, const double& scalar)
{
GVector result = vector;
result /= scalar;
return result;
}
#endif /* GVECTOR_HPP */