|
| 1 | +{{fbdoc item="title" value="Arrays"}}---- |
| 2 | +An array in fbc is a collection of elements where each element has the same type and is accessed with an index in to the array. |
| 3 | + |
| 4 | +Example: |
| 5 | +%%(freebasic) |
| 6 | + '' one dimensional array (1 index) |
| 7 | + dim a(1 to 10) as integer |
| 8 | + print a(1) '' first element (integer) |
| 9 | + print a(10) '' last element (integer) |
| 10 | + |
| 11 | + '' two dimensional array (2 indexes) |
| 12 | + dim b(1 to 2, 1 to 5) as integer |
| 13 | + print b(1,1) '' first element (integer) |
| 14 | + print b(2,5) '' last element (integer) |
| 15 | +%% |
| 16 | + |
| 17 | +{{fbdoc item="section" value="Array Dimensions and Bounds"}} |
| 18 | + |
| 19 | +The number of dimensions refers to the number of indexes that are required to be given to access an element of an array. The number of dimensions may or may not be part of the declaration. If the number of dimensions are known at compile time within the scope that the array is used, fbc can check and error if the wrong number of indexes are specified. |
| 20 | + |
| 21 | +The bounds of an array are the allowable minimum and maximum index values for each dimension. Accessing an array element with an index or indexes that are outside the array bounds of a dimension is undefined behaviour. |
| 22 | + |
| 23 | +fbc can check and error if an index or indexes (access) are outside the bounds of the array when compiled with '-exx' or '-earray' compile options. If the array bounds are compile-time constant, and the array access is compile-time constant, fbc can check if an array access is outside the bounds of the array at compile time. Otherwise, the array bounds check must occur at run-time if either the bounds or the access is non-constant. |
| 24 | + |
| 25 | +{{fbdoc item="section" value="Fixed dimension versus unknown dimension"}} |
| 26 | + |
| 27 | +The number of dimensions may be fixed or unknown. fbc will attempt to determine the number of dimensions an array is expected to have based on declarations for the array. If fbc cannot determine the number of dimensions at compile time, the number of dimensions will become fixed on first redimension of the array at run time. |
| 28 | + |
| 29 | +Example: fixed 2 dimension, dynamic bounds |
| 30 | +%%(freebasic) |
| 31 | +dim a(any, any) as integer |
| 32 | +redim a(1 to 2, 1 to 5) |
| 33 | +%% |
| 34 | + |
| 35 | +Example: Dynamic dimension, dynamic bounds |
| 36 | +%%(freebasic) |
| 37 | +dim a() as integer |
| 38 | + |
| 39 | +'' then only one of on first time use ... |
| 40 | +redim a(1 to 10) |
| 41 | +redim a(1 to 2, 1 to 5) |
| 42 | +redim a(1 to 2, 1 to 5, 1 to 3) |
| 43 | +%% |
| 44 | + |
| 45 | +Once number of dimensions are known to fbc, within the scope of the array, fbc will error if any access to the error has wrong number of dimensions. Or if still unknown at compile time, as in the case of an array passed as argument to a procedure and resized, the number of dimensions become fixed at run time. |
| 46 | + |
| 47 | +{{fbdoc item="section" value="Fixed bounds versus Dynamic bounds"}} |
| 48 | + |
| 49 | +Fixed length arrays have array bounds that are known at compile-time. Dynamic (or variable length) arrays have array bounds that can be altered and resized at run-time, and may be considered unknown at compile time. |
| 50 | + |
| 51 | +Example: fixed (constant) bounds and constant access |
| 52 | +%%(freebasic) |
| 53 | +dim a(1 to 10) as integer |
| 54 | +print a(11) '' compile time array out-of-bounds |
| 55 | +%% |
| 56 | + |
| 57 | +Example: fixed bounds and non-constant access |
| 58 | +%%(freebasic) |
| 59 | +dim a(1 to 10) as integer |
| 60 | +dim i as integer |
| 61 | +print a(i) '' run time array out-of-bounds |
| 62 | +%% |
| 63 | + |
| 64 | +Example: dynamic bounds |
| 65 | +%%(freebasic) |
| 66 | +dim a(any) as integer '' 1 dimensional, empty |
| 67 | +redim a(1 to 10) '' resized to 10 elements |
| 68 | +print a(11) '' run time array out-of-bounds |
| 69 | +print a(i) '' run time array out-of-bounds |
| 70 | +%% |
| 71 | + |
| 72 | +{{fbdoc item="section" value="Static Array versus Dynamic Array"}} |
| 73 | + |
| 74 | +Arrays may have static or dynamic memory allocation. The descriptor may be static or dynamic, and memory space for the data may be static or dynamic. The terms static and dynamic may be overused and so may lose meaning when describing an array. In this context static versus dynamic should not be confused with fixed-length or variable-length. In this context we are referring to how and where the array descriptor and it's associated data are allocated in memory, and to some extent the life time of the variable. |
| 75 | + |
| 76 | +For an array descriptor to be valid, it must be initialized. An uninitialized array descriptor will almost certainly lead to undefined behaviour at run time. |
| 77 | + |
| 78 | +The array descriptor itself may be allocated in .bss, .data, on stack or on heap, depending on the declaration of the array. Though typically not in .bss section because an array descriptor usually must be initialized to some non-zero default values to be usable. |
| 79 | + |
| 80 | +The array's data may be located in .bss section, .data section, on stack or on heap, depending on the declaration of the array. In fbc's current implementation, the array data for variable-length arrays is always allocated on the heap (i.e. malloc()). |
| 81 | + |
| 82 | +{{fbdoc item="section" value="Array Descriptor"}} |
| 83 | + |
| 84 | +At compile time, fbc allocates an array descriptor to store and track information about the array. |
| 85 | + |
| 86 | +From ##./inc/fbc-int/array.bi##): |
| 87 | +%%(freebasic) |
| 88 | + const FB_MAXDIMENSIONS as integer = 8 |
| 89 | + |
| 90 | + type FBARRAYDIM |
| 91 | + dim as uinteger elements '' number of elements |
| 92 | + dim as integer lbound '' dimension lower bound |
| 93 | + dim as integer ubound '' dimension upper bound |
| 94 | + end type |
| 95 | + |
| 96 | + type FBARRAY |
| 97 | + dim as any ptr index_ptr '' @array(0, 0, 0, ... ) |
| 98 | + dim as any ptr base_ptr '' start of memory at array lowest bounds |
| 99 | + dim as uinteger size '' byte size of allocated contents |
| 100 | + dim as uinteger element_len '' byte size of single element |
| 101 | + dim as uinteger dimensions '' number of dimensions |
| 102 | + dim as FBARRAYDIM dimTb(0 to FB_MAXDIMENSIONS-1) |
| 103 | + end type |
| 104 | +%% |
| 105 | + |
| 106 | +If the number of dimensions is unknown at compile time, then the full ##FB_MAXDIMENSIONS## is allocated in the ##dimTb()## field. Otherwise, if the number dimensions is known at compile time, then only the number of dimensions needed are allocated. Therefore the allocated ##FBARRAY## data may be smaller than the declared ##FBARRAY## structure. |
| 107 | + |
| 108 | +If an array is passed as argument to a procedure, an array descriptor is allocated. However, if the array is static, fixed length, and never passed as an argument, then all information about the array is known at compile time, including memory locations, and the allocation of a descriptor is optimized out, since all expressions involving the array are compile time constant. |
| 109 | + |
| 110 | +The array descriptor may also be allocated at run time, as would be in the case of allocating a new UDT containing a variable-length array field member. |
| 111 | + |
| 112 | +{{fbdoc item="subsect" value="FBARRAY.index"}} |
| 113 | +Pointer to the array data ##@array(0, 0, ...)##. This pointer may be outside of the actual array data as a kind of virtual pointer to use when calculating offsets using indexes in to the array. |
| 114 | + |
| 115 | +{{fbdoc item="subsect" value="FBARRAY.base"}} |
| 116 | +Pointer to the array's memory at the array's lowest bound. For variable-length arrays allocated at run time, this points to the allocated memory region (i.e. malloc) |
| 117 | + |
| 118 | +{{fbdoc item="subsect" value="FBARRAY.size"}} |
| 119 | +Total size in bytes of the array data. Size is equal to total number of elements in the array (all dimensions) multiplied by element length. i.e. ##size = dimTb(0).elements * element_len + dimTb(1).elements * element_len + ...## |
| 120 | + |
| 121 | +{{fbdoc item="subsect" value="FBARRAY.element_len"}} |
| 122 | +Size in bytes of an individual element. Must be set to non-zero value. |
| 123 | + |
| 124 | +{{fbdoc item="subsect" value="FBARRAY.dimensions"}} |
| 125 | +Number of valid dimensions in the dimTb() table. A value of zero (0) indicates that dimTb() has ##FB_MAXDIMENSIONS## avaiable, but the array does not yet have number of dimensions defined. On first REDIM, the number of dimensions will be set. |
| 126 | + |
| 127 | +{{fbdoc item="subsect" value="FBARRAY.dimTb()"}} |
| 128 | +dimTb() is an array of ##FBARRAYDIM## to indicate the bounds of each dimension. |
| 129 | + |
| 130 | +If the number of dimensions is unknown at compile time, then the full ##FB_MAXDIMENSIONS## is allocated in the ##dimTb()## field. Otherwise, if the number dimensions is known at compile time, then only the number of dimensions needed are allocated. Therefore the allocated ##FBARRAY## data may be smaller than the declared ##FBARRAY## structure. |
| 131 | + |
| 132 | +{{fbdoc item="subsect" value="FBARRAYDIM.elements"}} |
| 133 | +Number of elements in the dimension. i.e. ##(ubound-lbound+1)## |
| 134 | + |
| 135 | +{{fbdoc item="subsect" value="FBARRAYDIM.lbound"}} |
| 136 | +Lower bound is the lowest valid index in this dimension. |
| 137 | + |
| 138 | +{{fbdoc item="subsect" value="FBARRAYDIM.ubound"}} |
| 139 | +Upper bound is the highest valid index in this dimension. |
| 140 | + |
| 141 | + |
| 142 | +{{fbdoc item="back" value="DevToc|FreeBASIC Developer Information"}} |
| 143 | +{{fbdoc item="back" value="DocToc|Table of Contents"}} |
0 commit comments