/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*                                                                           */
/*   File....: heap.h                                                        */
/*   Name....: Heap Functions                                                */
/*   Author..: Thorsten Koch                                                 */
/*   Copyright by Author, All rights reserved                                */
/*                                                                           */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
 * Copyright (C) 2006-2026 by Thorsten Koch <koch@zib.de>
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
 */
#ifndef _HEAP_H_
#define _HEAP_H_

#ifndef _ENTRY_H_
#error "Need to include entry.h before heap.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

union heap_data
{
   Entry* entry;
};

typedef struct heap              Heap;
typedef union heap_data          HeapData;
typedef int                    (*HeapCmp)(HeapData, HeapData);

//lint -sem(        heap_new_entry, 1n > 0, 2p == 1, @P >= malloc(1)) 
extern Heap*        heap_new_entry(int size, HeapCmp entry_cmp) returns_NONNULL;
//lint -sem(        heap_free, custodial(1), inout(1), 1p == 1) 
extern void         heap_free(Heap* heap) expects_NONNULL;
//lint -sem(        heap_is_valid, 1p == 1, pure) 
extern bool         heap_is_valid(Heap const* heap) is_PURE;
//lint -sem(        heap_push_entry, inout(1), 1p == 1, custodial(2), 2p == 1) 
extern void         heap_push_entry(Heap* heap, Entry* entry) expects_NONNULL;
//lint -sem(        heap_pop_entry, inout(1), 1p == 1, @P >= malloc(1)) 
extern Entry*       heap_pop_entry(Heap* heap) expects_NONNULL returns_NONNULL;
//lint -sem(        heap_top_entry, 1p == 1, @p == 1) 
extern Entry const* heap_top_entry(Heap const* heap) expects_NONNULL returns_NONNULL;
//lint -sem(        heap_is_full, 1p == 1, pure) 
extern bool         heap_is_full(Heap const* heap) expects_NONNULL is_PURE;
//lint -sem(        heap_is_empty, 1p == 1, pure) 
extern bool         heap_is_empty(Heap const* heap) expects_NONNULL is_PURE;

#ifdef __cplusplus
}
#endif
#endif // _HEAP_H_ 
