improved naming

This commit is contained in:
2026-02-08 02:51:48 +03:00
parent d231139b83
commit 3e4598313d
3 changed files with 110 additions and 60 deletions

View File

@@ -23,4 +23,54 @@ namespace omath::iw_engine
[[nodiscard]] [[nodiscard]]
Mat4X4 calc_perspective_projection_matrix(float field_of_view, float aspect_ratio, float near, float far) noexcept; Mat4X4 calc_perspective_projection_matrix(float field_of_view, float aspect_ratio, float near, float far) noexcept;
template<class FloatingType>
requires std::is_floating_point_v<FloatingType>
[[nodiscard]]
constexpr FloatingType units_to_centimeters(const FloatingType& units)
{
constexpr auto centimeter_in_unit = static_cast<FloatingType>(2.54);
return units * centimeter_in_unit;
}
template<class FloatingType>
requires std::is_floating_point_v<FloatingType>
[[nodiscard]]
constexpr FloatingType units_to_meters(const FloatingType& units)
{
return units_to_centimeters(units) / static_cast<FloatingType>(100);
}
template<class FloatingType>
requires std::is_floating_point_v<FloatingType>
[[nodiscard]]
constexpr FloatingType units_to_kilometers(const FloatingType& units)
{
return units_to_meters(units) / static_cast<FloatingType>(1000);
}
template<class FloatingType>
requires std::is_floating_point_v<FloatingType>
[[nodiscard]]
constexpr FloatingType centimeters_to_units(const FloatingType& centimeters)
{
constexpr auto centimeter_in_unit = static_cast<FloatingType>(2.54);
return centimeters / centimeter_in_unit;
}
template<class FloatingType>
requires std::is_floating_point_v<FloatingType>
[[nodiscard]]
constexpr FloatingType meters_to_units(const FloatingType& meters)
{
return centimeters_to_units(meters * static_cast<FloatingType>(100));
}
template<class FloatingType>
requires std::is_floating_point_v<FloatingType>
[[nodiscard]]
constexpr FloatingType kilometers_to_units(const FloatingType& kilometers)
{
return meters_to_units(kilometers * static_cast<FloatingType>(1000));
}
} // namespace omath::iw_engine } // namespace omath::iw_engine

View File

@@ -26,50 +26,50 @@ namespace omath::source_engine
template<class FloatingType> template<class FloatingType>
requires std::is_floating_point_v<FloatingType> requires std::is_floating_point_v<FloatingType>
[[nodiscard]] [[nodiscard]]
constexpr FloatingType hammer_units_to_centimeters(const FloatingType& hammer_units) constexpr FloatingType units_to_centimeters(const FloatingType& units)
{ {
constexpr auto centimeter_in_hammer_unit = static_cast<FloatingType>(2.54); constexpr auto centimeter_in_unit = static_cast<FloatingType>(2.54);
return hammer_units * centimeter_in_hammer_unit; return units * centimeter_in_unit;
} }
template<class FloatingType> template<class FloatingType>
requires std::is_floating_point_v<FloatingType> requires std::is_floating_point_v<FloatingType>
[[nodiscard]] [[nodiscard]]
constexpr FloatingType hammer_units_to_meters(const FloatingType& hammer_units) constexpr FloatingType units_to_meters(const FloatingType& units)
{ {
return hammer_units_to_centimeters(hammer_units) / static_cast<FloatingType>(100); return units_to_centimeters(units) / static_cast<FloatingType>(100);
} }
template<class FloatingType> template<class FloatingType>
requires std::is_floating_point_v<FloatingType> requires std::is_floating_point_v<FloatingType>
[[nodiscard]] [[nodiscard]]
constexpr FloatingType hammer_units_to_kilometers(const FloatingType& hammer_units) constexpr FloatingType units_to_kilometers(const FloatingType& units)
{ {
return hammer_units_to_meters(hammer_units) / static_cast<FloatingType>(1000); return units_to_meters(units) / static_cast<FloatingType>(1000);
} }
template<class FloatingType> template<class FloatingType>
requires std::is_floating_point_v<FloatingType> requires std::is_floating_point_v<FloatingType>
[[nodiscard]] [[nodiscard]]
constexpr FloatingType centimeters_to_hammer_units(const FloatingType& centimeters) constexpr FloatingType centimeters_to_units(const FloatingType& centimeters)
{ {
constexpr auto centimeter_in_hammer_unit = static_cast<FloatingType>(2.54); constexpr auto centimeter_in_unit = static_cast<FloatingType>(2.54);
return centimeters / centimeter_in_hammer_unit; return centimeters / centimeter_in_unit;
} }
template<class FloatingType> template<class FloatingType>
requires std::is_floating_point_v<FloatingType> requires std::is_floating_point_v<FloatingType>
[[nodiscard]] [[nodiscard]]
constexpr FloatingType meters_to_hammer_units(const FloatingType& meters) constexpr FloatingType meters_to_units(const FloatingType& meters)
{ {
return centimeters_to_hammer_units(meters * static_cast<FloatingType>(100)); return centimeters_to_units(meters * static_cast<FloatingType>(100));
} }
template<class FloatingType> template<class FloatingType>
requires std::is_floating_point_v<FloatingType> requires std::is_floating_point_v<FloatingType>
[[nodiscard]] [[nodiscard]]
constexpr FloatingType kilometers_to_hammer_units(const FloatingType& kilometers) constexpr FloatingType kilometers_to_units(const FloatingType& kilometers)
{ {
return meters_to_hammer_units(kilometers * static_cast<FloatingType>(1000)); return meters_to_units(kilometers * static_cast<FloatingType>(1000));
} }
} // namespace omath::source_engine } // namespace omath::source_engine

