Eigen  5.0.1-dev+master
 
Loading...
Searching...
No Matches
SkewSymmetricMatrix3.h
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2009 Gael Guennebaud <gael.guennebaud@inria.fr>
5// Copyright (C) 2007-2009 Benoit Jacob <jacob.benoit.1@gmail.com>
6//
7// This Source Code Form is subject to the terms of the Mozilla
8// Public License v. 2.0. If a copy of the MPL was not distributed
9// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10// SPDX-License-Identifier: MPL-2.0
11
12#ifndef EIGEN_SKEWSYMMETRICMATRIX3_H
13#define EIGEN_SKEWSYMMETRICMATRIX3_H
14
15// IWYU pragma: private
16#include "./InternalHeaderCheck.h"
17
18namespace Eigen {
19
35template <typename Derived>
36class SkewSymmetricBase : public EigenBase<Derived> {
37 public:
38 using SkewSymmetricVectorType = typename internal::traits<Derived>::SkewSymmetricVectorType;
39 using Scalar = typename SkewSymmetricVectorType::Scalar;
40 using RealScalar = typename SkewSymmetricVectorType::RealScalar;
41 using StorageKind = typename internal::traits<Derived>::StorageKind;
42 using StorageIndex = typename internal::traits<Derived>::StorageIndex;
43
44 enum {
45 RowsAtCompileTime = SkewSymmetricVectorType::SizeAtCompileTime,
46 ColsAtCompileTime = SkewSymmetricVectorType::SizeAtCompileTime,
47 MaxRowsAtCompileTime = SkewSymmetricVectorType::MaxSizeAtCompileTime,
48 MaxColsAtCompileTime = SkewSymmetricVectorType::MaxSizeAtCompileTime,
49 IsVectorAtCompileTime = 0,
51 };
52
53 using DenseMatrixType =
55 using DenseType = DenseMatrixType;
56 using PlainObject = SkewSymmetricMatrix3<Scalar>;
57
59 EIGEN_DEVICE_FUNC inline const Derived& derived() const { return *static_cast<const Derived*>(this); }
61 EIGEN_DEVICE_FUNC inline Derived& derived() { return *static_cast<Derived*>(this); }
62
67 EIGEN_DEVICE_FUNC DenseMatrixType toDenseMatrix() const { return derived(); }
68
70 EIGEN_DEVICE_FUNC constexpr Scalar determinant() const { return 0; }
71
73 EIGEN_DEVICE_FUNC PlainObject transpose() const { return (-vector()).asSkewSymmetric(); }
74
76 EIGEN_DEVICE_FUNC DenseMatrixType exponential() const {
77 DenseMatrixType retVal = DenseMatrixType::Identity();
78 const SkewSymmetricVectorType& v = vector();
79 const Scalar norm2 = v.squaredNorm();
80 // exp(K) = I + K + O(|v|^2), so only a v whose squared norm is zero (or underflows) skips the formula.
81 if (numext::is_exactly_zero(norm2)) {
82 retVal += derived().toDenseMatrix();
83 return retVal;
84 }
85 const Scalar norm = numext::sqrt(norm2);
86 retVal += ((((1 - numext::cos(norm)) / norm2) * derived()) * derived()) +
87 (numext::sin(norm) / norm) * derived().toDenseMatrix();
88 return retVal;
89 }
90
92 EIGEN_DEVICE_FUNC inline const SkewSymmetricVectorType& vector() const { return derived().vector(); }
94 EIGEN_DEVICE_FUNC inline SkewSymmetricVectorType& vector() { return derived().vector(); }
95
97 EIGEN_DEVICE_FUNC constexpr Index rows() const { return 3; }
99 EIGEN_DEVICE_FUNC constexpr Index cols() const { return 3; }
100
102 template <typename MatrixDerived>
104 const MatrixBase<MatrixDerived>& matrix) const {
105 return Product<Derived, MatrixDerived, LazyProduct>(derived(), matrix.derived());
106 }
107
109 template <typename MatrixDerived>
114
116 template <typename DiagonalDerived>
121
123 template <typename DiagonalDerived>
128
129 template <typename OtherDerived>
130 using SkewSymmetricProductReturnType = SkewSymmetricWrapper<const EIGEN_CWISE_BINARY_RETURN_TYPE(
131 SkewSymmetricVectorType, typename OtherDerived::SkewSymmetricVectorType, internal::scalar_product_op)>;
132
135 template <typename OtherDerived>
136 EIGEN_DEVICE_FUNC SkewSymmetricProductReturnType<OtherDerived> wedge(
137 const SkewSymmetricBase<OtherDerived>& other) const {
138 return vector().cross(other.vector()).asSkewSymmetric();
139 }
140
141 using SkewSymmetricScaleReturnType = SkewSymmetricWrapper<const EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(
142 SkewSymmetricVectorType, Scalar, internal::scalar_product_op)>;
143
145 EIGEN_DEVICE_FUNC inline SkewSymmetricScaleReturnType operator*(const Scalar& scalar) const {
146 return (vector() * scalar).asSkewSymmetric();
147 }
148
149 using ScaleSkewSymmetricReturnType = SkewSymmetricWrapper<const EIGEN_SCALAR_BINARYOP_EXPR_RETURN_TYPE(
150 Scalar, SkewSymmetricVectorType, internal::scalar_product_op)>;
151
153 EIGEN_DEVICE_FUNC friend inline ScaleSkewSymmetricReturnType operator*(const Scalar& scalar,
154 const SkewSymmetricBase& other) {
155 return (scalar * other.vector()).asSkewSymmetric();
156 }
157
158 template <typename OtherDerived>
159 using SkewSymmetricSumReturnType = SkewSymmetricWrapper<const EIGEN_CWISE_BINARY_RETURN_TYPE(
160 SkewSymmetricVectorType, typename OtherDerived::SkewSymmetricVectorType, internal::scalar_sum_op)>;
161
163 template <typename OtherDerived>
164 EIGEN_DEVICE_FUNC inline SkewSymmetricSumReturnType<OtherDerived> operator+(
165 const SkewSymmetricBase<OtherDerived>& other) const {
166 return (vector() + other.vector()).asSkewSymmetric();
167 }
168
169 template <typename OtherDerived>
170 using SkewSymmetricDifferenceReturnType = SkewSymmetricWrapper<const EIGEN_CWISE_BINARY_RETURN_TYPE(
171 SkewSymmetricVectorType, typename OtherDerived::SkewSymmetricVectorType, internal::scalar_difference_op)>;
172
174 template <typename OtherDerived>
175 EIGEN_DEVICE_FUNC inline SkewSymmetricDifferenceReturnType<OtherDerived> operator-(
176 const SkewSymmetricBase<OtherDerived>& other) const {
177 return (vector() - other.vector()).asSkewSymmetric();
178 }
180 // Return type of dense +/- skew. Scalar follows ScalarBinaryOpTraits, so
181 // mixed-scalar cases go through the same promotion machinery as the rest of
182 // Eigen (and are rejected at compile time unless a user-provided
183 // specialization makes them valid). Shape is always 3x3.
184 template <typename OtherDerived, typename BinaryOp>
185 using DenseSkewBinaryReturnType = Matrix<
187 3>;
188
189 template <typename OtherDerived>
190 using DenseSkewSumReturnType =
191 DenseSkewBinaryReturnType<OtherDerived,
192 internal::scalar_sum_op<typename internal::traits<OtherDerived>::Scalar, Scalar>>;
193
194 template <typename OtherDerived>
195 using DenseSkewDifferenceReturnType = DenseSkewBinaryReturnType<
196 OtherDerived, internal::scalar_difference_op<typename internal::traits<OtherDerived>::Scalar, Scalar>>;
197
203 template <typename OtherDerived>
204 EIGEN_DEVICE_FUNC friend EIGEN_STRONG_INLINE DenseSkewSumReturnType<OtherDerived> operator+(
205 const MatrixBase<OtherDerived>& lhs, const SkewSymmetricBase& rhs) {
206 return lhs.derived() + rhs.toDenseMatrix();
207 }
208
212 template <typename OtherDerived>
213 EIGEN_DEVICE_FUNC friend EIGEN_STRONG_INLINE DenseSkewSumReturnType<OtherDerived> operator+(
214 const SkewSymmetricBase& lhs, const MatrixBase<OtherDerived>& rhs) {
215 return rhs + lhs;
216 }
217
219 template <typename OtherDerived>
220 EIGEN_DEVICE_FUNC friend EIGEN_STRONG_INLINE DenseSkewDifferenceReturnType<OtherDerived> operator-(
221 const MatrixBase<OtherDerived>& lhs, const SkewSymmetricBase& rhs) {
222 return lhs.derived() - rhs.toDenseMatrix();
223 }
224
226 template <typename OtherDerived>
227 EIGEN_DEVICE_FUNC friend EIGEN_STRONG_INLINE DenseSkewDifferenceReturnType<OtherDerived> operator-(
228 const SkewSymmetricBase& lhs, const MatrixBase<OtherDerived>& rhs) {
229 return lhs.toDenseMatrix() - rhs.derived();
230 }
231};
232
242
243namespace internal {
244template <typename Scalar_>
245struct traits<SkewSymmetricMatrix3<Scalar_>> : traits<Matrix<Scalar_, 3, 3, 0, 3, 3>> {
246 using SkewSymmetricVectorType = Matrix<Scalar_, 3, 1, 0, 3, 1>;
247 using StorageKind = SkewSymmetricShape;
248 enum { Flags = LvalueBit | NoPreferredStorageOrderBit | NestByRefBit };
249};
250} // namespace internal
251template <typename Scalar_>
252class SkewSymmetricMatrix3 : public SkewSymmetricBase<SkewSymmetricMatrix3<Scalar_>> {
253 public:
254#ifndef EIGEN_PARSED_BY_DOXYGEN
255 using SkewSymmetricVectorType = typename internal::traits<SkewSymmetricMatrix3>::SkewSymmetricVectorType;
256 using Nested = const SkewSymmetricMatrix3&;
257 using Scalar = Scalar_;
258 using StorageKind = typename internal::traits<SkewSymmetricMatrix3>::StorageKind;
259 using StorageIndex = typename internal::traits<SkewSymmetricMatrix3>::StorageIndex;
260#endif
261
262 protected:
263 SkewSymmetricVectorType m_vector;
264
265 public:
267 EIGEN_DEVICE_FUNC inline const SkewSymmetricVectorType& vector() const { return m_vector; }
269 EIGEN_DEVICE_FUNC inline SkewSymmetricVectorType& vector() { return m_vector; }
272 EIGEN_DEVICE_FUNC inline SkewSymmetricMatrix3() {}
273
275 EIGEN_DEVICE_FUNC inline SkewSymmetricMatrix3(const Scalar& x, const Scalar& y, const Scalar& z)
276 : m_vector(x, y, z) {}
277
279 EIGEN_DEVICE_FUNC explicit inline SkewSymmetricMatrix3(SkewSymmetricVectorType&& vec) : m_vector(std::move(vec)) {}
280
282 template <typename OtherDerived>
283 EIGEN_DEVICE_FUNC explicit inline SkewSymmetricMatrix3(const MatrixBase<OtherDerived>& other) : m_vector(other) {}
284
286 template <typename OtherDerived>
287 EIGEN_DEVICE_FUNC inline SkewSymmetricMatrix3(const SkewSymmetricBase<OtherDerived>& other)
288 : m_vector(other.vector()) {}
289
290#ifndef EIGEN_PARSED_BY_DOXYGEN
292 EIGEN_DEVICE_FUNC inline SkewSymmetricMatrix3(const SkewSymmetricMatrix3& other) : m_vector(other.vector()) {}
293#endif
294
296 template <typename OtherDerived>
298 m_vector = other.vector();
299 return *this;
300 }
301
302#ifndef EIGEN_PARSED_BY_DOXYGEN
306 EIGEN_DEVICE_FUNC SkewSymmetricMatrix3& operator=(const SkewSymmetricMatrix3& other) {
307 m_vector = other.vector();
308 return *this;
309 }
310#endif
311
312 using InitializeReturnType =
313 SkewSymmetricWrapper<const CwiseNullaryOp<internal::scalar_constant_op<Scalar>, SkewSymmetricVectorType>>;
314
315 using ZeroInitializeReturnType =
316 SkewSymmetricWrapper<const CwiseNullaryOp<internal::scalar_zero_op<Scalar>, SkewSymmetricVectorType>>;
317
319 EIGEN_DEVICE_FUNC static ZeroInitializeReturnType Zero() { return SkewSymmetricVectorType::Zero().asSkewSymmetric(); }
320
322 EIGEN_DEVICE_FUNC inline void setZero() { m_vector.setZero(); }
323};
324
338
339namespace internal {
340template <typename SkewSymmetricVectorType_>
341struct traits<SkewSymmetricWrapper<SkewSymmetricVectorType_>> {
342 using SkewSymmetricVectorType = SkewSymmetricVectorType_;
343 using Scalar = typename SkewSymmetricVectorType::Scalar;
344 using StorageIndex = typename SkewSymmetricVectorType::StorageIndex;
345 using StorageKind = SkewSymmetricShape;
346 using XprKind = typename traits<SkewSymmetricVectorType>::XprKind;
347 enum {
348 RowsAtCompileTime = SkewSymmetricVectorType::SizeAtCompileTime,
349 ColsAtCompileTime = SkewSymmetricVectorType::SizeAtCompileTime,
350 MaxRowsAtCompileTime = SkewSymmetricVectorType::MaxSizeAtCompileTime,
351 MaxColsAtCompileTime = SkewSymmetricVectorType::MaxSizeAtCompileTime,
352 Flags = (traits<SkewSymmetricVectorType>::Flags & LvalueBit) | NoPreferredStorageOrderBit
353 };
354};
355} // namespace internal
356
357template <typename SkewSymmetricVectorType_>
358class SkewSymmetricWrapper : public SkewSymmetricBase<SkewSymmetricWrapper<SkewSymmetricVectorType_>>,
359 internal::no_assignment_operator {
360 public:
361#ifndef EIGEN_PARSED_BY_DOXYGEN
362 using SkewSymmetricVectorType = SkewSymmetricVectorType_;
363 using Nested = SkewSymmetricWrapper;
364#endif
365
367 EIGEN_DEVICE_FUNC explicit inline SkewSymmetricWrapper(SkewSymmetricVectorType& a_vector) : m_vector(a_vector) {}
368
370 EIGEN_DEVICE_FUNC const SkewSymmetricVectorType& vector() const { return m_vector; }
371
372 protected:
373 typename SkewSymmetricVectorType::Nested m_vector;
374};
375
382template <typename Derived>
384 return SkewSymmetricWrapper<const Derived>(derived());
385}
386
390template <typename Derived>
391bool MatrixBase<Derived>::isSkewSymmetric(const RealScalar& prec) const {
392 if (cols() != rows()) return false;
393 return (this->transpose() + *this).isZero(prec);
394}
395
398template <typename Derived>
399template <typename SkewDerived>
404
405namespace internal {
406
407template <>
408struct storage_kind_to_shape<SkewSymmetricShape> {
409 using Shape = SkewSymmetricShape;
410};
411
412struct SkewSymmetric2Dense {};
413
414template <>
415struct AssignmentKind<DenseShape, SkewSymmetricShape> {
416 using Kind = SkewSymmetric2Dense;
417};
418
419// SkewSymmetric matrix to Dense assignment
420template <typename DstXprType, typename SrcXprType, typename Functor>
421struct Assignment<DstXprType, SrcXprType, Functor, SkewSymmetric2Dense> {
422 EIGEN_DEVICE_FUNC static void run(
423 DstXprType& dst, const SrcXprType& src,
424 const internal::assign_op<typename DstXprType::Scalar, typename SrcXprType::Scalar>& /*func*/) {
425 if ((dst.rows() != 3) || (dst.cols() != 3)) {
426 dst.resize(3, 3);
427 }
428 // The vector may be read from dst, so it is evaluated before dst is written.
429 const Matrix<typename SrcXprType::Scalar, 3, 1> v = src.vector();
430 dst.diagonal().setZero();
431 dst(0, 1) = -v(2);
432 dst(1, 0) = v(2);
433 dst(0, 2) = v(1);
434 dst(2, 0) = -v(1);
435 dst(1, 2) = -v(0);
436 dst(2, 1) = v(0);
437 }
438 EIGEN_DEVICE_FUNC static void run(
439 DstXprType& dst, const SrcXprType& src,
440 const internal::add_assign_op<typename DstXprType::Scalar, typename SrcXprType::Scalar>& func) {
441 update(dst, src, func);
442 }
443
444 EIGEN_DEVICE_FUNC static void run(
445 DstXprType& dst, const SrcXprType& src,
446 const internal::sub_assign_op<typename DstXprType::Scalar, typename SrcXprType::Scalar>& func) {
447 update(dst, src, func);
448 }
449
450 private:
451 // dst ?= src at the six off-diagonal entries; the diagonal of src is zero.
452 template <typename UpdateFunctor>
453 EIGEN_DEVICE_FUNC static void update(DstXprType& dst, const SrcXprType& src, const UpdateFunctor& func) {
454 eigen_assert(dst.rows() == 3 && dst.cols() == 3);
455 const Matrix<typename SrcXprType::Scalar, 3, 1> v = src.vector();
456 func.assignCoeff(dst.coeffRef(0, 1), -v(2));
457 func.assignCoeff(dst.coeffRef(1, 0), v(2));
458 func.assignCoeff(dst.coeffRef(0, 2), v(1));
459 func.assignCoeff(dst.coeffRef(2, 0), -v(1));
460 func.assignCoeff(dst.coeffRef(1, 2), -v(0));
461 func.assignCoeff(dst.coeffRef(2, 1), v(0));
462 }
463};
464
465} // namespace internal
466
467} // end namespace Eigen
468
469#endif // EIGEN_SKEWSYMMETRICMATRIX3_H
TransposeReturnType transpose()
Definition Transpose.h:165
typename internal::traits< Derived >::StorageIndex StorageIndex
The type used to store indices.
Definition DenseBase.h:60
typename internal::traits< Derived >::Scalar Scalar
Definition DenseBase.h:63
Base class for diagonal matrices and expressions.
Definition DiagonalMatrix.h:34
const Derived & derived() const
Definition DiagonalMatrix.h:60
Base class for all dense matrices, vectors, and expressions.
Definition MatrixBase.h:53
constexpr const SkewSymmetricWrapper< const Derived > asSkewSymmetric() const
Definition SkewSymmetricMatrix3.h:383
bool isSkewSymmetric(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition SkewSymmetricMatrix3.h:391
const Product< Derived, OtherDerived > operator*(const MatrixBase< OtherDerived > &other) const
Definition GeneralProduct.h:622
The matrix class, also used for vectors and row-vectors.
Definition Matrix.h:188
Expression of the product of two arbitrary matrices or vectors.
Definition Product.h:211
Base class for skew symmetric matrices and expressions.
Definition SkewSymmetricMatrix3.h:36
const SkewSymmetricVectorType & vector() const
Definition SkewSymmetricMatrix3.h:92
const Derived & derived() const
Definition SkewSymmetricMatrix3.h:59
SkewSymmetricDifferenceReturnType< OtherDerived > operator-(const SkewSymmetricBase< OtherDerived > &other) const
Definition SkewSymmetricMatrix3.h:175
DenseMatrixType toDenseMatrix() const
Definition SkewSymmetricMatrix3.h:67
constexpr Index rows() const
Definition SkewSymmetricMatrix3.h:97
constexpr Index cols() const
Definition SkewSymmetricMatrix3.h:99
SkewSymmetricScaleReturnType operator*(const Scalar &scalar) const
Definition SkewSymmetricMatrix3.h:145
Product< Derived, MatrixDerived, LazyProduct > operator*(const SkewSymmetricBase< MatrixDerived > &matrix) const
Definition SkewSymmetricMatrix3.h:110
Product< Derived, DiagonalDerived, LazyProduct > operator*(const DiagonalBase< DiagonalDerived > &diagonal) const
Definition SkewSymmetricMatrix3.h:117
friend DenseSkewSumReturnType< OtherDerived > operator+(const MatrixBase< OtherDerived > &lhs, const SkewSymmetricBase &rhs)
Definition SkewSymmetricMatrix3.h:204
friend Product< DiagonalDerived, Derived, LazyProduct > operator*(const DiagonalBase< DiagonalDerived > &diagonal, const SkewSymmetricBase &skew)
Definition SkewSymmetricMatrix3.h:124
friend DenseSkewDifferenceReturnType< OtherDerived > operator-(const MatrixBase< OtherDerived > &lhs, const SkewSymmetricBase &rhs)
Definition SkewSymmetricMatrix3.h:220
friend DenseSkewSumReturnType< OtherDerived > operator+(const SkewSymmetricBase &lhs, const MatrixBase< OtherDerived > &rhs)
Definition SkewSymmetricMatrix3.h:213
SkewSymmetricVectorType & vector()
Definition SkewSymmetricMatrix3.h:94
SkewSymmetricSumReturnType< OtherDerived > operator+(const SkewSymmetricBase< OtherDerived > &other) const
Definition SkewSymmetricMatrix3.h:164
friend DenseSkewDifferenceReturnType< OtherDerived > operator-(const SkewSymmetricBase &lhs, const MatrixBase< OtherDerived > &rhs)
Definition SkewSymmetricMatrix3.h:227
Product< Derived, MatrixDerived, LazyProduct > operator*(const MatrixBase< MatrixDerived > &matrix) const
Definition SkewSymmetricMatrix3.h:103
SkewSymmetricProductReturnType< OtherDerived > wedge(const SkewSymmetricBase< OtherDerived > &other) const
Definition SkewSymmetricMatrix3.h:136
constexpr Scalar determinant() const
Definition SkewSymmetricMatrix3.h:70
DenseMatrixType exponential() const
Definition SkewSymmetricMatrix3.h:76
Derived & derived()
Definition SkewSymmetricMatrix3.h:61
friend ScaleSkewSymmetricReturnType operator*(const Scalar &scalar, const SkewSymmetricBase &other)
Definition SkewSymmetricMatrix3.h:153
PlainObject transpose() const
Definition SkewSymmetricMatrix3.h:73
Represents a 3x3 skew symmetric matrix with its storage.
Definition SkewSymmetricMatrix3.h:252
static ZeroInitializeReturnType Zero()
Definition SkewSymmetricMatrix3.h:319
SkewSymmetricMatrix3(SkewSymmetricVectorType &&vec)
Constructs a SkewSymmetricMatrix3 from an r-value vector type.
Definition SkewSymmetricMatrix3.h:279
SkewSymmetricMatrix3 & operator=(const SkewSymmetricBase< OtherDerived > &other)
Definition SkewSymmetricMatrix3.h:297
SkewSymmetricMatrix3()
Definition SkewSymmetricMatrix3.h:272
SkewSymmetricVectorType & vector()
Definition SkewSymmetricMatrix3.h:269
SkewSymmetricMatrix3(const Scalar &x, const Scalar &y, const Scalar &z)
Definition SkewSymmetricMatrix3.h:275
void setZero()
Definition SkewSymmetricMatrix3.h:322
const SkewSymmetricVectorType & vector() const
Definition SkewSymmetricMatrix3.h:267
SkewSymmetricMatrix3(const MatrixBase< OtherDerived > &other)
Definition SkewSymmetricMatrix3.h:283
SkewSymmetricMatrix3(const SkewSymmetricBase< OtherDerived > &other)
Definition SkewSymmetricMatrix3.h:287
Expression of a skew symmetric matrix.
Definition SkewSymmetricMatrix3.h:359
const SkewSymmetricVectorType & vector() const
Definition SkewSymmetricMatrix3.h:370
SkewSymmetricWrapper(SkewSymmetricVectorType &a_vector)
Definition SkewSymmetricMatrix3.h:367
constexpr unsigned int NoPreferredStorageOrderBit
Definition Constants.h:183
constexpr unsigned int LvalueBit
Definition Constants.h:149
Definition EigenBase.h:34
Eigen::Index Index
The interface type of indices.
Definition EigenBase.h:44
Determines whether the given binary operation of two numeric types is allowed and what the scalar ret...
Definition XprHelper.h:1080