v/vlib/builtin/array.v

614 lines
14 KiB
V
Raw Normal View History

2020-01-23 21:04:46 +01:00
// Copyright (c) 2019-2020 Alexander Medvednikov. All rights reserved.
2019-06-23 04:21:30 +02:00
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
2019-06-22 20:20:28 +02:00
module builtin
2019-08-31 01:35:05 +02:00
import strings
2019-08-10 23:02:48 +02:00
2020-01-12 19:59:57 +01:00
pub struct array {
pub:
2019-12-18 18:07:32 +01:00
// Using a void pointer allows to implement arrays without generics and without generating
// extra code for every type.
2019-06-23 00:24:16 +02:00
data voidptr
2019-06-22 20:20:28 +02:00
len int
cap int
element_size int
}
// Internal function, used by V (`nums := []int`)
2019-12-31 19:42:16 +01:00
fn new_array(mylen int, cap int, elm_size int) array {
2019-12-19 21:52:45 +01:00
cap_ := if cap == 0 { 1 } else { cap }
2019-12-18 18:07:32 +01:00
arr := array{
2019-06-22 20:20:28 +02:00
len: mylen
cap: cap_
2019-06-22 20:20:28 +02:00
element_size: elm_size
data: vcalloc(cap_ * elm_size)
2019-06-22 20:20:28 +02:00
}
return arr
}
2019-08-31 01:35:05 +02:00
// TODO
pub fn make(len int, cap int, elm_size int) array {
2019-08-31 01:35:05 +02:00
return new_array(len, cap, elm_size)
}
2020-03-27 08:46:54 +01:00
/*
struct Foo {
a []string
b [][]string
}
*/
2019-06-22 20:20:28 +02:00
// Private function, used by V (`nums := [1, 2, 3]`)
fn new_array_from_c_array(len, cap, elm_size int, c_array voidptr) array {
2019-12-19 21:52:45 +01:00
cap_ := if cap == 0 { 1 } else { cap }
2020-03-21 19:52:19 +01:00
2019-12-18 18:07:32 +01:00
arr := array{
2019-06-22 20:20:28 +02:00
len: len
cap: cap
element_size: elm_size
data: vcalloc(cap_ * elm_size)
2019-06-22 20:20:28 +02:00
}
// TODO Write all memory functions (like memcpy) in V
2020-01-04 00:06:01 +01:00
C.memcpy(arr.data, c_array, len * elm_size)
2019-06-22 20:20:28 +02:00
return arr
}
// Private function, used by V (`nums := [1, 2, 3] !`)
fn new_array_from_c_array_no_alloc(len, cap, elm_size int, c_array voidptr) array {
2019-12-18 18:07:32 +01:00
arr := array{
2019-06-22 20:20:28 +02:00
len: len
cap: cap
element_size: elm_size
data: c_array
}
return arr
}
// Private function. Doubles array capacity if needed
fn (a mut array) ensure_cap(required int) {
2020-01-19 13:11:58 +01:00
if required <= a.cap {
return
}
2020-01-19 13:11:58 +01:00
mut cap := if a.cap == 0 { 2 } else { a.cap * 2 }
for required > cap {
cap *= 2
}
if a.cap == 0 {
a.data = vcalloc(cap * a.element_size)
2020-01-19 13:11:58 +01:00
}
else {
a.data = C.realloc(a.data, cap * a.element_size)
}
a.cap = cap
}
2020-02-29 15:25:49 +01:00
// repeat returns new array with the given array elements repeated given times.
pub fn (a array) repeat(count int) array {
if count < 0 {
panic('array.repeat: count is negative: $count')
}
2020-02-29 15:25:49 +01:00
mut size := count * a.len * a.element_size
2019-12-16 20:22:04 +01:00
if size == 0 {
size = a.element_size
}
2019-12-18 18:07:32 +01:00
arr := array{
2020-02-29 15:25:49 +01:00
len: count * a.len
cap: count * a.len
2019-09-14 22:48:30 +02:00
element_size: a.element_size
data: vcalloc(size)
2019-09-14 22:48:30 +02:00
}
2020-02-29 15:25:49 +01:00
for i in 0..count {
2020-04-02 14:58:45 +02:00
C.memcpy(byteptr(arr.data) + i * a.len * a.element_size, byteptr(a.data), a.len * a.element_size)
2019-09-14 22:48:30 +02:00
}
return arr
}
// array.sort sorts array in-place using given `compare` function as comparator
pub fn (a mut array) sort_with_compare(compare voidptr) {
2019-06-22 20:20:28 +02:00
C.qsort(a.data, a.len, a.element_size, compare)
}
// TODO array.insert is broken
// Cannot pass literal or primitive type as it cannot be cast to voidptr.
// In the current state only that would work:
2019-12-18 18:07:32 +01:00
// i := 3
// a.insert(0, &i)
// ----------------------------
pub fn (a mut array) insert(i int, val voidptr) {
$if !no_bounds_checking? {
if i < 0 || i > a.len {
panic('array.insert: index out of range (i == $i, a.len == $a.len)')
}
2019-06-22 20:20:28 +02:00
}
a.ensure_cap(a.len + 1)
2019-06-22 20:20:28 +02:00
size := a.element_size
2020-04-02 14:58:45 +02:00
C.memmove(byteptr(a.data) + (i + 1) * size, byteptr(a.data) + i * size, (a.len - i) * size)
C.memcpy(byteptr(a.data) + i * size, val, size)
a.len++
2019-06-22 20:20:28 +02:00
}
// TODO array.prepend is broken
// It depends on array.insert
// -----------------------------
pub fn (a mut array) prepend(val voidptr) {
2019-06-22 20:20:28 +02:00
a.insert(0, val)
}
// array.delete deletes array element at the given index
pub fn (a mut array) delete(i int) {
$if !no_bounds_checking? {
if i < 0 || i >= a.len {
panic('array.delete: index out of range (i == $i, a.len == $a.len)')
}
}
2019-06-22 20:20:28 +02:00
size := a.element_size
2020-04-02 14:58:45 +02:00
C.memmove(byteptr(a.data) + i * size, byteptr(a.data) + (i + 1) * size, (a.len - i) * size)
2019-06-22 20:20:28 +02:00
a.len--
}
2020-01-27 22:31:48 +01:00
// clears the array without deallocating the allocated data
pub fn (a mut array) clear() {
a.len = 0
}
2020-02-17 20:31:40 +01:00
// trims the array length to "index" without modifying the allocated data. If "index" is greater
// than len nothing will be changed
pub fn (a mut array) trim(index int) {
if index < a.len {
a.len = index
}
}
// Private function. Used to implement array[] operator
fn (a array) get(i int) voidptr {
$if !no_bounds_checking? {
if i < 0 || i >= a.len {
panic('array.get: index out of range (i == $i, a.len == $a.len)')
}
}
2020-04-02 15:31:44 +02:00
return byteptr(a.data) + i * a.element_size
}
2019-11-12 17:26:05 +01:00
// array.first returns the first element of the array
pub fn (a array) first() voidptr {
$if !no_bounds_checking? {
if a.len == 0 {
panic('array.first: array is empty')
}
2019-06-22 20:20:28 +02:00
}
2020-04-02 15:31:44 +02:00
return a.data
2019-06-22 20:20:28 +02:00
}
2019-11-12 17:26:05 +01:00
// array.last returns the last element of the array
pub fn (a array) last() voidptr {
$if !no_bounds_checking? {
if a.len == 0 {
panic('array.last: array is empty')
}
2019-06-22 20:20:28 +02:00
}
2020-04-02 15:31:44 +02:00
return byteptr(a.data) + (a.len - 1) * a.element_size
2019-06-22 20:20:28 +02:00
}
2020-01-08 10:19:12 +01:00
/*
// array.left returns a new array using the same buffer as the given array
// with the first `n` elements of the given array.
2019-11-30 10:37:34 +01:00
fn (a array) left(n int) array {
// $if !no_bounds_checking? {
// if n < 0 {
// panic('array.left: index is negative (n == $n)')
// }
// }
if n >= a.len {
return a.slice(0, a.len)
2019-06-22 20:20:28 +02:00
}
return a.slice(0, n)
2019-06-22 20:20:28 +02:00
}
// array.right returns an array using same buffer as the given array
// but starting with the element of the given array beyond the index `n`.
// If `n` is bigger or equal to the length of the given array,
// returns an empty array of the same type as the given array.
2019-11-30 10:37:34 +01:00
fn (a array) right(n int) array {
// $if !no_bounds_checking? {
// if n < 0 {
// panic('array.right: index is negative (n == $n)')
// }
// }
if n >= a.len {
return new_array(0, 0, a.element_size)
}
return a.slice(n, a.len)
2019-06-22 20:20:28 +02:00
}
2020-01-08 10:19:12 +01:00
*/
// array.slice returns an array using the same buffer as original array
// but starting from the `start` element and ending with the element before
// the `end` element of the original array with the length and capacity
// set to the number of the elements in the slice.
2019-11-30 10:37:34 +01:00
fn (a array) slice(start, _end int) array {
2019-12-16 23:29:40 +01:00
mut end := _end
$if !no_bounds_checking? {
if start > end {
panic('array.slice: invalid slice index ($start > $end)')
}
if end > a.len {
panic('array.slice: slice bounds out of range ($end >= $a.len)')
}
if start < 0 {
panic('array.slice: slice bounds out of range ($start < 0)')
}
2019-12-16 23:29:40 +01:00
}
l := end - start
2019-12-18 18:07:32 +01:00
res := array{
2019-12-16 23:29:40 +01:00
element_size: a.element_size
2020-04-02 15:31:44 +02:00
data: byteptr(a.data) + start * a.element_size
2019-12-16 23:29:40 +01:00
len: l
cap: l
}
return res
}
2020-01-08 10:19:12 +01:00
// used internally for [2..4]
fn (a array) slice2(start, _end int, end_max bool) array {
end := if end_max { a.len } else { _end }
return a.slice(start, end)
}
// array.clone returns an independent copy of a given array
2020-03-10 23:21:26 +01:00
pub fn (a &array) clone() array {
2020-01-08 10:19:12 +01:00
mut size := a.cap * a.element_size
if size == 0 {
size++
}
arr := array{
len: a.len
cap: a.cap
element_size: a.element_size
data: vcalloc(size)
2020-01-08 10:19:12 +01:00
}
2020-04-02 15:31:44 +02:00
C.memcpy(byteptr(arr.data), a.data, a.cap * a.element_size)
2020-01-08 10:19:12 +01:00
return arr
}
2020-03-10 23:21:26 +01:00
fn (a &array) slice_clone(start, _end int) array {
2019-06-22 20:20:28 +02:00
mut end := _end
$if !no_bounds_checking? {
if start > end {
panic('array.slice: invalid slice index ($start > $end)')
}
if end > a.len {
panic('array.slice: slice bounds out of range ($end >= $a.len)')
}
if start < 0 {
panic('array.slice: slice bounds out of range ($start < 0)')
}
2019-06-22 20:20:28 +02:00
}
l := end - start
2019-12-18 18:07:32 +01:00
res := array{
element_size: a.element_size
2020-04-02 15:31:44 +02:00
data: byteptr(a.data) + start * a.element_size
2019-06-22 20:20:28 +02:00
len: l
cap: l
}
2019-12-16 23:21:10 +01:00
return res.clone()
2019-06-22 20:20:28 +02:00
}
// Private function. Used to implement assigment to the array element.
fn (a mut array) set(i int, val voidptr) {
$if !no_bounds_checking? {
if i < 0 || i >= a.len {
panic('array.set: index out of range (i == $i, a.len == $a.len)')
}
2019-06-22 20:20:28 +02:00
}
2020-04-02 15:31:44 +02:00
C.memcpy(byteptr(a.data) + a.element_size * i, val, a.element_size)
2019-06-22 20:20:28 +02:00
}
fn (a mut array) push(val voidptr) {
a.ensure_cap(a.len + 1)
2020-04-02 15:31:44 +02:00
C.memcpy(byteptr(a.data) + a.element_size * a.len, val, a.element_size)
a.len++
}
// `val` is array.data
// TODO make private, right now it's used by strings.Builder
2020-03-08 22:11:56 +01:00
pub fn (a3 mut array) push_many(val voidptr, size int) {
if a3.data == val {
// handle `arr << arr`
copy := a3.clone()
a3.ensure_cap(a3.len + size)
2020-01-19 13:11:58 +01:00
//C.memcpy(a.data, copy.data, copy.element_size * copy.len)
2020-04-02 15:31:44 +02:00
C.memcpy(byteptr(a3.data) + a3.element_size * a3.len, copy.data, a3.element_size * size)
2020-01-19 13:11:58 +01:00
} else {
2020-03-08 22:11:56 +01:00
a3.ensure_cap(a3.len + size)
2020-04-02 15:31:44 +02:00
C.memcpy(byteptr(a3.data) + a3.element_size * a3.len, val, a3.element_size * size)
2020-01-19 13:11:58 +01:00
}
2020-03-08 22:11:56 +01:00
a3.len += size
}
// array.reverse returns a new array with the elements of
// the original array in reverse order.
2019-07-17 18:17:07 +02:00
pub fn (a array) reverse() array {
2020-02-29 20:44:02 +01:00
if a.len < 2 {
return a
}
2019-12-18 18:07:32 +01:00
arr := array{
2019-07-17 18:17:07 +02:00
len: a.len
cap: a.cap
element_size: a.element_size
data: vcalloc(a.cap * a.element_size)
2019-07-17 18:17:07 +02:00
}
for i in 0..a.len {
2020-03-20 16:51:36 +01:00
//C.memcpy(arr.data + i * arr.element_size, &a[a.len - 1 - i], arr.element_size)
2020-04-02 15:31:44 +02:00
C.memcpy(byteptr(arr.data) + i * arr.element_size, byteptr(a.data) + (a.len - 1 - i) * arr.element_size, arr.element_size)
2019-07-17 18:17:07 +02:00
}
return arr
}
2019-12-18 18:07:32 +01:00
// pub fn (a []int) free() {
[unsafe_fn]
pub fn (a array) free() {
2019-12-18 18:07:32 +01:00
// if a.is_slice {
// return
// }
2019-06-22 20:20:28 +02:00
C.free(a.data)
}
// []string.str returns a string representation of the array of strings
2020-03-11 18:48:59 +01:00
// => '["a", "b", "c"]'
2019-06-30 13:06:46 +02:00
pub fn (a []string) str() string {
2019-08-31 01:35:05 +02:00
mut sb := strings.new_builder(a.len * 3)
sb.write('[')
for i in 0..a.len {
2019-06-22 20:20:28 +02:00
val := a[i]
2019-09-14 22:48:30 +02:00
sb.write('"')
sb.write(val)
sb.write('"')
2019-06-22 20:20:28 +02:00
if i < a.len - 1 {
2019-08-31 01:35:05 +02:00
sb.write(', ')
2019-06-22 20:20:28 +02:00
}
}
2019-08-31 01:35:05 +02:00
sb.write(']')
return sb.str()
2019-06-22 20:20:28 +02:00
}
2020-03-11 18:48:59 +01:00
// []int.str returns a string representation of the array of ints
// => '[1, 2, 3]'
pub fn (a []int) str() string {
mut sb := strings.new_builder(a.len * 13)
sb.write('[')
for i in 0..a.len {
2020-03-21 19:52:19 +01:00
val := a[i].str()
sb.write(val)
2020-04-02 01:14:57 +02:00
//println('"$val"')
2020-04-02 01:47:32 +02:00
if a[i] != 0 {
val.free()
}
2020-03-11 18:48:59 +01:00
if i < a.len - 1 {
sb.write(', ')
}
}
sb.write(']')
return sb.str()
}
// []bool.str returns a string representation of the array of bools
2020-03-11 18:48:59 +01:00
// => '[true, true, false]'
pub fn (a []bool) str() string {
mut sb := strings.new_builder(a.len * 3)
sb.write('[')
for i in 0..a.len {
val := a[i]
if val {
sb.write('true')
2019-12-18 18:07:32 +01:00
}
else {
sb.write('false')
2019-11-30 10:37:34 +01:00
}
if i < a.len - 1 {
sb.write(', ')
}
}
sb.write(']')
return sb.str()
}
// []byte.hex returns a string with the hexadecimal representation
// of the byte elements of the array
2019-07-15 17:49:01 +02:00
pub fn (b []byte) hex() string {
2019-12-18 18:07:32 +01:00
mut hex := malloc(b.len * 2 + 1)
mut dst_i := 0
for i in b {
2020-03-18 16:47:37 +01:00
n0 := i >> 4
hex[dst_i++] = if n0 < 10 { n0 + `0` } else { n0 + 87 }
n1 := i & 0xF
hex[dst_i++] = if n1 < 10 { n1 + `0` } else { n1 + 87 }
}
hex[dst_i] = `\0`
return tos(hex,dst_i)
2019-07-15 17:49:01 +02:00
}
2019-07-28 17:19:59 +02:00
// copy copies the `src` byte array elements to the `dst` byte array.
// The number of the elements copied is the minimum of the length of both arrays.
// Returns the number of elements copied.
2019-07-28 17:19:59 +02:00
// TODO: implement for all types
pub fn copy(dst, src []byte) int {
if dst.len > 0 && src.len > 0 {
2020-02-02 14:31:54 +01:00
mut min := 0
min = if dst.len < src.len { dst.len } else { src.len }
2020-04-02 15:31:44 +02:00
C.memcpy(byteptr(dst.data), src[..min].data, dst.element_size * min)
2019-07-28 17:19:59 +02:00
return min
}
return 0
}
2019-09-01 19:55:34 +02:00
// Private function. Comparator for int type.
2019-11-18 22:27:27 +01:00
fn compare_ints(a, b &int) int {
if *a < *b {
2019-09-01 19:55:34 +02:00
return -1
}
2019-11-18 22:27:27 +01:00
if *a > *b {
2019-09-01 19:55:34 +02:00
return 1
}
return 0
}
// []int.sort sorts array of int in place in ascending order.
2019-09-01 19:55:34 +02:00
pub fn (a mut []int) sort() {
a.sort_with_compare(compare_ints)
}
2019-10-04 22:07:19 +02:00
// []string.index returns the index of the first element equal to the given value,
// or -1 if the value is not found in the array.
2019-10-04 22:07:19 +02:00
pub fn (a []string) index(v string) int {
for i in 0..a.len {
2019-10-04 22:07:19 +02:00
if a[i] == v {
return i
}
}
return -1
}
// []int.index returns the index of the first element equal to the given value,
// or -1 if the value is not found in the array.
2019-10-04 22:07:19 +02:00
pub fn (a []int) index(v int) int {
for i in 0..a.len {
2019-10-04 22:07:19 +02:00
if a[i] == v {
return i
}
}
return -1
}
// []byte.index returns the index of the first element equal to the given value,
// or -1 if the value is not found in the array.
2019-10-04 22:07:19 +02:00
pub fn (a []byte) index(v byte) int {
for i in 0..a.len {
2019-10-04 22:07:19 +02:00
if a[i] == v {
return i
}
}
return -1
}
// []char.index returns the index of the first element equal to the given value,
// or -1 if the value is not found in the array.
// TODO is `char` type yet in the language?
2019-10-04 22:07:19 +02:00
pub fn (a []char) index(v char) int {
for i in 0..a.len {
2019-10-04 22:07:19 +02:00
if a[i] == v {
return i
}
}
return -1
}
2019-10-08 12:23:17 +02:00
// []int.reduce executes a given reducer function on each element of the array,
2019-10-11 03:12:40 +02:00
// resulting in a single output value.
2019-12-18 18:07:32 +01:00
pub fn (a []int) reduce(iter fn(accum, curr int)int, accum_start int) int {
mut _accum := accum_start
for i in a {
_accum = iter(_accum, i)
2019-10-11 03:12:40 +02:00
}
2020-02-29 15:25:49 +01:00
2019-10-11 03:12:40 +02:00
return _accum
}
// array_eq<T> checks if two arrays contain all the same elements in the same order.
// []int == []int (also for: i64, f32, f64, byte, string)
2020-02-18 18:13:34 +01:00
/*
fn array_eq<T>(a1, a2 []T) bool {
if a1.len != a2.len {
return false
}
for i in 0..a1.len {
if a1[i] != a2[i] {
return false
}
}
return true
}
2019-10-31 11:08:01 +01:00
pub fn (a []int) eq(a2 []int) bool {
return array_eq(a, a2)
}
2019-10-31 11:08:01 +01:00
pub fn (a []i64) eq(a2 []i64) bool {
return array_eq(a, a2)
}
2019-10-31 11:08:01 +01:00
pub fn (a []byte) eq(a2 []byte) bool {
return array_eq(a, a2)
}
2019-10-31 11:08:01 +01:00
pub fn (a []f32) eq(a2 []f32) bool {
return array_eq(a, a2)
}
2020-02-18 18:13:34 +01:00
*/
2019-12-19 21:49:40 +01:00
2020-02-18 20:31:08 +01:00
pub fn (a1 []string) eq(a2 []string) bool {
//return array_eq(a, a2)
if a1.len != a2.len {
return false
}
for i in 0..a1.len {
2020-02-18 20:31:08 +01:00
if a1[i] != a2[i] {
return false
}
}
return true
}
2020-01-21 18:49:30 +01:00
// compare_i64 for []f64 sort_with_compare()
// sort []i64 with quicksort
// usage :
// mut x := [i64(100),10,70,28,92]
// x.sort_with_compare(compare_i64)
// println(x) // Sorted i64 Array
// output:
// [10, 28, 70, 92, 100]
pub fn compare_i64(a, b &i64) int {
if *a < *b {
return -1
}
if *a > *b {
return 1
}
return 0
}
// compare_f64 for []f64 sort_with_compare()
// ref. compare_i64(...)
pub fn compare_f64(a, b &f64) int {
if *a < *b {
return -1
}
if *a > *b {
return 1
}
return 0
}
// compare_f32 for []f32 sort_with_compare()
// ref. compare_i64(...)
pub fn compare_f32(a, b &f32) int {
if *a < *b {
return -1
}
if *a > *b {
return 1
}
return 0
}
2020-03-08 22:11:56 +01:00
// a.pointers() returns a new array, where each element
// is the address of the corresponding element in a.
pub fn (a array) pointers() []voidptr {
mut res := []voidptr
for i in 0..a.len {
2020-04-02 15:31:44 +02:00
res << byteptr(a.data) + i * a.element_size
}
return res
}