Skip to content

Latest commit

 

History

History
627 lines (541 loc) · 35.5 KB

CHANGELOG.md

File metadata and controls

627 lines (541 loc) · 35.5 KB
Raw

Change log

[v0.32.0] — 2022-01-14

This release adds one new quantity, MolarHeatCapacity, a new trait, ConstZero, and many internal improvements. The quickcheck 1.0 update uncovered a number of issues with floating point precision that were able to be resolved while still maintaining zero-cost guarantees.

Many thanks to adamreichold, B-Reif, remilauzier, and T-Bakker for pull requests included and issues resolved in this release.

Added

  • #250 Add ConstZero trait which is implemented by Quantity.
  • #263 MolarHeatCapacity quantity added.

Changed

  • #258 Use RUSTFLAGS="-D warnings" in CI to ensure that rustc warnings and caught and fail their respective workflows.
  • [Breaking] Rename Conversion::into_conversion to Conversion::conversion. Name change resolves Clippy wrong_self_convention warnings.
  • #260 Increase minimum supported rustc version to 1.43.0. Required to support quickcheck 1.0.
  • #260 Update to quickcheck 1.0. Change required the MSRV update as well as refactoring from_base, to_base, and multiple tests. The from_base and to_base changes provide better floating point precision while still maintaining zero-cost guarantees. The test changes better handle floating point precision issues as well as the wider range of values generated by quickcheck 1.0's Arbitrary implementation.
  • #268 Clarify powi documentation.

Deprecated

  • #260 Deprecate try-from feature. The feature will be removed in a future release of uom. Functionality previously exposed by the feature is now enabled by default.

Fixed

  • #252 Fix links within the documentation to use https. Many previously used http and were broken.
  • #260 Fix TryFrom<Duration> for Time<U, V>. Previously the conversion used the Duration's subsecond microseconds as nanoseconds. The conversion now correct uses the subsecond nanoseconds.

v0.31.1 — 2021-03-01

This release corrects documentation issues and documents fewer underlying storage types on docs.rs so that container time and memory limits are not exceeded.

Added

  • #241 Run rustdoc as part of tool checks and resolve previously ignored warnings.

Changed

  • #241 Document fewer underlying storage types on docs.rs so that container time and memory limits are not exceeded. Previous releases documented all features and caused documentation to fail to build.

v0.31.0 — 2021-01-05

This release adds a new macro, unit!, to allow for units to be defined outside of the quantity! macro as well as a Units enum for each quantity. A number of standard library traits are implemented. Build regressions caused by issues with the CI system and changes in Rust are now fixed.

Many thanks to bheisler, CreepySkeleton, DusterTheFirst, Lucretiel, and neoeinstein for pull requests included and issues resolved in this release.

Added

  • #173 Allow new units to be defined using unit! outside of quantity!. When using the pre-built SI system included with uom this macro allows for new units to quickly be defined without requiring a release. Pull requests to add new units upstream area always greatly appreciated.
  • #215 Add Units enum and fn units() -> impl Iterator<Item = Units> function for each quantity.
  • #227 Ensure UnwindSafe and RefUnwindSafe are implemented.
  • #217 Add trait implementations for Display and Error to ParseQuantityError.

Changed

  • #214 The FromStr implementation for quantities now supports the unit singular and plural descriptions in addition to the unit abbreviation.
  • #225 Convert CI to use Github Actions. This change fixes a number of problems with the old system and greatly improves build times.
  • #223 Correct build regressions introduced while no test job was run with the old CI system.

v0.30.0 — 2020-10-17

