I'm working with algorithms that filter their input (that is, remove part of it), and I'm not sure this phrase is unambiguous:
This function returns the filtered elements.
Is it obvious that filtered here means the elements that have passed the filter? Or could it mean the elements that have been filtered out?
If both are present, I believe it's easier to eliminate the ambiguity:
- This function returns a pair of lists (filtered_out,filtered_in) .
- This function returns a pair of lists (filtered_out,filtrate).
Buf if I see just a variable named filtered, without the _out and _in suffixes, I'm not sure which one should be inferred.