Made default capacity of dynamic arrays more consistent.

Before this if you do `arr: [dynamic]int` and then append to arr, then it will have capacity 8.
But if you did `arr := make([dynamic]int, context.temp_allocator)` then arr would have capacity 16.

Now both `arr: [dynamic]int` and `arr := make([dynamic]int, context.temp_allocator)` will resut in arr having zero 0. The only reason to use `make` without an explicit len or cap now is because you want to set it up for a non-default allocator. After the first call to `append` it will now in both cases have capacity 8.

I also updated the documentation on the strings builder, both to reflect this, and also to fix it incorrectly saying that len would be 'max(16,len)', which wasn't true even before these changes.
This commit is contained in:
Karl Zylinski
2024-06-29 08:57:21 +02:00
parent 06652bebce
commit 679f9b4e41
3 changed files with 15 additions and 14 deletions
+5 -5
View File
@@ -268,7 +268,7 @@ new_clone :: proc(data: $T, allocator := context.allocator, loc := #caller_locat
return return
} }
DEFAULT_RESERVE_CAPACITY :: 16 DEFAULT_DYNAMIC_ARRAY_CAPACITY :: 8
@(require_results) @(require_results)
make_aligned :: proc($T: typeid/[]$E, #any_int len: int, alignment: int, allocator := context.allocator, loc := #caller_location) -> (T, Allocator_Error) #optional_allocator_error { make_aligned :: proc($T: typeid/[]$E, #any_int len: int, alignment: int, allocator := context.allocator, loc := #caller_location) -> (T, Allocator_Error) #optional_allocator_error {
@@ -295,7 +295,7 @@ make_slice :: proc($T: typeid/[]$E, #any_int len: int, allocator := context.allo
// Note: Prefer using the procedure group `make`. // Note: Prefer using the procedure group `make`.
@(builtin, require_results) @(builtin, require_results)
make_dynamic_array :: proc($T: typeid/[dynamic]$E, allocator := context.allocator, loc := #caller_location) -> (T, Allocator_Error) #optional_allocator_error { make_dynamic_array :: proc($T: typeid/[dynamic]$E, allocator := context.allocator, loc := #caller_location) -> (T, Allocator_Error) #optional_allocator_error {
return make_dynamic_array_len_cap(T, 0, DEFAULT_RESERVE_CAPACITY, allocator, loc) return make_dynamic_array_len_cap(T, 0, 0, allocator, loc)
} }
// `make_dynamic_array_len` allocates and initializes a dynamic array. Like `new`, the first argument is a type, not a value. // `make_dynamic_array_len` allocates and initializes a dynamic array. Like `new`, the first argument is a type, not a value.
// Unlike `new`, `make`'s return value is the same as the type of its argument, not a pointer to it. // Unlike `new`, `make`'s return value is the same as the type of its argument, not a pointer to it.
@@ -423,8 +423,8 @@ _append_elem :: #force_inline proc(array: ^$T/[dynamic]$E, arg: E, should_zero:
return 1, nil return 1, nil
} else { } else {
if cap(array) < len(array)+1 { if cap(array) < len(array)+1 {
// Same behavior as _append_elems but there's only one arg, so we always just add 8. // Same behavior as _append_elems but there's only one arg, so we always just add DEFAULT_DYNAMIC_ARRAY_CAPACITY.
cap := 2 * cap(array) + 8 cap := 2 * cap(array) + DEFAULT_DYNAMIC_ARRAY_CAPACITY
// do not 'or_return' here as it could be a partial success // do not 'or_return' here as it could be a partial success
if should_zero { if should_zero {
@@ -473,7 +473,7 @@ _append_elems :: #force_inline proc(array: ^$T/[dynamic]$E, should_zero: bool, l
return arg_len, nil return arg_len, nil
} else { } else {
if cap(array) < len(array)+arg_len { if cap(array) < len(array)+arg_len {
cap := 2 * cap(array) + max(8, arg_len) cap := 2 * cap(array) + max(DEFAULT_DYNAMIC_ARRAY_CAPACITY, arg_len)
// do not 'or_return' here as it could be a partial success // do not 'or_return' here as it could be a partial success
if should_zero { if should_zero {
+4 -3
View File
@@ -147,7 +147,7 @@ make_soa_slice :: proc($T: typeid/#soa[]$E, length: int, allocator := context.al
@(builtin, require_results) @(builtin, require_results)
make_soa_dynamic_array :: proc($T: typeid/#soa[dynamic]$E, allocator := context.allocator, loc := #caller_location) -> (array: T, err: Allocator_Error) #optional_allocator_error { make_soa_dynamic_array :: proc($T: typeid/#soa[dynamic]$E, allocator := context.allocator, loc := #caller_location) -> (array: T, err: Allocator_Error) #optional_allocator_error {
context.allocator = allocator context.allocator = allocator
reserve_soa(&array, DEFAULT_RESERVE_CAPACITY, loc) or_return reserve_soa(&array, 0, loc) or_return
return array, nil return array, nil
} }
@@ -280,7 +280,8 @@ append_soa_elem :: proc(array: ^$T/#soa[dynamic]$E, arg: E, loc := #caller_locat
} }
if cap(array) <= len(array) + 1 { if cap(array) <= len(array) + 1 {
cap := 2 * cap(array) + 8 // Same behavior as append_soa_elems but there's only one arg, so we always just add DEFAULT_DYNAMIC_ARRAY_CAPACITY.
cap := 2 * cap(array) + DEFAULT_DYNAMIC_ARRAY_CAPACITY
err = reserve_soa(array, cap, loc) // do not 'or_return' here as it could be a partial success err = reserve_soa(array, cap, loc) // do not 'or_return' here as it could be a partial success
} }
@@ -337,7 +338,7 @@ append_soa_elems :: proc(array: ^$T/#soa[dynamic]$E, args: ..E, loc := #caller_l
} }
if cap(array) <= len(array)+arg_len { if cap(array) <= len(array)+arg_len {
cap := 2 * cap(array) + max(8, arg_len) cap := 2 * cap(array) + max(DEFAULT_DYNAMIC_ARRAY_CAPACITY, arg_len)
err = reserve_soa(array, cap, loc) // do not 'or_return' here as it could be a partial success err = reserve_soa(array, cap, loc) // do not 'or_return' here as it could be a partial success
} }
arg_len = min(cap(array)-len(array), arg_len) arg_len = min(cap(array)-len(array), arg_len)
+6 -6
View File
@@ -24,7 +24,7 @@ Builder :: struct {
buf: [dynamic]byte, buf: [dynamic]byte,
} }
/* /*
Produces a Builder with a default length of 0 and cap of 16 Produces an empty Builder
*Allocates Using Provided Allocator* *Allocates Using Provided Allocator*
@@ -39,7 +39,7 @@ builder_make_none :: proc(allocator := context.allocator, loc := #caller_locatio
return Builder{buf=make([dynamic]byte, allocator, loc) or_return }, nil return Builder{buf=make([dynamic]byte, allocator, loc) or_return }, nil
} }
/* /*
Produces a Builder with a specified length and cap of max(16,len) byte buffer Produces a Builder with specified length and capacity `len`.
*Allocates Using Provided Allocator* *Allocates Using Provided Allocator*
@@ -55,7 +55,7 @@ builder_make_len :: proc(len: int, allocator := context.allocator, loc := #calle
return Builder{buf=make([dynamic]byte, len, allocator, loc) or_return }, nil return Builder{buf=make([dynamic]byte, len, allocator, loc) or_return }, nil
} }
/* /*
Produces a Builder with a specified length and cap Produces a Builder with specified length `len` and capacity `cap`.
*Allocates Using Provided Allocator* *Allocates Using Provided Allocator*
@@ -103,7 +103,7 @@ builder_make :: proc{
builder_make_len_cap, builder_make_len_cap,
} }
/* /*
Initializes a Builder with a length of 0 and cap of 16 Initializes an empty Builder
It replaces the existing `buf` It replaces the existing `buf`
*Allocates Using Provided Allocator* *Allocates Using Provided Allocator*
@@ -121,7 +121,7 @@ builder_init_none :: proc(b: ^Builder, allocator := context.allocator, loc := #c
return b, nil return b, nil
} }
/* /*
Initializes a Builder with a specified length and cap, which is max(len,16) Initializes a Builder with specified length and capacity `len`.
It replaces the existing `buf` It replaces the existing `buf`
*Allocates Using Provided Allocator* *Allocates Using Provided Allocator*
@@ -140,7 +140,7 @@ builder_init_len :: proc(b: ^Builder, len: int, allocator := context.allocator,
return b, nil return b, nil
} }
/* /*
Initializes a Builder with a specified length and cap Initializes a Builder with specified length `len` and capacity `cap`.
It replaces the existing `buf` It replaces the existing `buf`
Inputs: Inputs: