Description
Return a signed minimum-image gap on one periodic axis.
A periodic coordinate identifies values separated by a whole cycle. Minimum-image gaps require a wrapping interval and an explicit half-cycle tie convention; signed direction and unsigned separation answer different questions.
Return a signed minimum-image gap on one periodic axis.
When to use this tool
Use Distance: Periodic Axis Minimum Image Gap when checking one explicit periodic-coordinate or gap convention.
How to use the tool and how it works
- Enter left, right, period. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read result. Expand result to inspect the returned fields.
Return a signed minimum-image gap on one periodic axis. Require period > 0; wrap right-left+period/2, then subtract period/2 to obtain a value in [-period/2,period/2).1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| left | Left | Required. Finite number. |
| right | Right | Required. Finite number. |
| period | Period | Required. Finite number. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| result | Returned object; expand its named members below. | Required. Object. |
| result.minimumImageGap | Signed wrapped gap in [-period/2,period/2); an exact half-cycle tie is negative. | Calculated result member: number. |
{
"input": {
"left": 1,
"right": 9,
"period": 10
},
"output": {
"result": {
"minimumImageGap": -2
}
}
}Limitations and assumptions
- An exact half-period tie is negative, not positive or direction-unique.
- Outputs are nested inside result. Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
- Numeric calculations use binary floating point unless exact decimal-integer arithmetic is explicitly stated. No hidden measurement tolerance or decimal rounding is added; nonfinite or out-of-contract results are rejected. Numeric signed-zero results are exported as zero.
Alternative or Complementary methods
Use a complete periodic geometry model when multiple axes, seam-crossing intervals or path winding matter.
References
Similar or alternative tools
- Periodic Box Wrap One Axis
Wrap a coordinate into a declared periodic box and return its image index.
- Periodic Distance Half Cell Ambiguity Label
Return minimum periodic separation and a half-cycle ambiguity flag.