ezzaze/binary-search

a PHP package for searching values in large arrays faster

Fund package maintenance!
ezzaze

1.1.0 2022-12-15 11:57 UTC

README

Latest Version on Packagist Tests Total Downloads

A small PHP package to help you perform a search in large scale arrays with a dramatically improved performance.

Installation

You can install the package via composer:

composer require ezzaze/binary-search

Usage

use Ezzaze\BinarySearch\BinarySearch;

$haystack = range(1,1000000);
$result1 = BinarySearch::exists(500, $haystack); //true
$result2 = BinarySearch::exists(0, $haystack); //false

If you have an already pre-sorted array you can skip the sorting before search by supplying false to the 3rd parameter

use Ezzaze\BinarySearch\BinarySearch;

$haystack = range(1,1000000);
$result = BinarySearch::exists(500, $haystack, false);

The package can also be used to search for multi-demensional array within another array as shown below

use Ezzaze\BinarySearch\BinarySearch;

$haystack = array_chunk(range(1,1000000), 2);
$result1 = BinarySearch::exists([500,501], $haystack); //true
$result2 = BinarySearch::exists([501, 502], $haystack); //false

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.