// Copyright (c) FIRST and other WPILib contributors. // Open Source Software; you can modify and/or share it under the terms of // the WPILib BSD license file in the root directory of this project. #include #include #include "frc/geometry/Quaternion.h" #include "units/angle.h" #include "units/math.h" using namespace frc; TEST(QuaternionTest, Init) { // Identity Quaternion q1; EXPECT_DOUBLE_EQ(1.0, q1.W()); EXPECT_DOUBLE_EQ(0.0, q1.X()); EXPECT_DOUBLE_EQ(0.0, q1.Y()); EXPECT_DOUBLE_EQ(0.0, q1.Z()); // Normalized Quaternion q2{0.5, 0.5, 0.5, 0.5}; EXPECT_DOUBLE_EQ(0.5, q2.W()); EXPECT_DOUBLE_EQ(0.5, q2.X()); EXPECT_DOUBLE_EQ(0.5, q2.Y()); EXPECT_DOUBLE_EQ(0.5, q2.Z()); // Unnormalized Quaternion q3{0.75, 0.3, 0.4, 0.5}; EXPECT_DOUBLE_EQ(0.75, q3.W()); EXPECT_DOUBLE_EQ(0.3, q3.X()); EXPECT_DOUBLE_EQ(0.4, q3.Y()); EXPECT_DOUBLE_EQ(0.5, q3.Z()); q3 = q3.Normalize(); double norm = std::sqrt(0.75 * 0.75 + 0.3 * 0.3 + 0.4 * 0.4 + 0.5 * 0.5); EXPECT_DOUBLE_EQ(0.75 / norm, q3.W()); EXPECT_DOUBLE_EQ(0.3 / norm, q3.X()); EXPECT_DOUBLE_EQ(0.4 / norm, q3.Y()); EXPECT_DOUBLE_EQ(0.5 / norm, q3.Z()); EXPECT_DOUBLE_EQ(1.0, q3.W() * q3.W() + q3.X() * q3.X() + q3.Y() * q3.Y() + q3.Z() * q3.Z()); } TEST(QuaternionTest, Addition) { Quaternion q{0.1, 0.2, 0.3, 0.4}; Quaternion p{0.5, 0.6, 0.7, 0.8}; auto sum = q + p; EXPECT_DOUBLE_EQ(q.W() + p.W(), sum.W()); EXPECT_DOUBLE_EQ(q.X() + p.X(), sum.X()); EXPECT_DOUBLE_EQ(q.Y() + p.Y(), sum.Y()); EXPECT_DOUBLE_EQ(q.Z() + p.Z(), sum.Z()); } TEST(QuaternionTest, Subtraction) { Quaternion q{0.1, 0.2, 0.3, 0.4}; Quaternion p{0.5, 0.6, 0.7, 0.8}; auto difference = q - p; EXPECT_DOUBLE_EQ(q.W() - p.W(), difference.W()); EXPECT_DOUBLE_EQ(q.X() - p.X(), difference.X()); EXPECT_DOUBLE_EQ(q.Y() - p.Y(), difference.Y()); EXPECT_DOUBLE_EQ(q.Z() - p.Z(), difference.Z()); } TEST(QuaternionTest, ScalarMultiplication) { Quaternion q{0.1, 0.2, 0.3, 0.4}; auto scalar = 2; auto product = q * scalar; EXPECT_DOUBLE_EQ(q.W() * scalar, product.W()); EXPECT_DOUBLE_EQ(q.X() * scalar, product.X()); EXPECT_DOUBLE_EQ(q.Y() * scalar, product.Y()); EXPECT_DOUBLE_EQ(q.Z() * scalar, product.Z()); } TEST(QuaternionTest, ScalarDivision) { Quaternion q{0.1, 0.2, 0.3, 0.4}; auto scalar = 2; auto product = q / scalar; EXPECT_DOUBLE_EQ(q.W() / scalar, product.W()); EXPECT_DOUBLE_EQ(q.X() / scalar, product.X()); EXPECT_DOUBLE_EQ(q.Y() / scalar, product.Y()); EXPECT_DOUBLE_EQ(q.Z() / scalar, product.Z()); } TEST(QuaternionTest, Multiply) { // 90° CCW rotations around each axis double c = units::math::cos(90_deg / 2.0); double s = units::math::sin(90_deg / 2.0); Quaternion xRot{c, s, 0.0, 0.0}; Quaternion yRot{c, 0.0, s, 0.0}; Quaternion zRot{c, 0.0, 0.0, s}; // 90° CCW X rotation, 90° CCW Y rotation, and 90° CCW Z rotation should // produce a 90° CCW Y rotation auto expected = yRot; auto actual = zRot * yRot * xRot; EXPECT_NEAR(expected.W(), actual.W(), 1e-9); EXPECT_NEAR(expected.X(), actual.X(), 1e-9); EXPECT_NEAR(expected.Y(), actual.Y(), 1e-9); EXPECT_NEAR(expected.Z(), actual.Z(), 1e-9); // Identity Quaternion q{0.72760687510899891, 0.29104275004359953, 0.38805700005813276, 0.48507125007266594}; actual = q * q.Inverse(); EXPECT_NEAR(1.0, actual.W(), 1e-9); EXPECT_NEAR(0.0, actual.X(), 1e-9); EXPECT_NEAR(0.0, actual.Y(), 1e-9); EXPECT_NEAR(0.0, actual.Z(), 1e-9); } TEST(QuaternionTest, Conjugate) { Quaternion q{0.72760687510899891, 0.29104275004359953, 0.38805700005813276, 0.48507125007266594}; auto conj = q.Conjugate(); EXPECT_DOUBLE_EQ(q.W(), conj.W()); EXPECT_DOUBLE_EQ(-q.X(), conj.X()); EXPECT_DOUBLE_EQ(-q.Y(), conj.Y()); EXPECT_DOUBLE_EQ(-q.Z(), conj.Z()); } TEST(QuaternionTest, Inverse) { Quaternion q{0.72760687510899891, 0.29104275004359953, 0.38805700005813276, 0.48507125007266594}; auto norm = q.Norm(); auto inv = q.Inverse(); EXPECT_DOUBLE_EQ(q.W() / (norm * norm), inv.W()); EXPECT_DOUBLE_EQ(-q.X() / (norm * norm), inv.X()); EXPECT_DOUBLE_EQ(-q.Y() / (norm * norm), inv.Y()); EXPECT_DOUBLE_EQ(-q.Z() / (norm * norm), inv.Z()); } TEST(QuaternionTest, Norm) { Quaternion q{3, 4, 12, 84}; auto norm = q.Norm(); EXPECT_NEAR(85, norm, 1e-9); } TEST(QuaternionTest, Exponential) { Quaternion q{1.1, 2.2, 3.3, 4.4}; Quaternion expect{2.81211398529184, -0.392521193481878, -0.588781790222817, -0.785042386963756}; auto q_exp = q.Exp(); EXPECT_EQ(expect, q_exp); } TEST(QuaternionTest, Logarithm) { Quaternion q{1.1, 2.2, 3.3, 4.4}; Quaternion expect{1.7959088706354, 0.515190292664085, 0.772785438996128, 1.03038058532817}; auto q_log = q.Log(); EXPECT_EQ(expect, q_log); Quaternion zero{0, 0, 0, 0}; Quaternion one{1, 0, 0, 0}; Quaternion i{0, 1, 0, 0}; Quaternion j{0, 0, 1, 0}; Quaternion k{0, 0, 0, 1}; Quaternion ln_half{std::log(0.5), -std::numbers::pi, 0, 0}; EXPECT_EQ(zero, one.Log()); EXPECT_EQ(i * std::numbers::pi / 2, i.Log()); EXPECT_EQ(j * std::numbers::pi / 2, j.Log()); EXPECT_EQ(k * std::numbers::pi / 2, k.Log()); EXPECT_EQ(i * -std::numbers::pi, (one * -1).Log()); EXPECT_EQ(ln_half, (one * -0.5).Log()); } TEST(QuaternionTest, LogarithmAndExponentialInverse) { Quaternion q{1.1, 2.2, 3.3, 4.4}; // These operations are order-dependent: ln(exp(q)) is congruent but not // necessarily equal to exp(ln(q)) due to the multi-valued nature of the // complex logarithm. auto q_log_exp = q.Log().Exp(); EXPECT_EQ(q, q_log_exp); Quaternion start{1, 2, 3, 4}; Quaternion expect{5, 6, 7, 8}; auto twist = start.Log(expect); auto actual = start.Exp(twist); EXPECT_EQ(expect, actual); } TEST(QuaternionTest, DotProduct) { Quaternion q{1.1, 2.2, 3.3, 4.4}; Quaternion p{5.5, 6.6, 7.7, 8.8}; EXPECT_NEAR(q.W() * p.W() + q.X() * p.X() + q.Y() * p.Y() + q.Z() * p.Z(), q.Dot(p), 1e-9); } TEST(QuaternionTest, DotProductAsEquality) { Quaternion q{1.1, 2.2, 3.3, 4.4}; auto q_conj = q.Conjugate(); EXPECT_NEAR(q.Dot(q), q.Norm() * q.Norm(), 1e-9); EXPECT_GT(std::abs(q.Dot(q_conj) - q.Norm() * q_conj.Norm()), 1e-9); }