Skip to content

Reference

Welcome to the mp-units Reference documentation! This section provides quick lookups, detailed API documentation, and comprehensive reference material for all library features.

What is the Reference?

The Reference is information-oriented documentation designed for looking up specific details when you already know what you need.

This section:

  • ✅ Provides quick access to specific information
  • ✅ Organizes content for efficient lookup
  • ✅ Lists all available systems, units, and quantities
  • ✅ Documents API details comprehensively

Prerequisites: Basic familiarity with mp-units concepts. Reference documentation assumes you understand fundamentals and need specific details.

Available References

Cheat Sheet

Quick reference for common operations and patterns—your go-to page for syntax and usage reminders.

Systems Reference

Comprehensive listings of all available physical units systems:

API Reference

Declarations for everything the library exposes: class templates, concepts, functions and their signatures, generated from the headers with MrDocs so they cannot drift from the code.

Units, quantities, dimensions and constants are not here - those live in the Systems Reference, which documents them as metrology rather than as C++ declarations.

Glossary

Definitions of metrology terms and concepts used throughout the library.

Bibliography

References to standards, papers, and resources that inform the library's design.

How to Use the Reference

Quick Lookup: Use the Cheat Sheet for common operations and syntax.

Find a Unit: Browse Systems Reference to locate specific units, quantities, or dimensions.

API Details: Check API Reference for detailed function signatures and class interfaces.

Terminology: Consult the Glossary when you encounter unfamiliar metrology terms.

When to Use the Reference

Use the Reference when you:

  • Need to quickly look up syntax or function names
  • Want to find a specific unit or quantity
  • Need precise API details
  • Are looking for a specific piece of information
  • Want to verify exact behavior or parameters

Other Resources