X-Git-Url: http://git.euphorik.ch/?a=blobdiff_plain;f=Parasitemia%2FParasitemiaCore%2FHeap.fs;h=32887a230b6cf5cdbde185dde5f441e13661e3f7;hb=170abb893b9e6babbf93276e39e8c984cedbc68f;hp=e4230ebbbf26960b8a9970634e3052fecde5cac7;hpb=4bfa3cbdc6145e6944f02e24829ab2ef3a851ac1;p=master-thesis.git

diff --git a/Parasitemia/ParasitemiaCore/Heap.fs b/Parasitemia/ParasitemiaCore/Heap.fs
index e4230eb..32887a2 100644
--- a/Parasitemia/ParasitemiaCore/Heap.fs
+++ b/Parasitemia/ParasitemiaCore/Heap.fs
@@ -13,6 +13,10 @@ type private Node<'k, 'v> =
     new (k, v) = { key = k; value = v }
     override this.ToString () = sprintf "%A -> %A" this.key this.value
 
+/// <summary>
+/// An heap min or max depending of the given key comparer.
+/// The goal is to have a set of data and be able to get the value associated with the min (or max) key value.
+/// </summary>
 type Heap<'k, 'v> (kComparer : IComparer<'k>) =
     let a = List<Node<'k, 'v>>()
 
@@ -94,5 +98,3 @@ type Heap<'k, 'v> (kComparer : IComparer<'k>) =
         max.key, max.value
 
     member this.Clear () = a.Clear()
-
-