diff --git a/CHANGES b/CHANGES index 75cca2c570..eb780a816f 100644 --- a/CHANGES +++ b/CHANGES @@ -1,4 +1,8 @@ +2.1-1007 | 2013-08-01 15:41:54 -0700 + + * More function documentation. (Bernhard Amann) + 2.1-1004 | 2013-08-01 14:37:43 -0700 * Adding a probabilistic data structure for computing "top k" diff --git a/VERSION b/VERSION index 3576d9c667..b52e411524 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.1-1004 +2.1-1007 diff --git a/src/probabilistic/Topk.h b/src/probabilistic/Topk.h index 6c9de36442..a9a0d80818 100644 --- a/src/probabilistic/Topk.h +++ b/src/probabilistic/Topk.h @@ -129,9 +129,30 @@ protected: TopkVal(); private: + /** + * Increment the counter for a specific element + * + * @param e element to increment counter for + * + * @param count increment counter by this much + */ void IncrementCounter(Element* e, unsigned int count = 1); - HashKey* GetHash(Val*) const; // this probably should go somewhere else. - void Typify(BroType*); + + /** + * get the hashkey for a specific value + * + * @param v value to generate key for + * + * @returns HashKey for value + */ + HashKey* GetHash(Val* v) const; // this probably should go somewhere else. + + /** + * Set the type that this TopK instance tracks + * + * @param t type that is tracked + */ + void Typify(BroType* t); BroType* type; CompositeHash* hash;