[#TrySub]
= TrySub
:mrdocs:

Subtract j from i in place, only if it does not underflow.

== Synopsis

Declared in `<util/overflow.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    std::unsigned_integral T,
    std::unsigned_integral U>
[[nodiscard]]
constexpr
bool
TrySub(
    T& i,
    U const j) noexcept;
----

== Return Value

true if `i >= j` and the subtraction was applied, false if it was left unchanged.

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

[cols="1,4"]
|===
| Name| Description
| *i*
| The minuend, updated to `i ‐ j` when the subtraction succeeds.
| *j*
| The amount to subtract.
|===


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