refactor: US system renamed to USCS

conanfile.py

@@ -159,6 +159,6 @@ class UnitsConan(ConanFile):
         self.cpp_info.components["si-imperial"].requires = ["si"]
         self.cpp_info.components["si-international"].requires = ["si"]
         self.cpp_info.components["si-typographic"].requires = ["si"]
-        self.cpp_info.components["si-us"].requires = ["si"]
+        self.cpp_info.components["si-uscs"].requires = ["si"]
         self.cpp_info.components["isq-iec80000"].requires = ["si"]
-        self.cpp_info.components["systems"].requires = ["isq", "isq-natural", "si", "si-cgs", "si-fps", "si-iau", "si-imperial", "si-international", "si-typographic", "si-us", "isq-iec80000"]
+        self.cpp_info.components["systems"].requires = ["isq", "isq-natural", "si", "si-cgs", "si-fps", "si-iau", "si-imperial", "si-international", "si-typographic", "si-uscs", "isq-iec80000"]

docs/CMakeLists.txt

@@ -238,8 +238,8 @@ set(unitsSphinxDocs
     "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/isq/si_typographic.rst"
     "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/isq/si/typographic/length.rst"
 
-    "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/isq/si_us.rst"
+    "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/isq/si_uscs.rst"
-    "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/isq/si/us/length.rst"
+    "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/isq/si/uscs/length.rst"
 
     "${CMAKE_CURRENT_SOURCE_DIR}/references.rst"
 

docs/reference/systems/isq.rst

@@ -18,7 +18,7 @@ Systems of Units based on the SI
 
     isq/si_cgs
     isq/si_international
-    isq/si_us
+    isq/si_uscs
     isq/si_imperial
     isq/si_fps
     isq/si_iau

docs/reference/systems/isq/si/us/length.rst

@@ -1,4 +0,0 @@
-Length
-======
-
-.. doxygenfile:: si/us/length.h

docs/reference/systems/isq/si/uscs/length.rst

@@ -0,0 +1,4 @@
+Length
+======
+
+.. doxygenfile:: si/uscs/length.h

docs/reference/systems/isq/si_us.rst

@@ -1,7 +0,0 @@
-US (based on SI)
-================
-
-.. toctree::
-    :maxdepth: 2
-
-    si/us/length

docs/reference/systems/isq/si_uscs.rst

@@ -0,0 +1,7 @@
+U.S. Customary Units (based on SI)
+==================================
+
+.. toctree::
+    :maxdepth: 2
+
+    si/uscs/length

example/aliases/CMakeLists.txt

@@ -34,7 +34,7 @@ endfunction()
 add_example(avg_speed mp-units::core-io mp-units::si mp-units::si-cgs mp-units::si-international)
 add_example(box_example mp-units::core-fmt mp-units::si)
 add_example(capacitor_time_curve mp-units::core-io mp-units::si)
-add_example(clcpp_response mp-units::core-fmt mp-units::core-io mp-units::si mp-units::si-iau mp-units::si-imperial mp-units::si-international mp-units::si-typographic mp-units::si-us)
+add_example(clcpp_response mp-units::core-fmt mp-units::core-io mp-units::si mp-units::si-iau mp-units::si-imperial mp-units::si-international mp-units::si-typographic mp-units::si-uscs)
 add_example(experimental_angle mp-units::core-fmt mp-units::core-io mp-units::si)
 add_example(foot_pound_second mp-units::core-fmt mp-units::si-fps)
 add_example(measurement mp-units::core-io mp-units::si)

example/aliases/clcpp_response.cpp

@@ -23,7 +23,7 @@
 #include <units/isq/si/length.h>
 #include <units/isq/si/time.h>
 #include <units/isq/si/typographic/length.h>
-#include <units/isq/si/us/length.h>
+#include <units/isq/si/uscs/length.h>
 #include <units/quantity_io.h>
 #include <iostream>
 
@@ -88,9 +88,9 @@ void quantities_with_typed_units()
   std::cout << " = " << iau::angstrom<>(meter) << '\n';
   std::cout << " = " << imperial::ch<>(meter) << '\n';
   std::cout << " = " << international::fathom<>(meter) << '\n';
-  std::cout << " = " << quantity_cast<units::isq::si::us::fathom>(meter) << '\n'; // `us` system namespace collides with a microsecond (si::time::us)
+  std::cout << " = " << quantity_cast<units::isq::si::uscs::fathom>(meter) << '\n'; // `us` system namespace collides with a microsecond (si::time::uscs)
   std::cout << " = " << international::ft<>(meter) << '\n';
-  std::cout << " = " << quantity_cast<units::isq::si::us::foot>(meter) << '\n'; // `us` system namespace collides with a microsecond (si::time::us)
+  std::cout << " = " << quantity_cast<units::isq::si::uscs::foot>(meter) << '\n'; // `us` system namespace collides with a microsecond (si::time::uscs)
   std::cout << " = " << international::in<>(meter) << '\n';
   std::cout << " = " << iau::ly<>(meter) << '\n';
   std::cout << " = " << international::mi<>(meter) << '\n';

example/literals/CMakeLists.txt

@@ -34,7 +34,7 @@ endfunction()
 add_example(avg_speed mp-units::core-io mp-units::si mp-units::si-cgs mp-units::si-international)
 add_example(box_example mp-units::core-fmt mp-units::si)
 add_example(capacitor_time_curve mp-units::core-io mp-units::si)
-add_example(clcpp_response mp-units::core-fmt mp-units::core-io mp-units::si mp-units::si-iau mp-units::si-imperial mp-units::si-international mp-units::si-typographic mp-units::si-us)
+add_example(clcpp_response mp-units::core-fmt mp-units::core-io mp-units::si mp-units::si-iau mp-units::si-imperial mp-units::si-international mp-units::si-typographic mp-units::si-uscs)
 add_example(experimental_angle mp-units::core-fmt mp-units::core-io mp-units::si)
 add_example(foot_pound_second mp-units::core-fmt mp-units::si-fps)
 add_example(total_energy mp-units::core-io mp-units::si mp-units::isq-natural)

example/literals/clcpp_response.cpp

@@ -23,7 +23,7 @@
 #include <units/isq/si/length.h>
 #include <units/isq/si/time.h>
 #include <units/isq/si/typographic/length.h>
-#include <units/isq/si/us/length.h>
+#include <units/isq/si/uscs/length.h>
 #include <units/quantity_io.h>
 #include <iostream>
 
@@ -87,9 +87,9 @@ void quantities_with_typed_units()
   std::cout << " = " << quantity_cast<si::iau::angstrom>(meter) << '\n';
   std::cout << " = " << quantity_cast<si::imperial::chain>(meter) << '\n';
   std::cout << " = " << quantity_cast<si::international::fathom>(meter) << '\n';
-  std::cout << " = " << quantity_cast<si::us::fathom>(meter) << '\n';
+  std::cout << " = " << quantity_cast<si::uscs::fathom>(meter) << '\n';
   std::cout << " = " << quantity_cast<si::international::foot>(meter) << '\n';
-  std::cout << " = " << quantity_cast<si::us::foot>(meter) << '\n';
+  std::cout << " = " << quantity_cast<si::uscs::foot>(meter) << '\n';
   std::cout << " = " << quantity_cast<si::international::inch>(meter) << '\n';
   std::cout << " = " << quantity_cast<si::iau::light_year>(meter) << '\n';
   std::cout << " = " << quantity_cast<si::international::mile>(meter) << '\n';

example/references/CMakeLists.txt

@@ -34,7 +34,7 @@ endfunction()
 add_example(avg_speed mp-units::core-io mp-units::si mp-units::si-cgs mp-units::si-international)
 add_example(box_example mp-units::core-fmt mp-units::si)
 add_example(capacitor_time_curve mp-units::core-io mp-units::si)
-add_example(clcpp_response mp-units::core-fmt mp-units::core-io mp-units::si mp-units::si-iau mp-units::si-imperial mp-units::si-international mp-units::si-typographic mp-units::si-us)
+add_example(clcpp_response mp-units::core-fmt mp-units::core-io mp-units::si mp-units::si-iau mp-units::si-imperial mp-units::si-international mp-units::si-typographic mp-units::si-uscs)
 add_example(experimental_angle mp-units::core-fmt mp-units::core-io mp-units::si)
 add_example(foot_pound_second mp-units::core-fmt mp-units::si-fps)
 add_example(total_energy mp-units::core-io mp-units::si mp-units::isq-natural)

example/references/clcpp_response.cpp

@@ -23,7 +23,7 @@
 #include <units/isq/si/length.h>
 #include <units/isq/si/time.h>
 #include <units/isq/si/typographic/length.h>
-#include <units/isq/si/us/length.h>
+#include <units/isq/si/uscs/length.h>
 #include <units/quantity_io.h>
 #include <iostream>
 
@@ -89,9 +89,9 @@ void quantities_with_typed_units()
   std::cout << " = " << quantity_cast<si::iau::angstrom>(meter) << '\n';
   std::cout << " = " << quantity_cast<si::imperial::chain>(meter) << '\n';
   std::cout << " = " << quantity_cast<si::international::fathom>(meter) << '\n';
-  std::cout << " = " << quantity_cast<si::us::fathom>(meter) << '\n';
+  std::cout << " = " << quantity_cast<si::uscs::fathom>(meter) << '\n';
   std::cout << " = " << quantity_cast<si::international::foot>(meter) << '\n';
-  std::cout << " = " << quantity_cast<si::us::foot>(meter) << '\n';
+  std::cout << " = " << quantity_cast<si::uscs::foot>(meter) << '\n';
   std::cout << " = " << quantity_cast<si::international::inch>(meter) << '\n';
   std::cout << " = " << quantity_cast<si::iau::light_year>(meter) << '\n';
   std::cout << " = " << quantity_cast<si::international::mile>(meter) << '\n';

src/systems/CMakeLists.txt

@@ -33,7 +33,7 @@ add_subdirectory(si-iau)
 add_subdirectory(si-imperial)
 add_subdirectory(si-international)
 add_subdirectory(si-typographic)
-add_subdirectory(si-us)
+add_subdirectory(si-uscs)
 
 # wrapper for all the systems
 add_library(mp-units-systems INTERFACE)
@@ -48,7 +48,7 @@ target_link_libraries(mp-units-systems INTERFACE
     mp-units::si-imperial
     mp-units::si-international
     mp-units::si-typographic
-    mp-units::si-us
+    mp-units::si-uscs
 )
 add_library(mp-units::systems ALIAS mp-units-systems)
 install(TARGETS mp-units-systems EXPORT mp-unitsTargets)

src/systems/si-uscs/CMakeLists.txt

@@ -22,4 +22,4 @@
 
 cmake_minimum_required(VERSION 3.15)
 
-add_units_module(si-us mp-units::si)
+add_units_module(si-uscs mp-units::si)

src/systems/si-uscs/include/units/isq/si/uscs/length.h

@@ -32,7 +32,7 @@
 #include <units/isq/si/length.h>
 #include <units/unit.h>
 
-namespace units::isq::si::us {
+namespace units::isq::si::uscs {
 
 // https://en.wikipedia.org/wiki/Foot_(unit)#US_survey_foot
 // https://www.nist.gov/pml/special-publication-811/nist-guide-si-appendix-b-conversion-factors#B6
@@ -50,16 +50,16 @@ struct mile : named_scaled_unit<mile, "mi(us)", no_prefix, ratio(5280), foot> {}
 inline namespace literals {
 
 // ft
-constexpr auto operator"" _q_ft_us(unsigned long long l) { gsl_ExpectsAudit(std::in_range<std::int64_t>(l)); return si::length<units::isq::si::us::foot, std::int64_t>(static_cast<std::int64_t>(l)); }
+constexpr auto operator"" _q_ft_us(unsigned long long l) { gsl_ExpectsAudit(std::in_range<std::int64_t>(l)); return si::length<units::isq::si::uscs::foot, std::int64_t>(static_cast<std::int64_t>(l)); }
-constexpr auto operator"" _q_ft_us(long double l) { return si::length<units::isq::si::us::foot, long double>(l); }
+constexpr auto operator"" _q_ft_us(long double l) { return si::length<units::isq::si::uscs::foot, long double>(l); }
 
 // fathom
-constexpr auto operator"" _q_fathom_us(unsigned long long l) { gsl_ExpectsAudit(std::in_range<std::int64_t>(l)); return si::length<units::isq::si::us::fathom, std::int64_t>(static_cast<std::int64_t>(l)); }
+constexpr auto operator"" _q_fathom_us(unsigned long long l) { gsl_ExpectsAudit(std::in_range<std::int64_t>(l)); return si::length<units::isq::si::uscs::fathom, std::int64_t>(static_cast<std::int64_t>(l)); }
-constexpr auto operator"" _q_fathom_us(long double l) { return si::length<units::isq::si::us::fathom, long double>(l); }
+constexpr auto operator"" _q_fathom_us(long double l) { return si::length<units::isq::si::uscs::fathom, long double>(l); }
 
 // mi
-constexpr auto operator"" _q_mi_us(unsigned long long l) { gsl_ExpectsAudit(std::in_range<std::int64_t>(l)); return si::length<units::isq::si::us::mile, std::int64_t>(static_cast<std::int64_t>(l)); }
+constexpr auto operator"" _q_mi_us(unsigned long long l) { gsl_ExpectsAudit(std::in_range<std::int64_t>(l)); return si::length<units::isq::si::uscs::mile, std::int64_t>(static_cast<std::int64_t>(l)); }
-constexpr auto operator"" _q_mi_us(long double l) { return si::length<units::isq::si::us::mile, long double>(l); }
+constexpr auto operator"" _q_mi_us(long double l) { return si::length<units::isq::si::uscs::mile, long double>(l); }
 
 }  // namespace literals
 
@@ -69,9 +69,9 @@ constexpr auto operator"" _q_mi_us(long double l) { return si::length<units::isq
 
 namespace length_references {
 
-inline constexpr auto ft = reference<si::dim_length, us::foot>{};
+inline constexpr auto ft = reference<si::dim_length, uscs::foot>{};
-inline constexpr auto fathom = reference<si::dim_length, us::fathom>{};
+inline constexpr auto fathom = reference<si::dim_length, uscs::fathom>{};
-inline constexpr auto mi = reference<si::dim_length, us::mile>{};
+inline constexpr auto mi = reference<si::dim_length, uscs::mile>{};
 
 }  // namespace length_references
 
@@ -83,16 +83,16 @@ using namespace length_references;
 
 #endif // UNITS_REFERENCES
 
-}  // namespace units::isq::si::us
+}  // namespace units::isq::si::uscs
 
 #ifdef UNITS_ALIASES
 
-namespace units::aliases::isq::si::us::inline length {
+namespace units::aliases::isq::si::uscs::inline length {
 
-template<Representation Rep = double> using ft = units::isq::si::length<units::isq::si::us::foot, Rep>;
+template<Representation Rep = double> using ft = units::isq::si::length<units::isq::si::uscs::foot, Rep>;
-template<Representation Rep = double> using fathom = units::isq::si::length<units::isq::si::us::fathom, Rep>;
+template<Representation Rep = double> using fathom = units::isq::si::length<units::isq::si::uscs::fathom, Rep>;
-template<Representation Rep = double> using mi = units::isq::si::length<units::isq::si::us::mile, Rep>;
+template<Representation Rep = double> using mi = units::isq::si::length<units::isq::si::uscs::mile, Rep>;
 
-}  // namespace units::aliases::isq::si::us::inline length
+}  // namespace units::aliases::isq::si::uscs::inline length
 
 #endif // UNITS_ALIASES

src/systems/si-uscs/include/units/isq/si/uscs/uscs.h

@@ -23,5 +23,5 @@
 #pragma once
 
 // IWYU pragma: begin_exports
-#include <units/isq/si/us/length.h>
+#include <units/isq/si/uscs/length.h>
 // IWYU pragma: end_exports

test/unit_test/runtime/fmt_units_test.cpp

@@ -28,13 +28,13 @@
 #include <units/isq/si/international/international.h>
 #include <units/isq/si/si.h>
 #include <units/isq/si/typographic/typographic.h>
-#include <units/isq/si/us/us.h>
+#include <units/isq/si/uscs/uscs.h>
 #include <catch2/catch.hpp>
 
 using namespace units::isq::si;
 using namespace units::isq::si::references;
 using namespace units::isq::si::international;
-using namespace units::isq::si::us;
+using namespace units::isq::si::uscs;
 using namespace units::isq::si::iau;
 using namespace units::isq::si::imperial;
 using namespace units::isq::si::imperial::references;

test/unit_test/static/quantity_point_test.cpp

@@ -27,7 +27,7 @@
 #include <units/chrono.h>
 #include <units/isq/si/length.h>
 #include <units/isq/si/speed.h>
-#include <units/isq/si/us/length.h>
+#include <units/isq/si/uscs/length.h>
 #include <units/isq/si/volume.h>
 #include <limits>
 #include <type_traits>
@@ -215,7 +215,7 @@ static_assert(compare<common_quantity_point<quantity_point<dim_length, kilometre
 
 // common_type
 
-using namespace units::isq::si::us::literals;
+using namespace units::isq::si::uscs::literals;
 
 static_assert(std::equality_comparable<decltype(quantity_point(1_q_m))>);
 static_assert(std::equality_comparable_with<decltype(quantity_point(1_q_m)), decltype(quantity_point(1_q_km))>);