[COLLECTIONS-749] Better documentation needed for HashFunctionIdentity.Signedness

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Done
• Affects Version/s: 4.5.0-M1
• Fix Version/s: 4.5.0-M1
• Component/s: Collection
• Assignee: Unassigned
• Reporter: Claude Warren
• Created: 17/Feb/20 20:54
• Updated: 06/Jul/22 07:07
• Resolved: 06/Jul/22 07:01

Description

From Alex Herbert:

HashFunctionIdentity.Signedness

This is not fully documented as to what the sign applies to. There is no
javadoc on the enum values for SIGNED and UNSIGNED. The current javadoc
states "Identifies the signedness of the calculations for this function".

I assume this applies to the Hash computation in 'long
HashFunction.apply(byte[], int)'

Does this mean the hash algorithm has a variant that can treat the
bytes/seed as signed or unsigned. If so which one because 2 enum values
cannot cover all 4 possibilities. Since there is no javadoc it is
unclear exactly what this property is supposed to indicate.

Issue Links

• is a child of: COLLECTIONS-728 BloomFilter contribution