* 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.16 $ 8/25/98 * @author Helena Shih */ typedef struct CompactShortArray { int32_t fStructSize; int16_t* fArray; uint16_t* fIndex; int32_t* fHashes; int32_t fCount; int16_t fDefaultValue; UBool fCompact; UBool fBogus; UBool fAlias; int32_t kBlockShift; int32_t kBlockMask; UBool fIAmOwned; /* don't free CSA on close */ } CompactShortArray; U_CAPI int32_t U_EXPORT2 ucmp16_getkUnicodeCount(void); U_CAPI int32_t U_EXPORT2 ucmp16_getkBlockCount(void); /** * Construct an empty CompactShortArray with uprv_malloc(). Do not call any of the * ucmp16_init*() functions after using this function. They will cause a memory * leak. * * @param defaultValue the default value for all characters not explicitly in the array * @see ucmp16_init * @see ucmp16_initBogus * @return The initialized array. */ U_CAPI CompactShortArray* U_EXPORT2 ucmp16_open(int16_t defaultValue); /** * Construct a CompactShortArray from a pre-computed index and values array. The values * will be adopted by the CompactShortArray. Memory is allocated with uprv_malloc. * 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. Do not call any of the * ucmp16_init*() functions after using this function. They will cause a memory * leak. The indexArray and newValues will be uprv_free'd when ucmp16_close() is called. * * @param indexArray the index array to be adopted * @param newValues the value array to be adopted * @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 * @see ucmp16_open * @see ucmp16_openAlias * @see ucmp16_init * @see ucmp16_initBogus */ U_CAPI CompactShortArray* U_EXPORT2 ucmp16_openAdopt(uint16_t *indexArray, int16_t *newValues, int32_t count, int16_t defaultValue); /** * Construct a CompactShortArray from a pre-computed index and values array. The values * will be adopted by the CompactShortArray. Memory is allocated with uprv_malloc. * 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. Do not call any of the * ucmp16_init*() functions after using this function. They will cause a memory * leak. The indexArray and newValues will be uprv_free'd when ucmp16_close() is called. * * @param indexArray the index array to be adopted * @param newValues the value array to be adopted * @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 * @see ucmp16_open * @see ucmp16_openAlias * @see ucmp16_init * @see ucmp16_initBogus */ U_CAPI CompactShortArray* U_EXPORT2 ucmp16_openAdoptWithBlockShift(uint16_t *indexArray, int16_t *newValues, int32_t count, int16_t defaultValue, int32_t blockShift); /** * Construct a CompactShortArray from a pre-computed index and values array. The values * will be aliased by the CompactShortArray. Memory is allocated with uprv_malloc. * 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. Do not call any of the * ucmp16_init*() functions after using this function. They will cause a memory * leak. * * @param indexArray the index array to be adopted * @param newValues the value array to be adopted * @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 * @see ucmp16_open * @see ucmp16_openAlias * @see ucmp16_init * @see ucmp16_initBogus */ U_CAPI CompactShortArray* U_EXPORT2 ucmp16_openAlias(uint16_t *indexArray, int16_t *newValues, int32_t count, int16_t defaultValue ); /** * Initialize an empty CompactShortArray. Do not call this function if * you created the array with any of the ucmp16_open*() funcitons because it * will cause a memory leak. * * @param defaultValue the default value for all characters not explicitly in the array * @param array An uninitialized CompactShortArray * @see ucmp16_open * @see ucmp16_openAdopt * @see ucmp16_openAlias * @see ucmp16_initAdopt * @see ucmp16_initAlias */ U_CAPI void U_EXPORT2 ucmp16_init(CompactShortArray* array, int16_t defaultValue); /** * Initialize an empty CompactShortArray to the bogus value. Do not call * this function if you created the array with ucmp16_open() because it * will cause a memory leak. * * @param array An uninitialized CompactShortArray * @see ucmp16_open * @see ucmp16_openAdopt * @see ucmp16_openAlias * @see ucmp16_isBogus * @see ucmp16_init * @see ucmp16_initAdopt * @see ucmp16_initAlias */ U_CAPI void U_EXPORT2 ucmp16_initBogus(CompactShortArray* array); /** * Initialize a CompactShortArray from a pre-computed index and values array. The values * will be adopted by the CompactShortArray. No memory is allocated. 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. The indexArray and newValues will be * uprv_free'd when ucmp16_close() is called. * * @param this_obj the CompactShortArray to be initialized * @param indexArray the index array to be adopted * @param newValues the value array to be adopted * @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 * @see ucmp16_open * @see ucmp16_openAdopt * @see ucmp16_openAlias * @see ucmp16_init * @see ucmp16_initAlias */ U_CAPI CompactShortArray* U_EXPORT2 ucmp16_initAdopt(CompactShortArray *this_obj, uint16_t *indexArray, int16_t *newValues, int32_t count, int16_t defaultValue ); /** * Initialize a CompactShortArray from a pre-computed index and values array. The values * will be adopted by the CompactShortArray. No memory is allocated. 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. The indexArray and newValues will be * uprv_free'd when ucmp16_close() is called. * * @param this_obj the CompactShortArray to be initialized * @param indexArray the index array to be adopted * @param newValues the value array to be adopted * @param count the number of entries in the value array * @param defaultValue the default value for all characters not explicitly in the array * @return The initialized array * @see compact * @see ucmp16_open * @see ucmp16_openAdopt * @see ucmp16_openAlias * @see ucmp16_init * @see ucmp16_initAlias * @see ucmp16_initAdopt */ U_CAPI CompactShortArray* U_EXPORT2 ucmp16_initAdoptWithBlockShift(CompactShortArray *this_obj, uint16_t *indexArray, int16_t *newValues, int32_t count, int16_t defaultValue, int32_t blockShift); /** * Initialize a CompactShortArray from a pre-computed index and values array. The values * will be aliased by the CompactShortArray. No memory is allocated. 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 this_obj the CompactShortArray to be initialized * @param indexArray the index array to be adopted * @param newValues the value array to be adopted * @param count the number of entries in the value array * @param defaultValue the default value for all characters not explicitly in the array * @return The initialized array * @see compact * @see ucmp16_open * @see ucmp16_openAdopt * @see ucmp16_openAlias * @see ucmp16_init * @see ucmp16_initAdopt */ U_CAPI CompactShortArray* U_EXPORT2 ucmp16_initAlias(CompactShortArray *this_obj, uint16_t *indexArray, int16_t *newValues, int32_t count, int16_t defaultValue ); /** * Initialize a CompactShortArray from a pre-computed index and values array. The values * will be aliased by the CompactShortArray. No memory is allocated. 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 this_obj the CompactShortArray to be initialized * @param indexArray the index array to be adopted * @param newValues the value array to be adopted * @param count the number of entries in the value array * @param defaultValue the default value for all characters not explicitly in the array * @return The initialized array * @see compact * @see ucmp16_open * @see ucmp16_openAdopt * @see ucmp16_openAlias * @see ucmp16_init * @see ucmp16_initAdopt */ U_CAPI CompactShortArray* U_EXPORT2 ucmp16_initAliasWithBlockShift(CompactShortArray *this_obj, uint16_t *indexArray, int16_t *newValues, int32_t count, int16_t defaultValue, int32_t blockShift); /** * Free up any allocated memory associated with this compact array. * The memory that is uprv_free'd depends on how the array was initialized * or opened. * * @param array The array to close */ U_CAPI void U_EXPORT2 ucmp16_close(CompactShortArray* array); /** * Returns TRUE if the creation of the compact array fails. */ U_CAPI UBool U_EXPORT2 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 character the character to set the mapped value with * @param value the new mapped value */ U_CAPI void U_EXPORT2 ucmp16_set(CompactShortArray *array, UChar character, 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 */ U_CAPI void U_EXPORT2 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. */ U_CAPI void U_EXPORT2 ucmp16_compact(CompactShortArray* array); /** * Get the default value. */ U_CAPI int16_t U_EXPORT2 ucmp16_getDefaultValue(const CompactShortArray* array); /** * Get the number of elements in the value array. * @return the number of elements in the value array. */ U_CAPI uint32_t U_EXPORT2 ucmp16_getCount(const CompactShortArray* array); /** * Get the address of the value array. * @return the address of the value array */ U_CAPI const int16_t* U_EXPORT2 ucmp16_getArray(const CompactShortArray* array); /** * Get the address of the index array. * @return the address of the index array */ U_CAPI const uint16_t* U_EXPORT2 ucmp16_getIndex(const CompactShortArray* array); /** INTERNAL USE ONLY **/ U_CAPI uint32_t U_EXPORT2 ucmp16_flattenMem(const CompactShortArray* array, UMemoryStream *MS); /** INTERNAL USE ONLY **/ U_CAPI void U_EXPORT2 ucmp16_initFromData(CompactShortArray* array, const uint8_t **source, UErrorCode *status); #endif