L_Heap (Lept4J - Leptonica for Java 1.12.0 API)

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 of arbitrary void* data
native declaration : heap.h:6
This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java or JNA.

Nested Class Summary

Nested Classes
Modifier and Type Class 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.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields
Modifier and Type	Field	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	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

Modifier and Type Method Description

protected java.util.List<java.lang.String> getFieldOrder()
Gets this Structure's field names in their proper order.
- Methods inherited from class com.sun.jna.Structure
  allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, 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, 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

- 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<java.lang.String> getFieldOrder()
```
    Gets this Structure's field names in their proper order.
    
    Overrides:
    
    getFieldOrder in class com.sun.jna.Structure
    
    Returns:
    
    list of ordered field names