The QuickHashIntStringHash class

(PECL quickhash >= Unknown)

Introduction

This class wraps around a hash containing integer numbers, where the values are strings. Hashes are also available as implementation of the ArrayAccess interface.

Hashes can also be iterated over with foreach as the Iterator interface is implemented as well. The order of which elements are returned in is not guaranteed.

Class synopsis

class QuickHashIntStringHash {

/* Constants */

const int CHECK_FOR_DUPES = 1;

const int DO_NOT_USE_ZEND_ALLOC = 2;

const int HASHER_NO_HASH = 256;

const int HASHER_JENKINS1 = 512;

const int HASHER_JENKINS2 = 1024;

/* Methods */

public function add(int $key, string $value): bool

public function __construct(int $size, int $options = 0)

public function delete(int $key): bool

public function exists(int $key): bool

public function get(int $key): mixed

public function getSize(): int

public static function loadFromFile(string $filename, int $size = 0, int $options = 0): QuickHashIntStringHash

public static function loadFromString(string $contents, int $size = 0, int $options = 0): QuickHashIntStringHash

public function saveToFile(string $filename): void

public function saveToString(): string

public function set(int $key, string $value): int

public function update(int $key, string $value): bool

}

Predefined Constants

QuickHashIntStringHash::CHECK_FOR_DUPES: If enabled, adding duplicate elements to a set (through either QuickHashIntStringHash::add() or QuickHashIntStringHash::loadFromFile()) will result in those elements to be dropped from the set. This will take up extra time, so only used when it is required.
QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC: Disables the use of PHP's internal memory manager for internal set structures. With this option enabled, internal allocations will not count towards the memory_limit settings.
QuickHashIntStringHash::HASHER_NO_HASH: Selects to not use a hashing function, but merely use a modulo to find the bucket list index. This is not faster than normal hashing, and gives more collisions.
QuickHashIntStringHash::HASHER_JENKINS1: This is the default hashing function to turn the integer hashes into bucket list indexes.
QuickHashIntStringHash::HASHER_JENKINS2: Selects a variant hashing algorithm.

QuickHashIntStringHash::add — This method adds a new entry to the hash
QuickHashIntStringHash::__construct — Creates a new QuickHashIntStringHash object
QuickHashIntStringHash::delete — This method deletes an entry from the hash
QuickHashIntStringHash::exists — This method checks whether a key is part of the hash
QuickHashIntStringHash::get — This method retrieves a value from the hash by its key
QuickHashIntStringHash::getSize — Returns the number of elements in the hash
QuickHashIntStringHash::loadFromFile — This factory method creates a hash from a file
QuickHashIntStringHash::loadFromString — This factory method creates a hash from a string
QuickHashIntStringHash::saveToFile — This method stores an in-memory hash to disk
QuickHashIntStringHash::saveToString — This method returns a serialized version of the hash
QuickHashIntStringHash::set — This method updates an entry in the hash with a new value, or adds a new one if the entry doesn't exist
QuickHashIntStringHash::update — This method updates an entry in the hash with a new value

The QuickHashIntStringHash class

Introduction

Class synopsis

Predefined Constants

Table of Contents