refactor: Refactored the library file tree

Resolves #249
2021-03-16 09:32:28 +01:00
1 parent d8367d31b8
commit 23720d055e
@@ -3,6 +3,7 @@
 - **0.7.0 WIP**
  - (!) refactor: `ScalableNumber` renamed to `QuantityValue`
  - (!) refactor: output stream operators moved to the `units/quantity_io.h` header file
+  - (!) refactor: Refactored the library file tree
  - refactor: quantity (kind) point updated to reflect latest changes to `quantity`
  - refactor: basic concepts, `quantity` and `quantity_cast` refactored
  - refactor: `abs()` definition refactored to be more explicit about the return type
@@ -3,9 +3,9 @@ Quick Start

 Here is a small example of possible operations::

-    #include <units/physical/si/derived/area.h>
-    #include <units/physical/si/derived/frequency.h>
-    #include <units/physical/si/derived/speed.h>
+    #include <units/physical/si/area.h>
+    #include <units/physical/si/frequency.h>
+    #include <units/physical/si/speed.h>

    using namespace units::physical::si;

@@ -38,8 +38,8 @@ performed without sacrificing on accuracy. Please see the below example for a qu
 of basic library features::

    #include <units/format.h>
-    #include <units/physical/si/derived/speed.h>
-    #include <units/physical/si/international/derived/speed.h>
+    #include <units/physical/si/speed.h>
+    #include <units/physical/si/international/speed.h>
    #include <units/quantity_io.h>
    #include <iostream>

@@ -1,4 +1,4 @@
 Bitrate
 =======

-.. doxygenfile:: data/derived/bitrate.h
+.. doxygenfile:: data/bitrate.h
@@ -1,4 +1,4 @@
 Information
 ===========

-.. doxygenfile:: data/base/information.h
+.. doxygenfile:: data/information.h
@@ -1,4 +1,4 @@
 Absorbed Dose
 =============

-.. doxygenfile:: si/derived/absorbed_dose.h
+.. doxygenfile:: si/absorbed_dose.h
@@ -1,4 +1,4 @@
 Acceleration
 ============

-.. doxygenfile:: si/derived/acceleration.h
+.. doxygenfile:: si/acceleration.h
@@ -1,4 +1,4 @@
 Amount of Substance
 ===================

-.. doxygenfile:: si/base/amount_of_substance.h
+.. doxygenfile:: si/amount_of_substance.h
@@ -1,4 +1,4 @@
 Area
 ====

-.. doxygenfile:: si/derived/area.h
+.. doxygenfile:: si/area.h
@@ -1,4 +1,4 @@
 Capacitance
 ===========

-.. doxygenfile:: si/derived/capacitance.h
+.. doxygenfile:: si/capacitance.h
@@ -1,4 +1,4 @@
 Catalytic Activity
 ==================

-.. doxygenfile:: si/derived/catalytic_activity.h
+.. doxygenfile:: si/catalytic_activity.h
@@ -1,4 +1,4 @@
 Acceleration
 ============

-.. doxygenfile:: si/cgs/derived/acceleration.h
+.. doxygenfile:: si/cgs/acceleration.h
@@ -1,4 +1,4 @@
 Area
 ====

-.. doxygenfile:: si/cgs/derived/area.h
+.. doxygenfile:: si/cgs/area.h
@@ -1,4 +1,4 @@
 Energy
 ======

-.. doxygenfile:: si/cgs/derived/energy.h
+.. doxygenfile:: si/cgs/energy.h
@@ -1,4 +1,4 @@
 Force
 =====

-.. doxygenfile:: si/cgs/derived/force.h
+.. doxygenfile:: si/cgs/force.h
@@ -1,4 +1,4 @@
 Length
 ======

-.. doxygenfile:: si/cgs/base/length.h
+.. doxygenfile:: si/cgs/length.h
@@ -1,4 +1,4 @@
 Mass
 ====

-.. doxygenfile:: si/cgs/base/mass.h
+.. doxygenfile:: si/cgs/mass.h
@@ -1,4 +1,4 @@
 Power
 =====

-.. doxygenfile:: si/cgs/derived/power.h
+.. doxygenfile:: si/cgs/power.h
@@ -1,4 +1,4 @@
 Pressure
 ========

-.. doxygenfile:: si/cgs/derived/pressure.h
+.. doxygenfile:: si/cgs/pressure.h
@@ -1,4 +1,4 @@
 Speed
 =====

-.. doxygenfile:: si/cgs/derived/speed.h
+.. doxygenfile:: si/cgs/speed.h
@@ -1,4 +1,4 @@
 Time
 ====

-.. doxygenfile:: si/cgs/base/time.h
+.. doxygenfile:: si/cgs/time.h
@@ -1,4 +1,4 @@
 Charge Density
 ==============

-.. doxygenfile:: si/derived/charge_density.h
+.. doxygenfile:: si/charge_density.h
@@ -1,4 +1,4 @@
 Concentration
 =============

