diff --git a/base/builtin/index.html b/base/builtin/index.html index d261c6bdf5..c2a4ed247b 100644 --- a/base/builtin/index.html +++ b/base/builtin/index.html @@ -233,28 +233,17 @@

Index

  • soa_zip
  • soa_unzip
  • raw_data
  • -
  • runtime.raw_soa_footer_slice
  • -
  • runtime.raw_soa_footer_dynamic_array
  • -
  • runtime.make_soa_aligned
  • runtime.container_of
  • -
  • runtime.make_soa_slice
  • -
  • runtime.make_soa_dynamic_array
  • runtime.init_global_temporary_allocator
  • runtime.copy_slice
  • -
  • runtime.make_soa_dynamic_array_len
  • runtime.copy_from_string
  • -
  • runtime.make_soa_dynamic_array_len_cap
  • runtime.unordered_remove
  • -
  • runtime.resize_soa
  • runtime.ordered_remove
  • runtime.remove_range
  • runtime.pop
  • runtime.pop_safe
  • -
  • runtime.reserve_soa
  • runtime.pop_front
  • -
  • runtime.append_soa_elem
  • runtime.pop_front_safe
  • -
  • runtime.append_soa_elems
  • runtime.delete_string
  • runtime.delete_cstring
  • runtime.delete_dynamic_array
  • @@ -262,9 +251,7 @@

    Index

  • runtime.delete_map
  • runtime.new
  • runtime.new_clone
  • -
  • runtime.unordered_remove_soa
  • runtime.make_slice
  • -
  • runtime.ordered_remove_soa
  • runtime.make_dynamic_array
  • runtime.make_dynamic_array_len
  • runtime.make_dynamic_array_len_cap
  • @@ -288,16 +275,29 @@

    Index

  • runtime.assign_at_elem
  • runtime.assign_at_elems
  • runtime.assign_at_elem_string
  • +
  • runtime.raw_soa_footer_slice
  • runtime.clear_dynamic_array
  • +
  • runtime.raw_soa_footer_dynamic_array
  • +
  • runtime.make_soa_aligned
  • +
  • runtime.make_soa_slice
  • runtime.reserve_dynamic_array
  • +
  • runtime.make_soa_dynamic_array
  • runtime.non_zero_reserve_dynamic_array
  • +
  • runtime.make_soa_dynamic_array_len
  • +
  • runtime.make_soa_dynamic_array_len_cap
  • runtime.resize_dynamic_array
  • runtime.non_zero_resize_dynamic_array
  • +
  • runtime.resize_soa
  • +
  • runtime.reserve_soa
  • runtime.map_insert
  • +
  • runtime.append_soa_elem
  • runtime.map_upsert
  • +
  • runtime.append_soa_elems
  • runtime.card
  • runtime.assert
  • +
  • runtime.unordered_remove_soa
  • runtime.panic
  • +
  • runtime.ordered_remove_soa
  • runtime.unimplemented
  • @@ -307,10 +307,8 @@

    Index

    Procedure Groups (19) @@ -1443,42 +1443,12 @@

    raw_data
    - -
    -
    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) {…}
    -
    -
    -
    -

    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 {…}
    -
    -
    -

    container_of ¶

    container_of :: proc "contextless" (ptr: $P/^$T, $T: typeid, $field_name: string = ) -> ^typeid {…}
    -

    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 {…}
    -
    -
    -

    init_global_temporary_allocator ¶

    init_global_temporary_allocator :: proc(size: int, backup_allocator := context.allocator) {…}
    @@ -1498,12 +1468,6 @@

    copy_slice

    -

    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 {…}
    -
    -
    -

    copy_from_string ¶

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

    -

    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 {…}
    -
    -
    -

    unordered_remove ¶

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

    -

    resize_soa ¶

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

    ordered_remove ¶

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

    pop_safe

    -

    reserve_soa ¶

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

    pop_front ¶

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

    pop_front

    -

    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_safe ¶

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

    pop_

    -

    append_soa_elems ¶

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

    delete_string ¶

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

    new_clone

    -

    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.

    -
    -
    -

    make_slice ¶

    make_slice :: proc($T: typeid/[]T, #any_int len: int, allocator := context.allocator, loc := #caller_location) -> (T, Allocator_Error) #optional_ok {…}
    @@ -1728,19 +1648,6 @@

    make_slice

    -

    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.

    -
    -
    -

    make_dynamic_array ¶

    make_dynamic_array :: proc($T: typeid/[dynamic]T, allocator := context.allocator, loc := #caller_location) -> (T, Allocator_Error) #optional_ok {…}
    @@ -1934,6 +1841,12 @@

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

    +

    clear_dynamic_array ¶

    clear_dynamic_array :: proc "contextless" (array: ^$T/[dynamic]$T) {…}
    @@ -1945,18 +1858,54 @@

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

    +
    +

    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 {…}
    +
    +
    +

    reserve_dynamic_array ¶

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

    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 {…}
    +
    +
    +

    non_zero_reserve_dynamic_array ¶

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

    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_dynamic_array ¶

    resize_dynamic_array :: proc(array: ^$T/[dynamic]$T, length: int, loc := #caller_location) -> Allocator_Error {…}
    @@ -1969,12 +1918,30 @@

    +

    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 {…}
    +
    +
    +

    map_insert ¶

    map_insert :: proc(m: ^$T/map[$T]$T, key: $T, value: $T, loc := #caller_location) -> (ptr: ^$T) {…}
    +

    append_soa_elem ¶

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

    map_upsert ¶

    map_upsert :: proc(m: ^$T/map[$T]$T, key: $T, value: $T, loc := #caller_location) -> (prev_key: $T, value_ptr: ^$T, found_previous: bool) {…}
    @@ -1988,6 +1955,12 @@

    map_upsert

    +

    append_soa_elems ¶

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

    card ¶

    card :: proc "contextless" (s: $S/bit_set[$T]) -> int {…}
    @@ -2000,30 +1973,45 @@

    assert +

    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.

    +
    +

    +

    panic ¶

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

    unimplemented ¶

    +

    ordered_remove_soa ¶

    -
    unimplemented :: proc(message: string, loc := #caller_location) -> ! {…}
    +
    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.

    +
    -

    Procedure Groups

    +

    Procedure Groups

    copy ¶

    @@ -2055,20 +2043,6 @@

    clear -

    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

    -
    -

    -

    reserve ¶

    reserve :: proc{
    @@ -2174,25 +2148,6 @@ 

    delete -

    delete_soa ¶

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

    -
    -

    clear_soa ¶

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

    make ¶

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

    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,
    +}
    +
    +
    +