未验证 提交 e6c0532f 编写于 作者: O openharmony_ci 提交者: Gitee

!1609 improve containers class API interface reference description

Merge pull request !1609 from wangyong/secdocs
...@@ -55,15 +55,15 @@ add(element: T): boolean ...@@ -55,15 +55,15 @@ add(element: T): boolean
**示例:** **示例:**
``` ```
let arrayList = new ArrayList(); let arrayList = new ArrayList();
arrayList.add("a"); let result = arrayList.add("a");
arrayList.add(1); let result1 = arrayList.add(1);
let b = [1, 2, 3]; let b = [1, 2, 3];
arrayList.add(b); let result2 = arrayList.add(b);
let c = {name: "lala", age: "13"}; let c = {name: "lala", age: "13"};
arrayList.add(false); let result3 = arrayList.add(false);
``` ```
### insert ### insert
...@@ -109,9 +109,9 @@ has(element: T): boolean ...@@ -109,9 +109,9 @@ has(element: T): boolean
``` ```
let arrayList = new ArrayList(); let arrayList = new ArrayList();
arrayList.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result = arrayList.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
arrayList.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); arrayList.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
arrayList.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result1 = arrayList.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
``` ```
### getIndexOf ### getIndexOf
...@@ -143,7 +143,7 @@ arrayList.add(2); ...@@ -143,7 +143,7 @@ arrayList.add(2);
arrayList.add(1); arrayList.add(1);
arrayList.add(2); arrayList.add(2);
arrayList.add(4); arrayList.add(4);
arrayList.getIndexOf(2); let result = arrayList.getIndexOf(2);
``` ```
### getLastIndexOf ### getLastIndexOf
...@@ -175,7 +175,7 @@ arrayList.add(2); ...@@ -175,7 +175,7 @@ arrayList.add(2);
arrayList.add(1); arrayList.add(1);
arrayList.add(2); arrayList.add(2);
arrayList.add(4); arrayList.add(4);
arrayList.getLastIndexOf(2); let result = arrayList.getLastIndexOf(2);
``` ```
### removeByIndex ### removeByIndex
...@@ -205,7 +205,7 @@ arrayList.add(4); ...@@ -205,7 +205,7 @@ arrayList.add(4);
arrayList.add(5); arrayList.add(5);
arrayList.add(2); arrayList.add(2);
arrayList.add(4); arrayList.add(4);
arrayList.removeByIndex(2); let result = arrayList.removeByIndex(2);
``` ```
### remove ### remove
...@@ -234,7 +234,7 @@ arrayList.add(2); ...@@ -234,7 +234,7 @@ arrayList.add(2);
arrayList.add(4); arrayList.add(4);
arrayList.add(5); arrayList.add(5);
arrayList.add(4); arrayList.add(4);
arrayList.remove(2); let result = arrayList.remove(2);
``` ```
### removeByRange ### removeByRange
...@@ -264,7 +264,7 @@ arrayList.removeByRange(2, 6); ...@@ -264,7 +264,7 @@ arrayList.removeByRange(2, 6);
``` ```
### replaceAllElements ### replaceAllElements
replaceAllElements(callbackfn: (value: T, index?: number, arraylist?: ArrayList<T>) => T, replaceAllElements(callbackfn: (value: T, index?: number, arrlist?: ArrayList<T>) => T,
thisArg?: Object): void thisArg?: Object): void
用户操作ArrayList中的元素,用操作后的元素替换原元素并返回操作后的元素。 用户操作ArrayList中的元素,用操作后的元素替换原元素并返回操作后的元素。
...@@ -280,9 +280,9 @@ callbackfn的参数说明: ...@@ -280,9 +280,9 @@ callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素 | | value | T | 是 | 当前遍历到的元素 |
| index | number | 否 | 当前遍历到的下标值 | | index | number | 否 | 当前遍历到的下标值 |
| arraylist | ArrayList<T> | 否 | 当前调用replaceAllElements方法的实例对象 | | arrlist | ArrayList<T> | 否 | 当前调用replaceAllElements方法的实例对象。 |
**示例:** **示例:**
...@@ -301,7 +301,7 @@ arrayList.replaceAllElements((value, index) => { ...@@ -301,7 +301,7 @@ arrayList.replaceAllElements((value, index) => {
``` ```
### forEach ### forEach
forEach(callbackfn: (value: T, index?: number, arraylist?: ArrayList<T>) => void, forEach(callbackfn: (value: T, index?: number, arrlist?: ArrayList<T>) => void,
thisArg?: Object): void thisArg?: Object): void
通过回调函数来遍历ArrayList实例对象上的元素以及元素对应的下标。 通过回调函数来遍历ArrayList实例对象上的元素以及元素对应的下标。
...@@ -319,7 +319,7 @@ callbackfn的参数说明: ...@@ -319,7 +319,7 @@ callbackfn的参数说明:
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 | | value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 | | index | number | 否 | 当前遍历到的下标值。 |
| arraylist | ArrayList<T> | 否 | 当前调用forEach方法的实例对象。 | | arrlist | ArrayList<T> | 否 | 当前调用forEach方法的实例对象。 |
**示例:** **示例:**
...@@ -391,9 +391,9 @@ arrayList.add(2); ...@@ -391,9 +391,9 @@ arrayList.add(2);
arrayList.add(4); arrayList.add(4);
arrayList.add(5); arrayList.add(5);
arrayList.add(4); arrayList.add(4);
arrayList.subArrayList(2, 4); let result1 = arrayList.subArrayList(2, 4);
arrayList.subArrayList(4, 3); let result2 = arrayList.subArrayList(4, 3);
arrayList.subArrayList(2, 6); let result3 = arrayList.subArrayList(2, 6);
``` ```
### clear ### clear
...@@ -415,7 +415,8 @@ arrayList.clear(); ...@@ -415,7 +415,8 @@ arrayList.clear();
### clone ### clone
clone(): ArrayList<T> clone(): ArrayList<T>
克隆一个与ArrayList一模一样的实例,并返回克隆后的实例,修改克隆后的实例并不会影响原实例。 克隆一个与ArrayList相同的实例,并返回克隆后的实例。修改克隆后的实例并不会影响原实例。
**返回值:** **返回值:**
...@@ -431,7 +432,7 @@ arrayList.add(2); ...@@ -431,7 +432,7 @@ arrayList.add(2);
arrayList.add(4); arrayList.add(4);
arrayList.add(5); arrayList.add(5);
arrayList.add(4); arrayList.add(4);
arrayList.clone(); let result = arrayList.clone();
``` ```
### getCapacity ### getCapacity
...@@ -453,7 +454,7 @@ arrayList.add(2); ...@@ -453,7 +454,7 @@ arrayList.add(2);
arrayList.add(4); arrayList.add(4);
arrayList.add(5); arrayList.add(5);
arrayList.add(4); arrayList.add(4);
arrayList.getCapacity(); let result = arrayList.getCapacity();
``` ```
### convertToArray ### convertToArray
...@@ -475,7 +476,7 @@ arrayList.add(2); ...@@ -475,7 +476,7 @@ arrayList.add(2);
arrayList.add(4); arrayList.add(4);
arrayList.add(5); arrayList.add(5);
arrayList.add(4); arrayList.add(4);
arrayList.convertToArray(); let result = arrayList.convertToArray();
``` ```
### isEmpty ### isEmpty
...@@ -497,7 +498,7 @@ arrayList.add(2); ...@@ -497,7 +498,7 @@ arrayList.add(2);
arrayList.add(4); arrayList.add(4);
arrayList.add(5); arrayList.add(5);
arrayList.add(4); arrayList.add(4);
arrayList.isEmpty(); let result = arrayList.isEmpty();
``` ```
### increaseCapacityTo ### increaseCapacityTo
......
...@@ -104,9 +104,9 @@ has(element: T): boolean ...@@ -104,9 +104,9 @@ has(element: T): boolean
``` ```
let deque = new Deque(); let deque = new Deque();
deque.has("Ahfbrgrbgnutfodgorrogorg"); let result = deque.has("Ahfbrgrbgnutfodgorrogorg");
deque.insertFront("Ahfbrgrbgnutfodgorrogorg"); deque.insertFront("Ahfbrgrbgnutfodgorrogorg");
deque.has("Ahfbrgrbgnutfodgorrogorg"); let result1 = deque.has("Ahfbrgrbgnutfodgorrogorg");
``` ```
### popFirst ### popFirst
...@@ -130,7 +130,7 @@ deque.insertFront(4); ...@@ -130,7 +130,7 @@ deque.insertFront(4);
deque.insertEnd(5); deque.insertEnd(5);
deque.insertFront(2); deque.insertFront(2);
deque.insertFront(4); deque.insertFront(4);
deque.popFirst(); let result = deque.popFirst();
``` ```
### popLast ### popLast
...@@ -155,6 +155,7 @@ deque.insertFront(5); ...@@ -155,6 +155,7 @@ deque.insertFront(5);
deque.insertFront(2); deque.insertFront(2);
deque.insertFront(4); deque.insertFront(4);
deque.popLast(); deque.popLast();
let result = deque.popLast();
``` ```
### forEach ### forEach
...@@ -211,7 +212,7 @@ deque.insertEnd(2); ...@@ -211,7 +212,7 @@ deque.insertEnd(2);
deque.insertEnd(4); deque.insertEnd(4);
deque.insertFront(5); deque.insertFront(5);
deque.insertFront(4); deque.insertFront(4);
deque.getFirst(); let result = deque.getFirst();
``` ```
### getLast ### getLast
...@@ -234,7 +235,7 @@ deque.insertFront(2); ...@@ -234,7 +235,7 @@ deque.insertFront(2);
deque.insertFront(4); deque.insertFront(4);
deque.insertFront(5); deque.insertFront(5);
deque.insertFront(4); deque.insertFront(4);
deque.getLast(); let result = deque.getLast();
``` ```
### [Symbol.iterator] ### [Symbol.iterator]
......
...@@ -53,7 +53,7 @@ isEmpty(): boolean ...@@ -53,7 +53,7 @@ isEmpty(): boolean
``` ```
const hashMap = new HashMap(); const hashMap = new HashMap();
hashMap.isEmpty(); let result = hashMap.isEmpty();
``` ```
...@@ -79,9 +79,9 @@ hasKey(key: K): boolean ...@@ -79,9 +79,9 @@ hasKey(key: K): boolean
``` ```
let hashMap = new HashMap(); let hashMap = new HashMap();
hashMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result = hashMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
hashMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result1 = hashMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
``` ```
...@@ -107,9 +107,9 @@ hasValue(value: V): boolean ...@@ -107,9 +107,9 @@ hasValue(value: V): boolean
``` ```
let hashMap = new HashMap(); let hashMap = new HashMap();
hashMap.hasValue(123); let result = hashMap.hasValue(123);
hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
hashMap.hasValue(123); let result1 = hashMap.hasValue(123);
``` ```
...@@ -137,7 +137,7 @@ get(key: K): V ...@@ -137,7 +137,7 @@ get(key: K): V
let hashMap = new HashMap(); let hashMap = new HashMap();
hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
hashMap.set("sdfs", 356); hashMap.set("sdfs", 356);
hashMap.get("sdfs"); let result = hashMap.get("sdfs");
``` ```
...@@ -145,13 +145,13 @@ hashMap.get("sdfs"); ...@@ -145,13 +145,13 @@ hashMap.get("sdfs");
setAll(map: HashMap<K, V>): void setAll(map: HashMap<K, V>): void
将一个HashMap中的所有元素组添加到另一个hashmap中。 将一个HashMap中的所有元素组添加到另一个hashMap中。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| map | HashMap<K, V> | 是 | 被添加元素的hashmap。 | | map | HashMap<K, V> | 是 | 被添加元素的hashMap。 |
**示例:** **示例:**
...@@ -181,13 +181,13 @@ set(key: K, value: V): Object ...@@ -181,13 +181,13 @@ set(key: K, value: V): Object
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Object | 返回添加后的hashmap。 | | Object | 返回添加后的hashMap。 |
**示例:** **示例:**
``` ```
let hashMap = new HashMap(); let hashMap = new HashMap();
hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); let result = hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
``` ```
...@@ -195,13 +195,13 @@ hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); ...@@ -195,13 +195,13 @@ hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
remove(key: K): V remove(key: K): V
删除指定的元素 删除指定key所对应元素。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | K | 是 | 依据key指定删除的元素。 | | key | K | 是 | 指定key。 |
**返回值:** **返回值:**
...@@ -215,7 +215,7 @@ remove(key: K): V ...@@ -215,7 +215,7 @@ remove(key: K): V
let hashMap = new HashMap(); let hashMap = new HashMap();
hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
hashMap.set("sdfs", 356); hashMap.set("sdfs", 356);
hashMap.remove("sdfs"); let result = hashMap.remove("sdfs");
``` ```
...@@ -239,7 +239,7 @@ hashMap.clear(); ...@@ -239,7 +239,7 @@ hashMap.clear();
keys(): IterableIterator&lt;K&gt; keys(): IterableIterator&lt;K&gt;
返回包含此映射中包含的键的新迭代器对象。 返回包含此映射中包含的键的新迭代器对象。
**返回值:** **返回值:**
...@@ -291,7 +291,7 @@ while(temp != undefined) { ...@@ -291,7 +291,7 @@ while(temp != undefined) {
### replace ### replace
replace(key: K, value: V): boolean replace(key: K, newValue: V): boolean
对HashMap中一组数据进行更新(替换)。 对HashMap中一组数据进行更新(替换)。
...@@ -300,7 +300,7 @@ replace(key: K, value: V): boolean ...@@ -300,7 +300,7 @@ replace(key: K, value: V): boolean
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | K | 是 | 依据key指定替换的元素。 | | key | K | 是 | 依据key指定替换的元素。 |
| value | V | 是 | 成员数据的新值。 | | newValue | V | 是 | 替换成员数据的值。 |
**返回值:** **返回值:**
...@@ -313,13 +313,13 @@ replace(key: K, value: V): boolean ...@@ -313,13 +313,13 @@ replace(key: K, value: V): boolean
``` ```
let hashMap = new HashMap(); let hashMap = new HashMap();
hashMap.set("sdfs", 123); hashMap.set("sdfs", 123);
hashMap.replace("sdfs", 357); let result = hashMap.replace("sdfs", 357);
``` ```
### forEach ### forEach
forEach(callbackfn: (value: V, key?: K, hashMap?: HashMap<K, V>) => void, thisArg?: Object): void forEach(callbackfn: (value: V, key?: K, map?: HashMap<K, V>) => void, thisArg?: Object): void
通过回调函数来遍历HashMap实例对象上的元素以及元素对应的下标。 通过回调函数来遍历HashMap实例对象上的元素以及元素对应的下标。
...@@ -335,7 +335,7 @@ callbackfn的参数说明: ...@@ -335,7 +335,7 @@ callbackfn的参数说明:
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | V | 是 | 当前遍历到的元素键值对的值。 | | value | V | 是 | 当前遍历到的元素键值对的值。 |
| key | K | 是 | 当前遍历到的元素键值对的键。 | | key | K | 是 | 当前遍历到的元素键值对的键。 |
| hashMap | HashMap<K, V> | 否 | 当前调用forEach方法的实例对象。 | | map | HashMap<K, V> | 否 | 当前调用forEach方法的实例对象。 |
**示例:** **示例:**
...@@ -353,7 +353,7 @@ hashMap.forEach((value, key) => { ...@@ -353,7 +353,7 @@ hashMap.forEach((value, key) => {
entries(): IterableIterator<[K, V]> entries(): IterableIterator<[K, V]>
返回包含此映射中包含的元素的新迭代器对象。 返回包含此映射中包含的键值对的新迭代器对象。
**返回值:** **返回值:**
......
...@@ -79,9 +79,9 @@ has(value: T): boolean ...@@ -79,9 +79,9 @@ has(value: T): boolean
``` ```
let hashSet = new HashSet(); let hashSet = new HashSet();
hashSet.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result = hashSet.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
hashSet.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result1 = hashSet.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
``` ```
...@@ -107,7 +107,7 @@ add(value: T): boolean ...@@ -107,7 +107,7 @@ add(value: T): boolean
``` ```
let hashSet = new HashSet(); let hashSet = new HashSet();
hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result = hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
``` ```
...@@ -135,7 +135,7 @@ remove(value: T): boolean ...@@ -135,7 +135,7 @@ remove(value: T): boolean
let hashSet = new HashSet(); let hashSet = new HashSet();
hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
hashSet.add("sdfs"); hashSet.add("sdfs");
hashSet.remove("sdfs"); let result = hashSet.remove("sdfs");
``` ```
...@@ -184,7 +184,7 @@ while(temp != undefined) { ...@@ -184,7 +184,7 @@ while(temp != undefined) {
### forEach ### forEach
forEach(callbackfn: (value: T, key?: T, hashSet?: HashSet&lt;T&gt;) => void, thisArg?: Object): void forEach(callbackfn: (value: T, key?: T, set?: HashSet&lt;T&gt;) => void, thisArg?: Object): void
通过回调函数来遍历实例对象上的元素以及元素对应的下标。 通过回调函数来遍历实例对象上的元素以及元素对应的下标。
...@@ -200,7 +200,7 @@ callbackfn的参数说明: ...@@ -200,7 +200,7 @@ callbackfn的参数说明:
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素键值对的值。 | | value | T | 是 | 当前遍历到的元素键值对的值。 |
| key | T | 否 | 当前遍历到的元素键值对的值(和value相同)。 | | key | T | 否 | 当前遍历到的元素键值对的值(和value相同)。 |
| hashSet | HashSet&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 | | set | HashSet&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
**示例:** **示例:**
...@@ -217,13 +217,13 @@ hashSet.forEach((value, key) => { ...@@ -217,13 +217,13 @@ hashSet.forEach((value, key) => {
### entries ### entries
entries(): IterableIterator<[T, T]> entries(): IterableIterator<[T, T]>
返回包含此映射中包含的元素的新迭代器对象。 返回包含此映射中包含的键值对的新迭代器对象。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| IterableIterator<[T, T]> | 返回一个迭代器 | | IterableIterator<[T, T]> | 返回一个迭代器 |
**示例:** **示例:**
......
...@@ -53,7 +53,7 @@ isEmpty(): boolean ...@@ -53,7 +53,7 @@ isEmpty(): boolean
``` ```
const lightWeightMap = new LightWeightMap(); const lightWeightMap = new LightWeightMap();
lightWeightMap.isEmpty(); let result = lightWeightMap.isEmpty();
``` ```
...@@ -97,21 +97,22 @@ hasKey(key: K): boolean; ...@@ -97,21 +97,22 @@ hasKey(key: K): boolean;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | K | 是 | 指定元素。 | | key | K | 是 | 指定key。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| boolean | 包含指定元素返回true,否则返回false。 | | boolean | 包含指定key返回true,否则返回false。 |
**示例:** **示例:**
``` ```
let lightWeightMap = new LightWeightMap(); let lightWeightMap = new LightWeightMap();
let result = lightWeightMap.hasKey;
lightWeightMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); lightWeightMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
lightWeightMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result1 = lightWeightMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
``` ```
...@@ -137,9 +138,9 @@ hasValue(value: V): boolean ...@@ -137,9 +138,9 @@ hasValue(value: V): boolean
``` ```
let lightWeightMap = new LightWeightMap(); let lightWeightMap = new LightWeightMap();
lightWeightMap.hasValue(123); let result = lightWeightMap.hasValue(123);
lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
lightWeightMap.hasValue(123); let result1 = lightWeightMap.hasValue(123);
``` ```
...@@ -187,7 +188,7 @@ get(key: K): V ...@@ -187,7 +188,7 @@ get(key: K): V
let lightWeightMap = new LightWeightMap(); let lightWeightMap = new LightWeightMap();
lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
lightWeightMap.set("sdfs", 356); lightWeightMap.set("sdfs", 356);
lightWeightMap.get("sdfs"); let result = lightWeightMap.get("sdfs");
``` ```
...@@ -215,7 +216,7 @@ getIndexOfKey(key: K): number ...@@ -215,7 +216,7 @@ getIndexOfKey(key: K): number
let lightWeightMap = new LightWeightMap(); let lightWeightMap = new LightWeightMap();
lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
lightWeightMap.set("sdfs", 356); lightWeightMap.set("sdfs", 356);
lightWeightMap.getIndexOfKey("sdfs"); let result = lightWeightMap.getIndexOfKey("sdfs");
``` ```
...@@ -243,7 +244,7 @@ getIndexOfValue(value: V): number ...@@ -243,7 +244,7 @@ getIndexOfValue(value: V): number
let lightWeightMap = new LightWeightMap(); let lightWeightMap = new LightWeightMap();
lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
lightWeightMap.set("sdfs", 356); lightWeightMap.set("sdfs", 356);
lightWeightMap.getIndexOfValue(123); let result = lightWeightMap.getIndexOfValue(123);
``` ```
...@@ -271,7 +272,7 @@ getKeyAt(index: number): K ...@@ -271,7 +272,7 @@ getKeyAt(index: number): K
let lightWeightMap = new LightWeightMap(); let lightWeightMap = new LightWeightMap();
lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
lightWeightMap.set("sdfs", 356); lightWeightMap.set("sdfs", 356);
lightWeightMap.getKeyAt(1); let result = lightWeightMap.getKeyAt(1);
``` ```
...@@ -279,13 +280,13 @@ lightWeightMap.getKeyAt(1); ...@@ -279,13 +280,13 @@ lightWeightMap.getKeyAt(1);
setAll(map: LightWeightMap<K, V>): void setAll(map: LightWeightMap<K, V>): void
将一个LightWeightMap中的所有元素组添加到另一个LightWeightMap中。 将一个LightWeightMap中的所有元素组添加到另一个lightWeightMap中。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| map | LightWeightMap<K, V> | 是 | 被添加元素的LightWeightMap。 | | map | LightWeightMap<K, V> | 是 | 被添加元素的lightWeightMap。 |
**示例:** **示例:**
...@@ -314,13 +315,13 @@ set(key: K, value: V): Object ...@@ -314,13 +315,13 @@ set(key: K, value: V): Object
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Object | 返回添加数据后的LightWeightMap。 | | Object | 返回添加数据后的lightWeightMap。 |
**示例:** **示例:**
``` ```
let lightWeightMap = new LightWeightMap(); let lightWeightMap = new LightWeightMap();
lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); let result = lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
``` ```
...@@ -328,13 +329,13 @@ lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); ...@@ -328,13 +329,13 @@ lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
remove(key: K): V remove(key: K): V
删除指定的元素。 删除并返回指定key映射的元素。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | K | 是 | 依据key指定删除的元素。 | | key | K | 是 | 指定key。 |
**返回值:** **返回值:**
...@@ -356,13 +357,13 @@ lightWeightMap.remove("sdfs"); ...@@ -356,13 +357,13 @@ lightWeightMap.remove("sdfs");
removeAt(index: number): boolean removeAt(index: number): boolean
删除指定下标的元素。 删除指定下标对应的元素。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| index | number | 是 | 指定想要删除元素下标 | | index | number | 是 | 指定下标。 |
**返回值:** **返回值:**
...@@ -376,7 +377,7 @@ removeAt(index: number): boolean ...@@ -376,7 +377,7 @@ removeAt(index: number): boolean
let lightWeightMap = new LightWeightMap(); let lightWeightMap = new LightWeightMap();
lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
lightWeightMap.set("sdfs", 356); lightWeightMap.set("sdfs", 356);
lightWeightMap.removeAt(1); let result = lightWeightMap.removeAt(1);
``` ```
...@@ -384,13 +385,13 @@ lightWeightMap.removeAt(1); ...@@ -384,13 +385,13 @@ lightWeightMap.removeAt(1);
setValueAt(index: number, newValue: V): boolean setValueAt(index: number, newValue: V): boolean
向LightWeightMap中具体位置替换键值对中的值 替换指定下标对应键值对中的元素
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| index | number | 是 | 指定替换数据下标。 | | index | number | 是 | 指定下标。 |
| newValue | V | 是 | 替换键值对中的值。 | | newValue | V | 是 | 替换键值对中的值。 |
**返回值:** **返回值:**
...@@ -413,19 +414,19 @@ lightWeightMap.setValueAt(1, 3546); ...@@ -413,19 +414,19 @@ lightWeightMap.setValueAt(1, 3546);
getValueAt(index: number): V getValueAt(index: number): V
获取LightWeightMap中具体位置键值对中的值 获取指定下标对应键值对中的元素
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| index | number | 是 | 指定查询数据下标 | | index | number | 是 | 指定下标。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| V | 返回指定位置中键值对的值。 | | V | 返回指定下标对应键值对中的元素。 |
**示例:** **示例:**
...@@ -433,7 +434,7 @@ getValueAt(index: number): V ...@@ -433,7 +434,7 @@ getValueAt(index: number): V
let lightWeightMap = new LightWeightMap(); let lightWeightMap = new LightWeightMap();
lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
lightWeightMap.set("sdfs", 356); lightWeightMap.set("sdfs", 356);
lightWeightMap.getValueAt(1); let result = lightWeightMap.getValueAt(1);
``` ```
...@@ -509,7 +510,7 @@ while(temp != undefined) { ...@@ -509,7 +510,7 @@ while(temp != undefined) {
### forEach ### forEach
forEach(callbackfn: (value: V, key?: K, lightWeightMap?: LightWeightMap<K, V>) => void, thisArg?: Object): void forEach(callbackfn: (value: V, key?: K, map?: LightWeightMap<K, V>) => void, thisArg?: Object): void
通过回调函数来遍历实例对象上的元素以及元素对应的下标。 通过回调函数来遍历实例对象上的元素以及元素对应的下标。
...@@ -525,7 +526,7 @@ callbackfn的参数说明: ...@@ -525,7 +526,7 @@ callbackfn的参数说明:
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | V | 是 | 当前遍历到的元素键值对的值。 | | value | V | 是 | 当前遍历到的元素键值对的值。 |
| key | K | 是 | 当前遍历到的元素键值对的键。 | | key | K | 是 | 当前遍历到的元素键值对的键。 |
| lightWeightMap | LightWeightMap<K, V> | 否 | 当前调用forEach方法的实例对象。 | | map | LightWeightMap<K, V> | 否 | 当前调用forEach方法的实例对象。 |
**示例:** **示例:**
...@@ -543,7 +544,7 @@ lightWeightMap.forEach((value, key) => { ...@@ -543,7 +544,7 @@ lightWeightMap.forEach((value, key) => {
entries(): IterableIterator<[K, V]> entries(): IterableIterator<[K, V]>
返回包含此映射中包含的元素的新迭代器对象。 返回包含此映射中包含的键值对的新迭代器对象。
**返回值:** **返回值:**
...@@ -566,6 +567,26 @@ while(temp != undefined) { ...@@ -566,6 +567,26 @@ while(temp != undefined) {
} }
``` ```
### toString
toString(): string
将此映射中包含的键值对拼接成字符串,并返回字符串类型。
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| string | 返回一个字符串。 |
**示例:**
```
let lightWeightMap = new LightWeightMap();
lightWeightMap.set("A", 123);
lightWeightMap.set("sdfs", 356);
let iter = lightWeightMap.toString();
```
### [Symbol.iterator] ### [Symbol.iterator]
......
...@@ -53,12 +53,12 @@ isEmpty(): boolean ...@@ -53,12 +53,12 @@ isEmpty(): boolean
``` ```
const lightWeightSet = new LightWeightSet(); const lightWeightSet = new LightWeightSet();
lightWeightSet.isEmpty(); let result = lightWeightSet.isEmpty();
``` ```
### add ### add
add(value: T): boolean add(obj: T): boolean
向此容器中添加数据。 向此容器中添加数据。
...@@ -66,7 +66,7 @@ add(value: T): boolean ...@@ -66,7 +66,7 @@ add(value: T): boolean
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | T | 是 | 添加的成员数据。 | | obj | T | 是 | 添加的成员数据。 |
**返回值:** **返回值:**
...@@ -78,7 +78,7 @@ add(value: T): boolean ...@@ -78,7 +78,7 @@ add(value: T): boolean
``` ```
let lightWeightSet = new LightWeightSet(); let lightWeightSet = new LightWeightSet();
lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result = lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
``` ```
...@@ -92,7 +92,7 @@ addAll(set: LightWeightSet&lt;T&gt;): boolean ...@@ -92,7 +92,7 @@ addAll(set: LightWeightSet&lt;T&gt;): boolean
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| set | LightWeightSet&lt;T&gt; | 是 | 提供添加元素的LightWeightSet。 | | set | LightWeightSet&lt;T&gt; | 是 | 提供添加元素的lightWeightSet。 |
**示例:** **示例:**
...@@ -102,7 +102,7 @@ lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); ...@@ -102,7 +102,7 @@ lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
lightWeightSet.add("sdfs"); lightWeightSet.add("sdfs");
let set = new LightWeightSet(); let set = new LightWeightSet();
set.add("sfage"); set.add("sfage");
lightWeightSet.addAll(set); let result = lightWeightSet.addAll(set);
``` ```
...@@ -138,29 +138,29 @@ let result = lightWeightSet.hasAll(set); ...@@ -138,29 +138,29 @@ let result = lightWeightSet.hasAll(set);
### has ### has
has(value: T): boolean; has(key: T): boolean
判断此容器中是否含有该指定value 判断此容器中是否含有该指定key
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | T | 是 | 指定元素 | | value | T | 是 | 指定key |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| boolean | 包含指定元素返回true,否则返回false。 | | boolean | 包含指定key返回true,否则返回false。 |
**示例:** **示例:**
``` ```
let lightWeightSet = new LightWeightSet(); let lightWeightSet = new LightWeightSet();
lightWeightSet.has(123); let result = lightWeightSet.has(123);
lightWeightSet.add(123); lightWeightSet.add(123);
lightWeightSet.has(123); let result = lightWeightSet.has(123);
``` ```
...@@ -195,7 +195,7 @@ let result = lightWeightSet.equal(obj); ...@@ -195,7 +195,7 @@ let result = lightWeightSet.equal(obj);
### ensureCapacityTo ### ensureCapacityTo
ensureCapacityTo(minimumCapacity: number): void increaseCapacityTo(minimumCapacity: number): void
将当前容器扩容至可以容纳指定数量元素。 将当前容器扩容至可以容纳指定数量元素。
...@@ -229,7 +229,7 @@ getIndexOf(key: T): number ...@@ -229,7 +229,7 @@ getIndexOf(key: T): number
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| number | 在LightWeightSet中指定数据的下标。 | | number | 在lightWeightSet中指定数据的下标。 |
**示例:** **示例:**
...@@ -237,7 +237,7 @@ getIndexOf(key: T): number ...@@ -237,7 +237,7 @@ getIndexOf(key: T): number
let lightWeightSet = new LightWeightSet(); let lightWeightSet = new LightWeightSet();
lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
lightWeightSet.add("sdfs"); lightWeightSet.add("sdfs");
lightWeightSet.getIndexOf("sdfs"); let result = lightWeightSet.getIndexOf("sdfs");
``` ```
...@@ -245,13 +245,13 @@ lightWeightSet.getIndexOf("sdfs"); ...@@ -245,13 +245,13 @@ lightWeightSet.getIndexOf("sdfs");
remove(key: T): T remove(key: T): T
删除指定的元素。 删除并返回指定key对应的元素。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | T | 是 | 依据key指定删除的元素。 | | key | T | 是 | 指定key。 |
**返回值:** **返回值:**
...@@ -265,7 +265,7 @@ remove(key: T): T ...@@ -265,7 +265,7 @@ remove(key: T): T
let lightWeightSet = new LightWeightSet(); let lightWeightSet = new LightWeightSet();
lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
lightWeightSet.add("sdfs"); lightWeightSet.add("sdfs");
lightWeightSet.remove("sdfs"); let result = lightWeightSet.remove("sdfs");
``` ```
...@@ -273,13 +273,13 @@ lightWeightSet.remove("sdfs"); ...@@ -273,13 +273,13 @@ lightWeightSet.remove("sdfs");
removeAt(index: number): boolean removeAt(index: number): boolean
删除指定下标的元素。 删除指定下标所对应的元素。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| index | number | 是 | 指定想要删除元素下标。 | | index | number | 是 | 指定下标。 |
**返回值:** **返回值:**
...@@ -293,7 +293,7 @@ removeAt(index: number): boolean ...@@ -293,7 +293,7 @@ removeAt(index: number): boolean
let lightWeightSet = new LightWeightSet(); let lightWeightSet = new LightWeightSet();
lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
lightWeightSet.add("sdfs"); lightWeightSet.add("sdfs");
lightWeightSet.removeAt(1); let result = lightWeightSet.removeAt(1);
``` ```
...@@ -301,19 +301,19 @@ lightWeightSet.removeAt(1); ...@@ -301,19 +301,19 @@ lightWeightSet.removeAt(1);
getValueAt(index: number): T getValueAt(index: number): T
获取此容器中具体位置的元素。 获取此容器中指定下标对应的元素。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| index | number | 是 | 指定查询数据下标。 | | index | number | 是 | 指定下标。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| T | 返回指定位置中元素。 | | T | 返回指定下标对应的元素。 |
**参数:** **参数:**
...@@ -321,7 +321,7 @@ getValueAt(index: number): T ...@@ -321,7 +321,7 @@ getValueAt(index: number): T
let lightWeightSet = new LightWeightSet(); let lightWeightSet = new LightWeightSet();
lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
lightWeightSet.add("sdfs"); lightWeightSet.add("sdfs");
lightWeightSet.getValueAt(1); let result = lightWeightSet.getValueAt(1);
``` ```
...@@ -359,7 +359,7 @@ toString(): String ...@@ -359,7 +359,7 @@ toString(): String
let lightWeightSet = new LightWeightSet(); let lightWeightSet = new LightWeightSet();
lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
lightWeightSet.add("sdfs"); lightWeightSet.add("sdfs");
lightWeightSet.toString(); let result = lightWeightSet.toString();
``` ```
...@@ -381,7 +381,7 @@ toArray(): Array&lt;T&gt; ...@@ -381,7 +381,7 @@ toArray(): Array&lt;T&gt;
let lightWeightSet = new LightWeightSet(); let lightWeightSet = new LightWeightSet();
lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
lightWeightSet.add("sdfs"); lightWeightSet.add("sdfs");
lightWeightSet.toString(); let result = lightWeightSet.toArray();
``` ```
...@@ -389,7 +389,7 @@ lightWeightSet.toString(); ...@@ -389,7 +389,7 @@ lightWeightSet.toString();
values(): IterableIterator&lt;T&gt; values(): IterableIterator&lt;T&gt;
返回包含此映射中包含的键的新迭代器对象。 返回包含此映射中包含的键的新迭代器对象。
**返回值:** **返回值:**
...@@ -414,7 +414,7 @@ while(index < lightWeightSet.length) { ...@@ -414,7 +414,7 @@ while(index < lightWeightSet.length) {
### forEach ### forEach
forEach(callbackfn: (value: T, key?: T, lightWeightSet?: LightWeightSet&lt;T&gt;) => void, thisArg?: Object): void forEach(callbackfn: (value: T, key?: T, set?: LightWeightSet&lt;T&gt;) => void, thisArg?: Object): void
通过回调函数来遍历LightWeightSet实例对象上的元素以及元素对应的下标。 通过回调函数来遍历LightWeightSet实例对象上的元素以及元素对应的下标。
...@@ -430,7 +430,7 @@ callbackfn的参数说明: ...@@ -430,7 +430,7 @@ callbackfn的参数说明:
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 | | value | T | 是 | 当前遍历到的元素。 |
| key | T | 否 | 当前遍历到的元素(和value相同)。 | | key | T | 否 | 当前遍历到的元素(和value相同)。 |
| lightWeightSet | LightWeightSet&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 | | set | LightWeightSet&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
**示例:** **示例:**
...@@ -448,7 +448,7 @@ lightWeightSet.forEach((value, key) => { ...@@ -448,7 +448,7 @@ lightWeightSet.forEach((value, key) => {
entries(): IterableIterator<[T, T]> entries(): IterableIterator<[T, T]>
返回包含此映射中包含的键的新迭代器对象。 返回包含此映射中包含的键值对的新迭代器对象。
**返回值:** **返回值:**
......
...@@ -27,7 +27,7 @@ SystemCapability.Utils.Lang ...@@ -27,7 +27,7 @@ SystemCapability.Utils.Lang
### constructor ### constructor
constructor(_head?: NodeObj&lt;T&gt;, _tail?: NodeObj&lt;T&gt;) constructor(head?: NodeObj&lt;T&gt;, tail?: NodeObj&lt;T&gt;)
LinkedList的构造函数。 LinkedList的构造函数。
...@@ -35,8 +35,8 @@ LinkedList的构造函数。 ...@@ -35,8 +35,8 @@ LinkedList的构造函数。
| 参数名 | 类型 | 可读 | 可写 | 说明 | | 参数名 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| _head | NodeObj&lt;T&gt; | 是 | 否 | 节点对象,含有element、next指向和prev指向。 | | head | NodeObj&lt;T&gt; | 是 | 否 | 节点对象,含有element、next指向和prev指向。 |
| _tail | NodeObj&lt;T&gt; | 是 | 否 | 节点对象,含有element、next指向和prev指向。 | | tail | NodeObj&lt;T&gt; | 是 | 否 | 节点对象,含有element、next指向和prev指向。 |
**示例:** **示例:**
...@@ -67,12 +67,12 @@ add(element: T): boolean ...@@ -67,12 +67,12 @@ add(element: T): boolean
``` ```
let linkedList = new LinkedList(); let linkedList = new LinkedList();
linkedList.add("a"); let result = linkedList.add("a");
linkedList.add(1); let result = linkedList.add(1);
let b = [1, 2, 3]; let b = [1, 2, 3];
linkedList.add(b); linkedList.add(b);
let c = {name : "lala", age : "13"}; let c = {name : "lala", age : "13"};
linkedList.add(false); let result3 = linkedList.add(false);
``` ```
### addFirst ### addFirst
...@@ -101,7 +101,7 @@ linkedList.addFirst(false); ...@@ -101,7 +101,7 @@ linkedList.addFirst(false);
### insert ### insert
insert(element: T, index: number): void insert(index: number, element: T): void
在长度范围内任意插入指定元素。 在长度范围内任意插入指定元素。
...@@ -116,9 +116,9 @@ insert(element: T, index: number): void ...@@ -116,9 +116,9 @@ insert(element: T, index: number): void
``` ```
let linkedList = new LinkedList(); let linkedList = new LinkedList();
linkedList.insert("A", 0); linkedList.insert(0, "A");
linkedList.insert(0, 1); linkedList.insert(1, 0);
linkedList.insert(true, 2); linkedList.insert(2, true);
``` ```
### has ### has
...@@ -143,9 +143,9 @@ has(element: T): boolean ...@@ -143,9 +143,9 @@ has(element: T): boolean
``` ```
let linkedList = new LinkedList(); let linkedList = new LinkedList();
linkedList.has("Ahfbrgrbgnutfodgorrogorg"); let result1 = linkedList.has("Ahfbrgrbgnutfodgorrogorg");
linkedList.add("Ahfbrgrbgnutfodgorrogorg"); linkedList.add("Ahfbrgrbgnutfodgorrogorg");
linkedList.has("Ahfbrgrbgnutfodgorrogorg"); let result = linkedList.has("Ahfbrgrbgnutfodgorrogorg");
``` ```
### get ### get
...@@ -177,7 +177,7 @@ linkedList.add(2); ...@@ -177,7 +177,7 @@ linkedList.add(2);
linkedList.add(1); linkedList.add(1);
linkedList.add(2); linkedList.add(2);
linkedList.add(4); linkedList.add(4);
linkedList.get(2); let result = linkedList.get(2);
``` ```
### getLastIndexOf ### getLastIndexOf
...@@ -209,7 +209,7 @@ linkedList.add(2); ...@@ -209,7 +209,7 @@ linkedList.add(2);
linkedList.add(1); linkedList.add(1);
linkedList.add(2); linkedList.add(2);
linkedList.add(4); linkedList.add(4);
linkedList.getLastIndexOf(2); let result = linkedList.getLastIndexOf(2);
``` ```
### getIndexOf ### getIndexOf
...@@ -241,7 +241,7 @@ linkedList.add(2); ...@@ -241,7 +241,7 @@ linkedList.add(2);
linkedList.add(1); linkedList.add(1);
linkedList.add(2); linkedList.add(2);
linkedList.add(4); linkedList.add(4);
linkedList.getIndexOf(2); let result = linkedList.getIndexOf(2);
``` ```
### removeByIndex ### removeByIndex
...@@ -271,7 +271,7 @@ linkedList.add(4); ...@@ -271,7 +271,7 @@ linkedList.add(4);
linkedList.add(5); linkedList.add(5);
linkedList.add(2); linkedList.add(2);
linkedList.add(4); linkedList.add(4);
linkedList.removeByIndex(2); let result = linkedList.removeByIndex(2);
``` ```
### removeFirst ### removeFirst
...@@ -295,7 +295,7 @@ linkedList.add(4); ...@@ -295,7 +295,7 @@ linkedList.add(4);
linkedList.add(5); linkedList.add(5);
linkedList.add(2); linkedList.add(2);
linkedList.add(4); linkedList.add(4);
linkedList.removeFirst(); let result = linkedList.removeFirst();
``` ```
### removeLast ### removeLast
...@@ -319,14 +319,14 @@ linkedList.add(4); ...@@ -319,14 +319,14 @@ linkedList.add(4);
linkedList.add(5); linkedList.add(5);
linkedList.add(2); linkedList.add(2);
linkedList.add(4); linkedList.add(4);
linkedList.removeLast(); let result = linkedList.removeLast();
``` ```
### remove ### remove
remove(element: T): boolean remove(element: T): boolean
删除指定的元素。 删除查找到的第一个指定的元素。
**参数:** **参数:**
...@@ -348,7 +348,7 @@ linkedList.add(2); ...@@ -348,7 +348,7 @@ linkedList.add(2);
linkedList.add(4); linkedList.add(4);
linkedList.add(5); linkedList.add(5);
linkedList.add(4); linkedList.add(4);
linkedList.remove(2); let result = linkedList.remove(2);
``` ```
### removeFirstFound ### removeFirstFound
...@@ -377,7 +377,7 @@ linkedList.add(2); ...@@ -377,7 +377,7 @@ linkedList.add(2);
linkedList.add(4); linkedList.add(4);
linkedList.add(5); linkedList.add(5);
linkedList.add(4); linkedList.add(4);
linkedList.removeFirstFound(4); let result = linkedList.removeFirstFound(4);
``` ```
### removeLastFound ### removeLastFound
...@@ -406,7 +406,7 @@ linkedList.add(2); ...@@ -406,7 +406,7 @@ linkedList.add(2);
linkedList.add(4); linkedList.add(4);
linkedList.add(5); linkedList.add(5);
linkedList.add(4); linkedList.add(4);
linkedList.removeLastFound(4); let result = linkedList.removeLastFound(4);
``` ```
### clone ### clone
...@@ -430,11 +430,11 @@ linkedList.add(2); ...@@ -430,11 +430,11 @@ linkedList.add(2);
linkedList.add(4); linkedList.add(4);
linkedList.add(5); linkedList.add(5);
linkedList.add(4); linkedList.add(4);
linkedList.clone(); let result = linkedList.clone();
``` ```
### forEach ### forEach
forEach(callbackfn: (value: T, index?: number, linkedlist?: LinkedList&lt;T&gt;) => void, forEach(callbackfn: (value: T, index?: number, LinkedList?: LinkedList&lt;T&gt;) => void,
thisArg?: Object): void thisArg?: Object): void
通过回调函数来遍历LinkedList实例对象上的元素以及元素对应的下标。 通过回调函数来遍历LinkedList实例对象上的元素以及元素对应的下标。
...@@ -452,7 +452,7 @@ callbackfn的参数说明: ...@@ -452,7 +452,7 @@ callbackfn的参数说明:
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 | | value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 | | index | number | 否 | 当前遍历到的下标值。 |
| linkedlist | LinkedList&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 | | LinkedList | LinkedList&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
**示例:** **示例:**
...@@ -484,8 +484,7 @@ linkedList.clear(); ...@@ -484,8 +484,7 @@ linkedList.clear();
``` ```
### set ### set
set(index: number, element: T): void set(index: number, element: T): T
将此LinkedList中指定位置的元素替换为指定元素。 将此LinkedList中指定位置的元素替换为指定元素。
**参数:** **参数:**
...@@ -495,6 +494,12 @@ set(index: number, element: T): void ...@@ -495,6 +494,12 @@ set(index: number, element: T): void
| index | number | 是 | 查找的下标值。 | | index | number | 是 | 查找的下标值。 |
| element | T | 是 | 用来替换的元素。 | | element | T | 是 | 用来替换的元素。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| T | 返回替换后的元素。 |
**示例:** **示例:**
``` ```
...@@ -503,7 +508,7 @@ linkedList.add(2); ...@@ -503,7 +508,7 @@ linkedList.add(2);
linkedList.add(4); linkedList.add(4);
linkedList.add(5); linkedList.add(5);
linkedList.add(4); linkedList.add(4);
linkedList.set(2, "b"); let result = linkedList.set(2, "b");
``` ```
### convertToArray ### convertToArray
...@@ -524,7 +529,7 @@ linkedList.add(2); ...@@ -524,7 +529,7 @@ linkedList.add(2);
linkedList.add(4); linkedList.add(4);
linkedList.add(5); linkedList.add(5);
linkedList.add(4); linkedList.add(4);
linkedList.convertToArray(); let result = linkedList.convertToArray();
``` ```
### getFirst ### getFirst
...@@ -547,7 +552,7 @@ linkedList.add(2); ...@@ -547,7 +552,7 @@ linkedList.add(2);
linkedList.add(4); linkedList.add(4);
linkedList.add(5); linkedList.add(5);
linkedList.add(4); linkedList.add(4);
linkedList.getFirst(); let result = linkedList.getFirst();
``` ```
### getLast ### getLast
......
...@@ -27,7 +27,7 @@ SystemCapability.Utils.Lang ...@@ -27,7 +27,7 @@ SystemCapability.Utils.Lang
### constructor ### constructor
constructor(_head?: NodeObj&lt;T&gt;) constructor(head?: NodeObj&lt;T&gt;)
List的构造函数。 List的构造函数。
...@@ -35,7 +35,7 @@ List的构造函数。 ...@@ -35,7 +35,7 @@ List的构造函数。
| 参数名 | 类型 | 可读 | 说明 | | 参数名 | 类型 | 可读 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| _head | NodeObj&lt;T&gt; | 是 | 节点对象,含有element、next指向。 | | head | NodeObj&lt;T&gt; | 是 | 节点对象,含有element、next指向。 |
**示例:** **示例:**
...@@ -66,12 +66,12 @@ add(element: T): boolean ...@@ -66,12 +66,12 @@ add(element: T): boolean
``` ```
let list = new List; let list = new List;
list.add("a"); let result = list.add("a");
list.add(1); let result1 = list.add(1);
let b = [1, 2, 3]; let b = [1, 2, 3];
list.add(b); list.add(b);
let c = {name : "lala", age : "13"}; let c = {name : "lala", age : "13"};
list.add(false); let result3 = list.add(false);
``` ```
### insert ### insert
...@@ -118,9 +118,9 @@ has(element: T): boolean ...@@ -118,9 +118,9 @@ has(element: T): boolean
``` ```
let list = new List(); let list = new List();
list.has("Ahfbrgrbgnutfodgorrogorg"); let result = list.has("Ahfbrgrbgnutfodgorrogorg");
list.add("Ahfbrgrbgnutfodgorrogorg"); list.add("Ahfbrgrbgnutfodgorrogorg");
list.has("Ahfbrgrbgnutfodgorrogorg"); let result1 = list.has("Ahfbrgrbgnutfodgorrogorg");
``` ```
### get ### get
...@@ -152,7 +152,7 @@ list.add(2); ...@@ -152,7 +152,7 @@ list.add(2);
list.add(1); list.add(1);
list.add(2); list.add(2);
list.add(4); list.add(4);
list.get(2); let result = list.get(2);
``` ```
### getLastIndexOf ### getLastIndexOf
...@@ -184,7 +184,7 @@ list.add(2); ...@@ -184,7 +184,7 @@ list.add(2);
list.add(1); list.add(1);
list.add(2); list.add(2);
list.add(4); list.add(4);
list.getLastIndexOf(2); let result = list.getLastIndexOf(2);
``` ```
### getIndexOf ### getIndexOf
...@@ -203,7 +203,7 @@ getIndexOf(element: T): number ...@@ -203,7 +203,7 @@ getIndexOf(element: T): number
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| number | 返回第一次找到指定元素的下标,没有找到返回-1 | | number | 返回第一次找到指定元素的下标,没有找到返回-1 |
**示例:** **示例:**
...@@ -217,6 +217,7 @@ list.add(1); ...@@ -217,6 +217,7 @@ list.add(1);
list.add(2); list.add(2);
list.add(4); list.add(4);
list.getIndexOf(2); list.getIndexOf(2);
let result = list.getIndexOf(2);
``` ```
### equal ### equal
...@@ -251,7 +252,7 @@ obj1.add(4); ...@@ -251,7 +252,7 @@ obj1.add(4);
obj1.add(5); obj1.add(5);
list.equal(obj1); list.equal(obj1);
let obj2 = {name : "lala", age : "13"}; let obj2 = {name : "lala", age : "13"};
list.equal(obj2); let result = list.equal(obj2);
``` ```
### removeByIndex ### removeByIndex
...@@ -281,7 +282,7 @@ list.add(4); ...@@ -281,7 +282,7 @@ list.add(4);
list.add(5); list.add(5);
list.add(2); list.add(2);
list.add(4); list.add(4);
list.removeByIndex(2); let result = list.removeByIndex(2);
``` ```
### remove ### remove
...@@ -294,7 +295,7 @@ remove(element: T): boolean ...@@ -294,7 +295,7 @@ remove(element: T): boolean
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| element | T | 是 | 指定元素 | | element | T | 是 | 指定元素 |
**返回值:** **返回值:**
...@@ -310,7 +311,7 @@ list.add(2); ...@@ -310,7 +311,7 @@ list.add(2);
list.add(4); list.add(4);
list.add(5); list.add(5);
list.add(4); list.add(4);
list.remove(2); let result = list.remove(2);
``` ```
### replaceAllElements ### replaceAllElements
...@@ -332,7 +333,7 @@ callbackfn的参数说明: ...@@ -332,7 +333,7 @@ callbackfn的参数说明:
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 | | value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 | | index | number | 否 | 当前遍历到的下标值。 |
| list | List&lt;T&gt; | 否 | 当前调用replaceAllElements方法的实例对象 | | list | List&lt;T&gt; | 否 | 当前调用replaceAllElements方法的实例对象 |
**示例:** **示例:**
...@@ -351,7 +352,7 @@ list.replaceAllElements((value, index) => { ...@@ -351,7 +352,7 @@ list.replaceAllElements((value, index) => {
``` ```
### forEach ### forEach
forEach(callbackfn: (value: T, index?: number, list?: List&lt;T&gt;) => void, forEach(callbackfn: (value: T, index?: number, List?: List&lt;T&gt;) => void,
thisArg?: Object): void thisArg?: Object): void
通过回调函数来遍历List实例对象上的元素以及元素对应的下标。 通过回调函数来遍历List实例对象上的元素以及元素对应的下标。
...@@ -360,8 +361,8 @@ thisArg?: Object): void ...@@ -360,8 +361,8 @@ thisArg?: Object): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callbackfn | function | 是 | 回调函数 | | callbackfn | function | 是 | 回调函数 |
| thisArg | Object | 否 | callbackfn被调用时用作this值 | | thisArg | Object | 否 | callbackfn被调用时用作this值 |
callbackfn的参数说明: callbackfn的参数说明:
...@@ -369,7 +370,7 @@ callbackfn的参数说明: ...@@ -369,7 +370,7 @@ callbackfn的参数说明:
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 | | value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 | | index | number | 否 | 当前遍历到的下标值。 |
| list | List&lt;T&gt; | 否 | 当前调用forEach方法的实例对象 | | List | List&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
**示例:** **示例:**
...@@ -431,7 +432,7 @@ getSubList(fromIndex: number, toIndex: number): List&lt;T&gt; ...@@ -431,7 +432,7 @@ getSubList(fromIndex: number, toIndex: number): List&lt;T&gt;
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| List&lt;T&gt; | 返回List对象实例 | | List&lt;T&gt; | 返回List对象实例 |
**示例:** **示例:**
...@@ -441,9 +442,9 @@ list.add(2); ...@@ -441,9 +442,9 @@ list.add(2);
list.add(4); list.add(4);
list.add(5); list.add(5);
list.add(4); list.add(4);
list.subList(2, 4); let result = list.subList(2, 4);
list.subList(4, 3); let result1 = list.subList(4, 3);
list.subList(2, 6); let result2 = list.subList(2, 6);
``` ```
### clear ### clear
...@@ -463,7 +464,7 @@ list.clear(); ...@@ -463,7 +464,7 @@ list.clear();
``` ```
### set ### set
set(index: number, element: T): void set(index: number, element: T): T
将此 List 中指定位置的元素替换为指定元素。 将此 List 中指定位置的元素替换为指定元素。
**参数:** **参数:**
...@@ -473,6 +474,12 @@ set(index: number, element: T): void ...@@ -473,6 +474,12 @@ set(index: number, element: T): void
| index | number | 是 | 查找的下标值。 | | index | number | 是 | 查找的下标值。 |
| element | T | 是 | 用来替换的元素。 | | element | T | 是 | 用来替换的元素。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| T | 返回替换后的元素 |
**示例:** **示例:**
``` ```
...@@ -504,7 +511,7 @@ list.add(2); ...@@ -504,7 +511,7 @@ list.add(2);
list.add(4); list.add(4);
list.add(5); list.add(5);
list.add(4); list.add(4);
list.convertToArray(); let result = list.convertToArray();
``` ```
### isEmpty ### isEmpty
...@@ -526,7 +533,7 @@ list.add(2); ...@@ -526,7 +533,7 @@ list.add(2);
list.add(4); list.add(4);
list.add(5); list.add(5);
list.add(4); list.add(4);
list.isEmpty(); let result = list.isEmpty();
``` ```
### getFirst ### getFirst
...@@ -549,7 +556,7 @@ list.add(2); ...@@ -549,7 +556,7 @@ list.add(2);
list.add(4); list.add(4);
list.add(5); list.add(5);
list.add(4); list.add(4);
list.getFirst(); let result = list.getFirst();
``` ```
### getLast ### getLast
...@@ -572,7 +579,7 @@ list.add(2); ...@@ -572,7 +579,7 @@ list.add(2);
list.add(4); list.add(4);
list.add(5); list.add(5);
list.add(4); list.add(4);
list.getLast(); let result = list.getLast();
``` ```
### [Symbol.iterator] ### [Symbol.iterator]
......
...@@ -53,7 +53,7 @@ isEmpty(): boolean ...@@ -53,7 +53,7 @@ isEmpty(): boolean
``` ```
const plainArray = new PlainArray(); const plainArray = new PlainArray();
plainArray.isEmpty(); let result = plainArray.isEmpty();
``` ```
...@@ -67,13 +67,13 @@ has(key: number): boolean ...@@ -67,13 +67,13 @@ has(key: number): boolean
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | number | 是 | 查询的元素。 | | key | number | 是 | 指定key。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| boolean | 包含指定元素返回true,否则返回false。 | | boolean | 包含指定key返回true,否则返回false。 |
**示例:** **示例:**
...@@ -81,7 +81,7 @@ has(key: number): boolean ...@@ -81,7 +81,7 @@ has(key: number): boolean
let plainArray = new PlainArray(); let plainArray = new PlainArray();
plainArray.has(1); plainArray.has(1);
plainArray.add(1, "sddfhf"); plainArray.add(1, "sddfhf");
plainArray.has(1); let result1 = plainArray.has(1);
``` ```
...@@ -109,7 +109,7 @@ get(key: number): T ...@@ -109,7 +109,7 @@ get(key: number): T
let plainArray = new PlainArray(); let plainArray = new PlainArray();
plainArray.add(1, "sddfhf"); plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf"); plainArray.add(2, "sffdfhf");
plainArray.get(1); let result = plainArray.get(1);
``` ```
...@@ -123,13 +123,13 @@ getIndexOfKey(key: number): number; ...@@ -123,13 +123,13 @@ getIndexOfKey(key: number): number;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | number | 是 | 被查找的元素。 | | key | number | 是 | 指定key。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| number | 返回指定元素第一次出现时的下标值,查找失败返回-1。 | | number | 返回指定key第一次出现时的下标值,查找失败返回-1。 |
**示例:** **示例:**
...@@ -137,7 +137,7 @@ getIndexOfKey(key: number): number; ...@@ -137,7 +137,7 @@ getIndexOfKey(key: number): number;
let plainArray = new PlainArray(); let plainArray = new PlainArray();
plainArray.add(1, "sddfhf"); plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf"); plainArray.add(2, "sffdfhf");
plainArray.getIndexOfKey("sdfs"); let result = plainArray.getIndexOfKey("sdfs");
``` ```
...@@ -151,7 +151,7 @@ getIndexOfValue(value: T): number; ...@@ -151,7 +151,7 @@ getIndexOfValue(value: T): number;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | T | 是 | 被查找的元素。 | | value | T | 是 | 指定元素。 |
**返回值:** **返回值:**
...@@ -165,7 +165,7 @@ getIndexOfValue(value: T): number; ...@@ -165,7 +165,7 @@ getIndexOfValue(value: T): number;
let plainArray = new PlainArray(); let plainArray = new PlainArray();
plainArray.add(1, "sddfhf"); plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf"); plainArray.add(2, "sffdfhf");
plainArray.getIndexOfValue("sddfhf"); let result = plainArray.getIndexOfValue("sddfhf");
``` ```
...@@ -179,13 +179,13 @@ getKeyAt(index: number): number; ...@@ -179,13 +179,13 @@ getKeyAt(index: number): number;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| index | number | 是 | 所查找的下标。 | | index | number | 是 | 指定下标。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| number | 返回该下标对应的元素键值对中key值,失败返回undefined。 | | number | 返回该下标对应的元素键值对中key值,失败返回-1。 |
**示例:** **示例:**
...@@ -193,17 +193,41 @@ getKeyAt(index: number): number; ...@@ -193,17 +193,41 @@ getKeyAt(index: number): number;
let plainArray = new PlainArray(); let plainArray = new PlainArray();
plainArray.add(1, "sddfhf"); plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf"); plainArray.add(2, "sffdfhf");
plainArray.getKeyAt(1); let result = plainArray.getKeyAt(1);
``` ```
### getValueAt
getValueAt(index: number): T
查找指定下标元素键值对中Value值,否则返回undefined。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定下标。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| T | 返回该下标对应的元素键值对中key值,失败返回undefined。 |
**示例:**
```
let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
let result = plainArray.getKeyAt(1);
```
### clone ### clone
clone(): PlainArray&lt;T&gt; clone(): PlainArray&lt;T&gt;
克隆一个实例,并返回克隆后的实例。 克隆一个实例,并返回克隆后的实例。修改克隆后的实例并不会影响原实例。
修改克隆后的实例并不会影响原实例。
**返回值:** **返回值:**
...@@ -223,7 +247,7 @@ let newPlainArray = plainArray.clone(); ...@@ -223,7 +247,7 @@ let newPlainArray = plainArray.clone();
### add ### add
add(key: number, value: T): boolean add(key: number, value: T): void
向容器中添加一组数据。 向容器中添加一组数据。
...@@ -234,12 +258,6 @@ add(key: number, value: T): boolean ...@@ -234,12 +258,6 @@ add(key: number, value: T): boolean
| key | number | 是 | 添加成员数据的键名。 | | key | number | 是 | 添加成员数据的键名。 |
| value | T | 是 | 添加成员数据的值。 | | value | T | 是 | 添加成员数据的值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 成功添加返回true,否则返回false。 |
**示例:** **示例:**
``` ```
...@@ -252,13 +270,13 @@ plainArray.add(1, "sddfhf"); ...@@ -252,13 +270,13 @@ plainArray.add(1, "sddfhf");
remove(key: number): T remove(key: number): T
删除指定元素。 删除指定key对应元素。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | number | 是 | 根据key删除的指定元素。 | | key | number | 是 | 指定key。 |
**返回值:** **返回值:**
...@@ -273,14 +291,15 @@ let plainArray = new PlainArray(); ...@@ -273,14 +291,15 @@ let plainArray = new PlainArray();
plainArray.add(1, "sddfhf"); plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf"); plainArray.add(2, "sffdfhf");
plainArray.remove(2); plainArray.remove(2);
let result = plainArray.remove(2);
``` ```
### removeAt ### removeAt
removeAt(index: number): boolean; removeAt(index: number): T
删除指定下标的元素。 删除指定下标对应的元素。
**参数:** **参数:**
...@@ -292,7 +311,7 @@ removeAt(index: number): boolean; ...@@ -292,7 +311,7 @@ removeAt(index: number): boolean;
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| boolean | 成功删除元素返回true,否则返回false。 | | T | 返回删除的元素。 |
**示例:** **示例:**
...@@ -301,6 +320,7 @@ let plainArray = new PlainArray(); ...@@ -301,6 +320,7 @@ let plainArray = new PlainArray();
plainArray.add(1, "sddfhf"); plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf"); plainArray.add(2, "sffdfhf");
plainArray.removeAt(1); plainArray.removeAt(1);
let result = plainArray.removeAt(1);
``` ```
...@@ -329,22 +349,22 @@ removeRangeFrom(index: number, size: number): number ...@@ -329,22 +349,22 @@ removeRangeFrom(index: number, size: number): number
let plainArray = new PlainArray(); let plainArray = new PlainArray();
plainArray.add(1, "sddfhf"); plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf"); plainArray.add(2, "sffdfhf");
plainArray.removeAt(1, 3); let result = plainArray.removeRangeFrom(1, 3);
``` ```
### setValueAt ### setValueAt
setValueAt(index: number, newValue: T): void setValueAt(index: number, value: T): void
向容器中具体位置替换键值对中的值。 替换容器中指定下标对应键值对中的键值。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| index | number | 是 | 指定替换数据下标。 | | index | number | 是 | 指定替换数据下标。 |
| newValue | T | 是 | 替换键值对中的值。 | | value | T | 是 | 替换键值对中的值。 |
**示例:** **示例:**
...@@ -374,7 +394,7 @@ toString(): String ...@@ -374,7 +394,7 @@ toString(): String
let plainArray = new PlainArray(); let plainArray = new PlainArray();
plainArray.add(1, "sddfhf"); plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf"); plainArray.add(2, "sffdfhf");
plainArray.toString(); let result = plainArray.toString();
``` ```
...@@ -396,7 +416,7 @@ plainArray.clear(); ...@@ -396,7 +416,7 @@ plainArray.clear();
### forEach ### forEach
forEach(callbackfn: (value: T, key?: number, plainArray?: PlainArray<number, T>) => void, thisArg?: Object): void forEach(callbackfn: (value: T, key?: number, PlainArray?: PlainArray<number, T>) => void, thisArg?: Object): void
通过回调函数来遍历实例对象上的元素以及元素对应的下标。 通过回调函数来遍历实例对象上的元素以及元素对应的下标。
......
...@@ -60,12 +60,13 @@ add(element: T): boolean ...@@ -60,12 +60,13 @@ add(element: T): boolean
``` ```
let queue = new Queue(); let queue = new Queue();
queue.add("a"); let result = queue.add("a");
let result1 = queue.add(1);
queue.add(1); queue.add(1);
let b = [1, 2, 3]; let b = [1, 2, 3];
queue.add(b); queue.add(b);
let c = {name : "lala", age : "13"}; let c = {name : "lala", age : "13"};
queue.add(false); let result3 = queue.add(c);
``` ```
### pop ### pop
...@@ -89,7 +90,7 @@ queue.add(4); ...@@ -89,7 +90,7 @@ queue.add(4);
queue.add(5); queue.add(5);
queue.add(2); queue.add(2);
queue.add(4); queue.add(4);
queue.pop(); let result = queue.pop();
``` ```
### getFirst ### getFirst
...@@ -112,11 +113,11 @@ queue.add(2); ...@@ -112,11 +113,11 @@ queue.add(2);
queue.add(4); queue.add(4);
queue.add(5); queue.add(5);
queue.add(2); queue.add(2);
queue.getFirst(); let result = queue.getFirst();
``` ```
### forEach ### forEach
forEach(callbackfn: (value: T, index?: number, queue?: Queue&lt;T&gt;) => void, forEach(callbackfn: (value: T, index?: number, Queue?: Queue&lt;T&gt;) => void,
thisArg?: Object): void thisArg?: Object): void
通过回调函数来遍历Queue实例对象上的元素以及元素对应的下标。 通过回调函数来遍历Queue实例对象上的元素以及元素对应的下标。
...@@ -132,9 +133,9 @@ callbackfn的参数说明: ...@@ -132,9 +133,9 @@ callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素 | | value | T | 是 | 当前遍历到的元素 |
| index | number | 否 | 当前遍历到的下标值 | | index | number | 否 | 当前遍历到的下标值 |
| queue | Queue&lt;T&gt; | 否 | 当前调用forEach方法的实例对象 | | Queue | Queue&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
**示例:** **示例:**
...@@ -161,7 +162,7 @@ queue.forEach((value, index) => { ...@@ -161,7 +162,7 @@ queue.forEach((value, index) => {
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| IterableIterator&lt;T&gt; | 返回一个迭代器 | | IterableIterator&lt;T&gt; | 返回一个迭代器 |
**示例:** **示例:**
``` ```
......
...@@ -60,12 +60,12 @@ push(item: T): T ...@@ -60,12 +60,12 @@ push(item: T): T
``` ```
let stack = new Stack(); let stack = new Stack();
stack.push("a"); let result = stack.push("a");
stack.push(1); let result1 = stack.push(1);
let b = [1, 2, 3]; let b = [1, 2, 3];
stack.push(b); stack.push(b);
let c = {name : "lala", age : "13"}; let c = {name : "lala", age : "13"};
stack.push(false); let result3 = stack.push(c);
``` ```
### pop ### pop
...@@ -89,7 +89,7 @@ stack.push(4); ...@@ -89,7 +89,7 @@ stack.push(4);
stack.push(5); stack.push(5);
stack.push(2); stack.push(2);
stack.push(4); stack.push(4);
stack.pop(); let result = stack.pop();
``` ```
### peek ### peek
...@@ -112,7 +112,7 @@ stack.push(2); ...@@ -112,7 +112,7 @@ stack.push(2);
stack.push(4); stack.push(4);
stack.push(5); stack.push(5);
stack.push(2); stack.push(2);
stack.peek(); let result = stack.peek();
``` ```
### locate ### locate
...@@ -141,7 +141,7 @@ stack.push(2); ...@@ -141,7 +141,7 @@ stack.push(2);
stack.push(4); stack.push(4);
stack.push(5); stack.push(5);
stack.push(2); stack.push(2);
stack.locate(2); let result = stack.locate(2);
``` ```
### forEach ### forEach
...@@ -197,7 +197,7 @@ stack.push(2); ...@@ -197,7 +197,7 @@ stack.push(2);
stack.push(4); stack.push(4);
stack.push(5); stack.push(5);
stack.push(4); stack.push(4);
stack.isEmpty(); let result = stack.isEmpty();
``` ```
### [Symbol.iterator] ### [Symbol.iterator]
......
...@@ -21,7 +21,7 @@ SystemCapability.Utils.Lang ...@@ -21,7 +21,7 @@ SystemCapability.Utils.Lang
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| length | number | 是 | 否 | TreeMap的元素个数 | | length | number | 是 | 否 | TreeMap的元素个数 |
### constructor ### constructor
...@@ -59,7 +59,7 @@ isEmpty(): boolean; ...@@ -59,7 +59,7 @@ isEmpty(): boolean;
``` ```
const treeMap = new TreeMap(); const treeMap = new TreeMap();
treeMap.isEmpty(); let result = treeMap.isEmpty();
``` ```
...@@ -73,21 +73,21 @@ hasKey(key: K): boolean; ...@@ -73,21 +73,21 @@ hasKey(key: K): boolean;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | K | 是 | 指定元素 | | key | K | 是 | 指定key |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| boolean | 包含指定元素返回true,否则返回false。 | | boolean | 包含指定key返回true,否则返回false。 |
**示例:** **示例:**
``` ```
let treeMap = new TreeMap(); let treeMap = new TreeMap();
treeMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result = treeMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
treeMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result1 = treeMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
``` ```
...@@ -95,7 +95,7 @@ treeMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); ...@@ -95,7 +95,7 @@ treeMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
hasValue(value: V): boolean hasValue(value: V): boolean
判断此容器中是否含有该指定value 判断此容器中是否含有该指定元素
**参数:** **参数:**
...@@ -113,9 +113,9 @@ hasValue(value: V): boolean ...@@ -113,9 +113,9 @@ hasValue(value: V): boolean
``` ```
let treeMap = new TreeMap(); let treeMap = new TreeMap();
treeMap.hasValue(123); let result = treeMap.hasValue(123);
treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
treeMap.hasValue(123); let result1 = treeMap.hasValue(123);
``` ```
...@@ -129,7 +129,7 @@ get(key: K): V ...@@ -129,7 +129,7 @@ get(key: K): V
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | K | 是 | 查找的指定key。 | | key | K | 是 | 指定key。 |
**返回值:** **返回值:**
...@@ -143,7 +143,7 @@ get(key: K): V ...@@ -143,7 +143,7 @@ get(key: K): V
let treeMap = new TreeMap(); let treeMap = new TreeMap();
treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
treeMap.set("sdfs", 356); treeMap.set("sdfs", 356);
treeMap.get("sdfs"); let result = treeMap.get("sdfs");
``` ```
...@@ -151,13 +151,13 @@ treeMap.get("sdfs"); ...@@ -151,13 +151,13 @@ treeMap.get("sdfs");
getFirstKey(): K; getFirstKey(): K;
获取容器中排序第一的数据 获取容器中排序第一的key
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| K | 返回排序第一的数据。 | | K | 返回排序第一的key。 |
**示例:** **示例:**
...@@ -173,13 +173,13 @@ let result = treeMap.getFirstKey(); ...@@ -173,13 +173,13 @@ let result = treeMap.getFirstKey();
getLastKey(): K; getLastKey(): K;
获取容器中排序最后的数据 获取容器中排序最后的key
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| K | 返回排序最后的数据 | | K | 返回排序最后的key |
**示例:** **示例:**
...@@ -195,13 +195,13 @@ let result = treeMap.getLastKey(); ...@@ -195,13 +195,13 @@ let result = treeMap.getLastKey();
setAll(map: TreeMap<K, V>): void setAll(map: TreeMap<K, V>): void
将一个treemap中的所有元素组添加到另一个treemap中。 将一个treemap中的所有元素组添加到另一个treeMap中。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| map | TreeMap<K, V> | 是 | 被添加元素的TreeMap。 | | map | TreeMap<K, V> | 是 | 被添加元素的treeMap。 |
**示例:** **示例:**
...@@ -230,7 +230,7 @@ set(key: K, value: V): Object ...@@ -230,7 +230,7 @@ set(key: K, value: V): Object
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Object | 返回添加后的treemap | | Object | 返回添加后的treeMap |
**示例:** **示例:**
...@@ -244,13 +244,13 @@ treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); ...@@ -244,13 +244,13 @@ treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
remove(key: K): V; remove(key: K): V;
删除指定的元素。 删除指定key对应的元素。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | K | 是 | 依据key指定删除的元素。 | | key | K | 是 | 指定key。 |
**返回值:** **返回值:**
...@@ -268,9 +268,9 @@ treeMap.remove("sdfs"); ...@@ -268,9 +268,9 @@ treeMap.remove("sdfs");
``` ```
### getLowerByKey ### getLowerKey
getLowerByKey(key: K): K getLowerKey(key: K): K
获取容器中比传入key排序靠前一位的key。 获取容器中比传入key排序靠前一位的key。
...@@ -293,13 +293,13 @@ let treeMap = new TreeMap(); ...@@ -293,13 +293,13 @@ let treeMap = new TreeMap();
treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
treeMap.set("sdfs", 356); treeMap.set("sdfs", 356);
treeMap.set("zdfgsd", 356); treeMap.set("zdfgsd", 356);
let result = treeMap.getLowerByKey("sdfs"); let result = treeMap.getLowerKey("sdfs");
``` ```
### getHigherByKey ### getHigherKey
getHigherByKey(key: K): K getHigherKey(key: K): K
获取容器中比传入key排序靠后一位的key。 获取容器中比传入key排序靠后一位的key。
...@@ -322,12 +322,11 @@ let treeMap = new TreeMap(); ...@@ -322,12 +322,11 @@ let treeMap = new TreeMap();
treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
treeMap.set("sdfs", 356); treeMap.set("sdfs", 356);
treeMap.set("zdfgsd", 356); treeMap.set("zdfgsd", 356);
let result = treeMap.getHigherByKey("sdfs"); let result = treeMap.getHigherKey("sdfs");
``` ```
### replace ### replace
replace(key: K, value: V): boolean replace(key: K, newValue: V): boolean
对TreeMap中一组数据进行更新(替换)。 对TreeMap中一组数据进行更新(替换)。
...@@ -335,21 +334,21 @@ replace(key: K, value: V): boolean ...@@ -335,21 +334,21 @@ replace(key: K, value: V): boolean
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | K | 是 | 依据key指定替换的元素。 | | key | K | 是 | 指定key。 |
| value | V | 是 | 成员数据的新值。 | | newValue | V | 是 | 替换的元素。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| boolean | 成功对已有数据进行替换返回true,否则返回false。 | | boolean | 对指定key对应的元素替换成功返回true,否则返回false。 |
**示例:** **示例:**
``` ```
let treeMap = new TreeMap(); let treeMap = new TreeMap();
treeMap.set("sdfs", 123); treeMap.set("sdfs", 123);
treeMap.replace("sdfs", 357); let result = treeMap.replace("sdfs", 357);
``` ```
...@@ -425,7 +424,7 @@ while(temp != undefined) { ...@@ -425,7 +424,7 @@ while(temp != undefined) {
### forEach ### forEach
forEach(callbackfn: (value: V, key?: K, treeMap?: TreeMap<K, V>) => void, thisArg?: Object): void forEach(callbackfn: (value: V, key?: K, map?: TreeMap<K, V>) => void, thisArg?: Object): void
通过回调函数来遍历实例对象上的元素以及元素对应的下标。 通过回调函数来遍历实例对象上的元素以及元素对应的下标。
...@@ -441,7 +440,7 @@ callbackfn的参数说明: ...@@ -441,7 +440,7 @@ callbackfn的参数说明:
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | V | 是 | 当前遍历到的元素键值对的值。 | | value | V | 是 | 当前遍历到的元素键值对的值。 |
| key | K | 是 | 当前遍历到的元素键值对的键。 | | key | K | 是 | 当前遍历到的元素键值对的键。 |
| treeMap | TreeMap<K, V> | 否 | 当前调用forEach方法的实例对象。 | | map | TreeMap<K, V> | 否 | 当前调用forEach方法的实例对象。 |
**示例:** **示例:**
...@@ -459,7 +458,7 @@ treeMap.forEach((value, key) => { ...@@ -459,7 +458,7 @@ treeMap.forEach((value, key) => {
entries(): IterableIterator<[K, V]> entries(): IterableIterator<[K, V]>
返回包含此映射中包含的元素的新迭代器对象。 返回包含此映射中包含的键值对的新迭代器对象。
**返回值:** **返回值:**
......
...@@ -59,7 +59,7 @@ isEmpty(): boolean ...@@ -59,7 +59,7 @@ isEmpty(): boolean
``` ```
const treeSet = new TreeSet(); const treeSet = new TreeSet();
treeSet.isEmpty(); let result = treeSet.isEmpty();
``` ```
...@@ -67,7 +67,7 @@ treeSet.isEmpty(); ...@@ -67,7 +67,7 @@ treeSet.isEmpty();
has(value: T): boolean has(value: T): boolean
判断此容器中是否含有该指定value 判断此容器中是否含有该指定元素
**参数:** **参数:**
...@@ -87,7 +87,7 @@ has(value: T): boolean ...@@ -87,7 +87,7 @@ has(value: T): boolean
let treeSet = new TreeSet(); let treeSet = new TreeSet();
treeSet.has(123); treeSet.has(123);
treeSet.add(123); treeSet.add(123);
treeSet.has(123); let result1 = treeSet.has(123);
``` ```
...@@ -156,13 +156,13 @@ add(value: T): boolean ...@@ -156,13 +156,13 @@ add(value: T): boolean
``` ```
let treeSet = new TreeSet(); let treeSet = new TreeSet();
treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result = treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
``` ```
### remove ### remove
remove(key: T): boolean remove(value: T): boolean;
删除指定的元素。 删除指定的元素。
...@@ -170,7 +170,7 @@ remove(key: T): boolean ...@@ -170,7 +170,7 @@ remove(key: T): boolean
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| key | T | 是 | 指定的元素。 | | value | T | 是 | 指定的元素。 |
**返回值:** **返回值:**
...@@ -184,7 +184,7 @@ remove(key: T): boolean ...@@ -184,7 +184,7 @@ remove(key: T): boolean
let treeSet = new TreeSet(); let treeSet = new TreeSet();
treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
treeSet.add("sdfs"); treeSet.add("sdfs");
treeSet.remove("sdfs"); let result = treeSet.remove("sdfs");
``` ```
...@@ -233,7 +233,7 @@ getHigherValue(key: T): T ...@@ -233,7 +233,7 @@ getHigherValue(key: T): T
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| T | 返回排序中传入元素后一位的数据 | | T | 返回排序中传入元素后一位的数据 |
**示例:** **示例:**
...@@ -278,7 +278,7 @@ popLast(): T ...@@ -278,7 +278,7 @@ popLast(): T
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| T | 返回删除的数据 | | T | 返回删除的数据 |
**返回值:** **返回值:**
...@@ -335,7 +335,7 @@ while(temp != undefined) { ...@@ -335,7 +335,7 @@ while(temp != undefined) {
### forEach ### forEach
forEach(callbackfn: (value: T, key?: T, treeSet?: TreeSet&lt;T&gt;) => void, thisArg?: Object): void forEach(callbackfn: (value: T, key?: T, set?: TreeSet&lt;T&gt;) => void, thisArg?: Object): void
通过回调函数来遍历实例对象上的元素以及元素对应的下标。 通过回调函数来遍历实例对象上的元素以及元素对应的下标。
...@@ -351,7 +351,7 @@ callbackfn的参数说明: ...@@ -351,7 +351,7 @@ callbackfn的参数说明:
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 | | value | T | 是 | 当前遍历到的元素。 |
| key | T | 否 | 当前遍历到的元素(和value相同)。 | | key | T | 否 | 当前遍历到的元素(和value相同)。 |
| treeSet | TreeSet&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 | | set | TreeSet&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
**示例:** **示例:**
...@@ -369,7 +369,7 @@ treeSet.forEach((value, key) => { ...@@ -369,7 +369,7 @@ treeSet.forEach((value, key) => {
entries(): IterableIterator<[T, T]> entries(): IterableIterator<[T, T]>
返回包含此映射中包含的元素的新迭代器对象。 返回包含此映射中包含的键值对的新迭代器对象。
**返回值:** **返回值:**
......
...@@ -48,24 +48,24 @@ add(element: T): boolean ...@@ -48,24 +48,24 @@ add(element: T): boolean
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| element | T | 是 | 添加进去的元素 | | element | T | 是 | 添加进去的元素 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| boolean | 插入成功返回true,失败返回false | | boolean | 插入成功返回true,失败返回false |
**示例:** **示例:**
``` ```
let vector = new Vector(); let vector = new Vector();
vector.add("a"); let result = vector.add("a");
vector.add(1); let result1 = vector.add(1);
let b = [1, 2, 3]; let b = [1, 2, 3];
vector.add(b); vector.add(b);
let c = {name : "lala", age : "13"}; let c = {name : "lala", age : "13"};
vector.add(false); let result3 = vector.add(c);
``` ```
### insert ### insert
...@@ -78,8 +78,8 @@ insert(element: T, index: number): void ...@@ -78,8 +78,8 @@ insert(element: T, index: number): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| element | T | 是 | 被插入的元素 | | element | T | 是 | 被插入的元素 |
| index | number | 是 | 被插入的位置索引 | | index | number | 是 | 被插入的位置索引 |
**示例:** **示例:**
...@@ -100,21 +100,21 @@ has(element: T): boolean ...@@ -100,21 +100,21 @@ has(element: T): boolean
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| element | T | 是 | 指定的元素 | | element | T | 是 | 指定的元素 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| boolean | 是否包含指定元素 | | boolean | 是否包含指定元素 |
**示例:** **示例:**
``` ```
let vector = new Vector(); let vector = new Vector();
vector.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result = vector.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
vector.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); vector.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
vector.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); let result = vector.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
``` ```
### getIndexOf ### getIndexOf
...@@ -127,13 +127,13 @@ getIndexOf(element: T): number ...@@ -127,13 +127,13 @@ getIndexOf(element: T): number
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| element | T | 是 | 指定的元素 | | element | T | 是 | 指定的元素 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| number | 返回指定元素第一次出现时的下标值,查找失败返回-1 | | number | 返回指定元素第一次出现时的下标值,查找失败返回-1 |
**示例:** **示例:**
...@@ -146,7 +146,7 @@ vector.add(2); ...@@ -146,7 +146,7 @@ vector.add(2);
vector.add(1); vector.add(1);
vector.add(2); vector.add(2);
vector.add(4); vector.add(4);
vector.getIndexOf(2); let result = vector.getIndexOf(2);
``` ```
### getLastIndexOf ### getLastIndexOf
...@@ -178,7 +178,7 @@ vector.add(2); ...@@ -178,7 +178,7 @@ vector.add(2);
vector.add(1); vector.add(1);
vector.add(2); vector.add(2);
vector.add(4); vector.add(4);
vector.getLastIndexOf(2); let result = vector.getLastIndexOf(2);
``` ```
### removeByIndex ### removeByIndex
...@@ -208,7 +208,7 @@ vector.add(4); ...@@ -208,7 +208,7 @@ vector.add(4);
vector.add(5); vector.add(5);
vector.add(2); vector.add(2);
vector.add(4); vector.add(4);
vector.removeByIndex(2); let result = vector.removeByIndex(2);
``` ```
### remove ### remove
...@@ -237,7 +237,7 @@ vector.add(2); ...@@ -237,7 +237,7 @@ vector.add(2);
vector.add(4); vector.add(4);
vector.add(5); vector.add(5);
vector.add(4); vector.add(4);
vector.remove(2); let result = vector.remove(2);
``` ```
### removeByRange ### removeByRange
...@@ -282,9 +282,9 @@ callbackfn的参数说明: ...@@ -282,9 +282,9 @@ callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素 | | value | T | 是 | 当前遍历到的元素 |
| index | number | 否 | 当前遍历到的下标值 | | index | number | 否 | 当前遍历到的下标值 |
| vector | Vector&lt;T&gt; | 否 | 当前调用replaceAllElements方法的实例对象 | | vector | Vector&lt;T&gt; | 否 | 当前调用replaceAllElements方法的实例对象 |
**示例:** **示例:**
...@@ -377,8 +377,8 @@ subVector(fromIndex: number, toIndex: number): Vector&lt;T&gt; ...@@ -377,8 +377,8 @@ subVector(fromIndex: number, toIndex: number): Vector&lt;T&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| fromIndex | number | 是 | 起始下标 | | fromIndex | number | 是 | 起始下标 |
| toIndex | number | 是 | 终止下标 | | toIndex | number | 是 | 终止下标 |
**返回值:** **返回值:**
...@@ -394,9 +394,9 @@ vector.add(2); ...@@ -394,9 +394,9 @@ vector.add(2);
vector.add(4); vector.add(4);
vector.add(5); vector.add(5);
vector.add(4); vector.add(4);
vector.subVector(2,4); let result = vector.subVector(2,4);
vector.subVector(4,3); let result1 = vector.subVector(4,3);
vector.subVector(2,6); let result2 = vector.subVector(2,6);
``` ```
...@@ -419,15 +419,13 @@ vector.clear(); ...@@ -419,15 +419,13 @@ vector.clear();
### clone ### clone
clone(): Vector&lt;T&gt; clone(): Vector&lt;T&gt;
克隆一个与Vector相同的实例,并返回克隆后的实例。 克隆一个与Vector相同的实例,并返回克隆后的实例。修改克隆后的实例并不会影响原实例。
修改克隆后的实例并不会影响原实例。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Vector&lt;T&gt; | 返回Vector对象实例 | | Vector&lt;T&gt; | 返回Vector对象实例 |
**示例:** **示例:**
...@@ -437,7 +435,7 @@ vector.add(2); ...@@ -437,7 +435,7 @@ vector.add(2);
vector.add(4); vector.add(4);
vector.add(5); vector.add(5);
vector.add(4); vector.add(4);
vector.clone(); let result = vector.clone();
``` ```
### getCapacity ### getCapacity
...@@ -459,7 +457,7 @@ vector.add(2); ...@@ -459,7 +457,7 @@ vector.add(2);
vector.add(4); vector.add(4);
vector.add(5); vector.add(5);
vector.add(4); vector.add(4);
vector.getCapacity(); let result = vector.getCapacity();
``` ```
### convertToArray ### convertToArray
...@@ -481,7 +479,7 @@ vector.add(2); ...@@ -481,7 +479,7 @@ vector.add(2);
vector.add(4); vector.add(4);
vector.add(5); vector.add(5);
vector.add(4); vector.add(4);
vector.convertToArray(); let result = vector.convertToArray();
``` ```
### isEmpty ### isEmpty
...@@ -503,7 +501,7 @@ vector.add(2); ...@@ -503,7 +501,7 @@ vector.add(2);
vector.add(4); vector.add(4);
vector.add(5); vector.add(5);
vector.add(4); vector.add(4);
vector.isEmpty(); let result = vector.isEmpty();
``` ```
### increaseCapacityTo ### increaseCapacityTo
...@@ -565,13 +563,12 @@ vector.add(2); ...@@ -565,13 +563,12 @@ vector.add(2);
vector.add(4); vector.add(4);
vector.add(5); vector.add(5);
vector.add(4); vector.add(4);
vector.toSting(); let result = vector.toSting();
``` ```
### copyToArray ### copyToArray
copyToArray(array: Array&lt;T&gt;): void; copyToArray(array: Array&lt;T&gt;): void
将Vector实例中的元素按照下标复制到指定数组。 将Vector实例中的元素按照下标复制到指定数组。
**参数:** **参数:**
...@@ -589,7 +586,7 @@ vector.add(4); ...@@ -589,7 +586,7 @@ vector.add(4);
vector.add(5); vector.add(5);
vector.add(4); vector.add(4);
let array = ["a", "b", "c", "d", "e", "f"]; let array = ["a", "b", "c", "d", "e", "f"];
vector.copyToArray(array); let result = vector.copyToArray(array);
``` ```
### getFirstElement ### getFirstElement
...@@ -612,7 +609,7 @@ vector.add(2); ...@@ -612,7 +609,7 @@ vector.add(2);
vector.add(4); vector.add(4);
vector.add(5); vector.add(5);
vector.add(4); vector.add(4);
vector.getFirstElement(); let result = vector.getFirstElement();
``` ```
### getLastElement ### getLastElement
...@@ -635,7 +632,7 @@ vector.add(2); ...@@ -635,7 +632,7 @@ vector.add(2);
vector.add(4); vector.add(4);
vector.add(5); vector.add(5);
vector.add(4); vector.add(4);
vector.getLastElement(); let result = vector.getLastElement();
``` ```
### getLastIndexFrom ### getLastIndexFrom
...@@ -666,12 +663,12 @@ vector.add(4); ...@@ -666,12 +663,12 @@ vector.add(4);
vector.add(5); vector.add(5);
vector.add(4); vector.add(4);
vector.add("a"); vector.add("a");
vector.getLastIndexFrom(4,3); let result = vector.getLastIndexFrom(4,3);
``` ```
### getIndexFrom ### getIndexFrom
getIndexFrom(element: T, index: number): number; getIndexFrom(element: T, index: number): number
从指定索引向前搜索,返回该元素的下标索引。 从指定索引向前搜索,返回该元素的下标索引。
...@@ -697,11 +694,11 @@ vector.add(4); ...@@ -697,11 +694,11 @@ vector.add(4);
vector.add(5); vector.add(5);
vector.add(4); vector.add(4);
vector.add("a"); vector.add("a");
vector.getIndexFrom(4, 3); let result = vector.getIndexFrom(4, 3);
``` ```
### setLength ### setLength
setLength(newSize: number): void; setLength(newSize: number): void
设置Vector实例的元素个数。 设置Vector实例的元素个数。
...@@ -723,6 +720,59 @@ vector.setLength(8); ...@@ -723,6 +720,59 @@ vector.setLength(8);
vector.setLength(2); vector.setLength(2);
``` ```
### get
get(index: number): T
根据下标值获取Vector实例中的元素。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 查找的下标值。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| T | 返回获取到的元素。 |
**示例:**
```
let vector = new Vector();
vector.add(2);
vector.add(4);
vector.add(5);
vector.add(4);
let result = vector.get(2);
```
### set
set(index: number, element: T): T
替换指定下标对应的元素。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定下标。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| T | 返回替换后的元素。 |
**示例:**
```
let vector = new Vector();
vector.add(2);
vector.add(4);
vector.add(5);
vector.add(4);
let result = vector.set(2, "A");
```
### [Symbol.iterator] ### [Symbol.iterator]
[Symbol.iterator]\(): IterableIterator&lt;T&gt; [Symbol.iterator]\(): IterableIterator&lt;T&gt;
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册