Commit fe73de51 authored by Hans-Peter Deifel's avatar Hans-Peter Deifel
Browse files

Clarify some documentation comments

parent eab9d4e3
......@@ -162,6 +162,8 @@ blockOfState p s = getState p s >>= \state ->
-- This is implemented in a way to efficiently split the block in marked and
-- unmarked states.
--
-- Calling 'mark' on an already marked state results in data corruption.
--
-- Runtime: O(1)
mark :: RefinablePartition s -> State -> ST s ()
mark partition s = do
......
......@@ -102,6 +102,11 @@ splitBlock b = ask >>= \(as, queue) -> lift $ do
deleteLargestM (Partition.blockSize (partition as)) (maybeAdd b blocks)
>>= mapM_ enqueue
-- | Returns a list of blocks that have at least one predecessor state of the
-- given block @S@.
--
-- Such predecessor states are marked for subsequent splitting and their edges
-- into @S@ are added to @toSub@.
collectTouchedBlocks :: forall s h. RefinementInterface h => Block -> SplitM s h [(Block, H3 h)]
collectTouchedBlocks blockS = do
(as, _) <- ask
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment