search

microsoft / knossos-ksc

Compiler with automatic differentiation
Other
45 stars 10 forks source link

Rename suf functions #874

Open awf opened 3 years ago

awf commented 3 years ago

Proposal: rename suffwdpass -> suffwd, sufrevpass -> sufbwd

Rationale: we have a lot of uses of "rev", with slightly different meanings, and this is an opportunity to reduce overlap.

Further proposal: suf is not really the key here, it's the bog, so rename suffwdpass -> bogfwd, sufrevpass -> bogbwd

awf commented 3 years ago

Observation: the 1-character difference may be a little hard to see, and hence prone to typos, so consider 'bogf/bogb' or 'suff/sufb'. I feel the latter two are easiest to distinguish, but "suff" evokes "suffix", which might confuse.

toelli-msft commented 3 years ago

My favourite is bogf/bogb. Personally I like changing from suf to bog for the reason you point out: the BOG is end and SUF is just the means. It also seems sensible to distinguish "backward sweep" from "reverse mode" (and f/b seem a bit neater and shorter than fwd/bwd).

awf commented 3 years ago

And are we OK with the frivolity of bog? ISTR we had a list of other options somewhere.