dec()

Decrements the given value by 1. If the first parameter is None or not a finite number, it resets to the third parameter. If the result goes below the second parameter, it resets to the third parameter.

Syntax

dec(value, min, reset)

Parameters

Parameter Type Description
value Number/None Value to decrement (None or invalid becomes reset).
min Number Minimum limit before resetting.
reset Number Value to reset to if None/invalid or limit exceeded.

Return Value

Examples

// If 'result' is NaN or None, it becomes reset (3).
result = nan();                // returns ---
result = dec(result, 0, 3);    // returns 3
result = dec(result, 0, 3);    // returns 2
result = dec(result, 0, 3);    // returns 1
result = dec(result, 0, 3);    // returns 0
result = dec(result, 0, 3);    // returns 3 (reset after going below min)

See also

inc
dec