[#mp_units-get_common_unit-02]
= xref:mp_units.adoc[mp_units]::get_common_unit
:relfileprefix: ../
:mrdocs:

Computes the common unit of three or more units

== Synopsis

Declared in `<mp‐units/framework/unit_conversion.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard]]
consteval
xref:mp_units/Unit.adoc[Unit] auto
get_common_unit(
    auto u1,
    auto u2,
    auto u3,
    auto... rest)
requires requires { mp_units::get_common_unit(mp_units::get_common_unit(u1, u2), u3, rest...); };
----

== Return Value

the common unit obtained by folding `get_common_unit` over `u1,` `u2,` `u3,` and `rest`

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Parameters

[cols="1,4"]
|===
| Name| Description
| *u1*
| first unit
| *u2*
| second unit
| *u3*
| third unit
| *rest*
| remaining units, if any
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#