xo-unit documentation

xo-unit is a lightweight header-only library that provides compile-time dimension checking and unit conversion.

Functionality is similar in spirit to that provided by boost::units; however there are some important differences:

• streamlined implementation using c++20 features.

• along with no-runtime-overhead compile-time unit inference, also provides defer-until-runtime representation.

• constexpr string representation for things like unit abbreviations.

• supports fractional dimensions, for concepts like volatility.

• integration with python (see sister project xo-pyunit)

Second, xo-unit supports fractional dimensions. This allows using it to naturally handle concepts like volatility (dimension 1/sqrt(time)), for example.

Finally, xo-unit is written with the expectation of providing python integration via pybind11. This requires a parallel set of data structures that can work at runtime (since we can’t construct new c++ types at runtime).

xo-unit contents

• Install
  • Include as submodule
  • Ubuntu Install Pattern
  • Installing from source
  • Use CMake Support
  • Build and Install with Unit Tests Enabled
  • Build Examples
  • Build and Install Documentation
  • Supported compilers
• Examples
  • Compile-time unit inference
  • Explicit scale conversion
  • Implicit Scale conversion
  • Scale conversion and arithmetic
  • Dimensionless quantities unwrap implicitly
  • Fractional dimension
  • Dynamic dimension
• Components
• Representation
• Quantity Reference
  • Quantity
  • Quantity Factory Functions
  • Quantity Unit Variables
  • Quantity Source Code
• Xquantity Reference
  • Xquantity
• Scaled Unit Reference
  • Scaled Unit Class
  • Scaled Unit Constants
• Natural Unit
  • Context
  • Introduction
  • Class
  • Member Variables
  • Type Traits
  • Constructors
  • Access Methods
  • General Methods
  • Conversion
  • Comparison Functions
• BPU
  • Context
  • Introduction
  • Class
  • Member Variables
  • Constructors
  • Access Methods
  • Other Methods
  • Comparison
  • Details
• Basis Unit Store
  • Class
  • Constants
  • Functions
• Basis Unit Reference
  • Basis Unit Class
  • Basis Unit Constants
• Native Dimension
  • Context
  • Introduction
  • Enum
  • Constants
  • Functions
• Development
  • Addding a Basis Unit
• Ubuntu Github Workflow
• Glossary
• Index
• Search Page