L_Heap (Lept4J)

java.lang.Object
- com.sun.jna.Structure
- - net.sourceforge.lept4j.L_Heap

Direct Known Subclasses:

L_Heap.ByReference, L_Heap.ByValue
```
public class L_Heap
extends com.sun.jna.Structure
```
heap.h
Expandable priority queue configured as a heap for arbitrary void* data
The L_Heap is used to implement a priority queue. The elements
in the heap are ordered in either increasing or decreasing key value.
The key is a float field 'keyval' that is required to be
contained in the elements of the queue.

The heap is a simple binary tree with the following constraints:
- the key of each node is >= the keys of the two children
- the tree is complete, meaning that each level (1, 2, 4, ...)
is filled and the last level is filled from left to right
The tree structure is implicit in the queue array, with the
array elements numbered as a breadth-first search of the tree
from left to right. It is thus guaranteed that the largest
(or smallest) key belongs to the first element in the array.
Heap sort is used to sort the array. Once an array has been
sorted as a heap, it is convenient to use it as a priority queue,
because the min (or max) elements are always at the root of
the tree (element 0), and once removed, the heap can be
resorted in not more than log[n] steps, where n is the number
of elements on the heap. Likewise, if an arbitrary element is
added to the end of the array A, the sorted heap can be restored
in not more than log[n] steps.
A L_Heap differs from a L_Queue in that the elements in the former
are sorted by a key. Internally, the array is maintained
as a queue, with a pointer to the end of the array. The
head of the array always remains at array[0]. The array is
maintained (sorted) as a heap. When an item is removed from
the head, the last item takes its place (thus reducing the
array length by 1), and this is followed by array element
swaps to restore the heap property. When an item is added,
it goes at the end of the array, and is swapped up to restore
the heap. If the ptr array is full, adding another item causes
the ptr array size to double.

For further implementation details, see heap.c.
native declaration : heap.h:41
This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java , Rococoa, or JNA.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class L_Heap.ByReference

static class L_Heap.ByValue
- Nested classes/interfaces inherited from class com.sun.jna.Structure
  com.sun.jna.Structure.StructField

Nested Classes
Modifier and Type	Class and Description
`static class`	`L_Heap.ByReference`
`static class`	`L_Heap.ByValue`

Field Summary

Fields
Modifier and Type	Field and Description
`com.sun.jna.ptr.PointerByReference`	`array` ptr array C type : void**
`int`	`direction` L_SORT_INCREASING or L_SORT_DECREASING C type : l_int32
`int`	`n` number of elements stored in the heap C type : l_int32
`int`	`nalloc` size of allocated ptr array C type : l_int32

Fields inherited from class com.sun.jna.Structure
ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors
Constructor and Description
`L_Heap()`
`L_Heap(int nalloc, int n, com.sun.jna.ptr.PointerByReference array, int direction)`
`L_Heap(com.sun.jna.Pointer peer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

protected java.util.List<?> getFieldOrder()
- Methods inherited from class com.sun.jna.Structure
  allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setFieldOrder, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.util.List<?>`	`getFieldOrder()`

- Field Detail
  - nalloc
```
public int nalloc
```
    size of allocated ptr array
    C type : l_int32
  - n
```
public int n
```
    number of elements stored in the heap
    C type : l_int32
  - array
```
public com.sun.jna.ptr.PointerByReference array
```
    ptr array
    C type : void**
  - direction
```
public int direction
```
    L_SORT_INCREASING or L_SORT_DECREASING
    C type : l_int32
- Constructor Detail
  - L_Heap
```
public L_Heap()
```
  - L_Heap
```
public L_Heap(int nalloc,
              int n,
              com.sun.jna.ptr.PointerByReference array,
              int direction)
```
    Parameters:
    
    nalloc - size of allocated ptr array
    C type : l_int32
    
    n - number of elements stored in the heap
    C type : l_int32
    
    array - ptr array
    C type : void**
    
    direction - L_SORT_INCREASING or L_SORT_DECREASING
    C type : l_int32
  - L_Heap
```
public L_Heap(com.sun.jna.Pointer peer)
```
- Method Detail
  - getFieldOrder
```
protected java.util.List<?> getFieldOrder()
```
    Specified by:
    
    getFieldOrder in class com.sun.jna.Structure

Class L_Heap

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.jna.Structure

Field Summary

Fields inherited from class com.sun.jna.Structure

Constructor Summary

Method Summary

Methods inherited from class com.sun.jna.Structure

Methods inherited from class java.lang.Object

Field Detail

nalloc

n

array

direction

Constructor Detail

L_Heap

L_Heap

L_Heap

Method Detail

getFieldOrder