Heap::hashtIndex

(Available since version 1.0)

Heap::hashtIndexReturns an index for use in a hash table

Description

protected mixed Heap::hashtIndex ( mixed $value )

Takes a value and returns a value to be used to represent it as an index in a hash table. (Hash tables are used to 'tag' nodes for faster updates.)

In most cases it simply returns value unaltered (unless Heap::value() has been overridden), but in the case of objects it returns their spl_object_hash().

Parameters

value

The value to be mapped.

Return Values

The hash table index.

To Top