1# @ohos.util.Vector (线性容器Vector) 2 3Vector是一种线性数据结构，底层基于数组实现。当Vector的内存用尽时，会自动分配更大的连续内存区，将原先的元素复制到新的内存区，并释放旧的内存区。使用Vector能够高效快速地访问元素。 4 5Vector和[ArrayList](js-apis-arraylist.md)相似，都是基于数组实现，但Vector提供了更多操作数组的接口。它们都可以动态调整容量，但Vector每次扩容增加1倍，ArrayList只扩容0.5倍。 6 7**推荐使用场景：** 当数据量大时，一般使用Vector来存取数据。 8 9文档中存在泛型的使用，涉及以下泛型标记符：<br> 10- T：Type，类 11 12> **说明：** 13> 14> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 15> 16> API version 9开始，该接口不再维护，推荐使用接口['@ohos.util.ArrayList'](js-apis-arraylist.md)。 17 18## 导入模块 19 20```ts 21import { Vector } from '@kit.ArkTS'; 22``` 23 24 25## Vector 26 27### 属性 28 29**系统能力：** SystemCapability.Utils.Lang 30 31| 名称 | 类型 | 可读 | 可写 | 说明 | 32| -------- | -------- | -------- | -------- | -------- | 33| length | number | 是 | 否 | Vector的元素个数。 | 34 35 36### constructor 37 38constructor() 39 40Vector的构造函数。 41 42**系统能力：** SystemCapability.Utils.Lang 43 44**示例：** 45 46```ts 47let vector : Vector<string | number | Array<number>> = new Vector(); 48``` 49 50 51### add 52 53add(element: T): boolean 54 55在Vector中尾部插入元素。 56 57**系统能力：** SystemCapability.Utils.Lang 58 59**参数：** 60 61| 参数名 | 类型 | 必填 | 说明 | 62| -------- | -------- | -------- | -------- | 63| element | T | 是 | 添加进去的元素。 | 64 65**返回值：** 66 67| 类型 | 说明 | 68| -------- | -------- | 69| boolean | 插入成功返回true，失败返回false。 | 70 71**示例：** 72 73```ts 74class C1 { 75 name: string = "" 76 age: string = "" 77} 78let vector : Vector<string | number | C1 | Array<number>> = new Vector(); 79let result = vector.add("a"); 80let result1 = vector.add(1); 81let b = [1, 2, 3]; 82let result2 = vector.add(b); 83let c: C1 = {name : "Jack", age : "13"}; 84let result3 = vector.add(c); 85``` 86 87### insert 88 89insert(element: T, index: number): void 90 91在长度范围内任意插入指定元素，并将其后续元素向右移动。 92 93**系统能力：** SystemCapability.Utils.Lang 94 95**参数：** 96 97| 参数名 | 类型 | 必填 | 说明 | 98| -------- | -------- | -------- | -------- | 99| element | T | 是 | 被插入的元素。 | 100| index | number | 是 | 被插入的位置索引。 | 101 102**示例：** 103 104```ts 105let vector : Vector<string | number | Object | Array<number>> = new Vector(); 106vector.insert("A", 0); 107vector.insert(0, 1); 108vector.insert(true, 2); 109``` 110 111### has 112 113has(element: T): boolean 114 115判断此Vector中是否含有该指定元素。 116 117**系统能力：** SystemCapability.Utils.Lang 118 119**参数：** 120 121| 参数名 | 类型 | 必填 | 说明 | 122| -------- | -------- | -------- | -------- | 123| element | T | 是 | 指定的元素。 | 124 125**返回值：** 126 127| 类型 | 说明 | 128| -------- | -------- | 129| boolean | 是否包含指定元素，true表示包含该元素，false表示不包含。 | 130 131**示例：** 132 133```ts 134let vector : Vector<string> = new Vector(); 135let result = vector.has("squirrel"); 136vector.add("squirrel"); 137let result1 = vector.has("squirrel"); 138``` 139 140### getIndexOf 141 142getIndexOf(element: T): number 143 144返回指定元素第一次出现时的下标值，查找失败返回-1。 145 146**系统能力：** SystemCapability.Utils.Lang 147 148**参数：** 149 150| 参数名 | 类型 | 必填 | 说明 | 151| -------- | -------- | -------- | -------- | 152| element | T | 是 | 指定的元素。 | 153 154**返回值：** 155 156| 类型 | 说明 | 157| -------- | -------- | 158| number | 返回指定元素第一次出现时的下标值，查找失败返回-1。 | 159 160**示例：** 161 162```ts 163let vector : Vector<number> = new Vector(); 164vector.add(2); 165vector.add(4); 166vector.add(5); 167vector.add(2); 168vector.add(1); 169vector.add(2); 170vector.add(4); 171let result = vector.getIndexOf(2); 172``` 173 174### getLastIndexOf 175 176getLastIndexOf(element: T): number 177 178返回指定元素最后一次出现时的下标值，查找失败返回-1。 179 180**系统能力：** SystemCapability.Utils.Lang 181 182**参数：** 183 184| 参数名 | 类型 | 必填 | 说明 | 185| -------- | -------- | -------- | -------- | 186| element | T | 是 | 指定元素。 | 187 188**返回值：** 189 190| 类型 | 说明 | 191| -------- | -------- | 192| number | 返回指定元素最后一次出现时的下标值，查找失败返回-1。 | 193 194**示例：** 195 196```ts 197let vector : Vector<number> = new Vector(); 198vector.add(2); 199vector.add(4); 200vector.add(5); 201vector.add(2); 202vector.add(1); 203vector.add(2); 204vector.add(4); 205let result = vector.getLastIndexOf(2); 206``` 207 208### removeByIndex 209 210removeByIndex(index: number): T 211 212根据元素的下标值查找元素，返回元素后将其删除，并将其后续元素向左移动。 213 214**系统能力：** SystemCapability.Utils.Lang 215 216**参数：** 217 218| 参数名 | 类型 | 必填 | 说明 | 219| -------- | -------- | -------- | -------- | 220| index | number | 是 | 指定元素的下标值。 | 221 222**返回值：** 223 224| 类型 | 说明 | 225| -------- | -------- | 226| T | 返回被删除的元素。数组为空时返回undefined，下标越界时抛出异常。 | 227 228**示例：** 229 230```ts 231let vector : Vector<number> = new Vector(); 232vector.add(2); 233vector.add(4); 234vector.add(5); 235vector.add(2); 236vector.add(4); 237let result = vector.removeByIndex(2); 238``` 239 240### remove 241 242remove(element: T): boolean 243 244删除查找到的第一个指定的元素。 245 246**系统能力：** SystemCapability.Utils.Lang 247 248**参数：** 249 250| 参数名 | 类型 | 必填 | 说明 | 251| -------- | -------- | -------- | -------- | 252| element | T | 是 | 指定元素。 | 253 254**返回值：** 255 256| 类型 | 说明 | 257| -------- | -------- | 258| boolean | 删除成功返回true，否则返回false。 | 259 260**示例：** 261 262```ts 263let vector : Vector<number> = new Vector(); 264vector.add(2); 265vector.add(4); 266vector.add(5); 267vector.add(4); 268let result = vector.remove(2); 269``` 270 271### removeByRange 272 273removeByRange(fromIndex: number, toIndex: number): void 274 275从一段范围内删除元素，包括起始值但不包括终止值。 276 277**系统能力：** SystemCapability.Utils.Lang 278 279**参数：** 280 281| 参数名 | 类型 | 必填 | 说明 | 282| -------- | -------- | -------- | -------- | 283| fromIndex | number | 是 | 起始下标。 | 284| toIndex | number | 是 | 终止下标。 | 285 286**示例：** 287 288```ts 289let vector : Vector<number> = new Vector(); 290vector.add(2); 291vector.add(4); 292vector.add(5); 293vector.add(4); 294vector.removeByRange(2,4); 295``` 296 297### replaceAllElements 298 299replaceAllElements(callbackFn: (value: T, index?: number, vector?: Vector<T>) => T, 300thisArg?: Object): void 301 302用户操作Vector中的元素，用操作后的元素替换原元素并返回操作后的元素。 303 304**系统能力：** SystemCapability.Utils.Lang 305 306**参数：** 307 308| 参数名 | 类型 | 必填 | 说明 | 309| -------- | -------- | -------- | -------- | 310| callbackFn | function | 是 | 回调函数。 | 311| thisArg | Object | 否 | callbackfn被调用时用作this值，默认值为当前实例对象。 | 312 313callbackfn的参数说明： 314 315| 参数名 | 类型 | 必填 | 说明 | 316| -------- | -------- | -------- | -------- | 317| value | T | 是 | 当前遍历到的元素。 | 318| index | number | 否 | 当前遍历到的下标值，默认值为0。 | 319| vector | Vector<T> | 否 | 当前调用replaceAllElements方法的实例对象，默认值为当前实例对象。 | 320 321**示例：** 322 323```ts 324let vector : Vector<number> = new Vector(); 325vector.add(2); 326vector.add(4); 327vector.add(5); 328vector.add(4); 329vector.replaceAllElements((value : number) : number => { 330 // 用户操作逻辑根据实际场景进行添加。 331 return value; 332}); 333``` 334 335### forEach 336 337forEach(callbackFn: (value: T, index?: number, vector?: Vector<T>) => void, 338thisArg?: Object): void 339 340通过回调函数来遍历Vector实例对象上的元素以及元素对应的下标。 341 342**系统能力：** SystemCapability.Utils.Lang 343 344**参数：** 345 346| 参数名 | 类型 | 必填 | 说明 | 347| -------- | -------- | -------- | -------- | 348| callbackFn | function | 是 | 回调函数。 | 349| thisArg | Object | 否 | callbackfn被调用时用作this值，默认值为当前实例对象。 | 350 351callbackfn的参数说明： 352 353| 参数名 | 类型 | 必填 | 说明 | 354| -------- | -------- | -------- | -------- | 355| value | T | 是 | 当前遍历到的元素。 | 356| index | number | 否 | 当前遍历到的下标值，默认值为0。 | 357| vector | Vector<T> | 否 | 当前调用forEach方法的实例对象，默认值为当前实例对象。 | 358 359**示例：** 360 361```ts 362let vector : Vector<number> = new Vector(); 363vector.add(2); 364vector.add(4); 365vector.add(5); 366vector.add(4); 367vector.forEach((value : number, index ?: number) : void => { 368 console.log("value:" + value, "index:" + index); 369}); 370``` 371 372### sort 373 374sort(comparator?: (firstValue: T, secondValue: T) => number): void 375 376对Vector中的元素进行一个排序操作。 377 378**系统能力：** SystemCapability.Utils.Lang 379 380**参数：** 381 382| 参数名 | 类型 | 必填 | 说明 | 383| -------- | -------- | -------- | -------- | 384| comparator | function | 否 | 回调函数，默认值为当前实例对象。 | 385 386comparator的参数说明： 387 388| 参数名 | 类型 | 必填 | 说明 | 389| -------- | -------- | -------- | -------- | 390| firstValue | T | 是 | 前一项元素。 | 391| secondValue | T | 是 | 后一项元素。 | 392 393**示例：** 394 395```ts 396let vector : Vector<number> = new Vector(); 397vector.add(2); 398vector.add(4); 399vector.add(5); 400vector.add(4); 401vector.sort((a: number, b: number) => a - b); 402vector.sort((a: number, b: number) => b - a); 403vector.sort(); 404``` 405 406### subVector 407 408subVector(fromIndex: number, toIndex: number): Vector<T> 409 410根据下标截取Vector中的一段元素，并返回这一段vector实例，包括起始值但不包括终止值。 411 412**系统能力：** SystemCapability.Utils.Lang 413 414**参数：** 415 416| 参数名 | 类型 | 必填 | 说明 | 417| -------- | -------- | -------- | -------- | 418| fromIndex | number | 是 | 起始下标。 | 419| toIndex | number | 是 | 终止下标。 | 420 421**返回值：** 422 423| 类型 | 说明 | 424| -------- | -------- | 425| Vector<T> | 返回Vector对象实例。 | 426 427**示例：** 428 429```ts 430let vector : Vector<number> = new Vector(); 431vector.add(2); 432vector.add(4); 433vector.add(5); 434vector.add(4); 435vector.add(6); 436vector.add(8); 437let result = vector.subVector(0,4); 438let result1 = vector.subVector(2,4); 439 440``` 441 442### clear 443 444clear(): void 445 446清除Vector中的所有元素，并把length置为0。 447 448**系统能力：** SystemCapability.Utils.Lang 449 450**示例：** 451 452```ts 453let vector : Vector<number> = new Vector(); 454vector.add(2); 455vector.add(4); 456vector.add(5); 457vector.add(4); 458vector.clear(); 459``` 460 461### clone 462 463clone(): Vector<T> 464 465克隆一个与Vector相同的实例，并返回克隆后的实例。修改克隆后的实例并不会影响原实例。 466 467**系统能力：** SystemCapability.Utils.Lang 468 469**返回值：** 470 471| 类型 | 说明 | 472| -------- | -------- | 473| Vector<T> | 返回Vector对象实例。 | 474 475**示例：** 476 477```ts 478let vector : Vector<number> = new Vector(); 479vector.add(2); 480vector.add(4); 481vector.add(5); 482vector.add(4); 483let result = vector.clone(); 484``` 485 486### getCapacity 487 488getCapacity(): number 489 490获取当前实例的容量大小。 491 492**系统能力：** SystemCapability.Utils.Lang 493 494**返回值：** 495 496| 类型 | 说明 | 497| -------- | -------- | 498| number | 返回Vector的容量大小。 | 499 500**示例：** 501 502```ts 503let vector : Vector<number> = new Vector(); 504vector.add(2); 505vector.add(4); 506vector.add(5); 507vector.add(4); 508let result = vector.getCapacity(); 509``` 510 511### convertToArray 512 513convertToArray(): Array<T> 514 515把当前Vector实例转换成数组，并返回转换后的数组。 516 517**系统能力：** SystemCapability.Utils.Lang 518 519**返回值：** 520 521| 类型 | 说明 | 522| -------- | -------- | 523| Array<T> | 返回数组类型。 | 524 525**示例：** 526 527```ts 528let vector : Vector<number> = new Vector(); 529vector.add(2); 530vector.add(4); 531vector.add(5); 532vector.add(4); 533let result = vector.convertToArray(); 534``` 535 536### isEmpty 537 538isEmpty(): boolean 539 540判断该Vector是否为空。 541 542**系统能力：** SystemCapability.Utils.Lang 543 544**返回值：** 545 546| 类型 | 说明 | 547| -------- | -------- | 548| boolean | 为空返回true，否则返回false。 | 549 550**示例：** 551 552```ts 553let vector : Vector<number> = new Vector(); 554vector.add(2); 555vector.add(4); 556vector.add(5); 557vector.add(4); 558let result = vector.isEmpty(); 559``` 560 561### increaseCapacityTo 562 563increaseCapacityTo(newCapacity: number): void 564 565如果传入的新容量大于或等于Vector中的元素个数，将容量变更为新容量。 566 567**系统能力：** SystemCapability.Utils.Lang 568 569**参数：** 570 571| 参数名 | 类型 | 必填 | 说明 | 572| -------- | -------- | -------- | -------- | 573| newCapacity | number | 是 | 新容量。 | 574 575**示例：** 576 577```ts 578let vector : Vector<number> = new Vector(); 579vector.add(2); 580vector.add(4); 581vector.add(5); 582vector.add(4); 583vector.increaseCapacityTo(2); 584vector.increaseCapacityTo(12); 585``` 586 587### trimToCurrentLength 588 589trimToCurrentLength(): void 590 591把容量限制为当前的length大小。 592 593**系统能力：** SystemCapability.Utils.Lang 594 595**示例：** 596 597```ts 598let vector : Vector<number> = new Vector(); 599vector.add(2); 600vector.add(4); 601vector.add(5); 602vector.add(4); 603vector.trimToCurrentLength(); 604``` 605 606### toString 607 608toString(): string 609 610用","将Vector实例中的元素按顺序拼接成字符串。 611 612**系统能力：** SystemCapability.Utils.Lang 613 614**返回值：** 615 616| 类型 | 说明 | 617| -------- | -------- | 618| string | 返回对应的字符串。 | 619 620**示例：** 621 622```ts 623let vector : Vector<number> = new Vector(); 624vector.add(2); 625vector.add(4); 626vector.add(5); 627vector.add(4); 628let result = vector.toString(); 629``` 630 631### copyToArray 632 633copyToArray(array: Array<T>): void 634 635将Vector实例中的元素按照下标复制到指定数组。 636 637**系统能力：** SystemCapability.Utils.Lang 638 639**参数：** 640 641| 参数名 | 类型 | 必填 | 说明 | 642| -------- | -------- | -------- | -------- | 643| array | Array<T> | 是 | 指定数组。 | 644 645### getFirstElement 646 647getFirstElement(): T 648 649获取实例中的第一个元素。 650 651**系统能力：** SystemCapability.Utils.Lang 652 653**返回值：** 654 655| 类型 | 说明 | 656| -------- | -------- | 657| T | 返回第一个元素。 | 658 659**示例：** 660 661```ts 662let vector : Vector<number> = new Vector(); 663vector.add(2); 664vector.add(4); 665vector.add(5); 666vector.add(4); 667let result = vector.getFirstElement(); 668``` 669 670### getLastElement 671 672getLastElement(): T 673 674获取Vector实例中的最后一个元素。 675 676**系统能力：** SystemCapability.Utils.Lang 677 678**返回值：** 679 680| 类型 | 说明 | 681| -------- | -------- | 682| T | 返回最后一个元素。 | 683 684**示例：** 685 686```ts 687let vector : Vector<number> = new Vector(); 688vector.add(2); 689vector.add(4); 690vector.add(5); 691vector.add(4); 692let result = vector.getLastElement(); 693``` 694 695### getLastIndexFrom 696 697getLastIndexFrom(element: T, index: number): number 698 699从指定索引向后搜索，返回该元素的下标索引。 700 701**系统能力：** SystemCapability.Utils.Lang 702 703**参数：** 704 705| 参数名 | 类型 | 必填 | 说明 | 706| -------- | -------- | -------- | -------- | 707| element | T | 是 | 要查找的元素。 | 708| index | number | 是 | 从指定索引开始搜索。 | 709 710**返回值：** 711 712| 类型 | 说明 | 713| -------- | -------- | 714| number | 返回该元素的下标，如果查找失败，则返回-1。 | 715 716**示例：** 717 718```ts 719let vector : Vector<number> = new Vector(); 720vector.add(2); 721vector.add(4); 722vector.add(5); 723vector.add(4); 724let result = vector.getLastIndexFrom(4,3); 725``` 726 727### getIndexFrom 728 729getIndexFrom(element: T, index: number): number 730 731从指定索引向前搜索，返回该元素的下标索引。 732 733**系统能力：** SystemCapability.Utils.Lang 734 735**参数：** 736 737| 参数名 | 类型 | 必填 | 说明 | 738| -------- | -------- | -------- | -------- | 739| element | T | 是 | 要查找的元素。 | 740| index | number | 是 | 从指定索引开始搜索。 | 741 742**返回值：** 743 744| 类型 | 说明 | 745| -------- | -------- | 746| number | 返回该元素的下标，如果查找失败，则返回 -1。 | 747 748**示例：** 749 750```ts 751let vector : Vector<number> = new Vector(); 752vector.add(2); 753vector.add(4); 754vector.add(5); 755vector.add(4); 756let result = vector.getIndexFrom(4, 3); 757``` 758 759### setLength 760 761setLength(newSize: number): void 762 763设置Vector实例的元素个数。 764 765**系统能力：** SystemCapability.Utils.Lang 766 767**参数：** 768 769| 参数名 | 类型 | 必填 | 说明 | 770| -------- | -------- | -------- | -------- | 771| newSize | number | 是 | 设置的新长度。 | 772 773**示例：** 774 775```ts 776let vector : Vector<number> = new Vector(); 777vector.add(2); 778vector.add(4); 779vector.add(5); 780vector.add(4); 781vector.setLength(8); 782vector.setLength(2); 783``` 784 785### get 786 787get(index: number): T 788 789根据下标值获取Vector实例中的元素。 790 791**系统能力：** SystemCapability.Utils.Lang 792 793**参数：** 794 795 | 参数名 | 类型 | 必填 | 说明 | 796 | -------- | -------- | -------- | -------- | 797 | index | number | 是 | 查找的下标值。 | 798 799**返回值：** 800 801 | 类型 | 说明 | 802 | -------- | -------- | 803 | T | 返回获取到的元素。 | 804 805**示例：** 806 807```ts 808let vector : Vector<number> = new Vector(); 809vector.add(2); 810vector.add(4); 811vector.add(5); 812vector.add(4); 813let result = vector.get(2); 814``` 815 816### set 817 818set(index: number, element: T): T 819 820将此Vector中指定位置的元素替换为指定元素。 821 822**系统能力：** SystemCapability.Utils.Lang 823 824**参数：** 825 826| 参数名 | 类型 | 必填 | 说明 | 827| -------- | -------- | -------- | -------- | 828| index | number | 是 | 查找的下标值。 | 829| element | T | 是 | 用来替换的元素。 | 830 831**返回值：** 832 833 | 类型 | 说明 | 834 | -------- | -------- | 835 | T | 返回替换后的元素。 | 836 837### [Symbol.iterator] 838 839[Symbol.iterator]\(): IterableIterator<T> 840 841返回一个迭代器，迭代器的每一项都是一个 JavaScript 对象,并返回该对象。 842 843**系统能力：** SystemCapability.Utils.Lang 844 845**返回值：** 846| 类型 | 说明 | 847| -------- | -------- | 848| IterableIterator<T> | 返回一个迭代器。 | 849 850**示例：** 851 852```ts 853let vector : Vector<number> = new Vector(); 854vector.add(2); 855vector.add(4); 856vector.add(5); 857vector.add(4); 858// 使用方法一： 859let nums: Array<number> = vector.convertToArray() 860for (let item of nums) { 861 console.log("value:" + item); 862} 863 864// 使用方法二： 865let iter = vector[Symbol.iterator](); 866let temp: IteratorResult<number> = iter.next().value; 867while(temp != undefined) { 868 console.log("value:" + temp); 869 temp = iter.next().value; 870} 871```