GCC Code Coverage Report

Directory: ./
File: python/doxygen_autodoc/coal/math/transform.h
Date: 2025-04-01 09:23:31
Exec Total Coverage
Lines: 36 40 90.0%
Branches: 20 50 40.0%
Line Branch Exec Source
1 #ifndef DOXYGEN_AUTODOC_COAL_MATH_TRANSFORM_H
2 #define DOXYGEN_AUTODOC_COAL_MATH_TRANSFORM_H
3
4 #include "/root/robotpkg/path/py-coal/work/coal-3.0.1/doc/python/doxygen.hh"
5
6 #include <coal/math/transform.h>
7
8 namespace doxygen {
9
10 template <>
11 struct class_doc_impl< coal::Transform3s >
12 {
13 5 static inline const char* run ()
14 {
15 5 return "Simple transform class used locally by InterpMotion. ";
16 }
17 static inline const char* attribute (const char* attrib)
18 {
19 (void)attrib; // turn off unused parameter warning.
20 return "";
21 }
22 };
23
24 template <>
25 struct constructor_0_impl< coal::Transform3s >
26 {
27 5 static inline const char* doc ()
28 {
29 5 return "Default transform is no movement. ";
30 }
31 5 static inline boost::python::detail::keywords<0+1> args ()
32 {
33 5 return (boost::python::arg("self"));
34 }
35 };
36
37 template <typename Matrixx3Like, typename Vector3Like>
38 struct constructor_2_impl< coal::Transform3s, const Eigen::MatrixBase< Matrixx3Like > &, const Eigen::MatrixBase< Vector3Like > & >
39 {
40 5 static inline const char* doc ()
41 {
42 5 return "Construct transform from rotation and translation. ";
43 }
44 5 static inline boost::python::detail::keywords<2+1> args ()
45 {
46
4/8
✓ Branch 2 taken 5 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 5 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 5 times.
✗ Branch 9 not taken.
✓ Branch 11 taken 5 times.
✗ Branch 12 not taken.
 10 return (boost::python::arg("self"), boost::python::arg("R_"), boost::python::arg("T_"));
47 }
48 };
49
50 template <typename Vector3Like>
51 struct constructor_2_impl< coal::Transform3s, const coal::Quats &, const Eigen::MatrixBase< Vector3Like > & >
52 {
53 5 static inline const char* doc ()
54 {
55 5 return "Construct transform from rotation and translation. ";
56 }
57 5 static inline boost::python::detail::keywords<2+1> args ()
58 {
59
4/8
✓ Branch 2 taken 5 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 5 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 5 times.
✗ Branch 9 not taken.
✓ Branch 11 taken 5 times.
✗ Branch 12 not taken.
 10 return (boost::python::arg("self"), boost::python::arg("q_"), boost::python::arg("T_"));
60 }
61 };
62
63 template <>
64 struct constructor_1_impl< coal::Transform3s, const coal::Matrix3s & >
65 {
66 5 static inline const char* doc ()
67 {
68 5 return "Construct transform from rotation. ";
69 }
70 5 static inline boost::python::detail::keywords<1+1> args ()
71 {
72
2/4
✓ Branch 2 taken 5 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 5 times.
✗ Branch 6 not taken.
 10 return (boost::python::arg("self"), boost::python::arg("R_"));
73 }
74 };
75
76 template <>
77 struct constructor_1_impl< coal::Transform3s, const coal::Quats & >
78 {
79 5 static inline const char* doc ()
80 {
81 5 return "Construct transform from rotation. ";
82 }
83 5 static inline boost::python::detail::keywords<1+1> args ()
84 {
85
2/4
✓ Branch 2 taken 5 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 5 times.
✗ Branch 6 not taken.
 10 return (boost::python::arg("self"), boost::python::arg("q_"));
86 }
87 };
88
89 template <>
90 struct constructor_1_impl< coal::Transform3s, const coal::Vec3s & >
91 {
92 5 static inline const char* doc ()
93 {
94 5 return "Construct transform from translation. ";
95 }
96 5 static inline boost::python::detail::keywords<1+1> args ()
97 {
98
2/4
✓ Branch 2 taken 5 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 5 times.
✗ Branch 6 not taken.
 10 return (boost::python::arg("self"), boost::python::arg("T_"));
99 }
100 };
101
102 template <>
103 struct constructor_1_impl< coal::Transform3s, const coal::Transform3s & >
104 {
105 5 static inline const char* doc ()
106 {
107 5 return "Construct transform from other transform. ";
108 }
109 5 static inline boost::python::detail::keywords<1+1> args ()
110 {
111
2/4
✓ Branch 2 taken 5 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 5 times.
✗ Branch 6 not taken.
 10 return (boost::python::arg("self"), boost::python::arg("tf"));
112 }
113 };
114
115 inline const char* member_func_doc ( coal::Transform3s & (coal::Transform3s::*function_ptr) (const coal::Transform3s &))
116 {
117 if (function_ptr == static_cast< coal::Transform3s & (coal::Transform3s::*) (const coal::Transform3s &)>(&coal::Transform3s::operator=))
118 return "operator = ";
119 return "";
120 }
121
122 inline boost::python::detail::keywords<2> member_func_args ( coal::Transform3s & (coal::Transform3s::*function_ptr) (const coal::Transform3s &))
123 {
124 if (function_ptr == static_cast< coal::Transform3s & (coal::Transform3s::*) (const coal::Transform3s &)>(&coal::Transform3s::operator=))
125 return (boost::python::arg("self"), boost::python::arg("tf"));
126 return (boost::python::arg("self"), boost::python::arg("arg0"));
127 }
128
129 10 inline const char* member_func_doc (const coal::Vec3s & (coal::Transform3s::*function_ptr) () const)
130 {
131
2/6
✓ Branch 0 taken 10 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 10 times.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
 10 if (function_ptr == static_cast<const coal::Vec3s & (coal::Transform3s::*) () const>(&coal::Transform3s::getTranslation))
132 10 return "get translation ";
133 ✗ if (function_ptr == static_cast<const coal::Vec3s & (coal::Transform3s::*) () const>(&coal::Transform3s::translation))
134 ✗ return "get translation ";
135 ✗ return "";
136 }
137
138 inline boost::python::detail::keywords<1> member_func_args (const coal::Vec3s & (coal::Transform3s::*function_ptr) () const)
139 {
140 if (function_ptr == static_cast<const coal::Vec3s & (coal::Transform3s::*) () const>(&coal::Transform3s::getTranslation))
141 return (boost::python::arg("self"));
142 if (function_ptr == static_cast<const coal::Vec3s & (coal::Transform3s::*) () const>(&coal::Transform3s::translation))
143 return (boost::python::arg("self"));
144 return (boost::python::arg("self"));
145 }
146
147 inline const char* member_func_doc ( coal::Vec3s & (coal::Transform3s::*function_ptr) ())
148 {
149 if (function_ptr == static_cast< coal::Vec3s & (coal::Transform3s::*) ()>(&coal::Transform3s::translation))
150 return "get translation ";
151 return "";
152 }
153
154 inline boost::python::detail::keywords<1> member_func_args ( coal::Vec3s & (coal::Transform3s::*function_ptr) ())
155 {
156 if (function_ptr == static_cast< coal::Vec3s & (coal::Transform3s::*) ()>(&coal::Transform3s::translation))
157 return (boost::python::arg("self"));
158 return (boost::python::arg("self"));
159 }
160
161 inline const char* member_func_doc (const coal::Matrix3s & (coal::Transform3s::*function_ptr) () const)
162 {
163 if (function_ptr == static_cast<const coal::Matrix3s & (coal::Transform3s::*) () const>(&coal::Transform3s::getRotation))
164 return "get rotation ";
165 if (function_ptr == static_cast<const coal::Matrix3s & (coal::Transform3s::*) () const>(&coal::Transform3s::rotation))
166 return "get rotation ";
167 return "";
168 }
169
170 inline boost::python::detail::keywords<1> member_func_args (const coal::Matrix3s & (coal::Transform3s::*function_ptr) () const)
171 {
172 if (function_ptr == static_cast<const coal::Matrix3s & (coal::Transform3s::*) () const>(&coal::Transform3s::getRotation))
173 return (boost::python::arg("self"));
174 if (function_ptr == static_cast<const coal::Matrix3s & (coal::Transform3s::*) () const>(&coal::Transform3s::rotation))
175 return (boost::python::arg("self"));
176 return (boost::python::arg("self"));
177 }
178
179 inline const char* member_func_doc ( coal::Matrix3s & (coal::Transform3s::*function_ptr) ())
180 {
181 if (function_ptr == static_cast< coal::Matrix3s & (coal::Transform3s::*) ()>(&coal::Transform3s::rotation))
182 return "get rotation ";
183 return "";
184 }
185
186 inline boost::python::detail::keywords<1> member_func_args ( coal::Matrix3s & (coal::Transform3s::*function_ptr) ())
187 {
188 if (function_ptr == static_cast< coal::Matrix3s & (coal::Transform3s::*) ()>(&coal::Transform3s::rotation))
189 return (boost::python::arg("self"));
190 return (boost::python::arg("self"));
191 }
192
193 inline const char* member_func_doc ( coal::Quats (coal::Transform3s::*function_ptr) () const)
194 {
195 if (function_ptr == static_cast< coal::Quats (coal::Transform3s::*) () const>(&coal::Transform3s::getQuatRotation))
196 return "get quaternion ";
197 return "";
198 }
199
200 inline boost::python::detail::keywords<1> member_func_args ( coal::Quats (coal::Transform3s::*function_ptr) () const)
201 {
202 if (function_ptr == static_cast< coal::Quats (coal::Transform3s::*) () const>(&coal::Transform3s::getQuatRotation))
203 return (boost::python::arg("self"));
204 return (boost::python::arg("self"));
205 }
206
207 template <typename Matrix3Like, typename Vector3Like>
208 inline const char* member_func_doc (void (coal::Transform3s::*function_ptr) (const Eigen::MatrixBase< Matrix3Like > &, const Eigen::MatrixBase< Vector3Like > &))
209 {
210 if (function_ptr == static_cast<void (coal::Transform3s::*) (const Eigen::MatrixBase< Matrix3Like > &, const Eigen::MatrixBase< Vector3Like > &)>(&coal::Transform3s::setTransform))
211 return "set transform from rotation and translation ";
212 return "";
213 }
214
215 template <typename Matrix3Like, typename Vector3Like>
216 inline boost::python::detail::keywords<3> member_func_args (void (coal::Transform3s::*function_ptr) (const Eigen::MatrixBase< Matrix3Like > &, const Eigen::MatrixBase< Vector3Like > &))
217 {
218 if (function_ptr == static_cast<void (coal::Transform3s::*) (const Eigen::MatrixBase< Matrix3Like > &, const Eigen::MatrixBase< Vector3Like > &)>(&coal::Transform3s::setTransform))
219 return (boost::python::arg("self"), boost::python::arg("R_"), boost::python::arg("T_"));
220 return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
221 }
222
223 inline const char* member_func_doc (void (coal::Transform3s::*function_ptr) (const coal::Quats &, const coal::Vec3s &))
224 {
225 if (function_ptr == static_cast<void (coal::Transform3s::*) (const coal::Quats &, const coal::Vec3s &)>(&coal::Transform3s::setTransform))
226 return "set transform from rotation and translation ";
227 return "";
228 }
229
230 inline boost::python::detail::keywords<3> member_func_args (void (coal::Transform3s::*function_ptr) (const coal::Quats &, const coal::Vec3s &))
231 {
232 if (function_ptr == static_cast<void (coal::Transform3s::*) (const coal::Quats &, const coal::Vec3s &)>(&coal::Transform3s::setTransform))
233 return (boost::python::arg("self"), boost::python::arg("q_"), boost::python::arg("T_"));
234 return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
235 }
236
237 template <typename Derived>
238 inline const char* member_func_doc (void (coal::Transform3s::*function_ptr) (const Eigen::MatrixBase< Derived > &))
239 {
240 if (function_ptr == static_cast<void (coal::Transform3s::*) (const Eigen::MatrixBase< Derived > &)>(&coal::Transform3s::setRotation))
241 return "set transform from rotation ";
242 if (function_ptr == static_cast<void (coal::Transform3s::*) (const Eigen::MatrixBase< Derived > &)>(&coal::Transform3s::setTranslation))
243 return "set transform from translation ";
244 return "";
245 }
246
247 template <typename Derived>
248 inline boost::python::detail::keywords<2> member_func_args (void (coal::Transform3s::*function_ptr) (const Eigen::MatrixBase< Derived > &))
249 {
250 if (function_ptr == static_cast<void (coal::Transform3s::*) (const Eigen::MatrixBase< Derived > &)>(&coal::Transform3s::setRotation))
251 return (boost::python::arg("self"), boost::python::arg("R_"));
252 if (function_ptr == static_cast<void (coal::Transform3s::*) (const Eigen::MatrixBase< Derived > &)>(&coal::Transform3s::setTranslation))
253 return (boost::python::arg("self"), boost::python::arg("T_"));
254 return (boost::python::arg("self"), boost::python::arg("arg0"));
255 }
256
257 inline const char* member_func_doc (void (coal::Transform3s::*function_ptr) (const coal::Quats &))
258 {
259 if (function_ptr == static_cast<void (coal::Transform3s::*) (const coal::Quats &)>(&coal::Transform3s::setQuatRotation))
260 return "set transform from rotation ";
261 return "";
262 }
263
264 inline boost::python::detail::keywords<2> member_func_args (void (coal::Transform3s::*function_ptr) (const coal::Quats &))
265 {
266 if (function_ptr == static_cast<void (coal::Transform3s::*) (const coal::Quats &)>(&coal::Transform3s::setQuatRotation))
267 return (boost::python::arg("self"), boost::python::arg("q_"));
268 return (boost::python::arg("self"), boost::python::arg("arg0"));
269 }
270
271 template <typename Derived>
272 inline const char* member_func_doc ( coal::Vec3s (coal::Transform3s::*function_ptr) (const Eigen::MatrixBase< Derived > &) const)
273 {
274 if (function_ptr == static_cast< coal::Vec3s (coal::Transform3s::*) (const Eigen::MatrixBase< Derived > &) const>(&coal::Transform3s::transform))
275 return "transform a given vector by the transform ";
276 if (function_ptr == static_cast< coal::Vec3s (coal::Transform3s::*) (const Eigen::MatrixBase< Derived > &) const>(&coal::Transform3s::inverseTransform))
277 return "transform a given vector by the inverse of the transform ";
278 return "";
279 }
280
281 template <typename Derived>
282 inline boost::python::detail::keywords<2> member_func_args ( coal::Vec3s (coal::Transform3s::*function_ptr) (const Eigen::MatrixBase< Derived > &) const)
283 {
284 if (function_ptr == static_cast< coal::Vec3s (coal::Transform3s::*) (const Eigen::MatrixBase< Derived > &) const>(&coal::Transform3s::transform))
285 return (boost::python::arg("self"), boost::python::arg("v"));
286 if (function_ptr == static_cast< coal::Vec3s (coal::Transform3s::*) (const Eigen::MatrixBase< Derived > &) const>(&coal::Transform3s::inverseTransform))
287 return (boost::python::arg("self"), boost::python::arg("v"));
288 return (boost::python::arg("self"), boost::python::arg("arg0"));
289 }
290
291 5 inline const char* member_func_doc ( coal::Transform3s & (coal::Transform3s::*function_ptr) ())
292 {
293
2/6
✓ Branch 0 taken 5 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 5 times.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
 5 if (function_ptr == static_cast< coal::Transform3s & (coal::Transform3s::*) ()>(&coal::Transform3s::inverseInPlace))
294 5 return "inverse transform ";
295 ✗ return "";
296 }
297
298 inline boost::python::detail::keywords<1> member_func_args ( coal::Transform3s & (coal::Transform3s::*function_ptr) ())
299 {
300 if (function_ptr == static_cast< coal::Transform3s & (coal::Transform3s::*) ()>(&coal::Transform3s::inverseInPlace))
301 return (boost::python::arg("self"));
302 return (boost::python::arg("self"));
303 }
304
305 inline const char* member_func_doc ( coal::Transform3s (coal::Transform3s::*function_ptr) ())
306 {
307 if (function_ptr == static_cast< coal::Transform3s (coal::Transform3s::*) ()>(&coal::Transform3s::inverse))
308 return "inverse transform ";
309 return "";
310 }
311
312 inline boost::python::detail::keywords<1> member_func_args ( coal::Transform3s (coal::Transform3s::*function_ptr) ())
313 {
314 if (function_ptr == static_cast< coal::Transform3s (coal::Transform3s::*) ()>(&coal::Transform3s::inverse))
315 return (boost::python::arg("self"));
316 return (boost::python::arg("self"));
317 }
318
319 inline const char* member_func_doc ( coal::Transform3s (coal::Transform3s::*function_ptr) (const coal::Transform3s &) const)
320 {
321 if (function_ptr == static_cast< coal::Transform3s (coal::Transform3s::*) (const coal::Transform3s &) const>(&coal::Transform3s::inverseTimes))
322 return "inverse the transform and multiply with another ";
323 if (function_ptr == static_cast< coal::Transform3s (coal::Transform3s::*) (const coal::Transform3s &) const>(&coal::Transform3s::operator*))
324 return "multiply with another transform ";
325 return "";
326 }
327
328 inline boost::python::detail::keywords<2> member_func_args ( coal::Transform3s (coal::Transform3s::*function_ptr) (const coal::Transform3s &) const)
329 {
330 if (function_ptr == static_cast< coal::Transform3s (coal::Transform3s::*) (const coal::Transform3s &) const>(&coal::Transform3s::inverseTimes))
331 return (boost::python::arg("self"), boost::python::arg("other"));
332 if (function_ptr == static_cast< coal::Transform3s (coal::Transform3s::*) (const coal::Transform3s &) const>(&coal::Transform3s::operator*))
333 return (boost::python::arg("self"), boost::python::arg("other"));
334 return (boost::python::arg("self"), boost::python::arg("arg0"));
335 }
336
337 inline const char* member_func_doc (const coal::Transform3s & (coal::Transform3s::*function_ptr) (const coal::Transform3s &))
338 {
339 if (function_ptr == static_cast<const coal::Transform3s & (coal::Transform3s::*) (const coal::Transform3s &)>(&coal::Transform3s::operator*=))
340 return "multiply with another transform ";
341 return "";
342 }
343
344 inline boost::python::detail::keywords<2> member_func_args (const coal::Transform3s & (coal::Transform3s::*function_ptr) (const coal::Transform3s &))
345 {
346 if (function_ptr == static_cast<const coal::Transform3s & (coal::Transform3s::*) (const coal::Transform3s &)>(&coal::Transform3s::operator*=))
347 return (boost::python::arg("self"), boost::python::arg("other"));
348 return (boost::python::arg("self"), boost::python::arg("arg0"));
349 }
350
351 inline const char* member_func_doc (bool (coal::Transform3s::*function_ptr) (const coal::Scalar &) const)
352 {
353 if (function_ptr == static_cast<bool (coal::Transform3s::*) (const coal::Scalar &) const>(&coal::Transform3s::isIdentity))
354 return "check whether the transform is identity ";
355 return "";
356 }
357
358 inline boost::python::detail::keywords<2> member_func_args (bool (coal::Transform3s::*function_ptr) (const coal::Scalar &) const)
359 {
360 if (function_ptr == static_cast<bool (coal::Transform3s::*) (const coal::Scalar &) const>(&coal::Transform3s::isIdentity))
361 return (boost::python::arg("self"), boost::python::arg("prec"));
362 return (boost::python::arg("self"), boost::python::arg("arg0"));
363 }
364
365 inline const char* member_func_doc (void (coal::Transform3s::*function_ptr) ())
366 {
367 if (function_ptr == static_cast<void (coal::Transform3s::*) ()>(&coal::Transform3s::setIdentity))
368 return "set the transform to be identity transform ";
369 if (function_ptr == static_cast<void (coal::Transform3s::*) ()>(&coal::Transform3s::setRandom))
370 return "set the transform to a random transform ";
371 return "";
372 }
373
374 inline boost::python::detail::keywords<1> member_func_args (void (coal::Transform3s::*function_ptr) ())
375 {
376 if (function_ptr == static_cast<void (coal::Transform3s::*) ()>(&coal::Transform3s::setIdentity))
377 return (boost::python::arg("self"));
378 if (function_ptr == static_cast<void (coal::Transform3s::*) ()>(&coal::Transform3s::setRandom))
379 return (boost::python::arg("self"));
380 return (boost::python::arg("self"));
381 }
382
383 inline const char* member_func_doc (bool (coal::Transform3s::*function_ptr) (const coal::Transform3s &) const)
384 {
385 if (function_ptr == static_cast<bool (coal::Transform3s::*) (const coal::Transform3s &) const>(&coal::Transform3s::operator==))
386 return "";
387 if (function_ptr == static_cast<bool (coal::Transform3s::*) (const coal::Transform3s &) const>(&coal::Transform3s::operator!=))
388 return "";
389 return "";
390 }
391
392 inline boost::python::detail::keywords<2> member_func_args (bool (coal::Transform3s::*function_ptr) (const coal::Transform3s &) const)
393 {
394 if (function_ptr == static_cast<bool (coal::Transform3s::*) (const coal::Transform3s &) const>(&coal::Transform3s::operator==))
395 return (boost::python::arg("self"), boost::python::arg("other"));
396 if (function_ptr == static_cast<bool (coal::Transform3s::*) (const coal::Transform3s &) const>(&coal::Transform3s::operator!=))
397 return (boost::python::arg("self"), boost::python::arg("other"));
398 return (boost::python::arg("self"), boost::python::arg("arg0"));
399 }
400 } // namespace doxygen
401
402 #endif // DOXYGEN_AUTODOC_COAL_MATH_TRANSFORM_H
403
404