js-apis-linkedlist.md 12.2 KB
Newer Older
L
linhaoran 已提交
1 2 3 4 5 6 7 8 9
# 线性容器LinkedList

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


## 导入模块

```
10
import LinkedList from '@ohos.util.LinkedList'  
L
linhaoran 已提交
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
```


## 权限




## LinkedList


### 属性

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| length | number | 是 | 否 | LinkedList的元素个数 |


### constructor

constructor(_head?: NodeObj<T>, _tail?: NodeObj<T>);

LinkedList的构造函数。

- 参数:
  | 参数名 | 类型 | 可读 | 可写 | 说明 |
  | -------- | -------- | -------- | -------- | -------- |
  | _head | NodeObj<T> | 是 | 否 | 入参对象,节点对象,含有element,和next指向,和prev指向 |
  | _tail | NodeObj<T> | 是 | 否 | 入参对象,节点对象,含有element,和next指向,和prev指向 |

- 示例:
  ```
  let linkedList = new LinkedList();
  ```


### add

add(element: T): boolean;

在LinkedList尾部插入元素。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 添加进去的元素 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 插入成功返回true,失败返回false |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add("a");
  linkedList.add(1);
  let b = [1, 2, 3];
  linkedList.add(b);
  let c = {name : "lala", age : "13"};
  linkedList.add(false);
  ```
### addFirst

addFirst(element: T): void;

在LinkedList头部插入元素。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 添加进去的元素 |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.addFirst("a");
  linkedList.addFirst(1);
  let b = [1, 2, 3];
  linkedList.addFirst(b);
  let c = {name : "lala", age : "13"};
  linkedList.addFirst(false);
  ```

### insert

insert(element: T, index: number): void;

在长度范围内任意插入指定元素。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 被插入的元素 |
  | index | number | 是 | 被插入的位置索引 |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.insert("A", 0);
  linkedList.insert(0, 1);
  linkedList.insert(true, 2);
  ```

### has

has(element: T): boolean;

判断此LinkedList中是否含有该指定元素。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 指定元素 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 是否包含指定元素 |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.has("Ahfbrgrbgnutfodgorrogorg");
  linkedList.add("Ahfbrgrbgnutfodgorrogorg");
  linkedList.has("Ahfbrgrbgnutfodgorrogorg");
  ```

### get

get(index: number): T;

根据下标获取LinkedList中的元素。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | index | number | 是 | 指定的下标值 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 根据下标查找到的元素 |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(2);
  linkedList.add(1);
  linkedList.add(2);
  linkedList.add(4);
  linkedList.get(2);
  ```
### getLastIndexOf

getLastIndexOf(element: T): number;

返回指定元素最后一次出现时的下标值,查找失败返回-1。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 指定元素 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回指定元素最后一次出现时的下标值,查找失败返回-1 |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(2);
  linkedList.add(1);
  linkedList.add(2);
  linkedList.add(4);
  linkedList.getLastIndexOf(2);
  ```

### getIndexOf

getIndexOf(element: T): number;

返回指定元素第一次出现时的下标值,查找失败返回-1。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 指定元素 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回指定元素第一次出现时的下标值,查找失败返回-1 |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(2);
  linkedList.add(1);
  linkedList.add(2);
  linkedList.add(4);
  linkedList.getIndexOf(2);
  ```
### removeByIndex

removeByIndex(index: number): T;

根据元素的下标值查找元素,返回元素后将其删除。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | index | number | 是 | 指定元素的下标值 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回删除的元素 |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(2);
  linkedList.add(4);
  linkedList.removeByIndex(2);
  ```
### removeFirst

removeFirst(): T;

删除并返回LinkedList的第一个元素。

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回删除的元素 |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(2);
  linkedList.add(4);
  linkedList.removeFirst();
  ```
### removeLast

removeLst(): T;

删除并返回LinkedList的最后一个元素。

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回删除的元素 |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(2);
  linkedList.add(4);
  linkedList.removeLast();
  ```

### remove

remove(element: T): boolean;

删除查找到的第一个指定的元素。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 指定元素 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 删除成功返回true,失败返回false |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(4);
  linkedList.remove(2);
  ```
### removeFirstFound

removeFirstFound(element: T): boolean;

删除第一次出现的指定元素。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 指定元素 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 删除成功返回true,失败返回false |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(4);
  linkedList.removeFirstFound(4);
  ```
### removeLastFound

removeLastFound(element: T): boolean;

删除最后一次出现的指定元素。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 指定元素 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 删除成功返回true,失败返回false |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(4);
  linkedList.removeLastFound(4);
  ```
### clone
clone(): LinkedList<T>;

克隆一个与LinkedList一模一样的实例,并返回克隆后的实例,修改克隆后的实例并不会影响原实例。

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | LinkedList<T> | 返回LinkedList对象实例 |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(4);
  linkedList.clone();
  ```
### forEach
forEach(callbackfn: (value: T, index?: number, linkedlist?: LinkedList<T>) => void,
thisArg?: Object): void;

通过回调函数来遍历LinkedList实例对象上的元素以及元素对应的下标。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | callbackfn | function | 是 | 回调函数 |
  | thisArg | Object | 否 | callbackfn被调用时用作this值 |

- callbackfn的参数说明
  
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | T | 是 | 当前遍历到的元素 |
  | index | number | 否 | 当前遍历到的下标值 |
  | linkedlist | LinkedList<T> | 否 | 当前调用forEach方法的实例对象 |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(4);
  linkedList.forEach((value, index) => {
    console.log(value, index);
  });
  ```
### clear
clear(): void;

清除LinkedList中的所有元素,并把length置为0。

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(4);
  linkedList.clear();
  ```
### set
set(index: number, element: T): T;
将此 LinkedList 中指定位置的元素替换为指定元素。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | index | number | 是 | 查找的下标值 |
  | element | T | 是 | 用来替换的元素 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回T类型 |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(4);
  linkedList.set(2, "b");
  ```
### convertToArray
convertToArray(): Array<T>;

把当前LinkedList实例转换成数组,并返回转换后的数组。

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | Array<T> | 返回数组类型 |

- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(4);
  linkedList.convertToArray();
  ```

### getFirst

getFirst(): T;
获取LinkedList实例中的第一个元素。

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回T型 |


- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(4);
  linkedList.getFirst();
  ```
### getLast

getLast(): T;
获取LinkedList实例中的最后一个元素。

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回T型 |


- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(4);
  linkedList.getLast();
  ```

### [Symbol.iterator]

[Symbol.iterator]\(): IterableIterator<T>;


返回一个迭代器,迭代器的每一项都是一个 JavaScript 对象,并返回该对象。


- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | IterableIterator<T> | 返回一个迭代器。 |


- 示例:
  ```
  let linkedList = new LinkedList();
  linkedList.add(2);
  linkedList.add(4);
  linkedList.add(5);
  linkedList.add(4);

  // 使用方法一:
  for (let item of linkedList) { 
    console.log(item); 
  } 

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