Categorygithub.com/woweh/go-units
repositorypackage
0.0.0-20231116074738-be29ffd193e4
Repository: https://github.com/woweh/go-units.git
Documentation: pkg.go.dev
Overview
Dependencies
11
Dependents
0

# Packages

No description provided by the author

# README

godocs.io

go-units

Go library for manipulating and converting between various units of measurement.

This is a fork of bcicen's go-units package, with significant breaking changes.
You find a list of breaking changes at the bottom of this page.

Principles

  • Name and Aliases are case-insensitive
  • Symbols are case-sensitive (e.g. MegaMeter Mm <> MilliMeter mm)
  • Names, symbols and aliases must be unique! => Looking up a unit must return 1 exact match!

Usage

In the most basic usage, go-units may be used to convert a value from one unit to another:

package main

import (
	"fmt"
	u "github.com/woweh/go-units"
)

func main() {
	// convert a simple float from celsius to fahrenheit
	fmt.Println(u.MustConvertFloat(25.5, u.Celsius, u.Fahrenheit)) // outputs "77.9 fahrenheit"

	// convert a units.Value instance
	val := u.NewValue(25.5, u.Celsius)

	fmt.Println(val)                           // "25.5 celsius"
	fmt.Println(val.MustConvert(u.Fahrenheit)) // "77.9 fahrenheit"
	fmt.Println(val.MustConvert(u.Kelvin))     // "298.65 kelvin"
}

Formatting

Aside from unit conversions, go-units may also be used for generating human-readable unit labels, plural names, and symbols:

val := u.NewValue(2.0, u.Nibble)
fmt.Println(val)                     // "2 nibbles"
fmt.Println(val.MustConvert(u.Byte)) // "1 byte"

// value formatting options may also be specified:
opts := u.FmtOptions{
  Label:     true, // append unit name/symbol
  Short:     true, // use unit symbol
  Precision: 3,
}

val = u.NewValue(15.456932, u.KiloMeter)
fmt.Println(val)           // "15.456932 kilometers"
fmt.Println(val.Fmt(opts)) // "15.457 km"
fmt.Println(val.Float())   // "15.456932"

Lookup

The package-level Find() method may be used to search for a unit by name, symbol, or alternate spelling:

// symbol
unit, err := u.Find("m")
// name
unit, err := u.Find("meter")
// alternate spelling
unit, err := u.Find("metre")

Custom Units

go-units comes with many unit names and symbols builtin; however, new units and conversions can be easily added:

// register custom unit names
Ding := u.NewUnit("ding", "di")
Dong := u.NewUnit("dong", "do")

// there are 100 dongs in a ding
u.NewRatioConversion(Ding, Dong, 100.0)

val := u.NewValue(25.0, Ding)

fmt.Printf("%s = %s\n", val, val.MustConvert(Dong)) // "25 dings = 2500 dongs"

// conversions are automatically registered when using magnitude prefix helper methods
KiloDong := u.Kilo(Dong)
fmt.Println(u.MustConvertFloat(1000.0, Dong, KiloDong)) // "1 kilodong"

You can also add aliases or symbols to existing units:

// add alternative spellings and translations
CubicMeter.AddAliases("cubic metre", "Quadratmeter", "Vierkante meter", "Metr kwadratowy", "Mètre carré")
// add additional symbols
CubicMeter.AddSymbols("m3", "m^3", "m**3", "cum", "cbm", "CBM", "M3")

Notes regarding unit and conversion definitions

When you specify a function conversion (NewConversionFromFn), you must also specify the inverse conversion.

Specifying a ratio conversion (NewRatioConversion) also registers the inverse conversions.
For ratio conversions you don't need to specify the inverse conversions.

The metric factory methods, like u.Kilo, will create the new unit with metric prefixes for name and symbols, and will register ratio conversions between the base unit and the derived metric unit.
There is no need to separately specify the ratio conversion.

Known Issues

Unicode symbols (e.g., ㎡, ㎢) can cause panics.
TODO: Investigate and debug.

References / Further Reading

The National Institute of Standards and Technology (NIST) - The NIST Guide for the use of the International System of Units - Appendix B, subsections B.8 Factors for Units Listed Alphabetically and B.9 Factors for units listed by kind of quantity or field of science.

Wikipedia contributors. "Conversion of units" Wikipedia, The Free Encyclopedia. Wikipedia, The Free Encyclopedia.

https://qudt.org/
The QUDT, or 'Quantity, Unit, Dimension and Type' collection of ontologies define the base classes properties, and restrictions used for modeling physical quantities, units of measure, and their dimensions in various measurement systems. QUDT provides a unified model of measurable quantities, units for measuring different kinds of quantities, the numerical values of quantities in different units of measure and the data structures and data types used to store and manipulate these objects in software. This OWL schema is a foundation for a basic treatment of units. Originally developed by TopQuadrant for the NASA Exploration Initiatives Ontology Models (NExIOM) project, they now form the basis of the NASA QUDT Handbook. QUDT aims to improve interoperability of data and the specification of information structures through industry standards for Units of Measure, Quantity Kinds, Dimensions and Data Types.

There are many online calculators and converters that you can use to cross-check conversions. Many of them provide explanations and formulae,

Breaking Changes compared to bcicen's version

  • Use unit pointers in the unitMap, units have a shared state.
  • Don't panic! AT least, try not to panic. There are still three methods that do panic:
    1. unit.newUnit - the private, internal factory to create new units => find duplicate names or symbols at compile time
    2. value.MustConvert
    3. units.MustConvertFloat
  • Change the signature of NewUnit, return (*Unit, error) instead of Unit.
  • Extend the Unit struct to support alternative symbols.
  • Symbols are case-sensitive.
  • Names, symbols and aliases must be unique!
    Before, only names had to be unique.
  • Add types for UnitSystem and UnitQuantity

Changes and Enhancements

  • Many additional units
  • Add methods to add aliases and symbols to units
  • Add methods to check if a unit has an alias or unit
  • Add methods to get a list of all unit names, symbols and aliases as CSV (> units.GetCsv())
  • Moved conversion tests into separate, per quantity, tests

Ideas