Quantify.NET 0.0.0-preview-002

Quantify.NET

A library to make usages of quantities easier and safer.

Key Features

• Strongly typed quantities and units: Quantify.NET uses a strongly typed approach to quantities and units. This means, for example, that you can't pass a length to a mass parameter. Reducing the risk of errors in your code.
• Extensive quantity support: Quantify.NET supports more than 100 quantities out-of-the-box. This includes common quantities like length, mass, time, temperature, and many more. See the supported quantities section for a complete list.
• Extensive unit support: Quantify.NET supports almost all imaginable units for each supported quantity. This includes common units like meter, kilogram, second, and many more. Using the unit builders, almost all units can dynamically be build. Still missing a unit? Just create a new unit by calling for example LengthUnit.CreateCustomUnit and pass the unit name and the conversion factor to the base unit. Or alternatively create an issue to add the unit to the library.
• Complex unit builders: Quantify.NET supports building complex units. For example, the SI unit of Power can be described as kg * m^2 / s^-3 and can be build using Quantify.NET using PowerUnit.Kilo.Gram.Meter.Squared.Per.Second.Cubed.
• Unit conversion: Quantify.NET can convert quantities to other units. This is done by using the ConvertTo method.
• Parsing: Quantify.NET supports parsing of quantities and units. This can be done using the Parse or TryParse methods.
• Arithmetic operations: Quantities support arithmetic operations on quantities. This includes addition, subtraction, multiplication and division.
• Comparison: Quantities can be compared with each other with respect to units. (e.g. 5 cm == 0.05 m)

Installation

NuGet

Install-Package Quantify.NET

Usage

Basic usage

using Quantify.Quantities;
using Quantify.Quantities.Units;

// Create a new quantity
Length meters = Length.Of(5, LengthUnit.Meter);

// Convert the quantity to another unit
Length lengthInFeet = meters.ConvertTo(LengthUnit.Foot);

More complex units

using Quantify.Quantities;
using Quantify.Quantities.Units;

// Create more complex units (1 Watt == 1 kg * m^2 / s^3))
Power power = Power.Of(5, PowerUnit.Kilo.Gram.Meter.Squared.Per.Second.Cubed);

// Convert the quantity to another unit (in logarithmic scale for example)
Power powerInDecibelMilliwatts = power.ConvertTo(PowerUnit.DecibelMilliwatt);

Parsing

using Quantify.Quantities;
using Quantify.Quantities.Units;

// Parse a quantity
Length length = Length.Parse("5 m");

// Parse a unit
LengthUnit lengthUnit = LengthUnit.Parse("cm");
PowerUnit powerUnit = PowerUnit.Parse("kg.m².s⁻³");

Arithmetic operations

using Quantify.Quantities;
using Quantify.Quantities.Units;

// Create a new quantity
Length length1 = Length.Of(500, LengthUnit.Mile);
Length length2 = Length.Of(10, LengthUnit.Meter);

// Add two quantities
Length length3 = length1 + length2;

// Subtract two quantities
Length length4 = length1 - length2;

// Substract or add non-absolute quantities
Temperature t = Temperature.Of(10, TemperatureUnit.Celsius) + TemperatureDifference.Of(32, TemperatureDifferenceUnit.Fahrenheit);

// Multiply a quantity with a scalar
Length length5 = length1 * 5;

// Divide a quantity by a scalar
Length length6 = length1 / 5;

// Arithmetics between two quantities can result in a new quantity type
Area area = length1 * length2;
Velocity velocity = length1 / Time.Of(10, TimeUnit.Minute);

Comparison

using Quantify.Quantities;
using Quantify.Quantities.Units;

// Create quantities
var length1 = Length.Of(5, LengthUnit.Meter);
var length2 = Length.Of(5, LengthUnit.Centi.Meter);

// Compare two quantities with respect of the unit
var isLength1GreaterThanLength2 = length1 > length2; // true
var isLength1LessThanLength2 = length1 < length2; // false
var isLength1EqualToLength2 = length1 == length2; // false

Supported quantities

Roadmap

• Add all quantities from https://en.wikipedia.org/wiki/List_of_physical_quantities
• Add more unit tests
• Add more parsing and serialization features
• Add multi-language support

License

Quantify.NET is licensed under the MIT License. See LICENSE for details.

Benchmarks

BenchmarkDotNet=v0.13.1, OS=Windows 10.0.26100
13th Gen Intel Core i7-13700K, 1 CPU, 24 logical and 16 physical cores
.NET SDK=9.0.201
  [Host]     : .NET 9.0.3 (9.0.325.11113), X64 RyuJIT
  DefaultJob : .NET 9.0.3 (9.0.325.11113), X64 RyuJIT