Saturate

Hook that implements saturation, i.e. any arithmetic operation that would overflow leaves the result at its extreme value (min or max depending on the direction of the overflow).

Saturation is not sticky; if a value reaches its saturation value, another operation may take it back to normal range.

struct Saturate {

static T onLowerBound(Rhs , T bound);

static T onUpperBound(Rhs , T bound);

static auto onOverflow(Lhs );

static typeof(Lhs() + Rhs()) onOverflow(Lhs lhs, Rhs rhs);

}

Members

Static functions

onLowerBound T onLowerBound(Rhs , T bound): Implements saturation for operators +=, -=, *=, /=, %=, ^^=, &=, |=, ^=, <<=, >>=, and >>>=. This hook is called if the result of the binary operation does not fit in Lhs without loss of information or a change in sign.
onOverflow typeof(Lhs() + Rhs()) onOverflow(Lhs lhs, Rhs rhs): Implements saturation for operators +, - (unary and binary), *, /, %, ^^, &, |, ^, <<, >>, and >>>.
onOverflow auto onOverflow(Lhs ): Implements saturation for operators +, - (unary and binary), *, /, %, ^^, &, |, ^, <<, >>, and >>>.
onUpperBound T onUpperBound(Rhs , T bound): Implements saturation for operators +=, -=, *=, /=, %=, ^^=, &=, |=, ^=, <<=, >>=, and >>>=. This hook is called if the result of the binary operation does not fit in Lhs without loss of information or a change in sign.

Examples

auto x = checked!Saturate(int.max);
++x;
assert(x == int.max);
--x;
assert(x == int.max - 1);
x = int.min;
assert(-x == int.max);
x -= 42;
assert(x == int.min);
assert(x * -2 == int.max);

Saturate

Members

Static functions

Examples

Meta

Source