This release adds a new quantity, RadiantExposure, implements Unpin for Quantity and upgrades uom to the 2018 edition. These changes also include an increase of the minimum supported rustc to 1.37.0. Many thanks to nicodemus26 and (Michael-F-Bryan)[https://github.com/Michael-F-Bryan] for pull requests included and issues resolved in this release.

Added

  • #202 RadiantExposure quantity added.
  • #204 Implement Unpin for Quantity.

Changed

  • #206 Upgrade uom to compile using the 2018 edition. Generated code still supports both the 2015 and 2018 edition.
  • #207 Increase minimum supported rustc version to 1.37.0. Required to support upgrading to the latest dependencies and to allow for the Kleene ? "at most one" repetition operator.

v0.29.0 — 2020-08-06

This release includes a number of changes for Angle, the addition of SolidAngle, and a new units for Energy and Luminance. Many thanks to adamreichold, AnickaBurova, and Atmelfan for pull requests included and issues resolved in this release.

Added

  • #196 SolidAngle quantity added.
  • #191 Add constants to Angle and SolidAngle representing half and full turns.
  • #194 Add foot-candle unit to Luminance.
  • #200 electronvolt-based Energy units added.

Changed

  • #192 Use f{32|64}::powi instead of Typenum::Pow::powi.
  • #123 Change examples to use Display instead of Debug.

Removed

  • #188 [Breaking] Remove From/Into impls for Angle and SolidAngle.

v0.28.0 — 2020-05-21

This release includes a number of trigonometric improvements as well as new units for Time. Many thanks to adamreichold and Aehmlo for pull requests included and issues resolved in this release.

Added

  • #182 Add inverse trigonometric functions to Ratio (acos, acosh, asin, asinh, atan, atanh) and Angle (atan2).
  • #184 Tropical and sidereal units added to Time.

Changed

  • #186 Make hypot available for all quantities, not just Length.
  • #187 [Breaking] Change trigonometric functions to return Ratio instead of the underlying storage type so that identities like x.sin().asin() == x are well-typed.

v0.27.0 — 2020-02-14

This release adds a number of quantities.

Added

  • #167 CatalyticActivity, CatalyticActivityConcentration, MassConcentration, and MolarConcentration quantities added.
  • #175 Curvature quantity added.

v0.26.0 — 2019-11-04

This release adds a number of thermodynamic quantities in addition to TryFrom implementations for Time and trigonometric functions on Angle.

Added

  • #164 HeatFluxDensity quantity added.
  • #155 HeatCapacity, HeatTransfer, MolarEnergy, MolarMass, SpecificHeatCapacity, ThermalConductivity quantities added.
  • #150 TryFrom implemented between std::time::Duration and uom::si::Time.
  • #151 Trigonometric functions added to Angle.

Changed

  • Increase minimum supported rustc version to 1.31.0. Required to because of backwards incompatibilities with Cargo.toml edition keyword. cfg-if introducted the keyword in a minor version update and other issues with the keyword prompted the update.

v0.25.0 — 2019-08-12

This release includes the long-requested Information and InformationRate quantities as well as support for i128/u128 as underlying storage types. A number of documentation updates, including for the 9th edition of the SI, are also included.

Added

  • #31 Information (bit, byte, ...) and InformationRate (bit/s, byte/s, ...) quantities added. Units for both SI (kilo, mega, ...) and binary (kibi, mebi, ...) prefixes are included.
  • #85 Add support for i128 and u128 as underlying storage types.
  • #160 AngularJerk quantity added.

Changed

  • #20 Document generic parameters.
  • #21 Move links inline for trait methods to work around documentation generation bug.
  • #111 Update documentation for SI base units for the 9th edition of the SI.
  • #127 Remove superscripts for power 1 to keep all SI documentation consistent.

v0.24.0 — 2019-06-20

This release fixes two separate issues to ensure that zero-cost code is generated. Many thanks to raimundomartins, apopiak, and gnzlbg for pull requests included and issues resolved in this release.

Added

  • #145 Add #[repr(transparent)] to Quantity to ensure that the ABI of the underlying storage type is used instead of struct ABI in FFI contexts.

Changed

  • #148 Increase minimum supported rustc version to 1.28.0. Required to support #[repr(transparent)].

Fixed

  • #143 Correct to_base and from_base to be zero-cost for float storage types.
  • #147 Correct typos in README and crate-level documentation.

v0.23.1 — 2019-05-29

This release fixes an issue with the autoconvert feature introduced in v0.23.0. Many thanks to dmit for pull requests included in this release.

Fixed

  • #141 From implementations to convert between quantities of different kinds now correctly use the autoconvert feature and no longer cause a compile error when the feature is disabled.

v0.23.0 — 2019-05-13

This release adds three new quantities, AngularAcceleration, AngularVelocity, and Torque. Changes to make Kinds more ergonomic to use are also included along with documentation changes. Many thanks to dunmatt and Aehmlo for pull requests included in this release.

Added

  • #136 AngularAcceleration quantity added.
  • #135 AngularVelocity quantity added.
  • #117 Torque quantity added.
  • Introduce AngleKind and si::marker to hold SI specific marker traits. From implementations for AngleKind added to more easily convert between uom::Kind and si::marker::AngleKind.
  • Allow documentation to be specified for base quantities in the system! macro. Documentation for the seven base SI quantities added.

Changed

  • #138 Maintain kind when multiplying a number by a quantity. Multiplying a quantity by a number already maintains kind.
  • #130 Rename Density to MassDensity. A type alias for Density is available for backwards compatibility.
  • #127 Make all SI quantity documentation follow a single, consistent format.

Deprecated

  • #130 Density has been renamed to MassDensity and is deprecated. Density will be removed in some future release.

v0.22.2 — 2019-04-28

This release adds Angle and Jerk quantities along with unit additions and conversion precision improvements to Acceleration and Velocity. Many thanks to dunmatt and nicodemus26 respectively.

Added

  • #89 Angle quantity added.
  • #128 Jerk quantity added. Acceleration and Velocity units added and precision for some existing units improved.

Changed

  • Continuous integration setup updated and improved.
    • Rust 1.34.0 is now used for rustfmt, clippy, and tarpaulin jobs.
    • rustfmt configuration updated.
    • clippy configuration corrected to run for all packages.

v0.22.1 — 2019-04-02

This release adds additional liter-based VolumeRate units.

Added

  • #121 Liter-based VolumeRate units added.

v0.22.0 — 2019-03-30

This release adds the Momentum quantity and additional liter-based volume units.

Added

  • #114 Momentum quantity added.
  • #116 Liter-based volume units added.

Changed

  • Continuous integration setup updated and improved.
    • Rust 1.33.0 is now used for rustfmt, clippy, and tarpaulin jobs.
    • The deny warnings job is joined into the clippy job.
    • The stable + tests job has been updated to catch errors with non-default underlying storage types in SI quantity tests.

Fixed

  • #119 Macros corrected to generate valid code for both 2015 and 2018 editions. Previously the doc test on the $quantities! macro would fail in a Rust 2018 crate. A new test crate, edition_check, was added to ensure uom remains usable in Rust 2018 code.

v0.21.1 — 2019-03-03

This release adds a few new units for ElectricCharge and Energy.

Added

  • #112 Additional ElectricCharge and Energy units added.

v0.21.0 — 2019-01-13

This release adds display tools for quantities resolving another long-standing issue, #13.

Added

  • #13 Add display tools for quantities. Allows Quantity to be formatted with the standard library formatting traits: Binary, Debug, Display, LowerExp, LowerHex, Octal, UpperExp, UpperHex.

Changed

  • Improve continuous integration setup.
    • Update clippy and rustfmt jobs to use the now stable non -preview components.
    • Run OSX and Windows builds on TravisCI.
    • Improve individual job build time by reducing unnecessary cached data.

v0.20.1 — 2018-09-13

This release resolves nightly rustc error E0659 the base.rs example caused by rust-lang/rust pull request #52841 "resolve: Implement prelude search for macro paths, implement tool attributes."

v0.20.0 — 2018-09-06

This release resolves long-standing issue #3 to implement thermodynamic temperature conversions (e.g. Celsius to Fahrenheit). Support is also added for multiple quantities of the same dimension (e.g. thermodynamic temperature and temperature interval, ratio and angle).

The release also contains a number of internal changes including a reorganization of tests into multiple files and updated CI setup to provide faster builds and more feature test coverage.

Added

  • #3 Implement thermodynamic temperature conversions (e.g. Celsius to Fahrenheit). Extend the quantity! macro to accept a coefficient and optional constant factor in the $conversion parameter to support these conversions.
  • #14 Implement FromStr.
  • #78 Add a Kind associated type to Dimensions.The new Kind associated type, defaulting to uom::Kind, allows for multiple quantities that have the same dimensions. Quantities of different kinds are not comparable. The marker traits implemented by a quantity's Kind control which operations are automatically implemented.
  • #95 TemperatureInterval quantity added. Includes Add, AddAssign, Sub, and SubAssign implementations between thermodynamic temperature and temperature interval.

Changed

  • [Breaking] Remove unused _unit: N parameters and require turbofish syntax for get, floor, ceil, round, trunc, and fract methods of Quantity. This is a breaking change and can easily be resolved. e.g. l.get(meter) becomes l.get::<meter>().
  • #98, #100 Correct uom feature hygiene in macro generated code. Previously the system! macro generated code that included #[cfg(feature = "...")] attributes on code in the crate executing the system! macro. With this fix these attributes will be eagerly evaluated and only generate code when the appropriate uom feature is enabled.
  • Spelling corrections for a number of documentation comments and unit abbreviations.

v0.19.0 — 2018-06-21

This release adds a number of additional quantities, configures uom to use rustfmt, and directly references num sub-crates to better control feature selection.

Added

  • Capacitance quantity added.
  • ElectricCharge quantity added.
  • ElectricalConductance quantity added.
  • ElectricalResistance quantity added.
  • Inductance quantity added.
  • Luminance quantity added.
  • MagneticFluxDensity quantity added.
  • MagneticFlux quantity added.

Changed

  • #57 num sub-crates num-traits, num-rational, and num-bigint are now directly referenced to control feature selection. std, rational, and bigint support are only included based on uom feature selection.
  • #80 Setup rustfmt so that uom code can be automatically formatted and builds are gated on changes not breaking formatting conventions.

v0.18.0 — 2018-05-10

This release contains a significant number of new quantities and units, compile time improvements, and a few bug fixes. See below for full details. Many thanks to Aehmlo for all of the new quantities and units. radix for the autoconvert feature. Nemo157 for hygiene fixes in the storage_types! macro.

Added

  • #54 [Breaking] Add an autoconvert feature, enabled by default, which allows for operations between quantities with different base units. autoconvert enabled is the same functionality as prior versions of uom. Disabling the feature only allows for quantities with the same base units to directly interact. The feature has been added to account for current compiler limitations where zero-cost code is not generated for non-floating point underlying storage types. With the feature disabled more optimal code will be generated for integral types. This feature will likely have no effect and subsequently be deprecated and removed once const fn and specialization are stabilized.
  • #61 [Breaking] The storage_types! macro now always uses underlying storage type features from the uom crate instead of the crate where the macro is executed.
  • #2 Additional Mass units added.
  • #5 Additional Velocity units added.
  • #6 Additional Area units added.
  • #7 Additional Volume units added.
  • #8 Additional Force units added.
  • #9 Additional Acceleration units added.
  • #30 Additional Frequency units added.
  • #64 Ratio (dimensionless) quantity added. Includes From<Ratio> for V and From<V> for Ratio implementations to allow for easy conversions between Ratio and the underlying storage type.
  • #66 Energy quantity added.
  • #67 AvailableEnergy quantity added.
  • #68 Density quantity added.
  • #69 Power quantity added.
  • #70 Pressure quantity added.
  • #71 MassRate quantity added.
  • #72 VolumeRate quantity added.
  • #74 ElectricPotential quantity added.
  • #75 Additional ElectricCurrent units added.

Changed

  • #52 Type aliases generated by the storage_type! macro are now public. e.g. pub type V = f32;. This change drastically reduces compile times, especially when multiple underlying storage types are enabled.
  • Dimension documentation for ElectricCurrent corrected to no longer references AmountOfSubstance and units smaller than milliampere have corrected abbreviations and descriptions.

Removed

  • #15 [Breaking] Remove Product implementation for Quantity. The product of a quantity is not that same quantity. e.g. Length * Length = Area.

v0.17.0 — 2018-03-14

This release implements a number of common traits from the standard library, the num crate, and the serde crate.

Added

  • #16 Implement Default.
  • #17 Implement PartialEq.
  • #50 Implement Eq.
  • #18 Implement PartialOrd.
  • #51 Implement Ord.
  • #56 Implement Sum.
  • #15 Implement Product.
  • #26 Implement num::Zero.
  • #35 Implement num::Saturating.
  • #37 Implement serde::Serialize and serde::Deserialize. Disabled by default. Enabled with the use_serde feature.

v0.16.0 — 2017-12-21

This release contains significant changes in order to support underlying storage types that implement the Num trait beyond f32 and f64. Many changes are breaking: marker traits are simplified and fewer macros are exported. New storage types are not enabled by default and can be used by including the corresponding feature. See the changes below for full details.

Added

  • Add missing #[derive(Hash)] attributes.
  • #29 A new macro, storage_types!, is now available to duplicate code on a per-storage type basis. See macro documentation for full details. The minimum supported rustc version is now 1.20.0.

Changed

  • #29 Underlying storage type now uses the Num trait from the num crate instead of fixed implementations for f32 and f64. Features for all types implementing Num have been added and control the availability of the type as an underlying storage type: usize, u8, u16, u32, u64, isize, i8, i16, i32, i64, bigint, biguint, rational, rational32, rational64, bigrational, f32, and f64. For compile time reasons only f32 and f64 are enabled by default. Tests are implemented for all underlying storage types but don't account for minimum or maximum values and will fail for non-float types where the conversion factor overflows the type's limits. A future release will correct this.
  • #29 [Breaking] Traits and structs generated by the system! macro have been significantly changed in order to support non-float underlying storage types.
    • Dimension changed to directly include associated types for quantity dimensions.
    • Units<V> is now only parameterized on V and contains associated types for base units.
    • Conversion<V> has been removed and replaced with uom::Conversion<V>.
    • $quantities<...> has been removed. Quantity dimensions are now directly in the Dimension trait.
    • BaseUnits<...> has been removed. Base units are not directly in the Units<V> trait.
    • uom::Conversion<V> added to replace Conversion<V> and gives access to a unit's conversion factor.
    • uom::ConversionFactor<V> added to represent conversion factors for underlying storage types where the type can't be used (e.g. i32's conversion factor is represented as Rational32.)
  • [Breaking] Macro usage and definitions have been simplified and consolidated. quantities!, replace_ty!, and unit! have been consolidated as "private" match arms of their calling macro. In order to reduce the chance of macro name collisions $quantities! is the only remaining generated exported macro (e.g. ISQ! for the si system). Generated macros for each quantity no longer exist. These changes make it easier to have multiple systems containing quantities with the same names. In order to support this change quantities in the units block of the system! macro must always be prefixed by the quantity's module (e.g. length::Length). Prefixing the module with the mod keyword instructs the system! macro not to generate a #[macro_use] pub mod $module; statement.

