Leptonica
1.54
|
l_int32 l_dnaaAddDna | ( | L_DNAA * | daa, |
L_DNA * | da, | ||
l_int32 | copyflag | ||
) |
Input: daa da (to be added) copyflag (L_INSERT, L_COPY, L_CLONE) Return: 0 if OK, 1 on error
l_int32 l_dnaaAddNumber | ( | L_DNAA * | daa, |
l_int32 | index, | ||
l_float64 | val | ||
) |
Input: daa index (of l_dna within l_dnaa) val (number to be added; stored as a double) Return: 0 if OK, 1 on error
Notes: (1) Adds to an existing l_dna only.
L_DNAA* l_dnaaCreate | ( | l_int32 | n | ) |
Input: size of l_dna ptr array to be alloc'd (0 for default) Return: daa, or null on error
l_int32 l_dnaAddNumber | ( | L_DNA * | da, |
l_float64 | val | ||
) |
Input: da val (float or int to be added; stored as a float) Return: 0 if OK, 1 on error
void l_dnaaDestroy | ( | L_DNAA ** | pdaa | ) |
Input: &dnaa <to be="" nulled="" if="" it="" exists>=""> Return: void
l_int32 l_dnaaExtendArray | ( | L_DNAA * | daa | ) |
Input: daa Return: 0 if OK, 1 on error
l_int32 l_dnaaGetCount | ( | L_DNAA * | daa | ) |
Input: daa Return: count (number of l_dna), or 0 if no l_dna or on error
L_DNA* l_dnaaGetDna | ( | L_DNAA * | daa, |
l_int32 | index, | ||
l_int32 | accessflag | ||
) |
Input: daa index (to the index-th l_dna) accessflag (L_COPY or L_CLONE) Return: l_dna, or null on error
l_int32 l_dnaaGetDnaCount | ( | L_DNAA * | daa, |
l_int32 | index | ||
) |
Input: daa index (of l_dna in daa) Return: count of numbers in the referenced l_dna, or 0 on error.
l_int32 l_dnaaGetNumberCount | ( | L_DNAA * | daa | ) |
Input: daa Return: count (total number of numbers in the l_dnaa), or 0 if no numbers or on error
Input: daa i (index of l_dna within l_dnaa) j (index into l_dna) val (<return> double value) Return: 0 if OK, 1 on error
L_DNAA* l_dnaaRead | ( | const char * | filename | ) |
Input: filename Return: daa, or null on error
L_DNAA* l_dnaaReadStream | ( | FILE * | fp | ) |
Input: stream Return: daa, or null on error
l_int32 l_dnaaReplaceDna | ( | L_DNAA * | daa, |
l_int32 | index, | ||
L_DNA * | da | ||
) |
Input: daa index (to the index-th l_dna) l_dna (insert and replace any existing one) Return: 0 if OK, 1 on error
Notes: (1) Any existing l_dna is destroyed, and the input one is inserted in its place. (2) If the index is invalid, return 1 (error)
l_int32 l_dnaaWrite | ( | const char * | filename, |
L_DNAA * | daa | ||
) |
Input: filename, daa Return: 0 if OK, 1 on error
l_int32 l_dnaaWriteStream | ( | FILE * | fp, |
L_DNAA * | daa | ||
) |
Input: stream, daa Return: 0 if OK, 1 on error
l_int32 l_dnaChangeRefcount | ( | L_DNA * | da, |
l_int32 | delta | ||
) |
l_dnaChangeRefCount()
Input: da delta (change to be applied) Return: 0 if OK, 1 on error
L_DNA* l_dnaClone | ( | L_DNA * | da | ) |
Input: da Return: ptr to same l_dna, or null on error
NUMA* l_dnaConvertToNuma | ( | L_DNA * | da | ) |
Input: da Return: na, or null on error
Input: da Return: copy of l_dna, or null on error
l_int32 l_dnaCopyXParameters | ( | L_DNA * | dad, |
L_DNA * | das | ||
) |
Input: dad (destination DNuma) das (source DNuma) Return: 0 if OK, 1 on error
L_DNA* l_dnaCreate | ( | l_int32 | n | ) |
Input: size of number array to be alloc'd (0 for default) Return: da, or null on error
L_DNA* l_dnaCreateFromDArray | ( | l_float64 * | darray, |
l_int32 | size, | ||
l_int32 | copyflag | ||
) |
Input: da (float) size (of the array) copyflag (L_INSERT or L_COPY) Return: da, or null on error
Notes: (1) With L_INSERT, ownership of the input array is transferred to the returned l_dna, and all elements are considered to be valid.
L_DNA* l_dnaCreateFromIArray | ( | l_int32 * | iarray, |
l_int32 | size | ||
) |
Input: iarray (integer) size (of the array) Return: da, or null on error
Notes: (1) We can't insert this int array into the l_dna, because a l_dna takes a double array. So this just copies the data from the input array into the l_dna. The input array continues to be owned by the caller.
void l_dnaDestroy | ( | L_DNA ** | pda | ) |
Input: &da (<to be="" nulled="" if="" it="" exists>="">) Return: void
Notes: (1) Decrements the ref count and, if 0, destroys the l_dna. (2) Always nulls the input ptr.
l_int32 l_dnaEmpty | ( | L_DNA * | da | ) |
Input: da Return: 0 if OK; 1 on error
Notes: (1) This does not change the allocation of the array. It just clears the number of stored numbers, so that the array appears to be empty.
l_int32 l_dnaExtendArray | ( | L_DNA * | da | ) |
Input: da Return: 0 if OK, 1 on error
l_int32 l_dnaGetCount | ( | L_DNA * | da | ) |
Input: da Return: count, or 0 if no numbers or on error
l_float64* l_dnaGetDArray | ( | L_DNA * | da, |
l_int32 | copyflag | ||
) |
Input: da copyflag (L_NOCOPY or L_COPY) Return: either the bare internal array or a copy of it, or null on error
Notes: (1) If copyflag == L_COPY, it makes a copy which the caller is responsible for freeing. Otherwise, it operates directly on the bare array of the l_dna. (2) Very important: for L_NOCOPY, any writes to the array will be in the l_dna. Do not write beyond the size of the count field, because it will not be accessable from the l_dna! If necessary, be sure to set the count field to a larger number (such as the alloc size) BEFORE calling this function. Creating with l_dnaMakeConstant() is another way to insure full initialization.
l_int32 l_dnaGetDValue | ( | L_DNA * | da, |
l_int32 | index, | ||
l_float64 * | pval | ||
) |
Input: da index (into l_dna) &val (<return> double value; 0.0 on error) Return: 0 if OK; 1 on error
Notes: (1) Caller may need to check the function return value to decide if a 0.0 in the returned ival is valid.
l_int32* l_dnaGetIArray | ( | L_DNA * | da | ) |
Input: da Return: a copy of the bare internal array, integerized by rounding, or null on error Notes: (1) A copy of the array is made, because we need to generate an integer array from the bare double array. The caller is responsible for freeing the array. (2) The array size is determined by the number of stored numbers, not by the size of the allocated array in the l_dna. (3) This function is provided to simplify calculations using the bare internal array, rather than continually calling accessors on the l_dna. It is typically used on an array of size 256.
l_int32 l_dnaGetIValue | ( | L_DNA * | da, |
l_int32 | index, | ||
l_int32 * | pival | ||
) |
Input: da index (into l_dna) &ival (<return> integer value; 0 on error) Return: 0 if OK; 1 on error
Notes: (1) Caller may need to check the function return value to decide if a 0 in the returned ival is valid.
l_int32 l_dnaGetRefcount | ( | L_DNA * | da | ) |
l_dnaGetRefCount()
Input: da Return: refcount, or UNDEF on error
l_int32 l_dnaGetXParameters | ( | L_DNA * | da, |
l_float64 * | pstartx, | ||
l_float64 * | pdelx | ||
) |
Input: da &startx (<optional return>=""> startx) &delx (<optional return>=""> delx) Return: 0 if OK, 1 on error
l_int32 l_dnaInsertNumber | ( | L_DNA * | da, |
l_int32 | index, | ||
l_float64 | val | ||
) |
Input: da index (location in da to insert new value) val (float64 or integer to be added) Return: 0 if OK, 1 on error
Notes: (1) This shifts da[i] --> da[i + 1] for all i >= index, and then inserts val as da[index]. (2) It should not be used repeatedly on large arrays, because the function is O(n).
L_DNA* l_dnaMakeDelta | ( | L_DNA * | das | ) |
Input: das (input l_dna) Return: dad (of difference values val[i+1] - val[i]), or null on error
L_DNA* l_dnaMakeSequence | ( | l_float64 | startval, |
l_float64 | increment, | ||
l_int32 | size | ||
) |
Input: startval increment size (of sequence) Return: l_dna of sequence of evenly spaced values, or null on error
Input: filename Return: da, or null on error
L_DNA* l_dnaReadStream | ( | FILE * | fp | ) |
Input: stream Return: da, or null on error
l_int32 l_dnaRemoveNumber | ( | L_DNA * | da, |
l_int32 | index | ||
) |
Input: da index (element to be removed) Return: 0 if OK, 1 on error
Notes: (1) This shifts da[i] --> da[i - 1] for all i > index. (2) It should not be used repeatedly on large arrays, because the function is O(n).
l_int32 l_dnaReplaceNumber | ( | L_DNA * | da, |
l_int32 | index, | ||
l_float64 | val | ||
) |
Input: da index (element to be replaced) val (new value to replace old one) Return: 0 if OK, 1 on error
l_int32 l_dnaSetCount | ( | L_DNA * | da, |
l_int32 | newcount | ||
) |
Input: da newcount Return: 0 if OK, 1 on error
Notes: (1) If newcount <= da->nalloc, this resets da->n. Using newcount = 0 is equivalent to l_dnaEmpty(). (2) If newcount > da->nalloc, this causes a realloc to a size da->nalloc = newcount. (3) All the previously unused values in da are set to 0.0.
l_int32 l_dnaSetValue | ( | L_DNA * | da, |
l_int32 | index, | ||
l_float64 | val | ||
) |
Input: da index (to element to be set) val (to set element) Return: 0 if OK; 1 on error
l_int32 l_dnaSetXParameters | ( | L_DNA * | da, |
l_float64 | startx, | ||
l_float64 | delx | ||
) |
Input: da startx (x value corresponding to da[0]) delx (difference in x values for the situation where the elements of da correspond to the evaulation of a function at equal intervals of size ) Return: 0 if OK, 1 on error
l_int32 l_dnaShiftValue | ( | L_DNA * | da, |
l_int32 | index, | ||
l_float64 | diff | ||
) |
Input: da index (to element to change relative to the current value) diff (increment if diff > 0 or decrement if diff < 0) Return: 0 if OK; 1 on error
l_int32 l_dnaWrite | ( | const char * | filename, |
L_DNA * | da | ||
) |
Input: filename, da Return: 0 if OK, 1 on error
l_int32 l_dnaWriteStream | ( | FILE * | fp, |
L_DNA * | da | ||
) |
Input: stream, da Return: 0 if OK, 1 on error
L_DNA* numaConvertToDna | ( | NUMA * | na | ) |
numaConvertToDna
Input: na Return: da, or null on error
const l_int32 INITIAL_PTR_ARRAYSIZE = 50 [static] |