Branch: Tag:

2015-08-13

2015-08-13 09:13:10 by Henrik Grubbström (Grubba) <grubba@grubba.org>

Documentation [ADT.Heap]: Added some cross-references.

71:      //! Push an element onto the heap. The heap will automatically sort itself   //! so that the smallest value will be at the top. + //! + //! @seealso + //! @[pop()], @[remove()]   void push(mixed value)   {    if(num_values >= sizeof(values))
94:      //! Removes and returns the item on top of the heap,   //! which also is the smallest value in the heap. + //! + //! @throws + //! Throws an error if the heap is empty. + //! + //! @seealso + //! @[peek()], @[push()], @[remove()]   mixed pop()   {    mixed ret;
120:      //! Returns the item on top of the heap (which is also the smallest value   //! in the heap) without removing it. + //! + //! @returns + //! Returns the smallest value on the heap if any, and + //! @expr{UNDEFINED@} otherwise. + //! + //! @seealso + //! @[pop()]   mixed peek()   {    if (!num_values)