* A compact array of any primitive data type serves two purposes: *
* The index array always points into particular parts of the data array * it is initially set up to point at regular block boundaries * The following example uses blocks of 4 for simplicity *
* Example: Expanded * BLOCK 0 1 2 3 4 * INDEX 0 4 8 12 16 ... * ARRAY abcdeababcdezyabcdea... * | | | | | |... **
* After compression, the index will point to various places in the data array * wherever there is a runs of the same elements as in the original *
* Example: Compressed * BLOCK 0 1 2 3 4 * INDEX 0 4 1 8 2 ... * ARRAY abcdeabazyabc... **
* If you look at the example, index number 2 in the expanded version points * to data position number 8, which has elements "bcde". In the compressed * version, index number 2 points to data position 1, which also has "bcde" * @see CompactByteArray * @see CompactIntArray * @see CompactCharArray * @see CompactStringArray * @version $Revision: 1.2 $ 8/25/98 * @author Helena Shih */ typedef struct { int16_t* fArray; uint16_t* fIndex; int32_t* fHashes; int32_t fCount; int16_t fDefaultValue; bool_t fCompact; bool_t fBogus; int32_t kBlockShift; int32_t kBlockMask; } CompactShortArray; CAPI const int32_t UCMP16_kMaxUnicode; CAPI const int32_t UCMP16_kUnicodeCount; CAPI const int32_t UCMP16_kBlockShift; CAPI const int32_t UCMP16_kBlockCount; CAPI const int32_t UCMP16_kBlockBytes; CAPI const int32_t UCMP16_kIndexShift; CAPI const int32_t UCMP16_kIndexCount; CAPI const uint32_t UCMP16_kBlockMask; CAPI int32_t ucmp16_getkUnicodeCount(void); CAPI int32_t ucmp16_getkBlockCount(void); CAPI int32_t ucmp16_getkIndexCount(void); /** * Construct an empty CompactShortArray. * @param defaultValue the default value for all characters not explicitly in the array */ CAPI CompactShortArray* ucmp16_open(int16_t defaultValue); /** * Construct a CompactShortArray from a pre-computed index and values array. The values * will be adobped by the CompactShortArray. Note: for speed, the compact method will * only re-use blocks in the values array that are on a block boundary. The pre-computed * arrays passed in to this constructor may re-use blocks at any position in the values * array. * @param indexArray the index array to be adopted * @param newValues the value array to be adobptd * @param count the number of entries in the value array * @param defaultValue the default value for all characters not explicitly in the array * @see compact */ CAPI CompactShortArray* ucmp16_openAdopt(uint16_t *indexArray, int16_t *newValues, int32_t count, int16_t defaultValue ); CAPI CompactShortArray* ucmp16_openAdoptWithBlockShift(uint16_t *indexArray, int16_t *newValues, int32_t count, int16_t defaultValue, int32_t blockShift); CAPI void ucmp16_close(CompactShortArray* array); /** * Returns TRUE if the creation of the compact array fails. */ CAPI bool_t ucmp16_isBogus(const CompactShortArray* array); /** * * Get the mapped value of a Unicode character. * @param index the character to get the mapped value with * @return the mapped value of the given character */ #define ucmp16_get(array, index) (array->fArray[(array->fIndex[(index >> array->kBlockShift)] )+ \ (index & array->kBlockMask)]) #define ucmp16_getu(array, index) (uint16_t)ucmp16_get(array, index) /** * Set a new value for a Unicode character. * Set automatically expands the array if it is compacted. * @param index the character to set the mapped value with * @param value the new mapped value */ CAPI void ucmp16_set(CompactShortArray *array, UChar index, int16_t value); /** * * Set new values for a range of Unicode character. * @param start the starting offset of the range * @param end the ending offset of the range * @param value the new mapped value */ CAPI void ucmp16_setRange(CompactShortArray* array, UChar start, UChar end, int16_t value); /** * Compact the array. For efficency, this method will only re-use * blocks in the values array that are on a block bounday. If you * want better compaction, you can do your own compaction and use * the constructor that lets you pass in the pre-computed arrays. */ CAPI void ucmp16_compact(CompactShortArray* array); /** * Get the default value. */ CAPI int16_t ucmp16_getDefaultValue(const CompactShortArray* array); /** * * Get the number of elements in the value array. * @return the number of elements in the value array. */ CAPI uint32_t ucmp16_getCount(const CompactShortArray* array); /** * * Get the address of the value array. * @return the address of the value array */ CAPI const int16_t* ucmp16_getArray(const CompactShortArray* array); /** * * Get the address of the index array. * @return the address of the index array */ CAPI const uint16_t* ucmp16_getIndex(const CompactShortArray* array); #endif