v0.15.0 — 2017-07-05

This release adds additional Time units; Frequency, Force, and Volume quantities; and numerous floating point methods such as min, max, and powi.

Added

  • #4 Additional Time units added.
  • Add missing giga units. e.g. gigameter.
  • #11 Add floating point classification methods classify, is_finite, is_infinte, is_nan, and is_normal for Quantity.
  • #11 Add floating point fractional methods floor, ceil, round, trunc, and fract for Quantity.
  • #11 Add floating point comparison methods max and min for Quantity.
  • #11 Add floating point mul_add method for Quantity.
  • #11 Add floating point powi method for Quantity.
  • #7 Volume quantity added. Additional units still need to be added.
  • #8 Force quantity added. Additional units still need to be added.
  • #30 Frequency quantity added. Additional units still need to be added.

v0.14.0 — 2017-05-30

Added

  • [Breaking] A new feature, std, is now available and is enabled by default. uom can still be compiled with no_std by using --no-default-features when compiling the crate or default-features = false in the dependencies section of Cargo.toml
  • #11 cbrt, recip, and sqrt are implemented for Quantity.

Changed

  • #28 Quantity fields made public in order to allow library users to create const values and instances of non-named quantities. e.g. const TIME_STEP: Time = Quantity { dimension: PhantomData, units: PhantomData, value: 0.1 }; This functionality will be deprecated and subsequently removed once the const fn feature is stabilized.
  • Tests now run for all enabled underlying storage types (f32, f64).

