Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit a3d0990

Browse files
CorreyLtrekhleb
authored andcommitted
Improve data-structures/heap/README.md (trekhleb#94)
* Update data-structure/heap/README.md The overuse of parenthesis in the previous description made the explanation of a heap more diffcult to read. Following technical writing standards, the topic of the sentence should be at the forefront of a sentence, to give the reader an idea of what is going to be explained in said sentence. The mention of min heap and max heap were previously in parenthesis, in the middle of the sentence. This change informs the reader that there are two types of heaps, with a preface indicating which one is being explained. * Add min heap picture and move max heap picture Add a picture of a min heap below the explanation of a min heap. Move the picture of a max heap below the explanation of a max heap. * Italicize heap terminology Italicize the terms 'max heap' and 'min heap' to make it clear to readers that new terminology is being introduced
1 parent b878390 commit a3d0990

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

src/data-structures/heap/README.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,22 @@
11
# Heap (data-structure)
22

33
In computer science, a heap is a specialized tree-based
4-
data structure that satisfies the heap property: if `P`
5-
is a parent node of `C`, then the key (the value) of `P`
6-
is either greater than or equal to (in a max heap) or
7-
less than or equal to (in a min heap) the key of `C`.
8-
The node at the "top" of the heap (with no parents) is
9-
called the root node.
4+
data structure that satisfies the heap property.
5+
6+
In a *min heap*, if `P` is a parent node of `C`, then the
7+
key (the value) of `P` is less than or equal to the
8+
key of `C`.
9+
10+
![MinHeap](https://upload.wikimedia.org/wikipedia/commons/6/69/Min-heap.png)
11+
12+
In a *max heap*, the key of `P` is greater than or equal
13+
to the key of `C`
1014

1115
![Heap](https://upload.wikimedia.org/wikipedia/commons/3/38/Max-Heap.svg)
1216

17+
The node at the "top" of the heap with no parents is
18+
called the root node.
19+
1320
## References
1421

1522
- [Wikipedia](https://en.wikipedia.org/wiki/Heap_(data_structure))

0 commit comments

Comments
 (0)