drizzle
C++ MySQL-protocol-compatible database server
Loading...
Searching...
No Matches
ut0bh.h File Reference
#include "univ.i"
Include dependency graph for ut0bh.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  ib_bh_struct

Typedefs

typedef int(* ib_bh_cmp_t) (const void *p1, const void *p2)
typedef struct ib_bh_struct ib_bh_t

Functions

UNIV_INLINE ulint ib_bh_size (const ib_bh_t *ib_bh)
UNIV_INLINE ibool ib_bh_is_empty (const ib_bh_t *ib_bh)
UNIV_INLINE ibool ib_bh_is_full (const ib_bh_t *ib_bh)
UNIV_INLINE void * ib_bh_get (ib_bh_t *ib_bh, ulint i)
UNIV_INLINE void * ib_bh_set (ib_bh_t *ib_bh, ulint i, const void *elem)
UNIV_INLINE void * ib_bh_first (ib_bh_t *ib_bh)
UNIV_INLINE void * ib_bh_last (ib_bh_t *ib_bh)
UNIV_INTERN ib_bh_t * ib_bh_create (ib_bh_cmp_t compare, ulint sizeof_elem, ulint max_elems)
UNIV_INTERN void ib_bh_free (ib_bh_t *ib_bh)
UNIV_INTERN void * ib_bh_push (ib_bh_t *ib_bh, const void *elem)
UNIV_INTERN void ib_bh_pop (ib_bh_t *ib_bh)

Detailed Description

Copyright (c) 2011, Oracle Corpn. All Rights Reserved.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.

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 General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Binary min-heap interface.

Created 2010-05-28 by Sunny Bains

Definition in file ut0bh.h.

Typedef Documentation

◆ ib_bh_cmp_t

typedef int(* ib_bh_cmp_t) (const void *p1, const void *p2)

Comparison function for objects in the binary heap.

Definition at line 32 of file ut0bh.h.

◆ ib_bh_t

typedef struct ib_bh_struct ib_bh_t

Definition at line 34 of file ut0bh.h.

Function Documentation

◆ ib_bh_create()

UNIV_INTERN ib_bh_t * ib_bh_create ( ib_bh_cmp_t compare,
ulint sizeof_elem,
ulint max_elems )

Create a binary heap.

Returns
a new binary heap in: max elements allowed

Create a binary heap.

Returns
a new binary heap
Parameters
comparein: comparator
sizeof_elemin: size of one element
max_elemsin: max elements allowed

Definition at line 45 of file ut0bh.cc.

◆ ib_bh_first()

UNIV_INLINE void * ib_bh_first ( ib_bh_t * ib_bh)

Return the first element from the binary heap.

Returns
pointer to first element or NULL if empty. in: instance

◆ ib_bh_free()

UNIV_INTERN void ib_bh_free ( ib_bh_t * ib_bh)

Free a binary heap.

Returns
a new binary heap in,own: instance

Free a binary heap.

Returns
a new binary heap
Parameters
ib_bhin/own: instance

Definition at line 71 of file ut0bh.cc.

◆ ib_bh_get()

UNIV_INLINE void * ib_bh_get ( ib_bh_t * ib_bh,
ulint i )

Get a pointer to the element.

Returns
pointer to element in: index
Parameters
ib_bhin: instance

◆ ib_bh_is_empty()

UNIV_INLINE ibool ib_bh_is_empty ( const ib_bh_t * ib_bh)

Test if binary heap is empty.

Returns
TRUE if empty. in: instance

◆ ib_bh_is_full()

UNIV_INLINE ibool ib_bh_is_full ( const ib_bh_t * ib_bh)

Test if binary heap is full.

Returns
TRUE if full. in: instance

◆ ib_bh_last()

UNIV_INLINE void * ib_bh_last ( ib_bh_t * ib_bh)

Return the last element from the binary heap.

Returns
pointer to last element or NULL if empty. in/out: instance

◆ ib_bh_pop()

UNIV_INTERN void ib_bh_pop ( ib_bh_t * ib_bh)

Remove the first element from the binary heap. in/out: instance

Remove the first element from the binary heap.

Parameters
ib_bhin/out: instance

Definition at line 119 of file ut0bh.cc.

◆ ib_bh_push()

UNIV_INTERN void * ib_bh_push ( ib_bh_t * ib_bh,
const void * elem )

Add an element to the binary heap. Note: The element is copied.

Returns
pointer to added element or NULL if full. in: element to add

Add an element to the binary heap. Note: The element is copied.

Returns
pointer to added element or NULL if full.
Parameters
ib_bhin/out: instance
elemin: element to add

Definition at line 83 of file ut0bh.cc.

◆ ib_bh_set()

UNIV_INLINE void * ib_bh_set ( ib_bh_t * ib_bh,
ulint i,
const void * elem )

Copy an element to the binary heap.

Returns
pointer to copied element in: element to add
Parameters
ib_bhin/out: instance
iin: index

◆ ib_bh_size()

UNIV_INLINE ulint ib_bh_size ( const ib_bh_t * ib_bh)

Get the number of elements in the binary heap.

Returns
number of elements in: instance