Fixed

  • Fixed incorrect conversion factor when multiplying or dividing Quantitys with different base units.

v0.13.0 — 2017-04-20

This release adds numerous tests both for code generated by the quantity!, system!, and $quantities! macros as well as derived quantities. Fixes for issues found during testing noted below. Quantity implementations for Area and Acceleration also added.

Added

  • #6 Area quantity added. Additional units still need to be added.
  • #9 Acceleration quantity added. Additional units still need to be added.

Changed

  • [Breaking] Remove the unused _unit parameter from Quantity::new and so summon the turbofish. e.g. Length::new(1.0, meter) becomes Length::new::<meter>(1.0).
  • #22 Change impl Debug for Quantity to use precision information. Previously the implementation checked the alternate flag which has no affect on printing raw floats.
  • #27 Change superscripts in documentation to the format supported by pulldown in anticipation of upcomming rustdoc changes.

Fixed

  • #22 Fix impl Sub for Quantity to be implemented in terms of - instead of +.

v0.12.0 — 2017-04-01

Continuous integration was setup to ensure that uom builds on stable, beta, nightly, and 1.15.0 (the minimum rustc version). Quantity descriptions, unit abbreviations, and unit descriptions added. Additional length units added to demonstrate the simplicity of the process.

Added

  • #1 Additional Length units added.
  • [Breaking] The quantity! macro accepts comments on units. To resolve macro parsing ambiguities each unit must be prefixed with an @.
  • #19 [Breaking] The quantity! macro includes the quantity description. The description can be accessed using the description() method in quantity submodules.
  • #19 [Breaking] The quantity! macro includes unit abbreviations as well as singular and plural descriptions. These values can be accessed from new abbreviation(), singular(), and plural() methods on the Unit trait. The original Unit<V> trait has been renamed Conversion<V>.
  • #12 Debug manually implemented for Quantity<D, U, V> to show the underlying value and associated units.
  • Test and compile-fail test modules setup. compile-fail tests for mismatched quantities and units added.

v0.11.0 — 2017-02-26

Proof-of-concept functionality for type-safe zero-cost dimensional analysis. uom [0.11.0] allows for the creation of custom systems or the use of the pre-built SI. Basic mathematical operations are implemented and a minimal set of quantities (length, mass, time...) and units (meter, kilometer, foot, mile, ...) are included.