-.. doxygenfile:: si/derived/concentration.h
+.. doxygenfile:: si/concentration.h
@@ -1,4 +1,4 @@
 Conductance
 ===========

-.. doxygenfile:: si/derived/conductance.h
+.. doxygenfile:: si/conductance.h
@@ -1,4 +1,4 @@
 Current density
 ===============

-.. doxygenfile:: si/derived/current_density.h
+.. doxygenfile:: si/current_density.h
@@ -1,4 +1,4 @@
 Density
 =======

-.. doxygenfile:: si/derived/density.h
+.. doxygenfile:: si/density.h
@@ -1,4 +1,4 @@
 Dynamic Viscosity
 =================

-.. doxygenfile:: si/derived/dynamic_viscosity.h
+.. doxygenfile:: si/dynamic_viscosity.h
@@ -1,4 +1,4 @@
 Electric Charge
 ===============

-.. doxygenfile:: si/derived/electric_charge.h
+.. doxygenfile:: si/electric_charge.h
@@ -1,4 +1,4 @@
 Electric Current
 ================

-.. doxygenfile:: si/base/electric_current.h
+.. doxygenfile:: si/electric_current.h
@@ -1,4 +1,4 @@
 Electric Field Strength
 =======================

-.. doxygenfile:: si/derived/electric_field_strength.h
+.. doxygenfile:: si/electric_field_strength.h
@@ -1,4 +1,4 @@
 Energy
 ======

-.. doxygenfile:: si/derived/energy.h
+.. doxygenfile:: si/energy.h
@@ -1,4 +1,4 @@
 Force
 =====

-.. doxygenfile:: si/derived/force.h
+.. doxygenfile:: si/force.h
@@ -1,4 +1,4 @@
 Acceleration
 ============

-.. doxygenfile:: si/fps/derived/acceleration.h
+.. doxygenfile:: si/fps/acceleration.h
@@ -1,4 +1,4 @@
 Area
 ====

-.. doxygenfile:: si/fps/derived/area.h
+.. doxygenfile:: si/fps/area.h
@@ -1,4 +1,4 @@
 Density
 =======

-.. doxygenfile:: si/fps/derived/density.h
+.. doxygenfile:: si/fps/density.h
@@ -1,4 +1,4 @@
 Energy
 ======

-.. doxygenfile:: si/fps/derived/energy.h
+.. doxygenfile:: si/fps/energy.h
@@ -1,4 +1,4 @@
 Force
 =====

-.. doxygenfile:: si/fps/derived/force.h
+.. doxygenfile:: si/fps/force.h
@@ -1,4 +1,4 @@
 Length
 ======

-.. doxygenfile:: si/fps/base/length.h
+.. doxygenfile:: si/fps/length.h
@@ -1,4 +1,4 @@
 Mass
 ====

-.. doxygenfile:: si/fps/base/mass.h
+.. doxygenfile:: si/fps/mass.h
@@ -1,4 +1,4 @@
 Power
 =====

-.. doxygenfile:: si/fps/derived/power.h
+.. doxygenfile:: si/fps/power.h
@@ -1,4 +1,4 @@
 Pressure
 ========

-.. doxygenfile:: si/fps/derived/pressure.h
+.. doxygenfile:: si/fps/pressure.h
@@ -1,4 +1,4 @@
 Speed
 =====

-.. doxygenfile:: si/fps/derived/speed.h
+.. doxygenfile:: si/fps/speed.h
@@ -1,4 +1,4 @@
 Time
 ====

-.. doxygenfile:: si/fps/base/time.h
+.. doxygenfile:: si/fps/time.h
@@ -1,4 +1,4 @@
 Volume
 ======

-.. doxygenfile:: si/fps/derived/volume.h
+.. doxygenfile:: si/fps/volume.h
@@ -1,4 +1,4 @@
 Frequency
 =========

-.. doxygenfile:: si/derived/frequency.h
+.. doxygenfile:: si/frequency.h
@@ -1,4 +1,4 @@
 Heat Capacity
 =============

-.. doxygenfile:: si/derived/heat_capacity.h
+.. doxygenfile:: si/heat_capacity.h
@@ -1,4 +1,4 @@
 Length
 ======

-.. doxygenfile:: si/iau/base/length.h
+.. doxygenfile:: si/iau/length.h
@@ -1,4 +1,4 @@
 Length
 ======

-.. doxygenfile:: si/imperial/base/length.h
+.. doxygenfile:: si/imperial/length.h
@@ -1,4 +1,4 @@
 Inductance
 ==========

-.. doxygenfile:: si/derived/inductance.h
+.. doxygenfile:: si/inductance.h
@@ -1,4 +1,4 @@
 Area
 ====

-.. doxygenfile:: si/international/derived/area.h
+.. doxygenfile:: si/international/area.h
@@ -1,4 +1,4 @@
 Length
 ======

