1# 非线性容器 2<!--Kit: ArkTS--> 3<!--Subsystem: CommonLibrary--> 4<!--Owner: @xliu-huanwei; @shilei123; @huanghello--> 5<!--Designer: @yuanyao14--> 6<!--Tester: @kirl75; @zsw_zhushiwei--> 7<!--Adviser: @ge-yafang--> 8 9 10非线性容器实现能快速查找的数据结构，其底层通过hash或者红黑树实现，包括HashMap、HashSet、TreeMap、TreeSet、LightWeightMap、LightWeightSet、PlainArray七种。非线性容器中的key及value的类型均满足ECMA标准。 11 12## 各非线性容器类型特征对比 13 14| 类名 | 特征及建议使用场景 | 15| --------- | ------- | 16| HashMap | 存储具有关联关系的键值对集合。键唯一，依据键的hash值确定存储位置。访问速度快，但不能自定义排序。推荐用于需要快速存取、插入删除键值对数据时使用。 | 17| HashSet | 存储一系列值的集合。值唯一，依据值的hash确定存储位置。允许放入null值，但不能自定义排序。适用于不重复的集合或去重某个集合。 | 18| TreeMap | 存储具有关联关系的键值对集合。键唯一，允许用户自定义排序方法。适用于按序存储键值对的场景。 | 19| TreeSet | 存储一系列值的集合。值唯一，允许用户自定义排序方法，但不建议放入null值。适用于按序存储集合的场景。 | 20| LightWeightMap | 存储具有关联关系的键值对集合。键唯一，底层采用轻量级结构，空间占用小。推荐用于存取键值对数据且内存不充足时。 | 21| LightWeightSet | 存储一系列值的集合。值唯一，底层采用轻量级结构，空间占用小。适用于不重复的集合或去重某个集合。 | 22| PlainArray | 存储具有关联关系的键值对集合。键唯一，底层与LightWeightMap一样采用轻量级结构，键固定为number类型。适用于存储键为number类型键值对的场景。 | 23 24## HashMap 25 26[HashMap](../reference/apis-arkts/js-apis-hashmap.md)可用来存储具有关联关系的key-value键值对集合，存储元素中key是唯一的，每个key会对应一个value值。 27 28HashMap通过泛型定义，利用键的哈希值确定存储位置，实现快速查找。初始容量为16，支持动态扩容，每次扩容为原容量的两倍。底层基于哈希表实现，冲突处理采用链地址法。 29 30HashMap和[TreeMap](../reference/apis-arkts/js-apis-treemap.md)相比，HashMap依据键的hashCode存取数据，访问速度较快。TreeMap则按顺序存取，效率较低。 31 32[HashSet](../reference/apis-arkts/js-apis-hashset.md)基于HashMap实现。HashMap的输入参数由key、value两个值组成。在HashSet中，只处理value对象。 33 34需要快速存取、删除以及插入键值对数据时，推荐使用HashMap。 35 36HashMap支持增、删、改、查操作，常用API如下： 37 38| 操作 | 方法 | 描述 | 39| --------- | ------- | ------- | 40| 增加元素 | set(key: K, value: V) | 增加一个键值对。 | 41| 访问元素 | get(key: K) | 获取key对应的value值。 | 42| 访问元素 | keys() | 返回一个迭代器对象，包含map中的所有key值。 | 43| 访问元素 | values() | 返回一个迭代器对象，包含map中的所有value值。 | 44| 访问元素 | entries() | 返回一个迭代器对象，包含map中的所有键值对。 | 45| 访问元素 | forEach(callbackFn: (value?: V, key?: K, map?: HashMap<K, V>) => void, thisArg?: Object) | 遍历访问整个map的元素。 | 46| 访问元素 | \[Symbol.iterator]():IterableIterator<[K,V]> | 创建迭代器以访问数据。 | 47| 修改元素 | replace(key: K, newValue: V) | 修改指定key对应的value值。 | 48| 修改元素 | forEach(callbackFn: (value?: V, key?: K, map?: HashMap<K, V>) => void, thisArg?: Object) | 遍历并修改整个map的元素。 | 49| 删除元素 | remove(key: K) | 删除map中匹配到的键值对。 | 50| 删除元素 | clear() | 清空整个map。 | 51 52## HashSet 53 54[HashSet](../reference/apis-arkts/js-apis-hashset.md)可用来存储一系列值的集合，存储元素中value是唯一的。 55 56HashSet基于泛型定义，集合中通过value的hash值确定存储位置，从而快速找到该值。初始容量为16，支持动态扩容，每次扩容为原始容量的2倍。value的类型需满足ECMA标准。HashSet基于[HashMap](../reference/apis-arkts/js-apis-hashmap.md)实现，只处理value对象，底层数据结构与HashMap一致。 57 58HashSet和[TreeSet](../reference/apis-arkts/js-apis-treeset.md)相比，HashSet中的数据无序存放，不支持用户指定排序方式，而TreeSet中的数据有序存放，支持用户通过排序函数对元素进行排序。它们集合中的元素都不允许重复，HashSet允许放入null值，但TreeSet不建议存放null值，可能会对排序结果产生影响。 59 60可以利用HashSet的不重复特性，在需要去重或确保集合元素唯一性时使用。 61 62HashSet支持增、删、改、查操作，常用API如下： 63 64| 操作 | 方法 | 描述 | 65| --------- | ------- | ------- | 66| 增加元素 | add(value: T) | 增加一个值。 | 67| 访问元素 | values() | 返回一个迭代器对象，包含set中的所有value。 | 68| 访问元素 | entries() | 返回一个迭代器对象，包含类似键值对的数组，键值都是value。 | 69| 访问元素 | forEach(callbackFn: (value?: T, key?: T, set?: HashSet\<T>) => void, thisArg?: Object) | 遍历访问整个set的元素。 | 70| 访问元素 | \[Symbol.iterator]():IterableIterator<T> | 创建迭代器以进行数据访问。 | 71| 修改元素 | forEach(callbackFn: (value?: T, key?: T, set?: HashSet\<T>) => void, thisArg?: Object) | 通过遍历对set中的元素进行操作，可能包括但不限于修改元素。 | 72| 删除元素 | remove(value: T) | 删除指定的元素。 | 73| 删除元素 | clear() | 清空整个set。 | 74 75## TreeMap 76 77[TreeMap](../reference/apis-arkts/js-apis-treemap.md)用于存储具有关联关系的key-value键值对集合，存储元素中key是唯一的，每个key对应一个value值。 78 79TreeMap的key按照泛型定义有序存储，基于红黑树实现，支持快速插入和删除，key的类型需满足ECMA标准。 80 81TreeMap和[HashMap](../reference/apis-arkts/js-apis-hashmap.md)相比，HashMap依据键的hashCode存取数据，访问速度较快。而TreeMap是有序存取，效率较低。 82 83一般需要存储有序键值对的场景，可以使用TreeMap。 84 85TreeMap支持增、删、改、查操作，常用 API 如下： 86 87| 操作 | 方法 | 描述 | 88| --------- | ------- | ------- | 89| 增加元素 | set(key: K, value: V) | 增加一个键值对。 | 90| 访问元素 | get(key: K) | 获取key对应的value值。 | 91| 访问元素 | getFirstKey() | 获取map中排在首位的key值。 | 92| 访问元素 | getLastKey() | 获取map中排在末位的key值。 | 93| 访问元素 | keys() | 返回一个迭代器对象，包含map中的所有key值。 | 94| 访问元素 | values() | 返回一个迭代器对象，包含map中的所有value值。 | 95| 访问元素 | entries() | 返回一个迭代器对象，包含map中的所有键值对。 | 96| 访问元素 | forEach(callbackFn: (value?: V, key?: K, map?: TreeMap<K, V>) => void, thisArg?: Object) | 遍历访问整个map的元素。 | 97| 访问元素 | \[Symbol.iterator]():IterableIterator<[K,V]> | 创建迭代器以进行数据访问。 | 98| 修改元素 | replace(key: K, newValue: V) | 修改指定key对应的value值。 | 99| 修改元素 | forEach(callbackFn: (value?: V, key?: K, map?: TreeMap<K, V>) => void, thisArg?: Object) | 通过遍历对map中的元素进行操作，可能包括但不限于修改元素。 | 100| 删除元素 | remove(key: K) | 删除map中匹配到的键值对。 | 101| 删除元素 | clear() | 清空整个map。 | 102 103## TreeSet 104 105[TreeSet](../reference/apis-arkts/js-apis-treeset.md)可用来存储一系列值的集合，存储元素中value是唯一的。 106 107TreeSet根据泛型定义有序存储值，底层实现基于红黑树，支持快速插入和删除。value的类型符合ECMA标准。 108 109TreeSet基于[TreeMap](../reference/apis-arkts/js-apis-treemap.md)实现，仅处理value对象，用于存储值的集合，元素中value唯一，并支持按用户定义的排序函数排序。用于存储值的集合，元素中value唯一，并支持按用户定义的排序函数排序。 110 111TreeSet和[HashSet](../reference/apis-arkts/js-apis-hashset.md)相比，HashSet无序存放数据，TreeSet有序存放数据。两者元素均不允许重复，HashSet允许null值，但TreeSet不建议存放null值，可能影响排序。 112 113在需要存储有序集合的场景中，可以使用TreeSet。 114 115TreeSet支持增、删、改、查操作，常用API如下： 116 117| 操作 | 方法 | 描述 | 118| --------- | ------- | ------- | 119| 增加元素 | add(value: T) | 增加一个值。 | 120| 访问元素 | values() | 返回一个迭代器对象，包含set中的所有value值。 | 121| 访问元素 | entries() | 返回一个迭代器对象，包含类似键值对的数组，键值都是value。 | 122| 访问元素 | getFirstValue() | 获取set中排在首位的value值。 | 123| 访问元素 | getLastValue() | 获取set中排在末位的value值。 | 124| 访问元素 | forEach(callbackFn: (value?: T, key?: T, set?: TreeSet\<T>) => void, thisArg?: Object) | 遍历访问整个set的元素。 | 125| 访问元素 | \[Symbol.iterator]():IterableIterator<T> | 创建迭代器以进行数据访问。 | 126| 修改元素 | forEach(callbackFn: (value?: T, key?: T, set?: TreeSet\<T>) => void, thisArg?: Object) | 通过遍历对set中的元素进行操作，可能包括但不限于修改元素。 | 127| 删除元素 | remove(value: T) | 删除指定的元素。 | 128| 删除元素 | clear() | 清空整个set。 | 129 130## LightWeightMap 131 132[LightWeightMap](../reference/apis-arkts/js-apis-lightweightmap.md)用于存储具有唯一键的键值对集合，存储元素中key是唯一的，每个key会对应一个value值。LightWeightMap依据泛型定义，采用轻量级结构，底层通过hash实现唯一key，冲突策略为线性探测。集合中的key值的查找依赖于hash值以及二分查找算法，通过一个数组存储hash值，然后映射到其他数组中的key值以及value值，key的类型满足ECMA标准。 133 134初始默认容量为8，每次扩容为原容量的2倍。 135 136LightWeightMap和[HashMap](../reference/apis-arkts/js-apis-hashmap.md)都是用来存储具有关联关系的key-value键值对集合，但LightWeightMap占用内存更小。 137 138当需要存储具有关联关系的key-value键值对集合时，推荐使用占用内存更小的LightWeightMap。 139 140LightWeightMap支持增、删、改、查操作，常用API如下： 141 142| 操作 | 方法 | 描述 | 143| --------- | ------- | ------- | 144| 增加元素 | set(key: K, value: V) | 增加一个键值对。 | 145| 访问元素 | get(key: K) | 获取key对应的value值。 | 146| 访问元素 | getIndexOfKey(key: K) | 获取map中指定key的index。 | 147| 访问元素 | getIndexOfValue(value: V) | 获取map中指定value出现的第一个的index。 | 148| 访问元素 | keys() | 返回一个迭代器对象，包含map中的所有key值。 | 149| 访问元素 | values() | 返回一个迭代器对象，包含map中的所有value值。 | 150| 访问元素 | entries() | 返回一个迭代器对象，包含map中的所有键值对。 | 151| 访问元素 | getKeyAt(index: number) | 获取指定index对应的key值。 | 152| 访问元素 | getValueAt(index: number) | 获取指定index对应的value值。 | 153| 访问元素 | forEach(callbackFn: (value?: V, key?: K, map?: LightWeightMap<K, V>) => void, thisArg?: Object) | 遍历访问整个map的元素。 | 154| 访问元素 | \[Symbol.iterator]():IterableIterator<[K,V]> | 创建迭代器以进行数据访问。 | 155| 修改元素 | setValueAt(index: number, newValue: V) | 修改指定index对应的value值。 | 156| 修改元素 | forEach(callbackFn: (value?: V, key?: K, map?: LightWeightMap<K, V>) => void, thisArg?: Object) | 通过遍历对map中的元素进行操作，可能包括但不限于修改元素。 | 157| 删除元素 | remove(key: K) | 删除map中指定key匹配到的键值对。 | 158| 删除元素 | removeAt(index: number) | 删除map中指定index对应的键值对。 | 159| 删除元素 | clear() | 清空整个map。 | 160 161## LightWeightSet 162 163[LightWeightSet](../reference/apis-arkts/js-apis-lightweightset.md)可用来存储一系列值的集合，存储元素中value是唯一的。 164 165LightWeightSet依据泛型定义，采用更加轻量级的结构，初始默认容量为8，每次扩容为原始容量的2倍。集合中的value值的查找依赖于hash值以及二分查找算法，通过一个数组存储hash值，然后映射到其他数组中的value值，value的类型满足ECMA标准。 166 167LightWeightSet底层通过hash表结构实现value的唯一性，冲突策略采用线性探测法，查找策略基于二分查找法。 168 169LightWeightSet和[HashSet](../reference/apis-arkts/js-apis-hashset.md)都是用来存储键值的集合，但LightWeightSet的占用内存更小。 170 171当需要存取某个集合或是对某个集合去重时，推荐使用占用内存更小的LightWeightSet。 172 173LightWeightSet支持增、删、改、查操作。常用API如下： 174 175| 操作 | 方法 | 描述 | 176| --------- | ------- | ------- | 177| 增加元素 | add(obj: T) | 增加一个值。 | 178| 访问元素 | getIndexOf(key: T) | 获取对应的index值。 | 179| 访问元素 | getValueAt(index: number) | 获取指定index对应的value值。 | 180| 访问元素 | values() | 返回一个迭代器对象，包含set中的所有value值。 | 181| 访问元素 | entries() | 返回一个迭代器对象，包含类似键值对的数组，键值都是value。 | 182| 访问元素 | forEach(callbackFn: (value?: T, key?: T, set?: LightWeightSet\<T>) => void, thisArg?: Object) | 遍历访问整个set的元素。 | 183| 访问元素 | \[Symbol.iterator]():IterableIterator<T> | 创建迭代器以进行数据访问。 | 184| 修改元素 | forEach(callbackFn: (value?: T, key?: T, set?: LightWeightSet\<T>) => void, thisArg?: Object) | 通过遍历对set中的元素进行操作，可能包括但不限于修改元素。 | 185| 删除元素 | remove(key: K) | 删除指定的元素。 | 186| 删除元素 | removeAt(index: number) | 删除set中指定index对应的值。 | 187| 删除元素 | clear() | 清空整个set。 | 188 189## PlainArray 190 191[PlainArray](../reference/apis-arkts/js-apis-plainarray.md)可用来存储具有关联关系的键值对集合，存储元素中key是唯一的，并且对于PlainArray来说，其key的类型为number类型。每个key会对应一个value值，类型依据泛型的定义，PlainArray采用轻量级的结构，集合中的key值的查找依赖于二分查找算法，然后映射到其他数组中的value值。 192 193初始默认容量为16，每次扩容为原始容量的2倍。 194 195PlainArray和[LightWeightMap](../reference/apis-arkts/js-apis-lightweightmap.md)都用于存储键值对，且采用轻量级结构。不过，PlainArray的键值类型仅限于number。 196 197当需要存储键为number类型的键值对时，可以使用PlainArray。 198 199PlainArray支持增、删、改、查操作。常用API如下： 200 201| 操作 | 方法 | 描述 | 202| --------- | ------- | ------- | 203| 增加元素 | add(key: number,value: T) | 增加一个键值对。 | 204| 访问元素 | get(key: number) | 获取key对应的value值。 | 205| 访问元素 | getIndexOfKey(key: number) | 获取PlainArray中指定key的index。 | 206| 访问元素 | getIndexOfValue(value: T) | 获取PlainArray中指定value出现的第一个的index。 | 207| 访问元素 | getKeyAt(index: number) | 获取指定index对应的key值。 | 208| 访问元素 | getValueAt(index: number) | 获取指定index对应的value值。 | 209| 访问元素 | forEach(callbackFn: (value: T, index?: number, PlainArray?: PlainArray\<T>) => void, thisArg?: Object) | 遍历访问整个PlainArray的元素。 | 210| 访问元素 | \[Symbol.iterator]():IterableIterator<[number, T]> | 创建迭代器以进行数据访问。 | 211| 修改元素 | setValueAt(index:number, value: T) | 修改指定index对应的value值。 | 212| 修改元素 | forEach(callbackFn: (value: T, index?: number, PlainArray?: PlainArray\<T>) => void, thisArg?: Object) | 通过遍历对PlainArray中的元素进行操作，可能包括但不限于修改元素。 | 213| 删除元素 | remove(key: number) | 删除PlainArray中指定key匹配到的键值对。 | 214| 删除元素 | removeAt(index: number) | 删除PlainArray中指定index对应的键值对。 | 215| 删除元素 | removeRangeFrom(index: number, size: number) | 删除PlainArray中指定范围内的元素。 | 216| 删除元素 | clear() | 清空整个PlainArray。 | 217 218## 非线性容器的使用 219 220此处列举常用的非线性容器HashMap、TreeMap、LightWeightMap、PlainArray的使用示例，包括导入模块、增加元素、访问元素及修改等操作，示例代码如下所示： 221 222 223```ts 224// HashMap 225import { HashMap } from '@kit.ArkTS'; // 导入HashMap模块 226 227let hashMap1: HashMap<string, number> = new HashMap(); 228hashMap1.set('a', 123); // 增加一个键为'a'，值为123的元素 229let hashMap2: HashMap<number, number> = new HashMap(); 230hashMap2.set(4, 123); // 增加一个键为4，值为123的元素 231console.info(`result: ${hashMap2.hasKey(4)}`); // 判断是否含有键为4的元素。输出：result: true 232console.info(`result: ${hashMap1.get('a')}`); // 访问键为'a'的元素。输出：result: 123 233 234// TreeMap 235import { TreeMap } from '@kit.ArkTS'; // 导入TreeMap模块 236 237let treeMap: TreeMap<string, number> = new TreeMap(); 238treeMap.set('a', 123); // 增加一个键为'a'，值为123的元素 239treeMap.set('6', 356); // 增加一个键为'6'，值为356的元素 240console.info(`result: ${treeMap.get('a')}`); // 访问键为'a'的元素。输出：result: 123 241console.info(`result: ${treeMap.getFirstKey()}`); // 访问首元素。输出：result: 6 242console.info(`result: ${treeMap.getLastKey()}`); // 访问尾元素。输出：result: a 243 244// LightWeightMap 245import { LightWeightMap } from '@kit.ArkTS'; // 导入LightWeightMap模块 246 247let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap(); 248lightWeightMap.set('x', 123); // 增加一个键为'x'，值为123的元素 249lightWeightMap.set('8', 356); // 增加一个键为'8'，值为356的元素 250console.info(`result: ${lightWeightMap.get('a')}`); // 访问键为'a'的元素。输出：result: undefined 251console.info(`result: ${lightWeightMap.get('x')}`); // 访问键为'x'的元素，获取其值。输出：result: 123 252console.info(`result: ${lightWeightMap.getIndexOfKey('8')}`); // 访问键为'8'的元素，获取其索引。输出：result: 0 253 254// PlainArray 255import { PlainArray } from '@kit.ArkTS'; // 导入PlainArray模块 256 257let plainArray: PlainArray<string> = new PlainArray(); 258plainArray.add(1, 'sdd'); // 增加一个键为1，值为'sdd'的元素 259plainArray.add(2, 'sff'); // 增加一个键为2，值为'sff'的元素 260console.info(`result: ${plainArray.get(1)}`); // 访问键为1的元素，获取值。输出：result: sdd 261console.info(`result: ${plainArray.getKeyAt(1)}`); // 访问索引为1的元素，获取键。输出：result: 2 262``` 263