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
350
351
|
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2024, Paul Elder <paul.elder@ideasonboard.com>
*
* Vector and related operations
*/
#include "vector.h"
#include <libcamera/base/log.h>
/**
* \file vector.h
* \brief Vector class
*/
namespace libcamera {
LOG_DEFINE_CATEGORY(Vector)
namespace ipa {
/**
* \class Vector
* \brief Vector class
* \tparam T Type of numerical values to be stored in the vector
* \tparam Rows Number of dimension of the vector (= number of elements)
*/
/**
* \fn Vector::Vector()
* \brief Construct an uninitialized vector
*/
/**
* \fn Vector::Vector(T scalar)
* \brief Construct a vector filled with a \a scalar value
* \param[in] scalar The scalar value
*/
/**
* \fn Vector::Vector(const std::array<T, Rows> &data)
* \brief Construct vector from supplied data
* \param data Data from which to construct a vector
*
* The size of \a data must be equal to the dimension size Rows of the vector.
*/
/**
* \fn T Vector::operator[](size_t i) const
* \brief Index to an element in the vector
* \param i Index of element to retrieve
* \return Element at index \a i from the vector
*/
/**
* \fn T &Vector::operator[](size_t i)
* \copydoc Vector::operator[](size_t i) const
*/
/**
* \fn Vector::operator-() const
* \brief Negate a Vector by negating both all of its coordinates
* \return The negated vector
*/
/**
* \fn Vector::operator+(Vector const &other) const
* \brief Calculate the sum of this vector and \a other element-wise
* \param[in] other The other vector
* \return The element-wise sum of this vector and \a other
*/
/**
* \fn Vector::operator+(T scalar) const
* \brief Calculate the sum of this vector and \a scalar element-wise
* \param[in] scalar The scalar
* \return The element-wise sum of this vector and \a other
*/
/**
* \fn Vector::operator-(Vector const &other) const
* \brief Calculate the difference of this vector and \a other element-wise
* \param[in] other The other vector
* \return The element-wise subtraction of \a other from this vector
*/
/**
* \fn Vector::operator-(T scalar) const
* \brief Calculate the difference of this vector and \a scalar element-wise
* \param[in] scalar The scalar
* \return The element-wise subtraction of \a scalar from this vector
*/
/**
* \fn Vector::operator*(const Vector &other) const
* \brief Calculate the product of this vector and \a other element-wise
* \param[in] other The other vector
* \return The element-wise product of this vector and \a other
*/
/**
* \fn Vector::operator*(T scalar) const
* \brief Calculate the product of this vector and \a scalar element-wise
* \param[in] scalar The scalar
* \return The element-wise product of this vector and \a scalar
*/
/**
* \fn Vector::operator/(const Vector &other) const
* \brief Calculate the quotient of this vector and \a other element-wise
* \param[in] other The other vector
* \return The element-wise division of this vector by \a other
*/
/**
* \fn Vector::operator/(T scalar) const
* \brief Calculate the quotient of this vector and \a scalar element-wise
* \param[in] scalar The scalar
* \return The element-wise division of this vector by \a scalar
*/
/**
* \fn Vector::operator+=(Vector const &other)
* \brief Add \a other element-wise to this vector
* \param[in] other The other vector
* \return This vector
*/
/**
* \fn Vector::operator+=(T scalar)
* \brief Add \a scalar element-wise to this vector
* \param[in] scalar The scalar
* \return This vector
*/
/**
* \fn Vector::operator-=(Vector const &other)
* \brief Subtract \a other element-wise from this vector
* \param[in] other The other vector
* \return This vector
*/
/**
* \fn Vector::operator-=(T scalar)
* \brief Subtract \a scalar element-wise from this vector
* \param[in] scalar The scalar
* \return This vector
*/
/**
* \fn Vector::operator*=(const Vector &other)
* \brief Multiply this vector by \a other element-wise
* \param[in] other The other vector
* \return This vector
*/
/**
* \fn Vector::operator*=(T scalar)
* \brief Multiply this vector by \a scalar element-wise
* \param[in] scalar The scalar
* \return This vector
*/
/**
* \fn Vector::operator/=(const Vector &other)
* \brief Divide this vector by \a other element-wise
* \param[in] other The other vector
* \return This vector
*/
/**
* \fn Vector::operator/=(T scalar)
* \brief Divide this vector by \a scalar element-wise
* \param[in] scalar The scalar
* \return This vector
*/
/**
* \fn Vector::min(const Vector &other) const
* \brief Calculate the minimum of this vector and \a other element-wise
* \param[in] other The other vector
* \return The element-wise minimum of this vector and \a other
*/
/**
* \fn Vector::min(T scalar) const
* \brief Calculate the minimum of this vector and \a scalar element-wise
* \param[in] scalar The scalar
* \return The element-wise minimum of this vector and \a scalar
*/
/**
* \fn Vector::max(const Vector &other) const
* \brief Calculate the maximum of this vector and \a other element-wise
* \param[in] other The other vector
* \return The element-wise maximum of this vector and \a other
*/
/**
* \fn Vector::max(T scalar) const
* \brief Calculate the maximum of this vector and \a scalar element-wise
* \param[in] scalar The scalar
* \return The element-wise maximum of this vector and \a scalar
*/
/**
* \fn Vector::dot(const Vector<T, Rows> &other) const
* \brief Compute the dot product
* \param[in] other The other vector
* \return The dot product of the two vectors
*/
/**
* \fn constexpr T &Vector::x()
* \brief Convenience function to access the first element of the vector
* \return The first element of the vector
*/
/**
* \fn constexpr T &Vector::y()
* \brief Convenience function to access the second element of the vector
* \return The second element of the vector
*/
/**
* \fn constexpr T &Vector::z()
* \brief Convenience function to access the third element of the vector
* \return The third element of the vector
*/
/**
* \fn constexpr const T &Vector::x() const
* \copydoc Vector::x()
*/
/**
* \fn constexpr const T &Vector::y() const
* \copydoc Vector::y()
*/
/**
* \fn constexpr const T &Vector::z() const
* \copydoc Vector::z()
*/
/**
* \fn constexpr T &Vector::r()
* \brief Convenience function to access the first element of the vector
* \return The first element of the vector
*/
/**
* \fn constexpr T &Vector::g()
* \brief Convenience function to access the second element of the vector
* \return The second element of the vector
*/
/**
* \fn constexpr T &Vector::b()
* \brief Convenience function to access the third element of the vector
* \return The third element of the vector
*/
/**
* \fn constexpr const T &Vector::r() const
* \copydoc Vector::r()
*/
/**
* \fn constexpr const T &Vector::g() const
* \copydoc Vector::g()
*/
/**
* \fn constexpr const T &Vector::b() const
* \copydoc Vector::b()
*/
/**
* \fn Vector::length2()
* \brief Get the squared length of the vector
* \return The squared length of the vector
*/
/**
* \fn Vector::length()
* \brief Get the length of the vector
* \return The length of the vector
*/
/**
* \fn Vector::sum() const
* \brief Calculate the sum of all the vector elements
* \tparam R The type of the sum
*
* The type R of the sum defaults to the type T of the elements, but can be set
* explicitly to use a different type in case the type T would risk
* overflowing.
*
* \return The sum of all the vector elements
*/
/**
* \fn Vector<T, Rows> operator*(const Matrix<T, Rows, Cols> &m, const Vector<T, Cols> &v)
* \brief Multiply a matrix by a vector
* \tparam T Numerical type of the contents of the matrix and vector
* \tparam Rows The number of rows in the matrix
* \tparam Cols The number of columns in the matrix (= rows in the vector)
* \param m The matrix
* \param v The vector
* \return Product of matrix \a m and vector \a v
*/
/**
* \typedef RGB
* \brief A Vector of 3 elements representing an RGB pixel value
*/
/**
* \fn bool operator==(const Vector<T, Rows> &lhs, const Vector<T, Rows> &rhs)
* \brief Compare vectors for equality
* \return True if the two vectors are equal, false otherwise
*/
/**
* \fn bool operator!=(const Vector<T, Rows> &lhs, const Vector<T, Rows> &rhs)
* \brief Compare vectors for inequality
* \return True if the two vectors are not equal, false otherwise
*/
#ifndef __DOXYGEN__
bool vectorValidateYaml(const YamlObject &obj, unsigned int size)
{
if (!obj.isList())
return false;
if (obj.size() != size) {
LOG(Vector, Error)
<< "Wrong number of values in YAML vector: expected "
<< size << ", got " << obj.size();
return false;
}
return true;
}
#endif /* __DOXYGEN__ */
} /* namespace ipa */
} /* namespace libcamera */
|
