OpenHarmony語言基礎(chǔ)類庫【@ohos.util.LightWeightSet (非線性容器LightWeightSet)】

LightWeightSet可用于存儲一系列值的集合，存儲元素中value值唯一。

LightWeightSet依據(jù)泛型定義，采用輕量級結(jié)構(gòu)，初始默認(rèn)容量大小為8，每次擴(kuò)容大小為原始容量的兩倍。

集合中value值的查找依賴于hash算法，通過一個數(shù)組存儲hash值，然后映射到其他數(shù)組中的value值。

LightWeightSet和[HashSet]都是用來存儲鍵值的集合，LightWeightSet的占用內(nèi)存更小。

推薦使用場景： 當(dāng)需要存取某個集合或是對某個集合去重時，推薦使用占用內(nèi)存更小的LightWeightSet。

文檔中存在泛型的使用，涉及以下泛型標(biāo)記符：

• T：Type，類

說明：

本模塊首批接口從API version 8開始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。

導(dǎo)入模塊

import LightWeightSet from '@ohos.util.LightWeightSet';

LightWeightSet

屬性

系統(tǒng)能力： SystemCapability.Utils.Lang

鴻蒙開發(fā)指導(dǎo)文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]點(diǎn)擊或者復(fù)制轉(zhuǎn)到。

constructor

constructor()

LightWeightSet的構(gòu)造函數(shù)。

系統(tǒng)能力： SystemCapability.Utils.Lang

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]。

示例：

let lightWeightSet = new LightWeightSet();

isEmpty

isEmpty(): boolean

判斷該容器是否為空。

系統(tǒng)能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]。

示例：

const lightWeightSet = new LightWeightSet();
let result = lightWeightSet.isEmpty();

add

add(obj: T): boolean

向此容器中添加數(shù)據(jù)。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]。

示例：

let lightWeightSet = new LightWeightSet();
let result = lightWeightSet.add("squirrel");

addAll

addAll(set: LightWeightSet): boolean

將另一個容器中的所有元素組添加到當(dāng)前容器中。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]。

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("squirrel");
lightWeightSet.add("sparrow");
let set = new LightWeightSet();
set.add("gull");
let result = lightWeightSet.addAll(set);

hasAll

hasAll(set: LightWeightSet): boolean

判斷此容器中是否含有該指定set中的所有元素。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]。

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("squirrel");
lightWeightSet.add("sparrow");
let set = new LightWeightSet();
set.add("sparrow");
let result = lightWeightSet.hasAll(set);

has

has(key: T): boolean

判斷此容器中是否含有該指定key。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]。

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add(123);
let result = lightWeightSet.has(123);

equal

equal(obj: Object): boolean

判斷此容器中是否含有該指定obj同類型的對象。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]。

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("squirrel");
lightWeightSet.add("sparrow");
let obj = ["sparrow", "squirrel"];
let result = lightWeightSet.equal(obj);

increaseCapacityTo

increaseCapacityTo(minimumCapacity: number): void

將當(dāng)前容器擴(kuò)容至可以容納指定數(shù)量元素。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.increaseCapacityTo(10);

getIndexOf

getIndexOf(key: T): number

獲取指定key所對應(yīng)的下標(biāo)。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("squirrel");
lightWeightSet.add("sparrow");
let result = lightWeightSet.getIndexOf("sparrow");

remove

remove(key: T): T

刪除并返回指定key對應(yīng)的元素。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("squirrel");
lightWeightSet.add("sparrow");
let result = lightWeightSet.remove("sparrow");

removeAt

removeAt(index: number): boolean

刪除指定下標(biāo)所對應(yīng)的元素。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("squirrel");
lightWeightSet.add("sparrow");
let result = lightWeightSet.removeAt(1);

getValueAt

getValueAt(index: number): T

獲取此容器中指定下標(biāo)對應(yīng)的元素。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]

參數(shù)：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("squirrel");
lightWeightSet.add("sparrow");
let result = lightWeightSet.getValueAt(1);

clear

clear(): void

清除容器中的所有元素，并把length置為0。

系統(tǒng)能力： SystemCapability.Utils.Lang

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("squirrel");
lightWeightSet.add("sparrow");
lightWeightSet.clear();

toString

toString(): String

獲取包含容器中所有鍵和值的字符串。

系統(tǒng)能力： SystemCapability.Utils.Lang

返回值：

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("squirrel");
lightWeightSet.add("sparrow");
let result = lightWeightSet.toString();

toArray

toArray(): Array

獲取包含此容器中所有對象的數(shù)組。

系統(tǒng)能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("squirrel");
lightWeightSet.add("sparrow");
let result = lightWeightSet.toArray();

values

values(): IterableIterator

返回包含此映射中包含的鍵值的新迭代器對象。

系統(tǒng)能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]。

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("squirrel");
lightWeightSet.add("sparrow");
let iter = lightWeightSet.values();
let index = 0;
while(index < lightWeightSet.length) {
  console.log(JSON.stringify(iter.next().value));
  index++;
}

forEach

forEach(callbackFn: (value?: T, key?: T, set?: LightWeightSet) => void, thisArg?: Object): void

通過回調(diào)函數(shù)來遍歷LightWeightSet實例對象上的元素以及元素對應(yīng)的下標(biāo)。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

callbackfn的參數(shù)說明：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]。

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("sparrow");
lightWeightSet.add("gull");
lightWeightSet.forEach((value, key) = > {
    console.log("value:" + value, "key:" + key);
});

entries

entries(): IterableIterator<[T, T]>

返回包含此映射中包含的鍵值對的新迭代器對象。

系統(tǒng)能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]。

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("squirrel");
lightWeightSet.add("sparrow");
let iter = lightWeightSet.entries();
let index = 0;
while(index < lightWeightSet.length) {
  console.log(JSON.stringify(iter.next().value));
  index++;
}

[Symbol.iterator]

HarmonyOS與OpenHarmony鴻蒙文檔籽料：mau123789是v直接拿

Symbol.iterator: IterableIterator

返回一個迭代器，迭代器的每一項都是一個 JavaScript 對象,并返回該對象。

系統(tǒng)能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見[語言基礎(chǔ)類庫錯誤碼]。

示例：

let lightWeightSet = new LightWeightSet();
lightWeightSet.add("squirrel");
lightWeightSet.add("sparrow");

// 使用方法一：
for (let item of lightWeightSet) { 
  console.log("value:" + item);
}

// 使用方法二：
let iter = lightWeightSet[Symbol.iterator]();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("value:" + temp);
  temp = iter.next().value;
}

審核編輯 黃宇