View File

@@ -9,88 +9,88 @@
TEST(unit_test_source_engine_units, HammerUnitsToCentimeters_BasicValues) TEST(unit_test_source_engine_units, HammerUnitsToCentimeters_BasicValues)
{ {
EXPECT_FLOAT_EQ(omath::source_engine::hammer_units_to_centimeters(0.0f), 0.0f); EXPECT_FLOAT_EQ(omath::source_engine::units_to_centimeters(0.0f), 0.0f);
EXPECT_FLOAT_EQ(omath::source_engine::hammer_units_to_centimeters(1.0f), 2.54f); EXPECT_FLOAT_EQ(omath::source_engine::units_to_centimeters(1.0f), 2.54f);
EXPECT_FLOAT_EQ(omath::source_engine::hammer_units_to_centimeters(10.0f), 25.4f); EXPECT_FLOAT_EQ(omath::source_engine::units_to_centimeters(10.0f), 25.4f);
EXPECT_FLOAT_EQ(omath::source_engine::hammer_units_to_centimeters(-2.0f), -5.08f); EXPECT_FLOAT_EQ(omath::source_engine::units_to_centimeters(-2.0f), -5.08f);
} }
TEST(unit_test_source_engine_units, HammerUnitsToMeters_BasicValues) TEST(unit_test_source_engine_units, HammerUnitsToMeters_BasicValues)
{ {
EXPECT_NEAR(omath::source_engine::hammer_units_to_meters(0.0), 0.0, 1e-12); EXPECT_NEAR(omath::source_engine::units_to_meters(0.0), 0.0, 1e-12);
EXPECT_NEAR(omath::source_engine::hammer_units_to_meters(1.0), 0.0254, 1e-12); EXPECT_NEAR(omath::source_engine::units_to_meters(1.0), 0.0254, 1e-12);
EXPECT_NEAR(omath::source_engine::hammer_units_to_meters(100.0), 2.54, 1e-12); EXPECT_NEAR(omath::source_engine::units_to_meters(100.0), 2.54, 1e-12);
EXPECT_NEAR(omath::source_engine::hammer_units_to_meters(-4.0), -0.1016, 1e-12); EXPECT_NEAR(omath::source_engine::units_to_meters(-4.0), -0.1016, 1e-12);
} }
TEST(unit_test_source_engine_units, HammerUnitsToKilometers_BasicValues) TEST(unit_test_source_engine_units, HammerUnitsToKilometers_BasicValues)
{ {
EXPECT_NEAR(omath::source_engine::hammer_units_to_kilometers(0.0), 0.0, 1e-15); EXPECT_NEAR(omath::source_engine::units_to_kilometers(0.0), 0.0, 1e-15);
EXPECT_NEAR(omath::source_engine::hammer_units_to_kilometers(1.0), 0.0000254, 1e-15); EXPECT_NEAR(omath::source_engine::units_to_kilometers(1.0), 0.0000254, 1e-15);
EXPECT_NEAR(omath::source_engine::hammer_units_to_kilometers(1000.0), 0.0254, 1e-15); EXPECT_NEAR(omath::source_engine::units_to_kilometers(1000.0), 0.0254, 1e-15);
EXPECT_NEAR(omath::source_engine::hammer_units_to_kilometers(-10.0), -0.000254, 1e-15); EXPECT_NEAR(omath::source_engine::units_to_kilometers(-10.0), -0.000254, 1e-15);
} }
TEST(unit_test_source_engine_units, CentimetersToHammerUnits_BasicValues) TEST(unit_test_source_engine_units, CentimetersToHammerUnits_BasicValues)
{ {
EXPECT_FLOAT_EQ(omath::source_engine::centimeters_to_hammer_units(0.0f), 0.0f); EXPECT_FLOAT_EQ(omath::source_engine::centimeters_to_units(0.0f), 0.0f);
EXPECT_NEAR(omath::source_engine::centimeters_to_hammer_units(2.54f), 1.0f, 1e-6f); EXPECT_NEAR(omath::source_engine::centimeters_to_units(2.54f), 1.0f, 1e-6f);
EXPECT_NEAR(omath::source_engine::centimeters_to_hammer_units(25.4f), 10.0f, 1e-5f); EXPECT_NEAR(omath::source_engine::centimeters_to_units(25.4f), 10.0f, 1e-5f);
EXPECT_NEAR(omath::source_engine::centimeters_to_hammer_units(-5.08f), -2.0f, 1e-6f); EXPECT_NEAR(omath::source_engine::centimeters_to_units(-5.08f), -2.0f, 1e-6f);
} }
TEST(unit_test_source_engine_units, MetersToHammerUnits_BasicValues) TEST(unit_test_source_engine_units, MetersToHammerUnits_BasicValues)
{ {
EXPECT_NEAR(omath::source_engine::meters_to_hammer_units(0.0), 0.0, 1e-12); EXPECT_NEAR(omath::source_engine::meters_to_units(0.0), 0.0, 1e-12);
EXPECT_NEAR(omath::source_engine::meters_to_hammer_units(0.0254), 1.0, 1e-12); EXPECT_NEAR(omath::source_engine::meters_to_units(0.0254), 1.0, 1e-12);
EXPECT_NEAR(omath::source_engine::meters_to_hammer_units(2.54), 100.0, 1e-10); EXPECT_NEAR(omath::source_engine::meters_to_units(2.54), 100.0, 1e-10);
EXPECT_NEAR(omath::source_engine::meters_to_hammer_units(-0.0508), -2.0, 1e-12); EXPECT_NEAR(omath::source_engine::meters_to_units(-0.0508), -2.0, 1e-12);
} }
TEST(unit_test_source_engine_units, KilometersToHammerUnits_BasicValues) TEST(unit_test_source_engine_units, KilometersToHammerUnits_BasicValues)
{ {
EXPECT_NEAR(omath::source_engine::kilometers_to_hammer_units(0.0), 0.0, 1e-9); EXPECT_NEAR(omath::source_engine::kilometers_to_units(0.0), 0.0, 1e-9);
EXPECT_NEAR(omath::source_engine::kilometers_to_hammer_units(0.0000254), 1.0, 1e-9); EXPECT_NEAR(omath::source_engine::kilometers_to_units(0.0000254), 1.0, 1e-9);
EXPECT_NEAR(omath::source_engine::kilometers_to_hammer_units(0.00254), 100.0, 1e-7); EXPECT_NEAR(omath::source_engine::kilometers_to_units(0.00254), 100.0, 1e-7);
EXPECT_NEAR(omath::source_engine::kilometers_to_hammer_units(-0.0000508), -2.0, 1e-9); EXPECT_NEAR(omath::source_engine::kilometers_to_units(-0.0000508), -2.0, 1e-9);
} }
TEST(unit_test_source_engine_units, RoundTrip_HammerToCentimetersToHammer) TEST(unit_test_source_engine_units, RoundTrip_HammerToCentimetersToHammer)
{ {
constexpr float hu_f = 123.456f; constexpr float hu_f = 123.456f;
constexpr auto cm_f = omath::source_engine::hammer_units_to_centimeters(hu_f); constexpr auto cm_f = omath::source_engine::units_to_centimeters(hu_f);
constexpr auto hu_f_back = omath::source_engine::centimeters_to_hammer_units(cm_f); constexpr auto hu_f_back = omath::source_engine::centimeters_to_units(cm_f);
EXPECT_NEAR(hu_f_back, hu_f, 1e-5f); EXPECT_NEAR(hu_f_back, hu_f, 1e-5f);
constexpr double hu_d = -98765.4321; constexpr double hu_d = -98765.4321;
constexpr auto cm_d = omath::source_engine::hammer_units_to_centimeters(hu_d); constexpr auto cm_d = omath::source_engine::units_to_centimeters(hu_d);
constexpr auto hu_d_back = omath::source_engine::centimeters_to_hammer_units(cm_d); constexpr auto hu_d_back = omath::source_engine::centimeters_to_units(cm_d);
EXPECT_NEAR(hu_d_back, hu_d, 1e-10); EXPECT_NEAR(hu_d_back, hu_d, 1e-10);
} }
TEST(unit_test_source_engine_units, RoundTrip_HammerToMetersToHammer) TEST(unit_test_source_engine_units, RoundTrip_HammerToMetersToHammer)
{ {
constexpr float hu_f = 2500.25f; constexpr float hu_f = 2500.25f;
constexpr auto m_f = omath::source_engine::hammer_units_to_meters(hu_f); constexpr auto m_f = omath::source_engine::units_to_meters(hu_f);
constexpr auto hu_f_back = omath::source_engine::meters_to_hammer_units(m_f); constexpr auto hu_f_back = omath::source_engine::meters_to_units(m_f);
EXPECT_NEAR(hu_f_back, hu_f, 1e-4f); EXPECT_NEAR(hu_f_back, hu_f, 1e-4f);
constexpr double hu_d = -42000.125; constexpr double hu_d = -42000.125;
constexpr auto m_d = omath::source_engine::hammer_units_to_meters(hu_d); constexpr auto m_d = omath::source_engine::units_to_meters(hu_d);
constexpr auto hu_d_back = omath::source_engine::meters_to_hammer_units(m_d); constexpr auto hu_d_back = omath::source_engine::meters_to_units(m_d);
EXPECT_NEAR(hu_d_back, hu_d, 1e-10); EXPECT_NEAR(hu_d_back, hu_d, 1e-10);
} }
TEST(unit_test_source_engine_units, RoundTrip_HammerToKilometersToHammer) TEST(unit_test_source_engine_units, RoundTrip_HammerToKilometersToHammer)
{ {
constexpr float hu_f = 100000.0f; constexpr float hu_f = 100000.0f;
constexpr auto km_f = omath::source_engine::hammer_units_to_kilometers(hu_f); constexpr auto km_f = omath::source_engine::units_to_kilometers(hu_f);
constexpr auto hu_f_back = omath::source_engine::kilometers_to_hammer_units(km_f); constexpr auto hu_f_back = omath::source_engine::kilometers_to_units(km_f);
EXPECT_NEAR(hu_f_back, hu_f, 1e-2f); // looser due to float scaling EXPECT_NEAR(hu_f_back, hu_f, 1e-2f); // looser due to float scaling
constexpr double hu_d = -1234567.89; constexpr double hu_d = -1234567.89;
constexpr auto km_d = omath::source_engine::hammer_units_to_kilometers(hu_d); constexpr auto km_d = omath::source_engine::units_to_kilometers(hu_d);
constexpr auto hu_d_back = omath::source_engine::kilometers_to_hammer_units(km_d); constexpr auto hu_d_back = omath::source_engine::kilometers_to_units(km_d);
EXPECT_NEAR(hu_d_back, hu_d, 1e-7); EXPECT_NEAR(hu_d_back, hu_d, 1e-7);
} }
@@ -99,12 +99,12 @@ TEST(unit_test_source_engine_units, ConversionChainConsistency)
// hu -> cm -> m -> km should match direct helpers // hu -> cm -> m -> km should match direct helpers
constexpr auto hu = 54321.123; constexpr auto hu = 54321.123;
constexpr auto cm = omath::source_engine::hammer_units_to_centimeters(hu); constexpr auto cm = omath::source_engine::units_to_centimeters(hu);
constexpr auto m_via_cm = cm / 100.0; constexpr auto m_via_cm = cm / 100.0;
constexpr auto km_via_cm = m_via_cm / 1000.0; constexpr auto km_via_cm = m_via_cm / 1000.0;
constexpr auto m_direct = omath::source_engine::hammer_units_to_meters(hu); constexpr auto m_direct = omath::source_engine::units_to_meters(hu);
constexpr auto km_direct = omath::source_engine::hammer_units_to_kilometers(hu); constexpr auto km_direct = omath::source_engine::units_to_kilometers(hu);
EXPECT_NEAR(m_direct, m_via_cm, 1e-12); EXPECT_NEAR(m_direct, m_via_cm, 1e-12);
EXPECT_NEAR(km_direct, km_via_cm, 1e-15); EXPECT_NEAR(km_direct, km_via_cm, 1e-15);
@@ -112,18 +112,18 @@ TEST(unit_test_source_engine_units, ConversionChainConsistency)
TEST(unit_test_source_engine_units, SupportsFloatAndDoubleTypes) TEST(unit_test_source_engine_units, SupportsFloatAndDoubleTypes)
{ {
static_assert(std::is_same_v<decltype(omath::source_engine::hammer_units_to_centimeters(1.0f)), float>); static_assert(std::is_same_v<decltype(omath::source_engine::units_to_centimeters(1.0f)), float>);
static_assert(std::is_same_v<decltype(omath::source_engine::hammer_units_to_centimeters(1.0)), double>); static_assert(std::is_same_v<decltype(omath::source_engine::units_to_centimeters(1.0)), double>);
static_assert(std::is_same_v<decltype(omath::source_engine::meters_to_hammer_units(1.0f)), float>); static_assert(std::is_same_v<decltype(omath::source_engine::meters_to_units(1.0f)), float>);
static_assert(std::is_same_v<decltype(omath::source_engine::kilometers_to_hammer_units(1.0)), double>); static_assert(std::is_same_v<decltype(omath::source_engine::kilometers_to_units(1.0)), double>);
} }
TEST(unit_test_source_engine_units, ConstexprEvaluation) TEST(unit_test_source_engine_units, ConstexprEvaluation)
{ {
constexpr double hu = 10.0; constexpr double hu = 10.0;
constexpr double cm = omath::source_engine::hammer_units_to_centimeters(hu); constexpr double cm = omath::source_engine::units_to_centimeters(hu);
constexpr double m = omath::source_engine::hammer_units_to_meters(hu); constexpr double m = omath::source_engine::units_to_meters(hu);
constexpr double km = omath::source_engine::hammer_units_to_kilometers(hu); constexpr double km = omath::source_engine::units_to_kilometers(hu);
static_assert(cm == 25.4, "constexpr hu->cm failed"); static_assert(cm == 25.4, "constexpr hu->cm failed");
static_assert(m == 0.254, "constexpr hu->m failed"); static_assert(m == 0.254, "constexpr hu->m failed");