[#mp_units-scale-00]
= xref:mp_units.adoc[mp_units]::scale
:relfileprefix: ../
:mrdocs:

Scale `value` by the unit magnitude passed as `m,` converting to type `To,` with the result rounded according to `policy.`

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    typename To,
    xref:mp_units/UnitMagnitude.adoc[UnitMagnitude] M,
    typename From,
    xref:mp_units/RoundingPolicy.adoc[RoundingPolicy] Policy>
requires detail::UnitMagnitudeScalable<From>
[[nodiscard]]
constexpr
auto
scale(
    M m,
    From const& value,
    Policy);
----

== Return Value

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

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