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
|
/* 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 a zero vector
*/
/**
* \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 Vector::readYaml
* \brief Populate the vector with yaml data
* \param yaml Yaml data to populate the vector with
*
* Any existing data in the vector will be overwritten. The size of the data
* read from \a yaml must be equal to the dimension size Rows of the vector.
*
* The yaml data is expected to be a list with elements of type T.
*
* \return 0 on success, negative error code otherwise
*/
/**
* \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::x()
* \brief Convenience function to access the first element of the vector
* \return The first element of the vector
*/
/**
* \fn Vector::y()
* \brief Convenience function to access the second element of the vector
* \return The second element of the vector
*/
/**
* \fn Vector::z()
* \brief Convenience function to access the third element of the vector
* \return The third element of the vector
*/
/**
* \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 Subtract one vector from another
* \param[in] other The other vector
* \return The difference of \a other from this vector
*/
/**
* \fn Vector::operator+()
* \brief Add two vectors together
* \param[in] other The other vector
* \return The sum of the two vectors
*/
/**
* \fn Vector::operator*(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 Vector::operator*(T factor) const
* \brief Multiply the vector by a scalar
* \param[in] factor The factor
* \return The vector multiplied by \a factor
*/
/**
* \fn Vector::operator/()
* \brief Divide the vector by a scalar
* \param[in] factor The factor
* \return The vector divided by \a factor
*/
/**
* \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 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 */
|
