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

Unit being a scaled version of another unit

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    xref:mp_units/UnitMagnitude.adoc[UnitMagnitude] auto M,
    xref:mp_units/Unit.adoc[Unit] U>
requires (M != mag<1>)
struct scaled_unit final
----

== Description

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

====

== Type Aliases

[cols="1"]
|===
| Name
| xref:mp_units/scaled_unit/_base_type_.adoc[`_base_type_`] 
|===


== Static Data Members

[cols="1"]
|===
| Name
| xref:mp_units/scaled_unit/_mag_.adoc[`_mag_`] 
| xref:mp_units/scaled_unit/_reference_unit_.adoc[`_reference_unit_`] 
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/cubic-0f.adoc[`cubic`]
| 
| xref:mp_units/equivalent-0d2.adoc[`equivalent`]
| 
| xref:mp_units/get_quantity_spec-08.adoc[`get_quantity_spec`]
| 
| xref:mp_units/get_unit-02.adoc[`get_unit`]
| 
| xref:mp_units/square-06.adoc[`square`]
| 
|===

== 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]#