 |
Leptonica 1.85.0
Image processing and image analysis suite
|
|
Leptonica 1.85.0
Image processing and image analysis suite
|
#include "allheaders.h"Go to the source code of this file.
Functions | |
| static l_int32 | ptraExtendArray (L_PTRA *pa) |
| L_PTRA * | ptraCreate (l_int32 n) |
| void | ptraDestroy (L_PTRA **ppa, l_int32 freeflag, l_int32 warnflag) |
| l_ok | ptraAdd (L_PTRA *pa, void *item) |
| l_ok | ptraInsert (L_PTRA *pa, l_int32 index, void *item, l_int32 shiftflag) |
| void * | ptraRemove (L_PTRA *pa, l_int32 index, l_int32 flag) |
| void * | ptraRemoveLast (L_PTRA *pa) |
| void * | ptraReplace (L_PTRA *pa, l_int32 index, void *item, l_int32 freeflag) |
| l_ok | ptraSwap (L_PTRA *pa, l_int32 index1, l_int32 index2) |
| l_ok | ptraCompactArray (L_PTRA *pa) |
| l_ok | ptraReverse (L_PTRA *pa) |
| l_ok | ptraJoin (L_PTRA *pa1, L_PTRA *pa2) |
| l_ok | ptraGetMaxIndex (L_PTRA *pa, l_int32 *pmaxindex) |
| l_ok | ptraGetActualCount (L_PTRA *pa, l_int32 *pcount) |
| void * | ptraGetPtrToItem (L_PTRA *pa, l_int32 index) |
| L_PTRAA * | ptraaCreate (l_int32 n) |
| void | ptraaDestroy (L_PTRAA **ppaa, l_int32 freeflag, l_int32 warnflag) |
| l_ok | ptraaGetSize (L_PTRAA *paa, l_int32 *psize) |
| l_ok | ptraaInsertPtra (L_PTRAA *paa, l_int32 index, L_PTRA *pa) |
| L_PTRA * | ptraaGetPtra (L_PTRAA *paa, l_int32 index, l_int32 accessflag) |
| L_PTRA * | ptraaFlattenToPtra (L_PTRAA *paa) |
Variables | |
| LEPT_DLL const l_uint32 | MaxInitPtraSize = 1000001 |
| static const l_int32 | DefaultInitPtraSize = 20 |
Ptra creation and destruction
L_PTRA *ptraCreate()
void *ptraDestroy()
Add/insert/remove/replace generic ptr object
l_int32 ptraAdd()
static l_int32 ptraExtendArray()
l_int32 ptraInsert()
void *ptraRemove()
void *ptraRemoveLast()
void *ptraReplace()
l_int32 ptraSwap()
l_int32 ptraCompactArray()
Other array operations
l_int32 ptraReverse()
l_int32 ptraJoin()
Simple Ptra accessors
l_int32 ptraGetMaxIndex()
l_int32 ptraGetActualCount()
void *ptraGetPtrToItem()
Ptraa creation and destruction
L_PTRAA *ptraaCreate()
void *ptraaDestroy()
Ptraa accessors
l_int32 ptraaGetSize()
l_int32 ptraaInsertPtra()
L_PTRA *ptraaGetPtra()
Ptraa conversion
L_PTRA *ptraaFlattenToPtra()
Notes on the Ptra:
(1) The Ptra is a struct, not an array. Always use the accessors
in this file, never the fields directly.
(2) Items can be placed anywhere in the allocated ptr array,
including one index beyond the last ptr (in which case the
ptr array is realloc'd).
(3) Thus, the items on the ptr array need not be compacted. In
general there will be null pointers in the ptr array.
(4) A compacted array will remain compacted on removal if
arbitrary items are removed with compaction, or if items
are removed from the end of the array.
(5) For addition to and removal from the end of the array, this
functions exactly like a stack, and with the same O(1) cost.
(6) This differs from the generic stack in that we allow
random access for insertion, removal and replacement.
Removal can be done without compacting the array.
Insertion into a null ptr in the array has no effect on
the other pointers, but insertion into a location already
occupied by an item has a cost proportional to the
distance to the next null ptr in the array.
(7) Null ptrs are valid input args for both insertion and
replacement; this allows arbitrary swapping.
(8) The item in the array with the largest index is at pa->imax.
This can be any value from -1 (initialized; all array ptrs
are null) up to pa->nalloc - 1 (the last ptr in the array).
(9) In referring to the array: the first ptr is the "top" or
"beginning"; the last pointer is the "bottom" or "end";
items are shifted "up" towards the top when compaction occurs;
and items are shifted "down" towards the bottom when forced to
move due to an insertion.
(10) It should be emphasized that insertion, removal and replacement
are general:
* You can insert an item into any ptr location in the
allocated ptr array, as well as into the next ptr address
beyond the allocated array (in which case a realloc will occur).
* You can remove or replace an item from any ptr location
in the allocated ptr array.
* When inserting into an occupied location, you have
three options for downshifting.
* When removing, you can either leave the ptr null or
compact the array.
Notes on the Ptraa:
(1) The Ptraa is a fixed size ptr array for holding Ptra.
In that respect, it is different from other pointer arrays, which
are extensible and grow using the *Add*() functions.
(2) In general, the Ptra ptrs in the Ptraa can be randomly occupied.
A typical usage is to allow an O(n) horizontal sort of Pix,
where the size of the Ptra array is the width of the image,
and each Ptra is an array of all the Pix at a specific x location.
Definition in file ptra.c.
| L_PTRAA * ptraaCreate | ( | l_int32 | n | ) |
| [in] | n | size of ptr array to be alloc'd |
Notes:
(1) The ptraa is generated with a fixed size, that can not change.
The ptra can be generated and inserted randomly into this array.
Definition at line 768 of file ptra.c.
References L_Ptraa::nalloc, L_Ptraa::ptra, and ptraaDestroy().
| l_ok ptraAdd | ( | L_PTRA * | pa, |
| void * | item ) |
| [in] | pa | ptra |
| [in] | item | generic ptr to a struct |
Notes:
(1) This adds the element to the next location beyond imax,
which is the largest occupied ptr in the array. This is
what you expect from a stack, where all ptrs up to and
including imax are occupied, but here the occuption of
items in the array is entirely arbitrary.
Definition at line 246 of file ptra.c.
References L_Ptra::array, L_Ptra::imax, L_Ptra::nactual, L_Ptra::nalloc, ptraExtendArray(), and ptraGetMaxIndex().
Referenced by ptraJoin().
| void ptraaDestroy | ( | L_PTRAA ** | ppaa, |
| l_int32 | freeflag, | ||
| l_int32 | warnflag ) |
| [in,out] | ppaa | will be set to null before returning |
| [in] | freeflag | TRUE to free each remaining item in each ptra |
| [in] | warnflag | TRUE to warn if any remaining items are not destroyed |
Notes:
(1) See ptraDestroy() for use of freeflag and warnflag.
(2) To destroy the ptraa, we destroy each ptra, then the ptr array,
then the ptraa, and then null the contents of the input ptr.
Definition at line 802 of file ptra.c.
References L_REMOVE, L_Ptraa::ptra, ptraaGetPtra(), ptraaGetSize(), and ptraDestroy().
Referenced by ptraaCreate().
| [in] | paa | ptraa |
Notes:
(1) This 'flattens' the ptraa to a ptra, taking the items in
each ptra, in order, starting with the first ptra, etc.
(2) As a side-effect, the ptra are all removed from the ptraa
and destroyed, leaving an empty ptraa.
Definition at line 950 of file ptra.c.
References L_REMOVE, ptraaGetPtra(), ptraaGetSize(), ptraCreate(), ptraDestroy(), and ptraJoin().
| [in] | paa | ptraa |
| [in] | index | location in array |
| [in] | accessflag | L_HANDLE_ONLY, L_REMOVE |
Notes:
(1) This returns the ptra ptr. If accessflag == L_HANDLE_ONLY,
the ptra is left on the ptraa. If accessflag == L_REMOVE,
the ptr in the ptraa is set to NULL, and the caller
is responsible for disposing of the ptra (either putting it
back on the ptraa, or destroying it).
(2) This returns NULL if there is no Ptra at the index location.
Definition at line 910 of file ptra.c.
References L_HANDLE_ONLY, L_REMOVE, L_Ptraa::ptra, and ptraaGetSize().
Referenced by ptraaDestroy(), and ptraaFlattenToPtra().
| l_ok ptraaGetSize | ( | L_PTRAA * | paa, |
| l_int32 * | psize ) |
| [in] | paa | |
| [out] | psize | size of ptr array |
Definition at line 840 of file ptra.c.
References L_Ptraa::nalloc.
Referenced by ptraaDestroy(), ptraaFlattenToPtra(), ptraaGetPtra(), and ptraaInsertPtra().
| [in] | paa | ptraa |
| [in] | index | location in array for insertion |
| [in] | pa | to be inserted |
Notes:
(1) Caller should check return value. On success, the Ptra
is inserted in the Ptraa and is owned by it. However,
on error, the Ptra remains owned by the caller.
Definition at line 869 of file ptra.c.
References L_Ptraa::ptra, and ptraaGetSize().
| l_ok ptraCompactArray | ( | L_PTRA * | pa | ) |
| [in] | pa |
Notes:
(1) This compacts the items on the array, filling any empty ptrs.
(2) This does not change the size of the array of ptrs.
Definition at line 580 of file ptra.c.
References L_Ptra::array, L_Ptra::imax, ptraGetActualCount(), and ptraGetMaxIndex().
| L_PTRA * ptraCreate | ( | l_int32 | n | ) |
| [in] | n | size of ptr array to be alloc'd; use 0 for default |
Definition at line 144 of file ptra.c.
References L_Ptra::array, DefaultInitPtraSize, L_Ptra::imax, L_Ptra::nactual, L_Ptra::nalloc, and ptraDestroy().
Referenced by ptraaFlattenToPtra().
| void ptraDestroy | ( | L_PTRA ** | ppa, |
| l_int32 | freeflag, | ||
| l_int32 | warnflag ) |
| [in,out] | ppa | will be set to null before returning |
| [in] | freeflag | TRUE to free each remaining item in the array |
| [in] | warnflag | TRUE to warn if any remaining items are not destroyed |
Notes:
(1) If freeflag == TRUE, frees each item in the array.
(2) If freeflag == FALSE and warnflag == TRUE, and there are
items on the array, this gives a warning and destroys the array.
If these items are not owned elsewhere, this will cause
a memory leak of all the items that were on the array.
So if the items are not owned elsewhere and require their
own destroy function, they must be destroyed before the ptra.
(3) If warnflag == FALSE, no warnings will be issued. This is
useful if the items are owned elsewhere, such as a
PixMemoryStore().
(4) To destroy the ptra, we destroy the ptr array, then
the ptra, and then null the contents of the input ptr.
Definition at line 192 of file ptra.c.
References L_Ptra::array, L_Ptra::imax, L_NO_COMPACTION, ptraGetActualCount(), and ptraRemove().
Referenced by ptraaDestroy(), ptraaFlattenToPtra(), and ptraCreate().
|
static |
| [in] | pa |
Definition at line 273 of file ptra.c.
References L_Ptra::array, and L_Ptra::nalloc.
Referenced by ptraAdd(), and ptraInsert().
| l_ok ptraGetActualCount | ( | L_PTRA * | pa, |
| l_int32 * | pcount ) |
| [in] | pa | ptra |
| [out] | pcount | actual number of items on the ptr array |
Notes:
(1) The actual number of items on the ptr array, pa->nactual,
will be smaller than pa->n if the array is not compacted.
Definition at line 709 of file ptra.c.
References L_Ptra::nactual.
Referenced by ptraCompactArray(), and ptraDestroy().
| l_ok ptraGetMaxIndex | ( | L_PTRA * | pa, |
| l_int32 * | pmaxindex ) |
| [in] | pa | ptra |
| [out] | pmaxindex | index of last item in the array; |
Notes:
(1) The largest index to an item in the array is maxindex.
maxindex is one less than the number of items that would be
in the array if there were no null pointers between 0
and maxindex - 1. However, because the internal ptr array
need not be compacted, there may be NULL pointers at
indices below maxindex; for example, if items have
been removed.
(2) When an item is added to the end of the array, it goes
into pa->array[maxindex + 1], and maxindex is then
incremented by 1.
(3) If there are no items in the array, this returns maxindex = -1.
Definition at line 683 of file ptra.c.
References L_Ptra::imax.
Referenced by ptraAdd(), ptraCompactArray(), ptraInsert(), ptraJoin(), ptraRemove(), ptraRemoveLast(), ptraReplace(), ptraReverse(), and ptraSwap().
| void * ptraGetPtrToItem | ( | L_PTRA * | pa, |
| l_int32 | index ) |
| [in] | pa | ptra |
| [in] | index | of element to be retrieved |
Notes:
(1) This returns a ptr to the item. You must cast it to
the type of item. Do not destroy it; the item belongs
to the Ptra.
(2) This can access all possible items on the ptr array.
If an item doesn't exist, it returns null.
Definition at line 739 of file ptra.c.
References L_Ptra::array, and L_Ptra::nalloc.
| l_ok ptraInsert | ( | L_PTRA * | pa, |
| l_int32 | index, | ||
| void * | item, | ||
| l_int32 | shiftflag ) |
| [in] | pa | ptra |
| [in] | index | location in ptra to insert new value |
| [in] | item | generic ptr to a struct; can be null |
| [in] | shiftflag | L_AUTO_DOWNSHIFT, L_MIN_DOWNSHIFT, L_FULL_DOWNSHIFT |
Notes:
(1) This checks first to see if the location is valid, and
then if there is presently an item there. If there is not,
it is simply inserted into that location.
(2) If there is an item at the insert location, items must be
moved down to make room for the insert. In the downward
shift there are three options, given by shiftflag.
~ If shiftflag == L_AUTO_DOWNSHIFT, a decision is made
whether, in a cascade of items, to downshift a minimum
amount or for all items above index. The decision is
based on the expectation of finding holes (null ptrs)
between index and the bottom of the array.
Assuming the holes are distributed uniformly, if 2 or more
holes are expected, we do a minimum shift.
~ If shiftflag == L_MIN_DOWNSHIFT, the downward shifting
cascade of items progresses a minimum amount, until
the first empty slot is reached. This mode requires
some computation before the actual shifting is done.
~ If shiftflag == L_FULL_DOWNSHIFT, a shifting cascade is
performed where pa[i] --> pa[i + 1] for all i >= index.
Then, the item is inserted at pa[index].
(3) If you are not using L_AUTO_DOWNSHIFT, the rule of thumb is
to use L_FULL_DOWNSHIFT if the array is compacted (each
element points to an item), and to use L_MIN_DOWNSHIFT
if there are a significant number of null pointers.
There is no penalty to using L_MIN_DOWNSHIFT for a
compacted array, however, because the full shift is required
and we don't do the O(n) computation to look for holes.
(4) This should not be used repeatedly on large arrays,
because the function is generally O(n).
(5) However, it can be used repeatedly if we start with an empty
ptr array and insert only once at each location. For example,
you can support an array of Numa, where at each ptr location
you store either 0 or 1 Numa, and the Numa can be added
randomly to the ptr array.
Definition at line 336 of file ptra.c.
References L_Ptra::array, L_Ptra::imax, L_AUTO_DOWNSHIFT, L_FULL_DOWNSHIFT, L_MIN_DOWNSHIFT, L_Ptra::nactual, L_Ptra::nalloc, ptraExtendArray(), and ptraGetMaxIndex().
Referenced by ptraSwap().
| [in] | pa1 | add to this one |
| [in] | pa2 | appended to pa1, and emptied of items; can be null |
Definition at line 635 of file ptra.c.
References L_NO_COMPACTION, ptraAdd(), ptraGetMaxIndex(), and ptraRemove().
Referenced by ptraaFlattenToPtra().
| void * ptraRemove | ( | L_PTRA * | pa, |
| l_int32 | index, | ||
| l_int32 | flag ) |
| [in] | pa | ptra |
| [in] | index | element to be removed |
| [in] | flag | L_NO_COMPACTION, L_COMPACTION |
Notes:
(1) If flag == L_NO_COMPACTION, this removes the item and
nulls the ptr on the array. If it takes the last item
in the array, pa->n is reduced to the next item.
(2) If flag == L_COMPACTION, this compacts the array for
for all i >= index. It should not be used repeatedly on
large arrays, because compaction is O(n).
(3) The ability to remove without automatic compaction allows
removal with cost O(1).
Definition at line 432 of file ptra.c.
References L_Ptra::array, L_Ptra::imax, L_COMPACTION, L_Ptra::nactual, and ptraGetMaxIndex().
Referenced by ptraDestroy(), ptraJoin(), ptraRemoveLast(), and ptraSwap().
| void * ptraRemoveLast | ( | L_PTRA * | pa | ) |
| [in] | pa | ptra |
Definition at line 479 of file ptra.c.
References L_NO_COMPACTION, ptraGetMaxIndex(), and ptraRemove().
| void * ptraReplace | ( | L_PTRA * | pa, |
| l_int32 | index, | ||
| void * | item, | ||
| l_int32 | freeflag ) |
| [in] | pa | ptra |
| [in] | index | element to be replaced |
| [in] | item | new generic ptr to a struct; can be null |
| [in] | freeflag | TRUE to free old item; FALSE to return it |
Definition at line 506 of file ptra.c.
References L_Ptra::array, L_Ptra::nactual, and ptraGetMaxIndex().
Referenced by ptraSwap().
| l_ok ptraReverse | ( | L_PTRA * | pa | ) |
| [in] | pa | ptra |
Definition at line 613 of file ptra.c.
References ptraGetMaxIndex(), and ptraSwap().
| l_ok ptraSwap | ( | L_PTRA * | pa, |
| l_int32 | index1, | ||
| l_int32 | index2 ) |
| [in] | pa | ptra |
| [in] | index1 | |
| [in] | index2 |
Definition at line 545 of file ptra.c.
References L_MIN_DOWNSHIFT, L_NO_COMPACTION, ptraGetMaxIndex(), ptraInsert(), ptraRemove(), and ptraReplace().
Referenced by ptraReverse().
|
static |
1.12.0