[#mp_units-quantity-01-numerical_value_ref_in-0d]
= xref:mp_units.adoc[mp_units]::xref:mp_units/quantity-01.adoc[quantity]::numerical_value_ref_in
:relfileprefix: ../../
:mrdocs:

`numerical_value_ref_in` overloads

== Synopses

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

Returns a mutable reference to the numerical value, in a unit equivalent to `unit`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<xref:mp_units/Unit.adoc[Unit] U>
requires (equivalent(U{}, unit))
[[nodiscard]]
constexpr
xref:mp_units/quantity-01/rep.adoc[rep]&
xref:mp_units/quantity-01/numerical_value_ref_in-098.adoc[numerical_value_ref_in](U u) & noexcept;
----

[.small]#xref:mp_units/quantity-01/numerical_value_ref_in-098.adoc[_» more..._]#

Returns a const reference to the numerical value, in a unit equivalent to `unit`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<xref:mp_units/Unit.adoc[Unit] U>
requires (equivalent(U{}, unit))
[[nodiscard]]
constexpr
xref:mp_units/quantity-01/rep.adoc[rep] const&
xref:mp_units/quantity-01/numerical_value_ref_in-095.adoc[numerical_value_ref_in](U u) const & noexcept;
----

[.small]#xref:mp_units/quantity-01/numerical_value_ref_in-095.adoc[_» more..._]#

Deleted overload that prevents forming a reference into a temporary quantity.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<xref:mp_units/Unit.adoc[Unit] U>
requires (equivalent(U{}, unit))
constexpr
xref:mp_units/quantity-01/rep.adoc[rep] const&&
xref:mp_units/quantity-01/numerical_value_ref_in-01.adoc[numerical_value_ref_in](U u) const && noexcept = delete;
----

[.small]#xref:mp_units/quantity-01/numerical_value_ref_in-01.adoc[_» more..._]#

== Return Value

* A reference to the stored numerical value.
* A const reference to the stored numerical value.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *u*
| a unit equivalent to `unit`
|===


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