Clarify identical hash() return values due to collisions

This commit is contained in:
Hugo Locurcio
2022-02-12 22:17:35 +01:00
parent d3a6b6daaa
commit 08541fe11d
4 changed files with 8 additions and 5 deletions

View File

@ -98,7 +98,8 @@
<method name="hash" qualifiers="const">
<return type="int" />
<description>
Returns the hash value of this [Callable]'s object.
Returns the 32-bit hash value of this [Callable]'s object.
[b]Note:[/b] [Callable]s with equal content will always produce identical hash values. However, the reverse is not true. Returning identical hash values does [i]not[/i] imply the callables are equal, because different callables can have identical hash values due to hash collisions. The engine uses a 32-bit hash algorithm for [method hash].
</description>
</method>
<method name="is_custom" qualifiers="const">