xo-unit: refactor: ++ docs

This commit is contained in:
Roland Conybeare 2024-05-07 23:12:04 -04:00
commit 5fd6bd3148
11 changed files with 225 additions and 151 deletions

View file

@ -63,97 +63,115 @@ namespace xo {
}
///@}
namespace bu {
// ----- mass -----
namespace detail {
namespace bu {
// ----- mass -----
/** @defgroup basis-unit-mass-units **/
///@{
constexpr basis_unit picogram = basis_unit(dim::mass, scalefactor_ratio_type( 1, 1000000000000));
constexpr basis_unit nanogram = basis_unit(dim::mass, scalefactor_ratio_type( 1, 1000000000));
constexpr basis_unit microgram = basis_unit(dim::mass, scalefactor_ratio_type( 1, 1000000));
constexpr basis_unit milligram = basis_unit(dim::mass, scalefactor_ratio_type( 1, 1000));
constexpr basis_unit gram = basis_unit(dim::mass, scalefactor_ratio_type( 1, 1));
constexpr basis_unit kilogram = basis_unit(dim::mass, scalefactor_ratio_type( 1000, 1));
constexpr basis_unit tonne = basis_unit(dim::mass, scalefactor_ratio_type( 1000000, 1));
constexpr basis_unit kilotonne = basis_unit(dim::mass, scalefactor_ratio_type( 1000000000, 1));
constexpr basis_unit megatonne = basis_unit(dim::mass, scalefactor_ratio_type( 1000000000000, 1));
constexpr basis_unit gigatonne = basis_unit(dim::mass, scalefactor_ratio_type(1000000000000000, 1));
///@}
constexpr basis_unit mass_unit(std::int64_t num, std::int64_t den) {
return basis_unit(dimension::mass, scalefactor_ratio_type(num, den));
}
// ----- distance -----
/** @defgroup basis-unit-mass-units **/
///@{
constexpr basis_unit picogram = mass_unit( 1, 1000000000000);
constexpr basis_unit nanogram = mass_unit( 1, 1000000000);
constexpr basis_unit microgram = mass_unit( 1, 1000000);
constexpr basis_unit milligram = mass_unit( 1, 1000);
constexpr basis_unit gram = mass_unit( 1, 1);
constexpr basis_unit kilogram = mass_unit( 1000, 1);
constexpr basis_unit tonne = mass_unit( 1000000, 1);
constexpr basis_unit kilotonne = mass_unit( 1000000000, 1);
constexpr basis_unit megatonne = mass_unit( 1000000000000, 1);
constexpr basis_unit gigatonne = mass_unit(1000000000000000, 1);
///@}
/** @defgroup basis-unit-distance-units **/
///@{
/* International spelling */
constexpr basis_unit picometre = basis_unit(dim::distance, scalefactor_ratio_type( 1, 1000000000000));
constexpr basis_unit nanometre = basis_unit(dim::distance, scalefactor_ratio_type( 1, 1000000000));
constexpr basis_unit micrometre = basis_unit(dim::distance, scalefactor_ratio_type( 1, 1000000));
constexpr basis_unit millimetre = basis_unit(dim::distance, scalefactor_ratio_type( 1, 1000));
constexpr basis_unit metre = basis_unit(dim::distance, scalefactor_ratio_type( 1, 1));
constexpr basis_unit kilometre = basis_unit(dim::distance, scalefactor_ratio_type( 1000, 1));
constexpr basis_unit megametre = basis_unit(dim::distance, scalefactor_ratio_type( 1000000, 1));
constexpr basis_unit gigametre = basis_unit(dim::distance, scalefactor_ratio_type( 1000000000, 1));
// ----- distance -----
constexpr basis_unit lightsecond = basis_unit(dim::distance, scalefactor_ratio_type( 299792458, 1));
constexpr basis_unit astronomicalunit = basis_unit(dim::distance, scalefactor_ratio_type( 149597870700, 1));
constexpr basis_unit distance_unit(std::int64_t num, std::int64_t den) {
return basis_unit(dimension::distance, scalefactor_ratio_type(num, den));
}
/* US spelling */
constexpr basis_unit picometer = picometre;
constexpr basis_unit nanometer = nanometre;
constexpr basis_unit micrometer = micrometre;
constexpr basis_unit millimeter = millimetre;
constexpr basis_unit meter = metre;
constexpr basis_unit kilometer = kilometre;
constexpr basis_unit megameter = megametre;
constexpr basis_unit gigameter = gigametre;
/** @defgroup basis-unit-distance-units **/
///@{
/* International spelling */
constexpr basis_unit picometre = distance_unit( 1, 1000000000000);
constexpr basis_unit nanometre = distance_unit( 1, 1000000000);
constexpr basis_unit micrometre = distance_unit( 1, 1000000);
constexpr basis_unit millimetre = distance_unit( 1, 1000);
constexpr basis_unit metre = distance_unit( 1, 1);
constexpr basis_unit kilometre = distance_unit( 1000, 1);
constexpr basis_unit megametre = distance_unit( 1000000, 1);
constexpr basis_unit gigametre = distance_unit( 1000000000, 1);
/** @brief basis-unit representing 1 inch; defined as exactly 1/12 feet **/
constexpr basis_unit inch = basis_unit(dim::distance, scalefactor_ratio_type( 3048, 120000));
/** @brief basis-unit representing 1 foot; defined as exactly 0.3048 meters **/
constexpr basis_unit foot = basis_unit(dim::distance, scalefactor_ratio_type( 3048, 10000));
/** @brief basis-unit representing 1 yard; defined as exactly 3 feet **/
constexpr basis_unit yard = basis_unit(dim::distance, scalefactor_ratio_type( 3*3048, 10000));
/** @brief basis-unit representing 1 mile; defined as exactly 1760 yards = 5280 feet **/
constexpr basis_unit mile = basis_unit(dim::distance, scalefactor_ratio_type( 5280*3048, 10000));
///@}
constexpr basis_unit lightsecond = distance_unit( 299792458, 1);
constexpr basis_unit astronomicalunit = distance_unit( 149597870700, 1);
// ----- time -----
/* US spelling */
constexpr basis_unit picometer = picometre;
constexpr basis_unit nanometer = nanometre;
constexpr basis_unit micrometer = micrometre;
constexpr basis_unit millimeter = millimetre;
constexpr basis_unit meter = metre;
constexpr basis_unit kilometer = kilometre;
constexpr basis_unit megameter = megametre;
constexpr basis_unit gigameter = gigametre;
/** @defgroup basis-unit-time-units **/
///@{
constexpr basis_unit picosecond = basis_unit(dim::time, scalefactor_ratio_type( 1, 1000000000000));
constexpr basis_unit nanosecond = basis_unit(dim::time, scalefactor_ratio_type( 1, 1000000000));
constexpr basis_unit microsecond = basis_unit(dim::time, scalefactor_ratio_type( 1, 1000000));
constexpr basis_unit millisecond = basis_unit(dim::time, scalefactor_ratio_type( 1, 1000));
constexpr basis_unit second = basis_unit(dim::time, scalefactor_ratio_type( 1, 1));
constexpr basis_unit minute = basis_unit(dim::time, scalefactor_ratio_type( 60, 1));
constexpr basis_unit hour = basis_unit(dim::time, scalefactor_ratio_type( 3600, 1));
constexpr basis_unit day = basis_unit(dim::time, scalefactor_ratio_type( 24*3600, 1));
constexpr basis_unit week = basis_unit(dim::time, scalefactor_ratio_type( 7*24*3600, 1));
constexpr basis_unit month = basis_unit(dim::time, scalefactor_ratio_type( 30*24*3600, 1));
constexpr basis_unit year = basis_unit(dim::time, scalefactor_ratio_type((365*24+6)*3600, 1));
/** @brief basis-unit representing 1 inch; defined as exactly 1/12 feet **/
constexpr basis_unit inch = distance_unit( 3048, 120000);
/** @brief basis-unit representing 1 foot; defined as exactly 0.3048 meters **/
constexpr basis_unit foot = distance_unit( 3048, 10000);
/** @brief basis-unit representing 1 yard; defined as exactly 3 feet **/
constexpr basis_unit yard = distance_unit( 3*3048, 10000);
/** @brief basis-unit representing 1 mile; defined as exactly 1760 yards = 5280 feet **/
constexpr basis_unit mile = distance_unit( 5280*3048, 10000);
///@}
/* alt conventions used in finance */
constexpr basis_unit year365 = basis_unit(dim::time, scalefactor_ratio_type( 365*24*3600, 1));
constexpr basis_unit year360 = basis_unit(dim::time, scalefactor_ratio_type( 360*24*3600, 1));
/* 250 = approx number of trading days in a calendar year */
constexpr basis_unit year250 = basis_unit(dim::time, scalefactor_ratio_type( 250*24*3600, 1));
///@}
// ----- time -----
// ----- currency -----
constexpr basis_unit time_unit(std::int64_t num, std::int64_t den) {
return basis_unit(dimension::time, scalefactor_ratio_type(num, den));
}
/** @defgroup basis-unit-misc-units **/
///@{
/** @defgroup basis-unit-time-units **/
///@{
constexpr basis_unit picosecond = time_unit( 1, 1000000000000);
constexpr basis_unit nanosecond = time_unit( 1, 1000000000);
constexpr basis_unit microsecond = time_unit( 1, 1000000);
constexpr basis_unit millisecond = time_unit( 1, 1000);
constexpr basis_unit second = time_unit( 1, 1);
constexpr basis_unit minute = time_unit( 60, 1);
constexpr basis_unit hour = time_unit( 3600, 1);
constexpr basis_unit day = time_unit( 24*3600, 1);
constexpr basis_unit week = time_unit( 7*24*3600, 1);
constexpr basis_unit month = time_unit( 30*24*3600, 1);
constexpr basis_unit year = time_unit( (365*24+6)*3600, 1);
/* pseudounit -- placeholder for any actual currency amount */
constexpr basis_unit currency = basis_unit(dim::currency, scalefactor_ratio_type( 1, 1));
/* alt conventions used in finance */
constexpr basis_unit year365 = time_unit( 365*24*3600, 1);
constexpr basis_unit year360 = time_unit( 360*24*3600, 1);
/* 250 = approx number of trading days in a calendar year */
constexpr basis_unit year250 = time_unit( 250*24*3600, 1);
// ----- price -----
constexpr basis_unit century = time_unit( 100L*(365*24+6)*3600, 1);
constexpr basis_unit millenium = time_unit(1000L*(365*24+6)*3600, 1);
///@}
// ----- currency -----
/** @defgroup basis-unit-misc-units **/
///@{
/* pseudounit -- placeholder for any actual currency amount */
constexpr basis_unit currency = basis_unit(dim::currency, scalefactor_ratio_type( 1, 1));
// ----- price -----
/* psuedounit -- context-dependent interpretation */
constexpr basis_unit price = basis_unit(dim::price, scalefactor_ratio_type( 1, 1));
///@}
} /*namespace bu*/
} /*namespace detail*/
/* psuedounit -- context-dependent interpretation */
constexpr basis_unit price = basis_unit(dim::price, scalefactor_ratio_type( 1, 1));
///@}
}
namespace units {
/** for runtime work, would like to be able to promptly find special abbreviation