BinarySearch.h File Reference

The header file for array management routines (Binary Search) More...

Go to the source code of this file.

Functions
VOID	BinarySearchPrintArray (UINT64 ArrayPtr[], UINT32 NumberOfItems)
	A utility function to print an array of size NumberOfItems.
BOOLEAN	BinarySearchPerformSearchItem (UINT64 ArrayPtr[], UINT32 NumberOfItems, UINT32 *ResultIndex, UINT64 Key)
	A utility function to perform the binary search.

Detailed Description

The header file for array management routines (Binary Search)

Author

Mohammad K. Fallah (mkf19.nosp@m.80@g.nosp@m.mail..nosp@m.com)

Version

0.5

Date

2023-07-28

Copyright

This project is released under the GNU Public License v3.

Function Documentation

BinarySearchPerformSearchItem()

BOOLEAN BinarySearchPerformSearchItem	(	UINT64	ArrayPtr[],
		UINT32	NumberOfItems,
		UINT32 *	ResultIndex,
		UINT64	Key )

A utility function to perform the binary search.

Parameters

ArrayPtr
NumberOfItems
ResultIndex
Key

Returns

BOOLEAN

{
    UINT32 Position = 0;
    UINT32 Limit    = NumberOfItems;
 
    while (Position < Limit)
    {
        UINT32 TestPos = Position + ((Limit - Position) >> 1);
 
        if (ArrayPtr[TestPos] < Key)
            Position = TestPos + 1;
        else
            Limit = TestPos;
    }
 
    if (Position < NumberOfItems && ArrayPtr[Position] == Key)
    {
        //
        // Set the result position in the array
        //
        *ResultIndex = Position;
        return TRUE;
    }
    else
    {
        return FALSE;
    }
}

BinarySearchPrintArray()

VOID BinarySearchPrintArray	(	UINT64	ArrayPtr[],
		UINT32	NumberOfItems )

A utility function to print an array of size NumberOfItems.

Parameters

ArrayPtr
NumberOfItems

Returns

VOID

{
    UINT32 i;
 
    for (i = 0; i < NumberOfItems; i++)
    {
        Log("%llx ", ArrayPtr[i]);
    }
 
    Log("\n");
}