awtk/docs/fscript_array.md

array 扩展函数

array 是一个通用的数组，里面可以放混合数据类型的数据。

array 有以下属性：

• size 元素的个数
• capacity 元素的最大个数

1.array_create

创建 array 对象。

---

原型

array_create() => object
array_create(elem1, elem2, elem3, ...) => object

示例

var a = array_create();
var b = array_create(123, 456, 789);

2.array_create_with_str

创建 array 对象。以指定的分隔符把字符串拆开，并转换为指定类型的数据，放入数组中。

---

原型

array_create_with_str(str, sep, type) => object

type 为可选参数，可选取值为：

• int 表示整数。
• double 表示浮点数。
• 其它或默认为字符串。

示例

var a = array_create_with_str("a2,a1,a3", ",");
a = array_create_with_str("2,1,3", ",", "int");
a = array_create_with_str("2,1,3", ",", "double");

3.array_create_repeated

创建 array 对象。

---

原型

array_create_repeated(value, nr) => object

• value 为初始化的值。
• nr 为值的个数。

示例

var a = array_create_repeated(123, 3);

4.array_dup

创建 array 对象。

---

原型

array_dup(arr, start, end) => object

1. start 为开始的位置，默认为 0。
2. end 为结束的位置（不包含）

示例

var a = array_create_with_str("2,1,3", ",", "int");
var b = array_dup(a);
var c = array_dup(a, 1);
var d = array_dup(a, 1, 2);

5.array_push

追加一个或多个数据，并返回写入数据的个数。

---

原型

array_push(array, v, ...) => uint32_t

示例

var a = array_create();
array_push(a, "123");
array_push(a, "456", "789");

6.array_pop

弹出最后一个元素

---

原型

array_pop(array) => value

示例

var a = array_create_with_str("2,1,3", ",", "int");
var b = array_pop(a);

7.array_shift

弹出第一个元素

---

原型

array_shift(array) => value

示例

var a = array_create_with_str("2,1,3", ",", "int");
var b = array_shift(a);

8.array_get

获取指定位置的元素

---

原型

array_get(array, index) => value

1. index 为负数时，从后往前取。比如-1 表示最后一个元素。
2. 此外，也可以通过 array.[index] 的方式访问数组元素。

示例

var a = array_create_with_str("2,1,3", ",", "int");
var b = array_get(a, 0);
var c = array_get(a, -1);
var d = a.[1]

9.array_set

修改指定位置的元素

---

原型

array_set(array, index, value) => bool

index 为负数时，从后往前取。比如-1 表示最后一个元素。

示例

var a = array_create_with_str("2,1,3", ",", "int");
array_set(a, 0, 4);
array_set(a, -1, 5);

10.array_insert

插入元素到指定位置

---

原型

array_insert(array, index, value) => bool

index 为负数时，从后往前取。比如-1 表示最后一个元素。

示例

var a = array_create_with_str("2,1,3", ",", "int");
array_insert(a, 0, 4);
array_insert(a, -1, 5);

11.array_index_of

获取元素首次出现的位置。

---

原型

array_index_of(array, value) => index

示例

var a = array_create_with_str("2,1,3", ",", "int");
var b = array_index_of(a, 1);

12.array_last_index_of

获取元素最后出现的位置。

---

原型

array_last_index_of(array, value) => index

示例

var a = array_create_with_str("2,1,3", ",", "int");
var b = array_last_index_of(a, 1);

13.array_remove

删除指定位置的元素

---

原型

array_remove(array, index) => bool

index 为负数时，从后往前取。比如-1 表示最后一个元素。

示例

var a = array_create_with_str("2,1,3", ",", "int");
array_remove(a, 0);
array_remove(a, -1);

14.array_get_and_remove

删除指定位置的元素，并返回该元素。

---

原型

array_get_and_remove(array, index) => value

index 为负数时，从后往前取。比如-1 表示最后一个元素。

示例

var a = array_create_with_str("2,1,3", ",", "int");
array_get_and_remove(a, 0);
array_get_and_remove(a, -1);

15.array_clear

删除全部元素

---

原型

array_clear(array) => bool

示例

var a = array_create_with_str("2,1,3", ",", "int");
array_clear(a);

16.array_join

连接全部元素成一个字符串。

---

原型

array_join(array, sep) => str

示例

var a = array_create_with_str("2,1,3", ",", "int");
var b = array_join(a, ",");

17.array_sort

根据当前的数据类型排序，以第一个元素类型为准。

---

原型

array_sort(array, ascending, ignore_case) => bool

1. ascending 是否为升序，默认是。
2. ignore_case 是否忽略大小写，仅用于字符串，默认为否。

示例

var a = array_create_with_str("2,1,3", ",", "int");
assert(array_sort(a));
var d = array_join(a, ":");
assert(d == "1:2:3")

assert(array_sort(a, false));
d = array_join(a, ":");
assert(d == "3:2:1")

18.array_min

获取最小值。

---

原型

array_min(array) => double

示例

var a = array_create_with_str("2,1,3", ",", "int");
var b = array_min(a);

19.array_max

获取最大值。

---

原型

array_max(array) => double

示例

var a = array_create_with_str("2,1,3", ",", "int");
var b = array_max(a);

20.array_avg

求平均值。

---

原型

array_avg(array) => double

示例

var a = array_create_with_str("2,1,3", ",", "int");
var b = array_avg(a);

21.array_sum

求和。

---

原型

array_sum(array) => double

示例

var a = array_create_with_str("2,1,3", ",", "int");
var b = array_sum(a);

22.array_clone_and_sort

clone一份数据，根据当前的数据类型排序，以第一个元素类型为准。

---

原型

array_clone_and_sort(array, ascending, ignore_case) => array

1. ascending 是否为升序，默认是。
2. ignore_case 是否忽略大小写，仅用于字符串，默认为否。

示例

var a = array_create_with_str("2,1,3", ",", "int");
var b = array_clone_and_sort(a);
var c = array_join(b, ":");
assert(c == "1:2:3")

23.array_reverse

反向。

---

原型

array_reverse(array) => bool

示例

var a = array_create_with_str("2,1,3", ",", "int");
array_reverse(a);

24.array_is_empty

判断数组是否为空。

---

原型

array_is_empty(array) => bool

示例

var a = array_create();
assert(array_is_empty(a));

25.array_size

获取数组中属性的个数。

---

原型

array_size(array) => size

示例

var a = array_create_with_str("2,1,3", ",", "int");
var b = array_size(a);

更多示例

var a = array_create()
assert(array_push(a,1,2,3) == 3)
assert(array_push(a,"a","b","c") == 3)
assert(array_pop(a), "c")
assert(array_pop(a), "b")
assert(array_pop(a), "a")
assert(array_pop(a), "3")
assert(array_pop(a), "2")
assert(array_pop(a), "1")
assert(value_is_valid(array_pop(a)))
assert(array_clear(a))
assert(a.size == 0)

assert(array_insert(a, 0, 'a'))
assert(array_insert(a, 1, 'b'))
assert(array_insert(a, 2, 'c'))
assert(array_insert(a, 3, 'd'))
assert(a.size == 4)
assert(array_remove(a, 0))

assert(array_get(a, 0) == 'b')
assert(array_set(a, 0, 'bbb'))
assert(array_get(a, 0) == 'bbb')
assert(array_set(a, 0, 'b'))

assert(array_get(a, 1) == 'c')
assert(array_set(a, 1, 'ccc'))
assert(array_get(a, 1) == 'ccc')
assert(array_set(a, 1, 'c'))
assert(array_join(a, ',') == 'b,c,d')
print(a.size, a.capacity)