Fixed Point Saturation Result
Saturate an exact fixed-point raw integer to an explicit word range, retaining whether clipping occurred.
Description
Saturate an exact fixed-point raw integer to an explicit word range, retaining whether clipping occurred.
Saturation clamps a stored integer to an explicit signed or unsigned field range. It differs from modular wraparound.
When to use this tool
Saturate an exact fixed-point raw integer to an explicit word range, retaining whether clipping occurred.
- Prepare the supplied integer, bits, signed fields for this operation.
- Compare the complete example with the representation used by your own input before carrying the result into another step.
How to use the tool and how it works
- Enter integer, bits, signed. Use the exact text syntax, units and index conventions explained below.
- Run the tool. If input validation fails, correct the supplied fields before interpreting any result.
- Read result.integer, result.saturated. Interpret false, null and empty lists using the distinctions below; they can be valid outputs.
For bits 1 to 128, compute the selected integer limits and return the nearest limit when outside, otherwise the unchanged integer. saturated indicates an actual clamp.1
| Input field | Meaning and representation | Accepted input |
|---|---|---|
| integer | Exact decimal integer text; keep it quoted in JSON rather than converting through a floating-point number. | Optional leading + or - and 1 to 256 decimal digits; no whitespace |
| bits | bits. | Integer from 1 to 128 inclusive |
| signed | Explicit choice for signed; supply a boolean rather than a text label. | true or false |
| Output field | Interpretation |
|---|---|
| result | Object containing the named outputs below. |
| result.integer | Exact decimal integer text under the operation described above. |
| result.saturated | Flag for saturated under the exact condition described above. |
{
"input": {
"integer": "20",
"bits": 4,
"signed": true
},
"output": {
"result": {
"integer": "7",
"saturated": true
}
}
}Limitations and assumptions
- No fractional scaling, arithmetic operation or machine instruction is executed. Inputs and result use exact decimal integer text.
- Exact decimal-spelling operations require digits before the optional decimal point and allow a signed exponent. Decimal text is bounded to 256 code units and effective scale to minus 256 through 256; integer-string fields allow a sign and up to 256 digits.
- Every declared top-level field is required and unexpected fields are rejected. Numeric inputs must be finite; ordinary text fields are bounded to 8,192 UTF-16 code units, with tighter operation-specific limits where stated.
- Lists are limited to 128 entries. JSON text must meet bounded size and depth checks, and numeric outputs beyond the safe finite magnitude are rejected. Exact large integers use decimal strings.
- Indexes are zero-based and spans have an exclusive end unless explicitly stated otherwise. A valid false, null or empty-list result is distinct from malformed input.
Alternative or Complementary methods
Preserve decimal and integer strings when exact comparisons matter. Select signedness, scale, rounding and overflow policies separately, and use the matching encoder/decoder rather than a floating-point approximation.
References
Similar or alternative tools
- Fixed Point Add Overflow Flag
Add exact raw fixed-point integers and flag explicit signed or unsigned word overflow; does not wrap or saturate.
- Fixed Point Division and Rescale
Exact raw fixed-point division and rescaling, truncating toward zero while retaining signed remainder evidence.