snap_hysteresis's tolerance band is asymmetric at two of its eight edges

Aperta
  • Qualcosa non va?
#76 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
rust
Ambito
embedded-iot

Direzione di ricerca

Start with src/lib.rs and run ops_tests::hysteresis::the_band_edges_are_asymmetric, which records the current behavior. Decide whether the tolerance policy should remain approximate or change to midpoint, scaled tolerance, or inclusive slack. Done means a deliberate behavior choice, updated tests, and a changelog-visible commit if behavior changes.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug

ops::snap_hysteresis (src/lib.rs) rejects an input further than
HYSTERESIS_TOLERANCE from the nearest legal setting. The constant is
0.05f32, whose exact value is 0.05000000074505805969, and the
comparison is against a subtraction whose result depends on which side
of its decimal value each f32 literal rounded to.

Measured

Both functions were transcribed verbatim into a scratch binary and run
under rustc -O rather than reasoned about on paper:

Setting −0.05 edge diff +0.05 edge diff
0 °C accepted 0.05 accepted 0.05
1 °C rejected 0.050000012 accepted 0.049999952
2 °C accepted 0.049999952 accepted 0.049999952
4 °C accepted 0.049999952 rejected 0.05000019

Six of eight edges are accepted, and the two rejections fall on
opposite sides — the low edge at 1 °C, the high edge at 4 °C. No
single description of the band is correct for all four settings.

So a caller asking for 0.95 °C of hysteresis gets InvalidInput, while
one asking for 1.05 °C gets Hysteresis::OneC. Both are the same
distance from 1 °C as written; only their f32 representations differ.

Status

Pinned as measured by
ops_tests::hysteresis::the_band_edges_are_asymmetric, added while
closing #66, so any change to it is deliberate rather than silent.
Whether it should change is this issue.

Note the ±0.05 °C band is driver policy, not a datasheet tolerance —
SBOS663A §7.5.3.1 Table 9 specifies the four discrete encodings and
says nothing about how an arbitrary float should reach one. #66 Part 2
records the band as a legal choice.

Options

Roughly in increasing order of disruption:

  1. Leave it. Document the band as approximate. A caller sitting
    within 0.05 °C of an edge is already asking for a setting it did not
    name, and the four settings are 1 °C apart.
  2. Compare against the midpoint between adjacent settings, or
    against a tolerance scaled per setting, so the decision does not
    turn on one constant's representation.
  3. Make the comparison inclusive with slack — e.g. > against
    HYSTERESIS_TOLERANCE + f32::EPSILON, making all eight edges
    accept.

Any of 2 or 3 changes behaviour for callers currently on the rejected
side of an edge, so it needs a changelog-visible commit.

Provenance

Raised while closing #66. Not a regression — the behaviour predates
that work; it was simply never asserted.

Lingua principale
Rust
Stelle
2
Fork
7
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenDevicePartnership/tmp108

Tutte le issue di OpenDevicePartnership/tmp108

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.