diff --git a/base/builtin/index.html b/base/builtin/index.html index 9b0d814d2b..7db7c75180 100644 --- a/base/builtin/index.html +++ b/base/builtin/index.html @@ -236,14 +236,27 @@

Index

  • runtime.container_of
  • runtime.init_global_temporary_allocator
  • runtime.copy_slice
  • +
  • runtime.raw_soa_footer_slice
  • +
  • runtime.raw_soa_footer_dynamic_array
  • runtime.copy_from_string
  • +
  • runtime.make_soa_aligned
  • +
  • runtime.make_soa_slice
  • runtime.unordered_remove
  • +
  • runtime.make_soa_dynamic_array
  • +
  • runtime.make_soa_dynamic_array_len
  • runtime.ordered_remove
  • +
  • runtime.make_soa_dynamic_array_len_cap
  • runtime.remove_range
  • runtime.pop
  • +
  • runtime.resize_soa
  • runtime.pop_safe
  • +
  • runtime.reserve_soa
  • +
  • runtime.append_soa_elem
  • runtime.pop_front
  • +
  • runtime.append_soa_elems
  • runtime.pop_front_safe
  • +
  • runtime.unordered_remove_soa
  • +
  • runtime.ordered_remove_soa
  • runtime.delete_string
  • runtime.delete_cstring
  • runtime.delete_dynamic_array
  • @@ -284,21 +297,8 @@

    Index

  • runtime.map_upsert
  • runtime.card
  • runtime.assert
  • -
  • runtime.raw_soa_footer_slice
  • -
  • runtime.raw_soa_footer_dynamic_array
  • runtime.panic
  • runtime.unimplemented
  • -
  • runtime.make_soa_aligned
  • -
  • runtime.make_soa_slice
  • -
  • runtime.make_soa_dynamic_array
  • -
  • runtime.make_soa_dynamic_array_len
  • -
  • runtime.make_soa_dynamic_array_len_cap
  • -
  • runtime.resize_soa
  • -
  • runtime.reserve_soa
  • -
  • runtime.append_soa_elem
  • -
  • runtime.append_soa_elems
  • -
  • runtime.unordered_remove_soa
  • -
  • runtime.ordered_remove_soa
  • @@ -308,12 +308,16 @@

    Index

    Procedure Groups (19) @@ -1468,6 +1468,18 @@

    copy_slice
    + +
    +
    raw_soa_footer_slice :: proc(array: ^$T/#soa[]$T) -> (footer: ^Raw_SOA_Footer_Slice) {…}
    +
    +
    +
    + +
    +
    raw_soa_footer_dynamic_array :: proc(array: ^$T/#soa[dynamic]$T) -> (footer: ^Raw_SOA_Footer_Dynamic_Array) {…}
    +
    +
    +

    copy_from_string ¶

    copy_from_string :: proc "contextless" (dst: $T/[]$E/u8, src: $S/string) -> int {…}
    @@ -1481,6 +1493,18 @@

    +

    make_soa_aligned ¶

    +
    +
    make_soa_aligned :: proc($T: typeid/#soa[]T, length: int, alignment: int, allocator := context.allocator, loc := #caller_location) -> (array: T, err: Allocator_Error) #optional_ok {…}
    +
    +
    +
    +

    make_soa_slice ¶

    +
    +
    make_soa_slice :: proc($T: typeid/#soa[]T, length: int, allocator := context.allocator, loc := #caller_location) -> (array: T, err: Allocator_Error) #optional_ok {…}
    +
    +
    +

    unordered_remove ¶

    unordered_remove :: proc(array: ^$T/[dynamic]$T, index: int, loc := #caller_location) {…}
    @@ -1495,6 +1519,18 @@

    +

    make_soa_dynamic_array ¶

    +
    +
    make_soa_dynamic_array :: proc($T: typeid/#soa[dynamic]T, allocator := context.allocator, loc := #caller_location) -> (array: T, err: Allocator_Error) #optional_ok {…}
    +
    +
    +
    +

    make_soa_dynamic_array_len ¶

    +
    +
    make_soa_dynamic_array_len :: proc($T: typeid/#soa[dynamic]T, #any_int length: int, allocator := context.allocator, loc := #caller_location) -> (array: T, err: Allocator_Error) #optional_ok {…}
    +
    +
    +

    ordered_remove ¶

    ordered_remove :: proc(array: ^$T/[dynamic]$T, index: int, loc := #caller_location) {…}
    @@ -1508,6 +1544,12 @@

    orde

    +

    make_soa_dynamic_array_len_cap ¶

    +
    +
    make_soa_dynamic_array_len_cap :: proc($T: typeid/#soa[dynamic]T, #any_int length, #any_int capacity: int, allocator := context.allocator, loc := #caller_location) -> (array: T, err: Allocator_Error) #optional_ok {…}
    +
    +
    +

    remove_range ¶

    remove_range :: proc(array: ^$T/[dynamic]$T, lo, hi: int, loc := #caller_location) {…}
    @@ -1531,6 +1573,12 @@

    pop

    +

    resize_soa ¶

    +
    +
    resize_soa :: proc(array: ^$T/#soa[dynamic]$T, length: int, loc := #caller_location) -> Allocator_Error {…}
    +
    +
    +

    pop_safe ¶

    pop_safe :: proc "contextless" (array: ^$T/[dynamic]$T) -> (res: $T, ok: bool) {…}
    @@ -1542,6 +1590,18 @@

    pop_safe

    +

    reserve_soa ¶

    +
    +
    reserve_soa :: proc(array: ^$T/#soa[dynamic]$T, capacity: int, loc := #caller_location) -> Allocator_Error {…}
    +
    +
    +
    +

    append_soa_elem ¶

    +
    +
    append_soa_elem :: proc(array: ^$T/#soa[dynamic]$T, arg: $T, loc := #caller_location) -> (n: int, err: Allocator_Error) #optional_ok {…}
    +
    +
    +

    pop_front ¶

    pop_front :: proc(array: ^$T/[dynamic]$T, loc := #caller_location) -> (res: $T) {…}
    @@ -1553,6 +1613,12 @@

    pop_front

    +

    append_soa_elems ¶

    +
    +
    append_soa_elems :: proc(array: ^$T/#soa[dynamic]$T, .. args: ..$T, loc := #caller_location) -> (n: int, err: Allocator_Error) #optional_ok {…}
    +
    +
    +

    pop_front_safe ¶

    pop_front_safe :: proc "contextless" (array: ^$T/[dynamic]$T) -> (res: $T, ok: bool) {…}
    @@ -1564,6 +1630,33 @@

    pop_

    +

    unordered_remove_soa ¶

    +
    +
    unordered_remove_soa :: proc(array: ^$T/#soa[dynamic]$T, index: int, loc := #caller_location) {…}
    +
    +
    +  +

    unordered_remove_soa removed the element at the specified index. It does so by replacing the current end value +with the old value, and reducing the length of the dynamic array by 1.

    +

    Note: This is an O(1) operation. +Note: If you the elements to remain in their order, use ordered_remove_soa. +Note: If the index is out of bounds, this procedure will panic.

    +
    +
    +
    +

    ordered_remove_soa ¶

    +
    +
    ordered_remove_soa :: proc(array: ^$T/#soa[dynamic]$T, index: int, loc := #caller_location) {…}
    +
    +
    +  +

    ordered_remove_soa removed the element at the specified index whilst keeping the order of the other elements.

    +

    Note: This is an O(N) operation. +Note: If you the elements do not have to remain in their order, prefer unordered_remove_soa. +Note: If the index is out of bounds, this procedure will panic.

    +
    +
    +

    delete_string ¶

    delete_string :: proc(str: string, allocator := context.allocator, loc := #caller_location) -> Allocator_Error {…}
    @@ -1907,18 +2000,6 @@

    assert - -
    -
    raw_soa_footer_slice :: proc(array: ^$T/#soa[]$T) -> (footer: ^Raw_SOA_Footer_Slice) {…}
    -
    -

    -
    - -
    -
    raw_soa_footer_dynamic_array :: proc(array: ^$T/#soa[dynamic]$T) -> (footer: ^Raw_SOA_Footer_Dynamic_Array) {…}
    -
    -
    -

    panic ¶

    panic :: proc(message: string, loc := #caller_location) -> ! {…}
    @@ -1930,102 +2011,47 @@

    unimpl
    unimplemented :: proc(message: string, loc := #caller_location) -> ! {…}

    +

    Procedure Groups

    -

    make_soa_aligned ¶

    -
    -
    make_soa_aligned :: proc($T: typeid/#soa[]T, length: int, alignment: int, allocator := context.allocator, loc := #caller_location) -> (array: T, err: Allocator_Error) #optional_ok {…}
    -
    -
    -
    -

    make_soa_slice ¶

    -
    -
    make_soa_slice :: proc($T: typeid/#soa[]T, length: int, allocator := context.allocator, loc := #caller_location) -> (array: T, err: Allocator_Error) #optional_ok {…}
    -
    -
    -
    -

    make_soa_dynamic_array ¶

    -
    -
    make_soa_dynamic_array :: proc($T: typeid/#soa[dynamic]T, allocator := context.allocator, loc := #caller_location) -> (array: T, err: Allocator_Error) #optional_ok {…}
    -
    -
    -
    -

    make_soa_dynamic_array_len ¶

    -
    -
    make_soa_dynamic_array_len :: proc($T: typeid/#soa[dynamic]T, #any_int length: int, allocator := context.allocator, loc := #caller_location) -> (array: T, err: Allocator_Error) #optional_ok {…}
    -
    -
    -
    -

    make_soa_dynamic_array_len_cap ¶

    -
    -
    make_soa_dynamic_array_len_cap :: proc($T: typeid/#soa[dynamic]T, #any_int length, #any_int capacity: int, allocator := context.allocator, loc := #caller_location) -> (array: T, err: Allocator_Error) #optional_ok {…}
    -
    -
    -
    -

    resize_soa ¶

    -
    -
    resize_soa :: proc(array: ^$T/#soa[dynamic]$T, length: int, loc := #caller_location) -> Allocator_Error {…}
    -
    -
    -
    -

    reserve_soa ¶

    -
    -
    reserve_soa :: proc(array: ^$T/#soa[dynamic]$T, capacity: int, loc := #caller_location) -> Allocator_Error {…}
    -
    -
    -
    -

    append_soa_elem ¶

    -
    -
    append_soa_elem :: proc(array: ^$T/#soa[dynamic]$T, arg: $T, loc := #caller_location) -> (n: int, err: Allocator_Error) #optional_ok {…}
    -
    -
    -
    -

    append_soa_elems ¶

    -
    -
    append_soa_elems :: proc(array: ^$T/#soa[dynamic]$T, .. args: ..$T, loc := #caller_location) -> (n: int, err: Allocator_Error) #optional_ok {…}
    -
    -
    -
    -

    unordered_remove_soa ¶

    +

    copy ¶

    -
    unordered_remove_soa :: proc(array: ^$T/#soa[dynamic]$T, index: int, loc := #caller_location) {…}
    +
    copy :: proc{
    +	copy_slice,
    +	copy_from_string,
    +}
    +
      -

    unordered_remove_soa removed the element at the specified index. It does so by replacing the current end value -with the old value, and reducing the length of the dynamic array by 1.

    -

    Note: This is an O(1) operation. -Note: If you the elements to remain in their order, use ordered_remove_soa. -Note: If the index is out of bounds, this procedure will panic.

    +

    copy is a built-in procedure that copies elements from a source slice/string src to a destination slice dst. +The source and destination may overlap. Copy returns the number of elements copied, which will be the minimum +of len(src) and len(dst).

    -

    ordered_remove_soa ¶

    +

    make_soa ¶

    -
    ordered_remove_soa :: proc(array: ^$T/#soa[dynamic]$T, index: int, loc := #caller_location) {…}
    +
    make_soa :: proc{
    +	make_soa_slice,
    +	make_soa_dynamic_array,
    +	make_soa_dynamic_array_len,
    +	make_soa_dynamic_array_len_cap,
    +}
    +
    -
    -  -

    ordered_remove_soa removed the element at the specified index whilst keeping the order of the other elements.

    -

    Note: This is an O(N) operation. -Note: If you the elements do not have to remain in their order, prefer unordered_remove_soa. -Note: If the index is out of bounds, this procedure will panic.

    -
    -

    Procedure Groups

    -

    copy ¶

    +

    append_soa ¶

    -
    copy :: proc{
    -	copy_slice,
    -	copy_from_string,
    +
    append_soa :: proc{
    +	append_soa_elem,
    +	append_soa_elems,
     }
     
      -

    copy is a built-in procedure that copies elements from a source slice/string src to a destination slice dst. -The source and destination may overlap. Copy returns the number of elements copied, which will be the minimum -of len(src) and len(dst).

    +

    The append_soa built-in procedure appends elements to the end of an #soa dynamic array

    @@ -2079,6 +2105,16 @@

    resize +

    delete_soa ¶

    +
    +
    delete_soa :: proc{
    +	delete_soa_slice,
    +	delete_soa_dynamic_array,
    +}
    +
    +
    +

    +

    non_zero_resize ¶

    non_zero_resize :: proc{
    @@ -2102,6 +2138,15 @@ 

    shrink +

    clear_soa ¶

    +
    +
    clear_soa :: proc{
    +	clear_soa_dynamic_array,
    +}
    +
    +
    +

    +

    free ¶

    free :: proc{
    @@ -2216,51 +2261,6 @@ 

    assign_at

    - -
    -

    append_soa ¶

    -
    -
    append_soa :: proc{
    -	append_soa_elem,
    -	append_soa_elems,
    -}
    -
    -
    -
    -  -

    The append_soa built-in procedure appends elements to the end of an #soa dynamic array

    -
    -
    -
    -

    delete_soa ¶

    -
    -
    delete_soa :: proc{
    -	delete_soa_slice,
    -	delete_soa_dynamic_array,
    -}
    -
    -
    -
    -
    -

    clear_soa ¶

    -
    -
    clear_soa :: proc{
    -	clear_soa_dynamic_array,
    -}
    -
    -
    -