Merge pull request #87 from bernedom/documentation/remove-bintray-links

Documentation/remove bintray links
bernedom · Mar 12, 2021 · b490c65 · b490c65 · bernedom · Mar 12, 2021
2 parents 417e517 + 5c01160
commit b490c65
Show file tree

Hide file tree

Showing 43 changed files with 90 additions and 108 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.0.5
+
+*   Fixed typos in documentation
+
 ## 2.0.4
 
 *   Add literals for ton types up to peta ton

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.12)
 
 project(
   "SI"
-  VERSION 2.0.4
+  VERSION 2.0.5
   DESCRIPTION
     "A header only c++ library that provides type safety and user defined literals for handling pyhsical values defined in the International System of Units."
   HOMEPAGE_URL "https://github.com/bernedom/SI"
@@ -61,8 +61,8 @@ if(SI_INSTALL_LIBRARY)
 
   configure_package_config_file(
     "${PROJECT_SOURCE_DIR}/cmake/${PROJECT_NAME}Config.cmake.in"
-    "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake" INSTALL_DESTINATION
-    ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake)
+    "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
+    INSTALL_DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake)
 
   install(
     EXPORT ${PROJECT_NAME}_Targets

diff --git a/README.md b/README.md
@@ -50,11 +50,11 @@ The typedefs are prefixed (or in rare cases interfixed) with the standard metric
 | --------------------------- | ---------------- | ----------- | --------------------------------------------------- | --------------------------------- |
 | Length                      | L                | m           | 10<sup>-18</sup> to 10<sup>18</sup>                 | `*_metre_t`                       |
 | Time                        | T                | s           | 10<sup>-18</sup> to 10<sup>0</sup> and 60/1, 3600/1 | `*_seconds_t, minutes_t, hours_t` |
-| Mass*                       | M                | kg          | 10<sup>-15</sup> to 10<sup>18</sup>                 | `*_gram_t`, `*_ton_t`               |
+| Mass*                       | M                | kg          | 10<sup>-15</sup> to 10<sup>18</sup>                 | `*_gram_t`, `*_ton_t`             |
 | Electric current            | I                | A           | 10<sup>-18</sup> to 10<sup>18</sup>                 | `*_ampere_t`                      |
 | Thermodynamic temperature** | t                | K           | 10<sup>-18</sup> to 10<sup>18</sup>                 | `*_kelvin_t`                      |
 | Amount of substance         | N                | mol         | 10<sup>-18</sup> to 10<sup>18</sup>                 | `*_mol_t`                         |
-| Luminousity                 | J                | cd          | 10<sup>-18</sup> to 10<sup>18</sup>                 | `*_candela_t`                     |
+| Luminosity                  | J                | cd          | 10<sup>-18</sup> to 10<sup>18</sup>                 | `*_candela_t`                     |
 
 \* for mass the base ratio is `kg` (not `g`) as defined in the SI unit table. So there is a mismatch between the literal prefix and the internal representation.
 
@@ -76,7 +76,7 @@ The typedefs are prefixed (or in rare cases interfixed) with the standard metric
 
 All units that can be built from other units decay to the respective units by inverting the mathematical operation. I.e if `Q = I * T` then `Q / I = T` and `Q / T = I`
 
-| Unit                 | Dimension Symbol | Unit Symbol | builable from    | implemented literals    | unit typedefs                                                      |
+| Unit                 | Dimension Symbol | Unit Symbol | buildable from   | implemented literals    | unit typedefs                                                      |
 | -------------------- | ---------------- | ----------- | ---------------- | ----------------------- | ------------------------------------------------------------------ |
 | Velocity             | v                | m/s         | L / T            | `m_p_s`, `km_p_h`, `_c` | `metre_per_second_t`, `kilometre_per_second_t`, `speed_of_light_t` |
 | Acceleration         | a                | m/s^2       | v / T, v^2 / L   | none                    | none                                                               |
@@ -135,7 +135,7 @@ See [the installation guide](doc/installation-guide.md) for detailed instruction
 
 ## Packaging
 
-SI is available as 'raw' download from this repo but also as [conan package](https://bintray.com/bernedom/conan/si%3ASI/_latestVersion). All releases are available from `SI/stable` from bintray. Getting SI from there is the preferred way.
+SI is available as 'raw' download from this repository but also as [conan package](https://conan.io/center/si). Getting SI from conan-center is the preferred way.
 
 ## Implementation details
 

diff --git a/doc/installation-guide.md b/doc/installation-guide.md
@@ -1,6 +1,6 @@
 # Installing `SI`
 
-The default installation location for SI is  `/usr/local/lib/SI`. SI can be installed using raw cmake, cpack (cmakes package mechanism), or as a conan.io package provided from [Bintray](https://bintray.com/bernedom/conan/SI%3ASI)
+The default installation location for SI is  `/usr/local/lib/si`. SI can be installed using raw cmake, cpack (cmakes package mechanism), or as a conan.io package provided from [conan center](https://conan.io/center/si). Early access to conan packages for unstable versions is available from [Bintray](https://bintray.com/bernedom/conan/si%3ASI)
 
 ## Installing using cmake
 

diff --git a/include/SI/absorbed_dose.h b/include/SI/absorbed_dose.h
@@ -1,5 +1,5 @@
 /**
- * This file is part of "SI" version 2.0.4
+ * This file is part of "SI" version 2.0.5
  * A header only c++ library that provides type safety and user defined literals
  * for handling pyhsical values defined in the International System of
  * Units

diff --git a/include/SI/acceleration.h b/include/SI/acceleration.h
@@ -1,5 +1,5 @@
 /**
- * This file is part of "SI" version 2.0.4
+ * This file is part of "SI" version 2.0.5
  * A header only c++ library that provides type safety and user defined literals
  * for handling pyhsical values defined in the International System of
  * Units

diff --git a/include/SI/angle.h b/include/SI/angle.h
@@ -1,5 +1,5 @@
 /**
- * This file is part of "SI" version 2.0.4
+ * This file is part of "SI" version 2.0.5
  * A header only c++ library that provides type safety and user defined literals
  * for handling pyhsical values defined in the International System of
  * Units

diff --git a/include/SI/area.h b/include/SI/area.h
@@ -1,5 +1,5 @@
 /**
- * This file is part of "SI" version 2.0.4
+ * This file is part of "SI" version 2.0.5
  * A header only c++ library that provides type safety and user defined literals
  * for handling pyhsical values defined in the International System of
  * Units

diff --git a/include/SI/astronomic.h b/include/SI/astronomic.h
@@ -1,5 +1,5 @@
 /**
- * This file is part of "SI" version 2.0.4
+ * This file is part of "SI" version 2.0.5
  * A header only c++ library that provides type safety and user defined literals
  * for handling pyhsical values defined in the International System of
  * Units

diff --git a/include/SI/catalytic_activity.h b/include/SI/catalytic_activity.h
@@ -1,5 +1,5 @@
 /**
- * This file is part of "SI" version 2.0.4
+ * This file is part of "SI" version 2.0.5
  * A header only c++ library that provides type safety and user defined literals
  * for handling pyhsical values defined in the International System of
  * Units

diff --git a/include/SI/detail/detail.h b/include/SI/detail/detail.h
@@ -1,5 +1,5 @@
 /**
- * This file is part of "SI" version 2.0.4
+ * This file is part of "SI" version 2.0.5
  * A header only c++ library that provides type safety and user defined literals
  * for handling pyhsical values defined in the International System of
  * Units
@@ -31,8 +31,7 @@ struct is_ratio<std::ratio<_num, _den>> : std::true_type {};
 template <typename _type>
 inline constexpr bool is_ratio_v = is_ratio<_type>::value;
 
-template <typename T,
-          std::enable_if_t<std::is_floating_point_v<T>> * = nullptr>
+template <typename T, std::enable_if_t<std::is_floating_point_v<T>> * = nullptr>
 constexpr bool epsEqual(const T &lhs, const T &rhs) {
 
   return (lhs - rhs) < std::numeric_limits<T>::epsilon() &&

diff --git a/include/SI/detail/number_parser.h b/include/SI/detail/number_parser.h
@@ -1,5 +1,5 @@
 /**
- * This file is part of "SI" version 2.0.4
+ * This file is part of "SI" version 2.0.5
  * A header only c++ library that provides type safety and user defined literals
  * for handling pyhsical values defined in the International System of
  * Units

diff --git a/include/SI/detail/operator_helpers.h b/include/SI/detail/operator_helpers.h
@@ -1,5 +1,5 @@
 /**
- * This file is part of "SI" version 2.0.4
+ * This file is part of "SI" version 2.0.5
  * A header only c++ library that provides type safety and user defined literals
  * for handling pyhsical values defined in the International System of
  * Units

diff --git a/include/SI/detail/unit.h b/include/SI/detail/unit.h
@@ -1,5 +1,5 @@
 /**
- * This file is part of "SI" version 2.0.4
+ * This file is part of "SI" version 2.0.5
  * A header only c++ library that provides type safety and user defined literals
  * for handling pyhsical values defined in the International System of
  * Units
@@ -51,10 +51,8 @@ template <typename _unit_lhs, typename _unit_rhs> struct unit_with_common_ratio;
 template <char _symbol, typename _exponent, typename _type,
           typename _ratio = std::ratio<1>>
 struct unit_t {
-  static_assert(std::is_arithmetic_v<_type>,
-                "Type is an arithmetic value");
-  static_assert(detail::is_ratio_v<_exponent>,
-                "_exponent is a ratio type");
+  static_assert(std::is_arithmetic_v<_type>, "Type is an arithmetic value");
+  static_assert(detail::is_ratio_v<_exponent>, "_exponent is a ratio type");
   static_assert(detail::is_ratio_v<_ratio>, "_ratio is a std::ratio");
   using ratio = _ratio;
   using internal_type = _type;
@@ -81,8 +79,7 @@ struct unit_t {
   constexpr unit_t(const unit_t<_symbol, _exponent, _rhs_type, _rhs_ratio> &rhs)
       : value_{
             unit_cast<unit_t<_symbol, _exponent, _type, _ratio>>(rhs).value()} {
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
     static_assert(
         SI_ENABLE_IMPLICIT_RATIO_CONVERSION ||
             std::ratio_equal_v<ratio, _rhs_ratio>,
@@ -94,8 +91,7 @@ struct unit_t {
       : value_{
             std::move(unit_cast<unit_t<_symbol, _exponent, _type, _ratio>>(rhs)
                           .value())} {
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
     static_assert(
         SI_ENABLE_IMPLICIT_RATIO_CONVERSION ||
             std::ratio_equal_v<ratio, _rhs_ratio>,
@@ -115,14 +111,13 @@ struct unit_t {
   constexpr unit_t &operator=(unit_t &&rhs) = default;
 
   /// Assignment of same unit but different ratio
-  template <typename _rhs_ratio,
-            std::enable_if_t<!std::ratio_equal_v<_rhs_ratio, _ratio>> * =
-                nullptr>
+  template <
+      typename _rhs_ratio,
+      std::enable_if_t<!std::ratio_equal_v<_rhs_ratio, _ratio>> * = nullptr>
   constexpr unit_t &
   operator=(const unit_t<_symbol, _exponent, _type, _rhs_ratio> &rhs) {
 
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
     static_assert(
         SI_ENABLE_IMPLICIT_RATIO_CONVERSION ||
             std::ratio_equal_v<ratio, _rhs_ratio>,
@@ -133,14 +128,13 @@ struct unit_t {
   }
 
   /// Move assignment of same unit but different ratio
-  template <typename _rhs_ratio,
-            std::enable_if_t<!std::ratio_equal_v<_rhs_ratio, _ratio>> * =
-                nullptr>
+  template <
+      typename _rhs_ratio,
+      std::enable_if_t<!std::ratio_equal_v<_rhs_ratio, _ratio>> * = nullptr>
   constexpr unit_t &
   operator=(unit_t<_symbol, _exponent, _type, _rhs_ratio> &&rhs) {
 
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
     static_assert(
         SI_ENABLE_IMPLICIT_RATIO_CONVERSION ||
             std::ratio_equal_v<ratio, _rhs_ratio>,
@@ -162,10 +156,8 @@ struct unit_t {
             std::ratio_equal_v<ratio, _rhs_ratio>,
         "Implicit ratio conversion disabled, convert before comparing");
 
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
-    static_assert(std::is_integral_v<_type> ||
-                      std::is_floating_point_v<_type>,
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
+    static_assert(std::is_integral_v<_type> || std::is_floating_point_v<_type>,
                   "Is integral or floating point");
     using gcd_unit = typename unit_with_common_ratio<
         typename std::remove_reference<decltype(rhs)>::type,
@@ -185,16 +177,14 @@ struct unit_t {
   template <typename _rhs_type, typename _rhs_ratio>
   constexpr bool operator!=(
       const unit_t<_symbol, _exponent, _rhs_type, _rhs_ratio> &rhs) const {
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
     return !(*this == rhs);
   }
 
   template <typename _rhs_type, typename _rhs_ratio>
   constexpr bool operator<(
       const unit_t<_symbol, _exponent, _rhs_type, _rhs_ratio> &rhs) const {
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
     static_assert(
         SI_ENABLE_IMPLICIT_RATIO_CONVERSION ||
             std::ratio_equal_v<ratio, _rhs_ratio>,
@@ -216,8 +206,7 @@ struct unit_t {
   template <typename _rhs_type, typename _rhs_ratio>
   constexpr bool operator>(
       const unit_t<_symbol, _exponent, _rhs_type, _rhs_ratio> &rhs) const {
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
     static_assert(
         SI_ENABLE_IMPLICIT_RATIO_CONVERSION ||
             std::ratio_equal_v<ratio, _rhs_ratio>,
@@ -260,8 +249,7 @@ struct unit_t {
       const unit_t<_symbol, _rhs_exponent, _rhs_type, _rhs_ratio> &rhs) const {
     static_assert(detail::is_ratio_v<_rhs_exponent>,
                   "rhs exponent is a ratio type");
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
 
     static_assert(
         SI_ENABLE_IMPLICIT_RATIO_CONVERSION ||
@@ -283,10 +271,9 @@ struct unit_t {
 
   /// divide with same unit with same ratio but not the same exponent
   /// @returns unit with exponents subtracted from each others
-  template <
-      typename _rhs_exponent, typename _rhs_type,
-      std::enable_if_t<std::ratio_not_equal_v<_rhs_exponent, _exponent>>
-          * = nullptr>
+  template <typename _rhs_exponent, typename _rhs_type,
+            std::enable_if_t<std::ratio_not_equal_v<_rhs_exponent, _exponent>>
+                * = nullptr>
   constexpr auto operator/(
       const unit_t<_symbol, _rhs_exponent, _rhs_type, _ratio> &rhs) const {
     static_assert(detail::is_ratio_v<_rhs_exponent>,
@@ -302,14 +289,12 @@ struct unit_t {
   /// divide with a same unit but different ratios
   /// the ratio of the result is the gcd of the two ratios and the exponents are
   /// subtracted
-  template <
-      typename _rhs_exponent, typename _rhs_type, typename _rhs_ratio,
-      std::enable_if_t<std::ratio_not_equal_v<_rhs_exponent, _exponent>>
-          * = nullptr>
+  template <typename _rhs_exponent, typename _rhs_type, typename _rhs_ratio,
+            std::enable_if_t<std::ratio_not_equal_v<_rhs_exponent, _exponent>>
+                * = nullptr>
   constexpr auto operator/(
       const unit_t<_symbol, _rhs_exponent, _rhs_type, _rhs_ratio> &rhs) const {
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
     static_assert(detail::is_ratio_v<_rhs_exponent>,
                   "rhs exponent is a ratio type");
     static_assert(
@@ -330,18 +315,17 @@ struct unit_t {
 
   /// if the same units of the same exponent but different ratio are divided
   /// then the result is a scalar
-  template <typename _rhs_exponent, typename _rhs_type, typename _rhs_ratio,
-            std::enable_if_t<std::ratio_equal_v<_rhs_exponent, exponent>>
-                * = nullptr>
+  template <
+      typename _rhs_exponent, typename _rhs_type, typename _rhs_ratio,
+      std::enable_if_t<std::ratio_equal_v<_rhs_exponent, exponent>> * = nullptr>
   constexpr _type operator/(
       const unit_t<_symbol, _rhs_exponent, _rhs_type, _rhs_ratio> &rhs) const {
     static_assert(SI_ENABLE_IMPLICIT_RATIO_CONVERSION ||
                       std::ratio_equal_v<_rhs_ratio, _ratio>,
                   "Implicit ratio conversion disabled, convert to same ratio "
                   "before dividing");
 
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
 
     static_assert(detail::is_ratio_v<_rhs_exponent>,
                   "rhs exponent is a ratio type");
@@ -364,8 +348,7 @@ struct unit_t {
   constexpr unit_t operator+(
       const unit_t<_symbol, _exponent, _rhs_type, _rhs_ratio> &rhs) const {
 
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
     static_assert(
         SI_ENABLE_IMPLICIT_RATIO_CONVERSION ||
             std::ratio_equal_v<ratio, _rhs_ratio>,
@@ -383,14 +366,13 @@ struct unit_t {
   }
 
   /// add value of the same type but possibly different ratio
-  template <typename _rhs_type, typename _rhs_ratio,
-            std::enable_if_t<!std::ratio_equal_v<_rhs_ratio, _ratio>> * =
-                nullptr>
+  template <
+      typename _rhs_type, typename _rhs_ratio,
+      std::enable_if_t<!std::ratio_equal_v<_rhs_ratio, _ratio>> * = nullptr>
   constexpr unit_t &
   operator+=(const unit_t<_symbol, _exponent, _rhs_type, _rhs_ratio> &rhs) {
 
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
     static_assert(
         SI_ENABLE_IMPLICIT_RATIO_CONVERSION ||
             std::ratio_equal_v<ratio, _rhs_ratio>,
@@ -406,8 +388,7 @@ struct unit_t {
   constexpr unit_t operator-(
       const unit_t<_symbol, _exponent, _rhs_type, _rhs_ratio> &rhs) const {
 
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
     static_assert(
         SI_ENABLE_IMPLICIT_RATIO_CONVERSION ||
             std::ratio_equal_v<ratio, _rhs_ratio>,
@@ -425,14 +406,12 @@ struct unit_t {
   }
 
   /// subtract value of the same type but possibly different ratio
-  template <
-      typename _rhs_type, typename _rhs_ratio,
-      std::enable_if<!std::ratio_equal_v<_rhs_ratio, _ratio>> * = nullptr>
+  template <typename _rhs_type, typename _rhs_ratio,
+            std::enable_if<!std::ratio_equal_v<_rhs_ratio, _ratio>> * = nullptr>
   constexpr unit_t &
   operator-=(const unit_t<_symbol, _exponent, _type, _rhs_ratio> &rhs) {
 
-    static_assert(detail::is_ratio_v<_rhs_ratio>,
-                  "_rhs_ratio is a std::ratio");
+    static_assert(detail::is_ratio_v<_rhs_ratio>, "_rhs_ratio is a std::ratio");
     static_assert(
         SI_ENABLE_IMPLICIT_RATIO_CONVERSION ||
             std::ratio_equal_v<ratio, _rhs_ratio>,

diff --git a/include/SI/detail/unit_symbol.h b/include/SI/detail/unit_symbol.h
@@ -1,5 +1,5 @@
 /**
- * This file is part of "SI" version 2.0.4
+ * This file is part of "SI" version 2.0.5
  * A header only c++ library that provides type safety and user defined literals
  * for handling pyhsical values defined in the International System of
  * Units

diff --git a/include/SI/electric_capacity.h b/include/SI/electric_capacity.h
@@ -1,5 +1,5 @@
 /**
- * This file is part of "SI" version 2.0.4
+ * This file is part of "SI" version 2.0.5
  * A header only c++ library that provides type safety and user defined literals
  * for handling pyhsical values defined in the International System of
  * Units