-.. doxygenfile:: si/international/base/length.h
+.. doxygenfile:: si/international/length.h
@@ -1,4 +1,4 @@
 Speed
 =====

-.. doxygenfile:: speed/derived/speed.h
+.. doxygenfile:: speed/speed.h
@@ -1,4 +1,4 @@
 Volume
 ======

-.. doxygenfile:: si/international/derived/volume.h
+.. doxygenfile:: si/international/volume.h
@@ -1,4 +1,4 @@
 Length
 ======

-.. doxygenfile:: si/base/length.h
+.. doxygenfile:: si/length.h
@@ -1,4 +1,4 @@
 Luminance
 =========

-.. doxygenfile:: si/derived/luminance.h
+.. doxygenfile:: si/luminance.h
@@ -1,4 +1,4 @@
 Luminous Intensity
 ==================

-.. doxygenfile:: si/base/luminous_intensity.h
+.. doxygenfile:: si/luminous_intensity.h
@@ -1,4 +1,4 @@
 Magnetic Flux
 =============

-.. doxygenfile:: si/derived/magnetic_flux.h
+.. doxygenfile:: si/magnetic_flux.h
@@ -1,4 +1,4 @@
 Magnetic Induction
 ==================

-.. doxygenfile:: si/derived/magnetic_induction.h
+.. doxygenfile:: si/magnetic_induction.h
@@ -1,4 +1,4 @@
 Mass
 ====

-.. doxygenfile:: si/base/mass.h
+.. doxygenfile:: si/mass.h
@@ -1,4 +1,4 @@
 Molar Energy
 ============

-.. doxygenfile:: si/derived/molar_energy.h
+.. doxygenfile:: si/molar_energy.h
@@ -1,4 +1,4 @@
 Momentum
 ========

-.. doxygenfile:: si/derived/momentum.h
+.. doxygenfile:: si/momentum.h
@@ -1,4 +1,4 @@
 Permeability
 ============

-.. doxygenfile:: si/derived/permeability.h
+.. doxygenfile:: si/permeability.h
@@ -1,4 +1,4 @@
 Permittivity
 ============

-.. doxygenfile:: si/derived/permittivity.h
+.. doxygenfile:: si/permittivity.h
@@ -1,4 +1,4 @@
 Power
 =====

-.. doxygenfile:: si/derived/power.h
+.. doxygenfile:: si/power.h
@@ -1,4 +1,4 @@
 Pressure
 ========

-.. doxygenfile:: si/derived/pressure.h
+.. doxygenfile:: si/pressure.h
@@ -1,4 +1,4 @@
 Resistance
 ==========

-.. doxygenfile:: si/derived/resistance.h
+.. doxygenfile:: si/resistance.h
@@ -1,4 +1,4 @@
 Speed
 =====

-.. doxygenfile:: si/derived/speed.h
+.. doxygenfile:: si/speed.h
@@ -1,4 +1,4 @@
 Surface Tension
 ===============

-.. doxygenfile:: si/derived/surface_tension.h
+.. doxygenfile:: si/surface_tension.h
@@ -1,4 +1,4 @@
 Thermal Conductivity
 ====================

-.. doxygenfile:: si/derived/thermal_conductivity.h
+.. doxygenfile:: si/thermal_conductivity.h
@@ -1,4 +1,4 @@
 Temperature
 ===========

-.. doxygenfile:: si/base/thermodynamic_temperature.h
+.. doxygenfile:: si/thermodynamic_temperature.h
@@ -1,4 +1,4 @@
 Time
 ====

-.. doxygenfile:: si/base/time.h
+.. doxygenfile:: si/time.h
@@ -1,4 +1,4 @@
 Length
 ======

-.. doxygenfile:: si/typographic/base/length.h
+.. doxygenfile:: si/typographic/length.h
@@ -1,4 +1,4 @@
 Length
 ======

-.. doxygenfile:: si/us/base/length.h
+.. doxygenfile:: si/us/length.h
@@ -1,4 +1,4 @@
 Voltage
 =======

-.. doxygenfile:: si/derived/voltage.h
+.. doxygenfile:: si/voltage.h
@@ -1,4 +1,4 @@
 Volume
 ======

-.. doxygenfile:: si/derived/volume.h
+.. doxygenfile:: si/volume.h
@@ -16,7 +16,7 @@ provide the following:
 For example, to provide support for the ``std::chrono::duration`` it is enough to define::

    #include <units/customization_points.h>
-    #include <units/physical/si/base/time.h>
+    #include <units/physical/si/time.h>
    #include <chrono>

    namespace units {
@@ -41,8 +41,8 @@ dimensions used in the division operation:
 .. code-block::
    :emphasize-lines: 1-2,8,10

-    #include <units/physical/si/base/length.h>
-    #include <units/physical/si/base/time.h>
+    #include <units/physical/si/length.h>
+    #include <units/physical/si/time.h>

    using namespace units::physical::si;