Kernel/linux-next
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git synced 2025-01-15 12:07:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

lib min_heap: add brief introduction to Min Heap API

Browse Source 
A short description of the Min Heap API is added to the min_heap.h,
explaining its purpose for managing min-heaps and emphasizing the use of
macro wrappers instead of direct function calls.  For more details, users
are directed to the documentation at Documentation/core-api/min_heap.rst.

Link: https://lkml.kernel.org/r/20241129181222.646855-4-visitorckw@gmail.com
Signed-off-by: Kuan-Wei Chiu <visitorckw@gmail.com>
Cc: Ching-Chun (Jim) Huang <jserv@ccns.ncku.edu.tw>
Cc: Geert Uytterhoeven <geert@linux-m68k.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
This commit is contained in:
Kuan-Wei Chiu 2024-11-30 02:12:21 +08:00 committed by Andrew Morton
parent 005e3ec8ca
commit 0b82cadf64
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/linux/min_heap.h
View File

@ -6,6 +6,17 @@
#include <linux/string.h>
#include <linux/types.h>
/*
* The Min Heap API provides utilities for managing min-heaps, a binary tree
* structure where each node's value is less than or equal to its children's
* values, ensuring the smallest element is at the root.
*
* Users should avoid directly calling functions prefixed with __min_heap_*().
* Instead, use the provided macro wrappers.
*
* For further details and examples, refer to Documentation/core-api/min_heap.rst.
*/
/**
* Data structure to hold a min-heap.
* @nr: Number of elements currently in the heap.