[#mp_units-scaled_unit]
= xref:mp_units.adoc[mp&lowbar;units]::scaled&lowbar;unit
:relfileprefix: ../
:mrdocs:

Unit being a scaled version of another unit

== Synopsis

Declared in `&lt;mp&hyphen;units&sol;framework&sol;unit&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;
    xref:mp_units/UnitMagnitude.adoc[UnitMagnitude] auto M,
    xref:mp_units/Unit.adoc[Unit] U&gt;
requires (M !&equals; detail&colon;&colon;unit&lowbar;magnitude&lt;&gt;&lcub;&rcub; &amp;&amp; M !&equals; mag&lt;1&gt;)
struct scaled&lowbar;unit final
    : &sol;&ast; implementation-defined &ast;&sol;
----

== Description

[NOTE]
====
User should not instantiate this type! It is not exported from the C&plus;&plus; module&period; The library will instantiate this type automatically based on the unit arithmetic equation provided by the user&period;

====

== Base Classes

[cols="1,4"]
|===
|Name|Description

| `&sol;&ast; implementation-defined &ast;&sol;`
| 
|===

== Template Parameters

[cols="1,4"]
|===
|Name|Description

| *M*
| magnitude describing the scale factor
| *U*
| reference unit being scaled
|===


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