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

Computes the IEEE remainder of the floating point division operation x / y.

== Synopsis

Declared in `<mp‐units/math.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    auto R1,
    typename Rep1,
    auto R2,
    typename Rep2>
requires requires(Rep1 v1, Rep2 v2) {
    get_common_reference(R1, R2);
    requires requires { remainder(v1, v2); } || requires { std::remainder(v1, v2); };
  }
[[nodiscard]]
constexpr
xref:mp_units/QuantityOf.adoc[QuantityOf<get_quantity_spec(R1)>] auto
remainder(
    xref:mp_units/quantity-01.adoc[quantity<R1, Rep1>] const& x,
    xref:mp_units/quantity-01.adoc[quantity<R2, Rep2>] const& y) noexcept;
----

== Parameters

[cols=2]
|===
| Name
| Description
| *x*
| A quantity
| *y*
| A quantity
|===


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