WPILibC++ 2023.4.3-108-ge5452e3
RealSvd2x2.h
Go to the documentation of this file.
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2009-2010 Benoit Jacob <jacob.benoit.1@gmail.com>
5// Copyright (C) 2013-2016 Gael Guennebaud <gael.guennebaud@inria.fr>
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
11#ifndef EIGEN_REALSVD2X2_H
12#define EIGEN_REALSVD2X2_H
13
14namespace Eigen {
15
16namespace internal {
17
18template<typename MatrixType, typename RealScalar, typename Index>
19void real_2x2_jacobi_svd(const MatrixType& matrix, Index p, Index q,
22{
23 using std::sqrt;
24 using std::abs;
26 m << numext::real(matrix.coeff(p,p)), numext::real(matrix.coeff(p,q)),
27 numext::real(matrix.coeff(q,p)), numext::real(matrix.coeff(q,q));
29 RealScalar t = m.coeff(0,0) + m.coeff(1,1);
30 RealScalar d = m.coeff(1,0) - m.coeff(0,1);
31
33 {
34 rot1.s() = RealScalar(0);
35 rot1.c() = RealScalar(1);
36 }
37 else
38 {
39 // If d!=0, then t/d cannot overflow because the magnitude of the
40 // entries forming d are not too small compared to the ones forming t.
41 RealScalar u = t / d;
42 RealScalar tmp = sqrt(RealScalar(1) + numext::abs2(u));
43 rot1.s() = RealScalar(1) / tmp;
44 rot1.c() = u / tmp;
45 }
46 m.applyOnTheLeft(0,1,rot1);
47 j_right->makeJacobi(m,0,1);
48 *j_left = rot1 * j_right->transpose();
49}
50
51} // end namespace internal
52
53} // end namespace Eigen
54
55#endif // EIGEN_REALSVD2X2_H
EIGEN_DEVICE_FUNC RealReturnType real() const
Definition: CommonCwiseUnaryOps.h:100
\jacobi_module
Definition: Jacobi.h:35
EIGEN_DEVICE_FUNC JacobiRotation transpose() const
Returns the transposed transformation.
Definition: Jacobi.h:63
EIGEN_DEVICE_FUNC Scalar & s()
Definition: Jacobi.h:49
EIGEN_DEVICE_FUNC Scalar & c()
Definition: Jacobi.h:47
EIGEN_DEVICE_FUNC bool makeJacobi(const MatrixBase< Derived > &, Index p, Index q)
Makes *this as a Jacobi rotation J such that applying J on both the right and left sides of the 2x2 s...
Definition: Jacobi.h:139
The matrix class, also used for vectors and row-vectors.
Definition: Matrix.h:180
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar & coeff(Index rowId, Index colId) const
This is an overloaded version of DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index,...
Definition: PlainObjectBase.h:152
UnitType abs(const UnitType x) noexcept
Compute absolute value.
Definition: math.h:721
auto sqrt(const UnitType &value) noexcept -> unit_t< square_root< typename units::traits::unit_t_traits< UnitType >::unit_type >, typename units::traits::unit_t_traits< UnitType >::underlying_type, linear_scale >
computes the square root of value
Definition: math.h:483
constexpr common_t< T1, T2 > min(const T1 x, const T2 y) noexcept
Compile-time pairwise minimum function.
Definition: min.hpp:35
void real_2x2_jacobi_svd(const MatrixType &matrix, Index p, Index q, JacobiRotation< RealScalar > *j_left, JacobiRotation< RealScalar > *j_right)
Definition: RealSvd2x2.h:19
EIGEN_DEVICE_FUNC bool abs2(bool x)
Definition: MathFunctions.h:1292
Namespace containing all symbols from the Eigen library.
Definition: Core:141
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74
Definition: Eigen_Colamd.h:50