forked from mpusz/mp-units
3039 lines
114 KiB
HTML
3039 lines
114 KiB
HTML
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
<meta name="description" content="The quantities and units library for C++">
|
|
|
|
|
|
<meta name="author" content="mp-units Team">
|
|
|
|
|
|
<link rel="canonical" href="https://mpusz.github.io/mp-units/2.2/getting_started/installation_and_usage/">
|
|
|
|
|
|
<link rel="prev" href="../cpp_compiler_support/">
|
|
|
|
|
|
<link rel="next" href="../faq/">
|
|
|
|
|
|
<link rel="alternate" type="application/rss+xml" title="RSS feed" href="../../feed_rss_created.xml">
|
|
<link rel="alternate" type="application/rss+xml" title="RSS feed of updated content" href="../../feed_rss_updated.xml">
|
|
|
|
<link rel="icon" href="../../assets/images/mp-units-color.svg">
|
|
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">
|
|
|
|
|
|
|
|
<title>Installation and Usage - mp-units</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/main.6543a935.min.css">
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../stylesheets/extra.css">
|
|
|
|
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta property="og:type" content="website" >
|
|
|
|
<meta property="og:title" content="Installation and Usage - mp-units" >
|
|
|
|
<meta property="og:description" content="The quantities and units library for C++" >
|
|
|
|
<meta property="og:image" content="https://mpusz.github.io/mp-units/2.2/assets/images/social/getting_started/installation_and_usage.png" >
|
|
|
|
<meta property="og:image:type" content="image/png" >
|
|
|
|
<meta property="og:image:width" content="1200" >
|
|
|
|
<meta property="og:image:height" content="630" >
|
|
|
|
<meta property="og:url" content="https://mpusz.github.io/mp-units/2.2/getting_started/installation_and_usage/" >
|
|
|
|
<meta name="twitter:card" content="summary_large_image" >
|
|
|
|
<meta name="twitter:title" content="Installation and Usage - mp-units" >
|
|
|
|
<meta name="twitter:description" content="The quantities and units library for C++" >
|
|
|
|
<meta name="twitter:image" content="https://mpusz.github.io/mp-units/2.2/assets/images/social/getting_started/installation_and_usage.png" >
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
|
|
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#installation-and-usage" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
|
|
|
|
<aside class="md-banner md-banner--warning">
|
|
<div class="md-banner__inner md-grid md-typeset">
|
|
|
|
You're not viewing the latest version.
|
|
<a href="../../..">
|
|
<strong>Click here to go to latest.</strong>
|
|
</a>
|
|
|
|
</div>
|
|
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
|
|
</aside>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<header class="md-header" data-md-component="header">
|
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
<a href="../.." title="mp-units" class="md-header__button md-logo" aria-label="mp-units" data-md-component="logo">
|
|
|
|
<img src="../../assets/images/mp-units-transparent-white.svg" alt="logo">
|
|
|
|
</a>
|
|
<label class="md-header__button md-icon" for="__drawer">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
|
|
</label>
|
|
<div class="md-header__title" data-md-component="header-title">
|
|
<div class="md-header__ellipsis">
|
|
<div class="md-header__topic">
|
|
<span class="md-ellipsis">
|
|
mp-units
|
|
</span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis">
|
|
|
|
Installation and Usage
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<form class="md-header__option" data-md-component="palette">
|
|
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
|
|
|
|
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg>
|
|
</label>
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
|
|
|
|
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z"/></svg>
|
|
</label>
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="custom" aria-label="Switch to system preference" type="radio" name="__palette" id="__palette_2">
|
|
|
|
<label class="md-header__button md-icon" title="Switch to system preference" for="__palette_0" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg>
|
|
</label>
|
|
|
|
|
|
</form>
|
|
|
|
|
|
|
|
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
|
|
|
|
|
|
|
<label class="md-header__button md-icon" for="__search">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
|
|
</label>
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
|
|
</label>
|
|
<nav class="md-search__options" aria-label="Search">
|
|
|
|
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7 0-.24-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91 1.61 0 2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08Z"/></svg>
|
|
</a>
|
|
|
|
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
|
|
</button>
|
|
</nav>
|
|
|
|
<div class="md-search__suggest" data-md-component="search-suggest"></div>
|
|
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
<div class="md-search-result__meta">
|
|
Initializing search
|
|
</div>
|
|
<ol class="md-search-result__list" role="presentation"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-header__source">
|
|
<a href="https://github.com/mpusz/mp-units" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
mpusz/mp-units
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
|
|
<div class="md-grid">
|
|
<ul class="md-tabs__list">
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../.." class="md-tabs__link">
|
|
|
|
|
|
|
|
|
|
Home
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item md-tabs__item--active">
|
|
<a href="../introduction/" class="md-tabs__link">
|
|
|
|
|
|
|
|
|
|
Getting Started
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../../users_guide/terms_and_definitions/" class="md-tabs__link">
|
|
|
|
|
|
|
|
|
|
User's Guide
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../../blog/" class="md-tabs__link">
|
|
|
|
|
|
|
|
|
|
Blog
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../../release_notes/" class="md-tabs__link">
|
|
|
|
|
|
|
|
|
|
Release Notes
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
</nav>
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href="../.." title="mp-units" class="md-nav__button md-logo" aria-label="mp-units" data-md-component="logo">
|
|
|
|
<img src="../../assets/images/mp-units-transparent-white.svg" alt="logo">
|
|
|
|
</a>
|
|
mp-units
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
<a href="https://github.com/mpusz/mp-units" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
mpusz/mp-units
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../.." class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Home
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Getting Started
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
|
|
<label class="md-nav__title" for="__nav_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Getting Started
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../introduction/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Introduction
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../quick_start/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Quick Start
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../look_and_feel/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Look and Feel
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../cpp_compiler_support/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
C++ compiler support (API/ABI)
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Installation and Usage
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Installation and Usage
|
|
</span>
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#project-structure" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Project structure
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Project structure">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#repository-directory-tree-and-dependencies" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Repository directory tree and dependencies
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#modules" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Modules
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#header-files" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Header files
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Header files">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#core-library" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Core library
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#systems-and-associated-utilities" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Systems and associated utilities
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Systems and associated utilities">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#systems-of-quantities" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Systems of quantities
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#systems-of-units" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Systems of units
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#obtaining-dependencies" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Obtaining dependencies
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Obtaining dependencies">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#conan-quick-intro" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Conan quick intro
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#build-options" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Build options
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Build options">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#conan-options" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Conan options
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#conan-configuration-properties" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Conan configuration properties
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cmake-options" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
CMake options
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="CMake options">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#options-for-mp-units-project-developers" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Options for mp-units project developers
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cmake-with-presets-support" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
CMake with presets support
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#installation-and-reuse" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Installation and reuse
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Installation and reuse">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#copy" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Copy
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#copy-cmake" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Copy + CMake
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#conan-cmake-release" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Conan + CMake (release)
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#conan-cmake-live-at-head" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Conan + CMake (Live At Head)
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#install" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Install
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#contributing-or-just-building-all-the-tests-and-examples" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Contributing (or just building all the tests and examples)
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#building-documentation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Building documentation
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#packaging" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Packaging
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#uploading-mp-units-package-to-the-conan-server" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Uploading mp-units package to the Conan server
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../faq/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
FAQ
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
User's Guide
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
User's Guide
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/terms_and_definitions/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Terms and Definitions
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Framework Basics
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Framework Basics
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/interface_introduction/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Interface Introduction
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/design_overview/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Design Overview
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/systems_of_quantities/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Systems of Quantities
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/systems_of_units/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Systems of Units
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/simple_and_typed_quantities/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Simple and Typed Quantities
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/value_conversions/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Value Conversions
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/character_of_a_quantity/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Character of a Quantity
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/dimensionless_quantities/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Dimensionless Quantities
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/quantity_arithmetics/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Quantity Arithmetics
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/generic_interfaces/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Generic Interfaces
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/faster_than_lightspeed_constants/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Faster-than-lightspeed Constants
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/the_affine_space/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
The Affine Space
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/obtaining_metadata/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Obtaining Metadata
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/concepts/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Concepts
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/framework_basics/text_output/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Text Output
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_3" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_3" id="__nav_3_3_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Defining Systems
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Defining Systems
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/defining_systems/introduction/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Introduction
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/defining_systems/isq/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
International System of Quantities (ISQ)
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/defining_systems/si/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
International System of Units (SI)
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/defining_systems/strong_angular_system/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Strong Angular System
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/defining_systems/natural_units/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Natural Units
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_4" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Use Cases
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Use Cases
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/use_cases/pure_dimensional_analysis/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Pure Dimensional Analysis
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/use_cases/working_with_legacy_interfaces/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Working with Legacy Interfaces
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/use_cases/using_custom_representation_types/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Using Custom Representation Types
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/use_cases/interoperability_with_other_libraries/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Interoperability with Other Libraries
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/use_cases/extending_the_library/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Extending the Library
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/use_cases/wide_compatibility/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Wide Compatibility
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_5" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3_5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Examples
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/examples/tags_index/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Tags Index
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_5_2" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_5_2" id="__nav_3_5_2_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
All Examples
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_5_2_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3_5_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
All Examples
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/examples/hello_units/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
hello_units
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/examples/avg_speed/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
avg_speed
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../users_guide/examples/si_constants/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
si_constants
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_6" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Appendix
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3_6">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Appendix
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../appendix/glossary/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Glossary
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../appendix/references/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
References
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
|
|
|
|
|
|
|
|
<div class="md-nav__link md-nav__container">
|
|
<a href="../../blog/" class="md-nav__link ">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Blog
|
|
</span>
|
|
|
|
|
|
</a>
|
|
|
|
|
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
</div>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Blog
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Archive
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_4_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Archive
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../blog/archive/2024/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
2024
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../blog/archive/2023/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
2023
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Categories
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_4_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Categories
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../blog/category/releases/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Releases
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../blog/category/wg21/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
WG21
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../release_notes/" class="md-nav__link">
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Release Notes
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/mpusz/mp-units/edit/master/docs/getting_started/installation_and_usage.md" title="Edit this page" class="md-content__button md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4v-2m10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1 2.1 2.1Z"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/mpusz/mp-units/raw/master/docs/getting_started/installation_and_usage.md" title="View source of this page" class="md-content__button md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.15 8.15 0 0 1-1.23-2Z"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
<h1 id="installation-and-usage">Installation And Usage<a class="headerlink" href="#installation-and-usage" title="Permanent link">¶</a></h1>
|
|
<p>This chapter provides all the necessary information to obtain and build the code using <strong>mp-units</strong>.
|
|
It also describes how to build or distribute the library and generate its documentation.</p>
|
|
<h2 id="project-structure">Project structure<a class="headerlink" href="#project-structure" title="Permanent link">¶</a></h2>
|
|
<h3 id="repository-directory-tree-and-dependencies">Repository directory tree and dependencies<a class="headerlink" href="#repository-directory-tree-and-dependencies" title="Permanent link">¶</a></h3>
|
|
<p>The <a href="https://github.com/mpusz/mp-units">GitHub repository</a> contains three independent CMake-based
|
|
projects:</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong><em>./src</em></strong></p>
|
|
<ul>
|
|
<li>header-only project containing whole <strong>mp-units</strong> library</li>
|
|
<li><em>./src/CMakeList.txt</em> file is intended as an <strong>entry point for library users</strong></li>
|
|
<li>
|
|
<p>in case this library becomes part of the C++ standard, it will have no external dependencies
|
|
but until then, it depends on the following:</p>
|
|
<ul>
|
|
<li><a href="https://github.com/gsl-lite/gsl-lite">gsl-lite</a> or <a href="https://github.com/microsoft/GSL">ms-gsl</a>
|
|
to verify runtime contracts (if contract checking is enabled),</li>
|
|
<li><a href="https://github.com/fmtlib/fmt">{fmt}</a> to provide text formatting of quantities
|
|
(if <code>std::format</code> is not supported yet on a specific compiler).</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong><em>.</em></strong></p>
|
|
<ul>
|
|
<li>project used as an <strong>entry point for library development and CI/CD</strong></li>
|
|
<li>it wraps <em>./src</em> project together with usage examples and tests</li>
|
|
<li>
|
|
<p>additionally to the dependencies of <em>./src</em> project, it uses:</p>
|
|
<ul>
|
|
<li><a href="https://github.com/catchorg/Catch2">Catch2</a> library as a unit tests framework,</li>
|
|
<li><a href="https://github.com/BobSteagall/wg21/tree/master/include">linear algebra</a>
|
|
library based on proposal <a href="https://wg21.link/P1385">P1385</a> used in some examples
|
|
and tests.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong><em>./test_package</em></strong></p>
|
|
<ul>
|
|
<li>CMake library installation and Conan package verification.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="admonition important">
|
|
<p class="admonition-title">Important: Library users should not use the top-level CMake file</p>
|
|
<p>Top level <em>CMakeLists.txt</em> file should only be used by <strong>mp-units</strong> developers and contributors
|
|
as an entry point for the project's development. We want to ensure that everyone will build <strong>ALL</strong>
|
|
the code correctly before pushing a commit. Having such options would allow unintended issues to
|
|
leak to PRs and CI.</p>
|
|
<p>This is why our projects have two entry points:</p>
|
|
<ul>
|
|
<li><em>./CMakeLists.txt</em> is <strong>to be used by projects developers</strong> to build <strong>ALL</strong> the project code
|
|
with really restrictive compilation flags,</li>
|
|
<li><em>./src/CMakeLists.txt</em> contains only a pure library definition and <strong>should be used by the
|
|
customers</strong> that prefer to use CMake's
|
|
<a href="https://cmake.org/cmake/help/latest/command/add_subdirectory.html"><code>add_subdirectory()</code></a> to
|
|
handle the dependencies.</li>
|
|
</ul>
|
|
<p>To learn more about the rationale, please check our
|
|
<a href="../faq/#why-dont-we-have-cmake-options-to-disable-the-building-of-tests-and-examples">FAQ</a>.</p>
|
|
</div>
|
|
<h3 id="modules">Modules<a class="headerlink" href="#modules" title="Permanent link">¶</a></h3>
|
|
<p>The <strong>mp-units</strong> library provides the following C++ modules:</p>
|
|
<pre class="mermaid"><code>flowchart TD
|
|
mp_units --- mp_units.systems --- mp_units.core</code></pre>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>C++ Module</th>
|
|
<th>CMake Target</th>
|
|
<th>Contents</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>mp_units.core</code></td>
|
|
<td><code>mp-units::core</code></td>
|
|
<td>Core library framework and systems-independent utilities</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>mp_units.systems</code></td>
|
|
<td><code>mp-units::systems</code></td>
|
|
<td>All the systems of quantities and units</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>mp_units</code></td>
|
|
<td><code>mp-units::mp-units</code></td>
|
|
<td>Core + Systems</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>C++ modules are provided within the package only when:</p>
|
|
<ul>
|
|
<li><a href="#cxx_modules"><code>cxx_modules</code></a> Conan option is set to <code>True</code>,</li>
|
|
<li><a href="#MP_UNITS_BUILD_CXX_MODULES"><code>MP_UNITS_BUILD_CXX_MODULES</code></a> CMake option is set to <code>ON</code>.</li>
|
|
</ul>
|
|
</div>
|
|
<h3 id="header-files">Header files<a class="headerlink" href="#header-files" title="Permanent link">¶</a></h3>
|
|
<p>All of the project's header files can be found in the <code>mp-units/...</code> subdirectory.</p>
|
|
<h4 id="core-library">Core library<a class="headerlink" href="#core-library" title="Permanent link">¶</a></h4>
|
|
<ul>
|
|
<li><code>mp-units/framework.h</code> contains the entire library's framework definitions,</li>
|
|
<li><code>mp-units/concepts.h</code> exposes only the library's concepts for generic code needs,</li>
|
|
<li><code>mp-units/format.h</code> provides text formatting support,</li>
|
|
<li><code>mp-units/ostream.h</code> enables streaming of the library's objects to the text output,</li>
|
|
<li><code>mp-units/math.h</code> provides overloads of common math functions for quantities,</li>
|
|
<li><code>mp-units/random.h</code> provides C++ pseudo-random number generators for quantities,</li>
|
|
<li><code>mp-units/compat_macros.h</code> provides macros for <a href="../../users_guide/use_cases/wide_compatibility/">wide compatibility</a>.</li>
|
|
</ul>
|
|
<details class="info">
|
|
<summary>More details</summary>
|
|
<p>More detailed header files can be found in subfolders which typically should not be
|
|
included by the end users:</p>
|
|
<ul>
|
|
<li><code>mp-units/framework/...</code> provides all the public interfaces of the framework,</li>
|
|
<li><code>mp-units/bits/...</code> provides private implementation details only (no public definitions),</li>
|
|
<li><code>mp-units/ext/...</code> contains external dependencies that at some point in the future should
|
|
be replaced with C++ standard library facilities.</li>
|
|
</ul>
|
|
</details>
|
|
<h4 id="systems-and-associated-utilities">Systems and associated utilities<a class="headerlink" href="#systems-and-associated-utilities" title="Permanent link">¶</a></h4>
|
|
<p>The systems definitions can be found in the <code>mp-units/systems/...</code> subdirectory:</p>
|
|
<h5 id="systems-of-quantities">Systems of quantities<a class="headerlink" href="#systems-of-quantities" title="Permanent link">¶</a></h5>
|
|
<ul>
|
|
<li><code>mp-units/systems/isq.h</code> provides
|
|
<a href="https://en.wikipedia.org/wiki/International_System_of_Quantities">International System of Quantities (ISQ)</a>
|
|
definitions,</li>
|
|
</ul>
|
|
<details class="tip">
|
|
<summary>Tip: Improving compile times</summary>
|
|
<p><code>mp-units/systems/isq.h</code> might be expensive to compile in every translation unit. There are
|
|
some smaller, domain targeted files available for explicit inclusion in the
|
|
<code>mp-units/systems/isq/...</code> subdirectory.</p>
|
|
</details>
|
|
<h5 id="systems-of-units">Systems of units<a class="headerlink" href="#systems-of-units" title="Permanent link">¶</a></h5>
|
|
<ul>
|
|
<li><code>mp-units/systems/si.h</code> provides
|
|
<a href="https://en.wikipedia.org/wiki/International_System_of_Units">International System of Units (SI)</a>
|
|
definitions and associated math functions,</li>
|
|
<li><code>mp-units/systems/angular.h</code> provides strong angular units and associated math functions,</li>
|
|
<li><code>mp-units/systems/international.h</code> provides
|
|
<a href="https://en.wikipedia.org/wiki/International_yard_and_pound">international yard and pound</a> units,</li>
|
|
<li><code>mp-units/systems/imperial.h</code> includes <code>international.h</code> and extends it with
|
|
<a href="https://en.wikipedia.org/wiki/Imperial_units">imperial units</a>,</li>
|
|
<li><code>mp-units/systems/usc.h</code> includes <code>international.h</code> and extends it with
|
|
<a href="https://en.wikipedia.org/wiki/United_States_customary_units">United States customary system of units</a>,</li>
|
|
<li><code>mp-units/systems/cgs.h</code> provides
|
|
<a href="https://en.wikipedia.org/wiki/Centimetre%E2%80%93gram%E2%80%93second_system_of_units">centimetre-gram-second system of units</a>,</li>
|
|
<li><code>mp-units/systems/iau.h</code> provides
|
|
<a href="https://en.wikipedia.org/wiki/Astronomical_system_of_units">astronomical system of units</a>,</li>
|
|
<li><code>mp-units/systems/hep.h</code> provides units used in
|
|
<a href="https://en.wikipedia.org/wiki/Particle_physics">high-energy physics</a>,</li>
|
|
<li><code>mp-units/systems/typographic.h</code> provides units used in
|
|
<a href="https://en.wikipedia.org/wiki/Typographic_unit">typography or typesetting</a>,</li>
|
|
<li><code>mp-units/systems/natural.h</code> provides an example implementation of
|
|
<a href="https://en.wikipedia.org/wiki/Natural_units">natural units</a>.</li>
|
|
</ul>
|
|
<details class="tip">
|
|
<summary>Tip: Improving compile times</summary>
|
|
<p><code>mp-units/systems/si.h</code> might be expensive to compile in every translation unit.
|
|
There are some smaller files available for explicit inclusion in the
|
|
<code>mp-units/systems/si/...</code> subdirectory.</p>
|
|
<p><code>mp-units/systems/si/unit_symbols.h</code> is the most expensive to include.</p>
|
|
</details>
|
|
<h2 id="obtaining-dependencies">Obtaining dependencies<a class="headerlink" href="#obtaining-dependencies" title="Permanent link">¶</a></h2>
|
|
<p>This library assumes that most of the dependencies will be provided by the
|
|
<a href="https://conan.io/">Conan Package Manager</a>. If you want to obtain required
|
|
dependencies by other means, some modifications to the library's CMake files might be needed.
|
|
The rest of the dependencies responsible for documentation generation are provided by
|
|
<code>python3-pip</code>.</p>
|
|
<h3 id="conan-quick-intro">Conan quick intro<a class="headerlink" href="#conan-quick-intro" title="Permanent link">¶</a></h3>
|
|
<p>In case you are not familiar with Conan, to install it (or upgrade) just do:</p>
|
|
<div class="language-shell highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>pip<span class="w"> </span>install<span class="w"> </span>-U<span class="w"> </span>conan
|
|
</span></code></pre></div>
|
|
<p>After that, you might need to add a custom profile file for your development environment
|
|
in <em>~/.conan2/profiles</em> directory. An example profile can look as follows:</p>
|
|
<div class="language-ini highlight"><span class="filename">~/.conan2/profiles/gcc12</span><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="k">[settings]</span>
|
|
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="na">arch</span><span class="o">=</span><span class="s">x86_64</span>
|
|
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="na">build_type</span><span class="o">=</span><span class="s">Release</span>
|
|
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="na">compiler</span><span class="o">=</span><span class="s">gcc</span>
|
|
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="hll"><span class="na">compiler.cppstd</span><span class="o">=</span><span class="s">20</span>
|
|
</span></span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="na">compiler.libcxx</span><span class="o">=</span><span class="s">libstdc++11</span>
|
|
</span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="na">compiler.version</span><span class="o">=</span><span class="s">12</span>
|
|
</span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="na">os</span><span class="o">=</span><span class="s">Linux</span>
|
|
</span><span id="__span-1-9"><a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a>
|
|
</span><span id="__span-1-10"><a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="k">[conf]</span>
|
|
</span><span id="__span-1-11"><a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="na">tools.build</span><span class="o">:</span><span class="s">compiler_executables={"c": "gcc-12", "cpp": "g++-12"}</span>
|
|
</span></code></pre></div>
|
|
<div class="admonition tip">
|
|
<p class="admonition-title">Setting the language version</p>
|
|
<p>Please note that the <strong>mp-units</strong> library requires at least C++20 to be set in a Conan profile
|
|
or forced via the Conan command line. If we do the former, we will not need to provide
|
|
<code>-s compiler.cppstd=20</code> every time we run a Conan command line (as provided in the command
|
|
line instructions below).</p>
|
|
</div>
|
|
<div class="admonition tip">
|
|
<p class="admonition-title">Using Ninja as a CMake generator for Conan</p>
|
|
<p>It is highly recommended to set Ninja as a CMake generator for Conan. To do so, we should
|
|
create a <em>~/.conan2/global.conf</em> file that will set <code>tools.cmake.cmaketoolchain:generator</code>
|
|
to one of the Ninja generators. For example:</p>
|
|
<div class="language-text highlight"><span class="filename">~/.conan2/global.conf</span><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>tools.cmake.cmaketoolchain:generator="Ninja Multi-Config"
|
|
</span></code></pre></div>
|
|
</div>
|
|
<div class="admonition tip">
|
|
<p class="admonition-title">Separate build folders for different configurations</p>
|
|
<p><em>~/.conan2/global.conf</em> file may also set <code>tools.cmake.cmake_layout:build_folder_vars</code> which
|
|
<a href="https://docs.conan.io/2/reference/tools/cmake/cmake_layout.html#multi-setting-option-cmake-layout">makes working with several compilers or build configurations easier</a>.
|
|
For example, the below line will force Conan to generate separate CMake presets and folders for
|
|
each compiler and C++ standard version:</p>
|
|
<div class="language-text highlight"><span class="filename">~/.conan2/global.conf</span><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>tools.cmake.cmake_layout:build_folder_vars=["settings.compiler", "settings.compiler.version", "settings.compiler.cppstd"]
|
|
</span></code></pre></div>
|
|
<p>In such a case, we will need to use a configuration-specific preset name in the Conan instructions
|
|
provided below rather than just <code>conan-default</code> and <code>conan-release</code>
|
|
(e.g. <code>conan-gcc-13-23</code> and <code>conan-gcc-13-23-release</code>)</p>
|
|
</div>
|
|
<h2 id="build-options">Build options<a class="headerlink" href="#build-options" title="Permanent link">¶</a></h2>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>Most of the below options are related to the C++ language features available in the compilers.
|
|
Please refer to the <a href="../cpp_compiler_support/">C++ compiler support</a> chapter to learn more
|
|
about which C++ features are required and which compiler support them.</p>
|
|
</div>
|
|
<h3 id="conan-options">Conan options<a class="headerlink" href="#conan-options" title="Permanent link">¶</a></h3>
|
|
<dl>
|
|
<dt><a href="#cxx_modules" id="cxx_modules"><code>cxx_modules</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>auto</code>/<code>True</code>/<code>False</code> (Default: <code>auto</code>)</p>
|
|
<p>Configures CMake to add C++ modules to the list of default targets.</p>
|
|
</dd>
|
|
<dt><a href="#std_format" id="std_format"><code>std_format</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>auto</code>/<code>True</code>/<code>False</code> (Default: <code>auto</code>)</p>
|
|
<p>Enables the usage of <a href="https://en.cppreference.com/w/cpp/utility/format/format"><code>std::format</code></a>
|
|
and associated facilities for text formatting. If it is not supported, then
|
|
the <a href="https://github.com/fmtlib/fmt">{fmt}</a> library is used instead.</p>
|
|
</dd>
|
|
<dt><a href="#string_view_ret" id="string_view_ret"><code>string_view_ret</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>auto</code>/<code>True</code>/<code>False</code> (Default: <code>auto</code>)</p>
|
|
<p>Enables returning <code>std::string_view</code> from the
|
|
<a href="../../users_guide/framework_basics/text_output/#unit_symbol"><code>unit_symbol()</code></a>
|
|
and <a href="../../users_guide/framework_basics/text_output/#dimension_symbol"><code>dimension_symbol()</code></a>
|
|
functions. If this feature is not available, those functions will return
|
|
<code>mp_units::basic_fixed_string<CharT, N></code> instead.</p>
|
|
</dd>
|
|
<dt><a href="#no_crtp" id="no_crtp"><code>no_crtp</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>auto</code>/<code>True</code>/<code>False</code> (Default: <code>auto</code>)</p>
|
|
<p>Removes the need for the usage of the CRTP idiom in the
|
|
<a href="../../users_guide/framework_basics/systems_of_quantities/#defining-quantities"><code>quantity_spec</code> definitions</a>.</p>
|
|
</dd>
|
|
<dt><a href="#contracts" id="contracts"><code>contracts</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>none</code>/<code>gsl-lite</code>/<code>ms-gsl</code> (Default: <code>gsl-lite</code>)</p>
|
|
<p>Enables checking of preconditions and additional asserts in the code.</p>
|
|
</dd>
|
|
<dt><a href="#freestanding" id="freestanding"><code>freestanding</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>True</code>/<code>False</code> (Default: <code>False</code>)</p>
|
|
<p>Configures the library in the <a href="https://en.cppreference.com/w/cpp/freestanding">freestanding</a>
|
|
mode. When enabled, the library's source code should build with the compiler's
|
|
<a href="https://gcc.gnu.org/onlinedocs/gcc/C-Dialect-Options.html"><code>-ffreestanding</code></a> compilation option
|
|
without any issues.</p>
|
|
</dd>
|
|
</dl>
|
|
<h3 id="conan-configuration-properties">Conan configuration properties<a class="headerlink" href="#conan-configuration-properties" title="Permanent link">¶</a></h3>
|
|
<dl>
|
|
<dt><a href="#user.mp-units.build-all" id="user.mp-units.build-all"><code>user.mp-units.build:all</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>True</code>/<code>False</code> (Default: <code>False</code>)</p>
|
|
<p>Enables compilation of all the source code, including tests and examples. To support this, it requires some additional Conan build dependencies described in
|
|
<a href="#repository-directory-tree-and-dependencies">Repository directory tree and dependencies</a>.
|
|
It also runs unit tests during Conan build (unless
|
|
<a href="https://docs.conan.io/2/reference/commands/config.html?highlight=tools.build:skip_test#conan-config-list"><code>tools.build:skip_test</code></a>
|
|
configuration property is set to <code>True</code>).</p>
|
|
</dd>
|
|
<dt><a href="#user-skip-la" id="user-skip-la"><code>user.mp-units.build:skip_la</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>True</code>/<code>False</code> (Default: <code>False</code>)</p>
|
|
<p>If <code>user.mp-units.build:all</code> is enabled, among others, Conan installs the external
|
|
<a href="https://conan.io/center/recipes/wg21-linear_algebra">wg21-linear_algebra</a>
|
|
dependency and enables the compilation of linear algebra-based tests and usage examples.
|
|
Such behavior can be disabled with this option.</p>
|
|
</dd>
|
|
<dt><a href="#user.mp-units.analyze-clang-tidy" id="user.mp-units.analyze-clang-tidy"><code>user.mp-units.analyze:clang-tidy</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>True</code>/<code>False</code> (Default: <code>False</code>)</p>
|
|
<p>Enables clang-tidy analysis.</p>
|
|
</dd>
|
|
</dl>
|
|
<h3 id="cmake-options">CMake options<a class="headerlink" href="#cmake-options" title="Permanent link">¶</a></h3>
|
|
<dl>
|
|
<dt><a href="#MP_UNITS_BUILD_AS_SYSTEM_HEADERS" id="MP_UNITS_BUILD_AS_SYSTEM_HEADERS"><code>MP_UNITS_BUILD_AS_SYSTEM_HEADERS</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>ON</code>/<code>OFF</code> (Default: <code>OFF</code>)</p>
|
|
<p>Exports library as system headers.</p>
|
|
</dd>
|
|
<dt><a href="#MP_UNITS_BUILD_CXX_MODULES" id="MP_UNITS_BUILD_CXX_MODULES"><code>MP_UNITS_BUILD_CXX_MODULES</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>ON</code>/<code>OFF</code> (Default: <code>OFF</code>)</p>
|
|
<p>Adds C++ modules to the list of default targets.</p>
|
|
</dd>
|
|
<dt><a href="#MP_UNITS_API_STD_FORMAT" id="MP_UNITS_API_STD_FORMAT"><code>MP_UNITS_API_STD_FORMAT</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>AUTO</code>/<code>TRUE</code>/<code>FALSE</code> (Default: <code>AUTO</code>)</p>
|
|
<p>Enables the usage of <a href="https://en.cppreference.com/w/cpp/utility/format/format"><code>std::format</code></a>
|
|
and associated facilities for text formatting. If it is not supported, then
|
|
the <a href="https://github.com/fmtlib/fmt">{fmt}</a> library is used instead.</p>
|
|
</dd>
|
|
<dt><a href="#MP_UNITS_API_STRING_VIEW_RET" id="MP_UNITS_API_STRING_VIEW_RET"><code>MP_UNITS_API_STRING_VIEW_RET</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>AUTO</code>/<code>TRUE</code>/<code>FALSE</code> (Default: <code>AUTO</code>)</p>
|
|
<p>Enables returning <code>std::string_view</code> from the
|
|
<a href="../../users_guide/framework_basics/text_output/#unit_symbol"><code>unit_symbol()</code></a>
|
|
and <a href="../../users_guide/framework_basics/text_output/#dimension_symbol"><code>dimension_symbol()</code></a>
|
|
functions. If this feature is not available, those functions will return
|
|
<code>mp_units::basic_fixed_string<CharT, N></code> instead.</p>
|
|
</dd>
|
|
<dt><a href="#MP_UNITS_API_NO_CRTP" id="MP_UNITS_API_NO_CRTP"><code>MP_UNITS_API_NO_CRTP</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>AUTO</code>/<code>TRUE</code>/<code>FALSE</code> (Default: <code>AUTO</code>)</p>
|
|
<p>Removes the need for the usage of the CRTP idiom in the
|
|
<a href="../../users_guide/framework_basics/systems_of_quantities/#defining-quantities"><code>quantity_spec</code> definitions</a>.</p>
|
|
</dd>
|
|
<dt><a href="#MP_UNITS_API_CONTRACTS" id="MP_UNITS_API_CONTRACTS"><code>MP_UNITS_API_CONTRACTS</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>NONE</code>/<code>GSL-LITE</code>/<code>MS-GSL</code> (Default: <code>GSL-LITE</code>)</p>
|
|
<p>Enables checking of preconditions and additional asserts in the code.</p>
|
|
</dd>
|
|
<dt><a href="#MP_UNITS_API_FREESTANDING" id="MP_UNITS_API_FREESTANDING"><code>MP_UNITS_API_FREESTANDING</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>ON</code>/<code>OFF</code> (Default: <code>OFF</code>)</p>
|
|
<p>Configures the library in the <a href="https://en.cppreference.com/w/cpp/freestanding">freestanding</a>
|
|
mode. When enabled, the library's source code should build with the compiler's
|
|
<a href="https://gcc.gnu.org/onlinedocs/gcc/C-Dialect-Options.html"><code>-ffreestanding</code></a> compilation option
|
|
without any issues.</p>
|
|
</dd>
|
|
</dl>
|
|
<h4 id="options-for-mp-units-project-developers">Options for mp-units project developers<a class="headerlink" href="#options-for-mp-units-project-developers" title="Permanent link">¶</a></h4>
|
|
<dl>
|
|
<dt><a href="#MP_UNITS_DEV_BUILD_LA" id="MP_UNITS_DEV_BUILD_LA"><code>MP_UNITS_DEV_BUILD_LA</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>ON</code>/<code>OFF</code> (Default: <code>ON</code>)</p>
|
|
<p>Enables building code depending on the linear algebra library.</p>
|
|
</dd>
|
|
<dt><a href="#MP_UNITS_DEV_IWYU" id="MP_UNITS_DEV_IWYU"><code>MP_UNITS_DEV_IWYU</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>ON</code>/<code>OFF</code> (Default: <code>OFF</code>)</p>
|
|
<p>Enables include-what-you-use analysis.</p>
|
|
</dd>
|
|
<dt><a href="#MP_UNITS_DEV_CLANG_TIDY" id="MP_UNITS_DEV_CLANG_TIDY"><code>MP_UNITS_DEV_CLANG_TIDY</code></a></dt>
|
|
<dd>
|
|
<p><a href="https://github.com/mpusz/mp-units/releases/tag/v2.2.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> 2.2.0</a> · <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.75 1a.75.75 0 0 1 .75.75V4h6.532c.42 0 .826.15 1.143.425l3.187 2.75a1.75 1.75 0 0 1 0 2.65l-3.187 2.75a1.75 1.75 0 0 1-1.143.425H12.5v9.25a.75.75 0 0 1-1.5 0V13H3.75A1.75 1.75 0 0 1 2 11.25v-5.5C2 4.783 2.784 4 3.75 4H11V1.75a.75.75 0 0 1 .75-.75Zm7.282 4.5H3.75a.25.25 0 0 0-.25.25v5.5c0 .138.112.25.25.25h15.282c.06 0 .118-.021.163-.06l3.188-2.75a.248.248 0 0 0 0-.38l-3.188-2.75a.249.249 0 0 0-.163-.06Z"/></svg></span> <code>ON</code>/<code>OFF</code> (Default: <code>OFF</code>)</p>
|
|
<p>Enables clang-tidy analysis.</p>
|
|
</dd>
|
|
</dl>
|
|
<h2 id="cmake-with-presets-support">CMake with presets support<a class="headerlink" href="#cmake-with-presets-support" title="Permanent link">¶</a></h2>
|
|
<p>It is recommended to use at least CMake 3.23 to build this project as this version introduced support
|
|
for CMake Presets schema version 4, used now by Conan to generate presets files. All build instructions
|
|
below assume that you have such support. If not, your CMake invocations have to be replaced with something
|
|
like:</p>
|
|
<div class="language-shell highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>mkdir<span class="w"> </span>build<span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="nb">cd</span><span class="w"> </span>build
|
|
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>cmake<span class="w"> </span>..<span class="w"> </span>-G<span class="w"> </span><span class="s2">"Ninja Multi-Config"</span><span class="w"> </span>-DCMAKE_TOOLCHAIN_FILE<span class="o">=</span><path_to_generators_dir>/conan_toolchain.cmake
|
|
</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>cmake<span class="w"> </span>--build<span class="w"> </span>.<span class="w"> </span>--config<span class="w"> </span>Release
|
|
</span></code></pre></div>
|
|
<div class="admonition tip">
|
|
<p class="admonition-title">Tip</p>
|
|
<p>In case you can't use CMake 3.23 but you have access to CMake 3.20 or later, you can append
|
|
<code>-c tools.cmake.cmaketoolchain.presets:max_schema_version=2</code> to the <code>conan install</code> command
|
|
which will force Conan to use an older version of the CMake Presets schema.</p>
|
|
</div>
|
|
<h2 id="installation-and-reuse">Installation and reuse<a class="headerlink" href="#installation-and-reuse" title="Permanent link">¶</a></h2>
|
|
<p>There are many different ways of installing/reusing <strong>mp-units</strong> in your project. Below we mention
|
|
only a few of many options possible.</p>
|
|
<div class="admonition important">
|
|
<p class="admonition-title">Important: Prefer using Conan if possible</p>
|
|
<p>The easiest and most recommended way to obtain <strong>mp-units</strong> is with the Conan package manager.
|
|
See <a href="#conan-cmake-release">Conan + CMake (release)</a> for a detailed instruction.</p>
|
|
</div>
|
|
<h3 id="copy">Copy<a class="headerlink" href="#copy" title="Permanent link">¶</a></h3>
|
|
<p>As <strong>mp-units</strong> is a C++ header-only library you can simply copy all needed <em>src/*/include</em> subdirectories
|
|
to your source tree.</p>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>In such a case, you are on your own to ensure all the dependencies are installed and their header
|
|
files can be located during the build. Please also note that some compiler-specific flags are needed
|
|
to make the code compile without issues.</p>
|
|
</div>
|
|
<h3 id="copy-cmake">Copy + CMake<a class="headerlink" href="#copy-cmake" title="Permanent link">¶</a></h3>
|
|
<p>If you copy the whole <strong>mp-units</strong> repository to your project's file tree, you can reuse CMake targets
|
|
defined by the library. To do so, <strong>you should use <em>CMakeLists.txt</em> file from the <em>./src</em> directory</strong>:</p>
|
|
<div class="language-cmake highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="nb">add_subdirectory</span><span class="p">(</span><span class="s"><path_to_units_folder>/src</span><span class="p">)</span>
|
|
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="c"># ...</span>
|
|
</span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="nb">target_link_libraries</span><span class="p">(</span><span class="s"><your_target></span><span class="w"> </span><span class="s"><PUBLIC|PRIVATE|INTERFACE></span><span class="w"> </span><span class="s">mp-units::mp-units</span><span class="p">)</span>
|
|
</span></code></pre></div>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>You are still on your own to make sure all the dependencies are installed and their header and CMake
|
|
configuration files can be located during the build.</p>
|
|
</div>
|
|
<h3 id="conan-cmake-release">Conan + CMake (release)<a class="headerlink" href="#conan-cmake-release" title="Permanent link">¶</a></h3>
|
|
<div class="admonition tip">
|
|
<p class="admonition-title">Tip</p>
|
|
<p>If you are new to the Conan package manager, it is highly recommended to read
|
|
<a href="#obtaining-dependencies">Obtaining Dependencies</a> and refer to
|
|
<a href="https://docs.conan.io/2/tutorial/consuming_packages.html">Consuming packages</a>
|
|
chapter of the official Conan documentation for more information.</p>
|
|
</div>
|
|
<p><strong>mp-units</strong> releases are hosted on <a href="https://conan.io/center/recipes/mp-units">Conan-Center</a>.
|
|
The following steps may be performed to obtain an official library release:</p>
|
|
<ol>
|
|
<li>
|
|
<p>Create Conan configuration file (either <em>conanfile.txt</em> or <em>conanfile.py</em>) in your
|
|
project's top-level directory and add <strong>mp-units</strong> as a dependency of your project.
|
|
For example, the simplest file may look as follows:</p>
|
|
<div class="language-ini highlight"><span class="filename">conanfile.txt</span><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="k">[requires]</span>
|
|
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="na">mp-units/2.2.0</span>
|
|
</span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>
|
|
</span><span id="__span-6-4"><a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="k">[options]</span>
|
|
</span><span id="__span-6-5"><a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="na">mp-units</span><span class="o">:</span><span class="s">cxx_modules=True</span>
|
|
</span><span id="__span-6-6"><a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a>
|
|
</span><span id="__span-6-7"><a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a><span class="k">[layout]</span>
|
|
</span><span id="__span-6-8"><a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a><span class="na">cmake_layout</span>
|
|
</span><span id="__span-6-9"><a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a>
|
|
</span><span id="__span-6-10"><a id="__codelineno-6-10" name="__codelineno-6-10" href="#__codelineno-6-10"></a><span class="k">[generators]</span>
|
|
</span><span id="__span-6-11"><a id="__codelineno-6-11" name="__codelineno-6-11" href="#__codelineno-6-11"></a><span class="na">CMakeToolchain</span>
|
|
</span><span id="__span-6-12"><a id="__codelineno-6-12" name="__codelineno-6-12" href="#__codelineno-6-12"></a><span class="na">CMakeDeps</span>
|
|
</span></code></pre></div>
|
|
</li>
|
|
<li>
|
|
<p>Import <strong>mp-units</strong> and its dependencies definitions to your project's build procedure
|
|
with <code>find_package</code>:</p>
|
|
<div class="language-cmake highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="nb">find_package</span><span class="p">(</span><span class="s">mp-units</span><span class="w"> </span><span class="s">REQUIRED</span><span class="p">)</span>
|
|
</span></code></pre></div>
|
|
</li>
|
|
<li>
|
|
<p>Link your CMake targets with <strong>mp-units</strong>:</p>
|
|
<div class="language-cmake highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="nb">target_link_libraries</span><span class="p">(</span><span class="s"><your_target></span><span class="w"> </span><span class="s"><PUBLIC|PRIVATE|INTERFACE></span><span class="w"> </span><span class="s">mp-units::mp-units</span><span class="p">)</span>
|
|
</span></code></pre></div>
|
|
</li>
|
|
<li>
|
|
<p>Download, build, and install Conan dependencies before running the CMake configuration step:</p>
|
|
<div class="language-shell highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>conan<span class="w"> </span>install<span class="w"> </span>.<span class="w"> </span>-pr<span class="w"> </span><your_conan_profile><span class="w"> </span>-s<span class="w"> </span>compiler.cppstd<span class="o">=</span><span class="m">20</span><span class="w"> </span>-b<span class="o">=</span>missing
|
|
</span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a>cmake<span class="w"> </span>--preset<span class="w"> </span>conan-default
|
|
</span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a>cmake<span class="w"> </span>--build<span class="w"> </span>--preset<span class="w"> </span>conan-release
|
|
</span></code></pre></div>
|
|
</li>
|
|
</ol>
|
|
<h3 id="conan-cmake-live-at-head">Conan + CMake (Live At Head)<a class="headerlink" href="#conan-cmake-live-at-head" title="Permanent link">¶</a></h3>
|
|
<p>This chapter describes the procedure to Live At Head, which means using the latest stable version
|
|
of <strong>mp-units</strong> all the time.</p>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>Please note that even though the Conan packages that you will be using are generated <strong>ONLY</strong>
|
|
for builds that are considered stable (passed our CI tests), some minor regressions may happen
|
|
(our CI and C++20 build environment is not perfect yet). Also, please expect that the library
|
|
interface might, and probably will, change occasionally. Even though we do our best, such
|
|
changes might not be reflected in the project's documentation right away.</p>
|
|
</div>
|
|
<p>The procedure is similar to the one described in <a href="#conan-cmake-release">Conan + CMake (release)</a>
|
|
with the following differences:</p>
|
|
<ol>
|
|
<li>
|
|
<p>Before starting the previous procedure, add <strong>mp-units</strong> remote to your Conan configuration:</p>
|
|
<div class="language-shell highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>conan<span class="w"> </span>remote<span class="w"> </span>add<span class="w"> </span>conan-mpusz<span class="w"> </span>https://mpusz.jfrog.io/artifactory/api/conan/conan-oss
|
|
</span></code></pre></div>
|
|
</li>
|
|
<li>
|
|
<p>In your Conan configuration file, provide the package identifier of the <code>mpusz/testing</code> stream:</p>
|
|
<div class="language-ini highlight"><span class="filename">conanfile.txt</span><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="k">[requires]</span>
|
|
</span><span id="__span-11-2"><a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><span class="hll"><span class="na">mp-units/2.3.0@mpusz/testing</span>
|
|
</span></span><span id="__span-11-3"><a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a>
|
|
</span><span id="__span-11-4"><a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a><span class="k">[options]</span>
|
|
</span><span id="__span-11-5"><a id="__codelineno-11-5" name="__codelineno-11-5" href="#__codelineno-11-5"></a><span class="na">mp-units</span><span class="o">:</span><span class="s">cxx_modules=True</span>
|
|
</span><span id="__span-11-6"><a id="__codelineno-11-6" name="__codelineno-11-6" href="#__codelineno-11-6"></a>
|
|
</span><span id="__span-11-7"><a id="__codelineno-11-7" name="__codelineno-11-7" href="#__codelineno-11-7"></a><span class="k">[layout]</span>
|
|
</span><span id="__span-11-8"><a id="__codelineno-11-8" name="__codelineno-11-8" href="#__codelineno-11-8"></a><span class="na">cmake_layout</span>
|
|
</span><span id="__span-11-9"><a id="__codelineno-11-9" name="__codelineno-11-9" href="#__codelineno-11-9"></a>
|
|
</span><span id="__span-11-10"><a id="__codelineno-11-10" name="__codelineno-11-10" href="#__codelineno-11-10"></a><span class="k">[generators]</span>
|
|
</span><span id="__span-11-11"><a id="__codelineno-11-11" name="__codelineno-11-11" href="#__codelineno-11-11"></a><span class="na">CMakeToolchain</span>
|
|
</span><span id="__span-11-12"><a id="__codelineno-11-12" name="__codelineno-11-12" href="#__codelineno-11-12"></a><span class="na">CMakeDeps</span>
|
|
</span></code></pre></div>
|
|
<div class="admonition tip">
|
|
<p class="admonition-title">Tip</p>
|
|
<p>The identifiers of the latest packages can always be found in
|
|
<a href="https://github.com/mpusz/mp-units/blob/master/README.md">the project's README file</a> or on
|
|
<a href="https://mpusz.jfrog.io/ui/packages/conan:%2F%2Fmp-units">the project's Artifactory</a>.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<p>Force Conan to check for updated recipes with <code>-u</code>:</p>
|
|
<div class="language-shell highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>conan<span class="w"> </span>install<span class="w"> </span>.<span class="w"> </span>-pr<span class="w"> </span><your_conan_profile><span class="w"> </span>-s<span class="w"> </span>compiler.cppstd<span class="o">=</span><span class="m">20</span><span class="w"> </span>-b<span class="o">=</span>missing<span class="w"> </span>-u
|
|
</span></code></pre></div>
|
|
</li>
|
|
</ol>
|
|
<h3 id="install">Install<a class="headerlink" href="#install" title="Permanent link">¶</a></h3>
|
|
<p>In case you don't want to use Conan in your project and just want to install the <strong>mp-units</strong>
|
|
library on your file system and use <code>find_package(mp-units)</code> from another repository to find it;
|
|
it is enough to perform the following steps:</p>
|
|
<div class="language-shell highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>conan<span class="w"> </span>install<span class="w"> </span>.<span class="w"> </span>-pr<span class="w"> </span><your_conan_profile><span class="w"> </span>-s<span class="w"> </span>compiler.cppstd<span class="o">=</span><span class="m">20</span><span class="w"> </span>-b<span class="o">=</span>missing
|
|
</span><span id="__span-13-2"><a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a>mv<span class="w"> </span>CMakeUserPresets.json<span class="w"> </span>src
|
|
</span><span id="__span-13-3"><a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a><span class="nb">cd</span><span class="w"> </span>src
|
|
</span><span id="__span-13-4"><a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a>cmake<span class="w"> </span>--preset<span class="w"> </span>conan-default<span class="w"> </span>-DCMAKE_INSTALL_PREFIX<span class="o">=</span><your_installation_path>
|
|
</span><span id="__span-13-5"><a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a>cmake<span class="w"> </span>--build<span class="w"> </span>--preset<span class="w"> </span>conan-release<span class="w"> </span>--target<span class="w"> </span>install
|
|
</span></code></pre></div>
|
|
<h2 id="contributing-or-just-building-all-the-tests-and-examples">Contributing (or just building all the tests and examples)<a class="headerlink" href="#contributing-or-just-building-all-the-tests-and-examples" title="Permanent link">¶</a></h2>
|
|
<p>In case you would like to build all the <strong>mp-units</strong> source code (with unit tests and examples),
|
|
you should:</p>
|
|
<ol>
|
|
<li>Use the <em>CMakeLists.txt</em> from the top-level directory.</li>
|
|
<li>Run Conan with <a href="#user.mp-units.build-all"><code>user.mp-units.build:all</code></a> = <code>True</code>.</li>
|
|
</ol>
|
|
<div class="language-shell highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/mpusz/mp-units.git<span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="nb">cd</span><span class="w"> </span>units
|
|
</span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a>conan<span class="w"> </span>build<span class="w"> </span>.<span class="w"> </span>-pr<span class="w"> </span><your_conan_profile><span class="w"> </span>-s<span class="w"> </span>compiler.cppstd<span class="o">=</span><span class="m">23</span><span class="w"> </span>-o<span class="w"> </span><span class="nv">cxx_modules</span><span class="o">=</span>True<span class="w"> </span>-c<span class="w"> </span>user.mp-units.build:all<span class="o">=</span>True<span class="w"> </span>-b<span class="w"> </span>missing
|
|
</span></code></pre></div>
|
|
<p>The above will download and install all of the dependencies needed for the development of the library,
|
|
build all of the source code, and run unit tests.</p>
|
|
<p>If you prefer to build the project via CMake rather than Conan, then you should replace
|
|
the <code>conan build</code> with <code>conan install</code> command and then follow with a regular CMake build:</p>
|
|
<div class="language-shell highlight"><pre><span></span><code><span id="__span-15-1"><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a>cmake<span class="w"> </span>--preset<span class="w"> </span>conan-default
|
|
</span><span id="__span-15-2"><a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a>cmake<span class="w"> </span>--build<span class="w"> </span>--preset<span class="w"> </span>conan-release
|
|
</span><span id="__span-15-3"><a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a>cmake<span class="w"> </span>--build<span class="w"> </span>--preset<span class="w"> </span>conan-release<span class="w"> </span>--target<span class="w"> </span>all_verify_interface_header_sets
|
|
</span><span id="__span-15-4"><a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a>cmake<span class="w"> </span>--build<span class="w"> </span>--preset<span class="w"> </span>conan-release<span class="w"> </span>--target<span class="w"> </span><span class="nb">test</span>
|
|
</span></code></pre></div>
|
|
<h2 id="building-documentation">Building documentation<a class="headerlink" href="#building-documentation" title="Permanent link">¶</a></h2>
|
|
<p>Starting from <strong>mp-units 2.0</strong> we are using <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>
|
|
to build our documentation. The easiest way to install all the required dependencies
|
|
is with <code>pip</code>:</p>
|
|
<div class="language-shell highlight"><pre><span></span><code><span id="__span-16-1"><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a>pip<span class="w"> </span>install<span class="w"> </span>-U<span class="w"> </span>mkdocs-material<span class="w"> </span>mkdocs-rss-plugin
|
|
</span></code></pre></div>
|
|
<p>Additionally, a <a href="https://www.cairographics.org/">Cairo Graphics library</a> is required by
|
|
Material for MkDocs. Please follow the
|
|
<a href="https://squidfunk.github.io/mkdocs-material/plugins/requirements/image-processing/#cairo-graphics">official MkDocs documentation to install it</a>.</p>
|
|
<p>After that, you can either:</p>
|
|
<ul>
|
|
<li>
|
|
<p>easily <a href="https://squidfunk.github.io/mkdocs-material/creating-your-site/#previewing-as-you-write">start a live server to preview the documentation as you write</a></p>
|
|
<div class="language-shell highlight"><pre><span></span><code><span id="__span-17-1"><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a>mkdocs<span class="w"> </span>serve
|
|
</span></code></pre></div>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://squidfunk.github.io/mkdocs-material/creating-your-site/#building-your-site">build the documentation</a></p>
|
|
<div class="language-shell highlight"><pre><span></span><code><span id="__span-18-1"><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a>mkdocs<span class="w"> </span>build
|
|
</span></code></pre></div>
|
|
</li>
|
|
</ul>
|
|
<h2 id="packaging">Packaging<a class="headerlink" href="#packaging" title="Permanent link">¶</a></h2>
|
|
<p>To test CMake installation and Conan packaging or create a Conan package run:</p>
|
|
<div class="language-shell highlight"><pre><span></span><code><span id="__span-19-1"><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>conan<span class="w"> </span>create<span class="w"> </span>.<span class="w"> </span>--user<span class="w"> </span><username><span class="w"> </span>--channel<span class="w"> </span><channel><span class="w"> </span>-pr<span class="w"> </span><your_conan_profile><span class="w"> </span>-s<span class="w"> </span>compiler.cppstd<span class="o">=</span><span class="m">20</span><span class="w"> </span>-o<span class="w"> </span><span class="nv">cxx_modules</span><span class="o">=</span>True<span class="w"> </span>-c<span class="w"> </span>user.mp-units.build:all<span class="o">=</span>True<span class="w"> </span>-b<span class="w"> </span>missing
|
|
</span></code></pre></div>
|
|
<p>The above will create a Conan package and run tests provided in <em>./test_package</em> directory.</p>
|
|
<h2 id="uploading-mp-units-package-to-the-conan-server">Uploading <strong>mp-units</strong> package to the Conan server<a class="headerlink" href="#uploading-mp-units-package-to-the-conan-server" title="Permanent link">¶</a></h2>
|
|
<div class="language-shell highlight"><pre><span></span><code><span id="__span-20-1"><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a>conan<span class="w"> </span>upload<span class="w"> </span>-r<span class="w"> </span><remote-name><span class="w"> </span>--all<span class="w"> </span>mp-units/2.2.0@<user>/<channel>
|
|
</span></code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
|
|
|
|
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
|
</div>
|
|
|
|
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg>
|
|
Back to top
|
|
</button>
|
|
|
|
</main>
|
|
|
|
<footer class="md-footer">
|
|
|
|
|
|
|
|
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
|
|
|
|
|
<a href="../cpp_compiler_support/" class="md-footer__link md-footer__link--prev" aria-label="Previous: C++ compiler support (API/ABI)">
|
|
<div class="md-footer__button md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
|
|
</div>
|
|
<div class="md-footer__title">
|
|
<span class="md-footer__direction">
|
|
Previous
|
|
</span>
|
|
<div class="md-ellipsis">
|
|
C++ compiler support (API/ABI)
|
|
</div>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
|
|
<a href="../faq/" class="md-footer__link md-footer__link--next" aria-label="Next: FAQ">
|
|
<div class="md-footer__title">
|
|
<span class="md-footer__direction">
|
|
Next
|
|
</span>
|
|
<div class="md-ellipsis">
|
|
FAQ
|
|
</div>
|
|
</div>
|
|
<div class="md-footer__button md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg>
|
|
</div>
|
|
</a>
|
|
|
|
</nav>
|
|
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-copyright">
|
|
|
|
<div class="md-copyright__highlight">
|
|
Copyright © 2018-2023 Mateusz Pusz
|
|
</div>
|
|
|
|
|
|
Made with
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
Material for MkDocs
|
|
</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
|
|
|
|
<script id="__config" type="application/json">{"base": "../..", "features": ["content.action.edit", "content.action.view", "content.code.annotate", "content.code.copy", "navigation.indexes", "navigation.tabs", "navigation.footer", "navigation.top", "search.highlight", "search.share", "search.suggest", "toc.follow", "toc.integrate"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
|
|
|
|
|
|
<script src="../../assets/javascripts/bundle.ad660dcc.min.js"></script>
|
|
|
|
<script src="../../javascripts/mathjax.js"></script>
|
|
|
|
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |