Заготовки по С / Динамические структуры / GDSL / Документация

4.9 Heap manipulation module

97

ˆ the default COMP_F always returns 0

Note:

Complexity: O( 1 )

re ondition:

nothing

Parameters:

f the new

to reate

NAME The name

COMP_F Fun tion to ompare elements into the heap

ALLOC

F F

n to allo

t when inserting it in

FREE

F F

to free elemheapt when removing it from the heap

Returns:

llo ated heap ase of su ess.

the newly

NULL in ase of insu ient memory.

See also:

free()(p. 97)

gdsl_heap_ ush()(p. 98)

4.9.2.2 void gdsl_heap_free (gdsl_heap_t H)

stroy heap.

deallo ated

itself too.

De

all the elements of the heap H by alling H's FREE F fun tion

pass to gdsl

heap

allo ()(p. 96). The name of H is deallo ated and H is

Note:

HComplexity:also:ondition:Theust heapbe O(validtodestroyHgdsl) _heap_t

SeePPrearameters:

| |

98

gdsl Module Do umentation

4.9.2.3

void gdsl_heap_ ush (gdsl_heap_t H)

Flu h

h ap.

allo ()(p. 96). H is not deallo ated itself and H's name

pass d to gdsl_heap

Deallois not

atdi ed.

Note:

all the elements of the heap H by alling H's FREE F fun tion

Complexitalso:ondition:Theust heapbey:a validO(to Hushgdsl) _heap_t

SeePPrearameters:HH

|

|

The ur ed string MUST NOT be freed.

H The heap to get the name from

Returns:

the name of the heap H.

See also:

gdsl_heap_set_name()(p. 100)

Generated on Thu Jun 22 11:15:30 2006 for gdsl by Doxygen

Heap manipulation module

99

re ondition:

valid gdsl_heap_t

ust be

Parameters:

H

The heap to get the op from

Returns:

on

at the top position of the heap H if H is not empty.

the el

The rementur ed elementained is not removed from H.

NULL if the heap H is empty.

See also:

gdsl_heap_set_top()(p. 100)

4.9.2.7

bool gdsl heap_is_empty ( onst gdsl_heap_t H)

Che k if a heap is empty.

Note:

y: O( 1 )

heap t

ComplexitH ust be a valid gdsl

100

gdsl Module Do umentation

Parameters:

H The heap to he k

Returns:

H is empty.

TRUE if

FALSE iftheheap H is not empty.

4.9.2.8 gdsl_heap_t gdsl_heap_set_name (gdsl_heap_t H, onst

PNote:ChangeSetarameters:retheHComplexity:ondition:nametheustharpreviousheapbeofavalidO(NEWheap1name)gdsl.NAMEofheapthe heap)t H to a opy of NEW_NAME.

The

to hange the

e

NEW_NAME The new name of H

Returns:

the modi ed heap ase of su ess.

NULL in ase of insu i

t memory.

4.9 Heap

module

101

The oldmanipulationtop elemen value n ase VALUE is lesser than all oth r H elements.

Returns:

NULL in ase of VALUE is greather or equal to all other H elements.

See also:

gdsl_heap_get_top()(p. 99)

4.9.2.10

gdsl_element_t gdsl_heap_insert (gdsl_heap_t H, void

Hondition:Theust heapbeThevalidtovaluemodifygdslusedHheap)to) maket the new element to insert into H

Parameters:reVALUE

|

|

Returns:

lement E

ase of su ess.

the

NULLinsertedase of insu ient memory.

See also:

allo

(p. 96)

gdsl_heap_get

size()(p. 99)

remov

4.9.2.11

del te()

gdsl_element_t gdsl_heap_remove_top (gdsl_heap_t

Remov

H)

a heap (POP).

he top element from the heap H. The element is removed from H and

is also returned.

Note:

102

gdsl Module Do umentation

re ondition:

Parameters:ust be

valid gdsl_heap_t

H The heap

modify

Returns:

the removed top elemen .

NULL if the heap is empty.

See also:

ins rt()(p. 101)

gdsl_heap_delete

top()(p. 102)

4.9.2.12

gdsl

h ap_t gdsl

heap_delete_top (gdsl_heap_t H)

Removthethe top

element from the heap H. The element is removed from H

D lete

top elem from a heap.

nd is also deallo ated using H's FREE_F fun tion passed to gdsl heap_-

allo ()(p. 96), then H is returned.

Note:

Parameters:retheHComplexitondition:Themodiustheapbeheapy:d validO(heaptomodifyloggdslafter(Hremovalheap)) t of top element.

Returns:

|

|

NULL if

is empty.

See also:

(p.

101)(p. 101)

gdsl_heap_remov

map forward ( onst

4.9.2.13

elemen _top(

he

4.9 Heap manipulation module

103

Note:

HComplexitondition:Theust heapbeFDAy:TheO(validtoAmapHUser'sgdsl)fun heapdatastion._passedt&MAPtoMAPF!=_NULLF

Parameters:reUSERMAP

| |

Returns:

the rst elemen for whi h MAP_F returns GDSL_MAP_STOP.

NULL when the parsing is done.

( onst gdsl_heap_t H,

4.9.2.14

gdsl_heap_

voidgdsl_write_fun writeWRITE_F, FILE OUTPUT_FILE,

USER_DATA User's datas passed to WRITE_F.

See also:

write xml()(p. 103)

gdsl_heap_dump()(p. 104)

_xml ( onst gdsl_heap_t H,

4.9.2.15

gdsl_heap_

void_write_fun writeWRITE_F, FILE

OUTPUT_FILE,

gdsl

104

gdsl Module Do umentation

rite the elements of the heap H to

FILE, nto XML

nguage.

If WRITE

!=

NULL, then uses

WRITE F to write H's lements

OUTPUT

FILE. Additionnal USER_OUTPUTDA A argument ould be

passed to

WRITE F.

Note:

HComplexitondition:Theust heapbey:FvalidO(toFILEThewriteHgdslwrite)The.heapfunle tionwheret &. OUTPUTtowriteH'sFILEelements!=NULL.

Parameters:reOUTPUTWRITE

| |

USER_DATA User's datas passed to WRITE_F.

See also:

write()(p. 103)

gdsl_heap_dump()(p. 104)

4.9.2.16

gdsl_heap_dump ( onst gdsl_heap_t H,