[#mp_units-operator_mod-03]
= xref:mp_units.adoc[mp_units]::operator%
:relfileprefix: ../
:mrdocs:

Modulus operator

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    auto R1,
    typename Rep1,
    xref:mp_units/RepresentationOf.adoc[RepresentationOf<get_quantity_spec(R1)>] Value>
requires ImplicitFromNumber<R1> && InvokeResultOf<get_quantity_spec(R1), std::modulus<>, Rep1, const Value&>
[[nodiscard]]
constexpr
xref:mp_units/Quantity-0c.adoc[Quantity] auto
operator%(
    Value const& lhs,
    xref:mp_units/quantity-01.adoc[quantity<R1, Rep1>] const& rhs);
----

[NOTE]
====
This function is a https://en.cppreference.com/w/cpp/language/friend[hidden friend] of xref:mp_units/quantity-01.adoc[quantity], declared inside an implementation-defined base class: it can be found only through argument-dependent lookup.
====

== Return Value

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

[cols="1,4"]
|===
| Name| Description
| *lhs*
| The left operand
| *rhs*
| The right operand
|===


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