js-apis-deque.md 5.1 KB
Newer Older
L
linhaoran 已提交
1 2 3 4 5 6 7 8 9 10 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
# 线性容器Deque

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


## 导入模块

```
import Deque from '@ohos.deque'  
```


## 权限




## Deque


### 属性

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


### constructor

constructor() 

constructor是Deque的构造函数。


- 参数:
  | 参数名 | 类型 | 可读 | 可写 | 说明 |
  | -------- | -------- | -------- | -------- | -------- |
  | 无 | 无 | 是 | 否 | 无 |

- 示例:
  ```
  let queue = new Queue();
  ```


### insertFront

insertFront(element: T): void 

在deque头部插入元素

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

- 示例:
  ```
  const deque = new Deque;
  deque.insertFront("a");
  deque.insertFront(1);
  let b = [1,2,3];
  deque.insertFront(b);
  let c = {name:"lala",age:"13"};
  deque.insertFront(false)
  ```
### insertEnd

insertEnd(element: T): void 

在deque尾部插入元素

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

- 示例:
  ```
  const deque = new Deque;
  deque.insertEnd("a");
  deque.insertEnd(1);
  let b = [1,2,3];
  deque.insertEnd(b);
  let c = {name:"lala",age:"13"};
  deque.insertEnd(false)
  ```
### has

has(element: T): boolean

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

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 是否包含的元素 |

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

- 示例:
  ```
  const deque = new Deque()
  deque.has("Ahfbrgrbgnutfodgorrogorg");
  deque.insertFront("Ahfbrgrbgnutfodgorrogorg");
  deque.has("Ahfbrgrbgnutfodgorrogorg");

  ```
### popFirst

popFirst(): T

删除并返回双端队列的首元素

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

- 示例:
  ```
  const deque = new Deque();
  deque.insertFront(2);
  deque.insertFront(4);
  deque.insertEnd(5);
  deque.insertFront(2);
  deque.insertFront(4);
  deque.popFirst();

  ```
### popLast

popLast(): T

删除并返回双端队列的尾元素

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

- 示例:
  ```
  const deque = new Deque();
  deque.insertFront(2);
  deque.insertEnd(4);
  deque.insertFront(5);
  deque.insertFront(2);
  deque.insertFront(4);
  deque.popLast();

  ```

### forEach
forEach(callbackfn: (value: T, index?: number, deque?: Deque<T>) => void,
thisArg?: Object): void 

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

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

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

- 示例:
  ```
  const deque = new Deque();
  deque.insertFront(2);
  deque.insertEnd(4);
  deque.insertFront(5);
  deque.insertEnd(4);
  deque.forEach((value,index)=>{
    console.log(value,index)
  });

  ```

### getFirst

getFirst(): T
获取Deque实例中的头元素

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


- 示例:
  ```
  const deque = new Deque();
  deque.insertEnd(2);
  deque.insertEnd(4);
  deque.insertFront(5);
  deque.insertFront(4);
  deque.getFirst();
  ```
### getLast

getLast(): T 
获取Deque实例中的尾元素

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


- 示例:
  ```
  const deque = new Deque();
  deque.insertFront(2);
  deque.insertFront(4);
  deque.insertFront(5);
  deque.insertFront(4);
  deque.getLast();
  ```

### [Symbol.iterator]

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


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


- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | IterableIterator&lt;[T,&nbsp;boolean]&gt; | 返回一个迭代器。 |


- 示例:
  ```
  const deque = new Deque();
  deque.insertFront(2);
  deque.insertFront(4);
  deque.insertFront(5);
  deque.insertFront(4);
  for (let item of deque) { 
    console.log(item); 
  } 
  ```