Skip to content

arrays.c

reverse_array

Synopsis

mixed *reverse_array(mixed *arr)

Parameters

  • mixed* arr - The input array.

Returns

mixed* - A new array with elements in reverse order.

Description

Returns a new array with the elements of the input array in reverse order.

shift

Synopsis

mixed shift(mixed ref *arr)

Parameters

  • mixed* arr - The array from which to shift an element.

Returns

mixed - The first element of the array.

Description

Removes and returns the first element of the array.

uniform_array

Synopsis

int uniform_array(string type, mixed *arr)

Parameters

  • string type - The type to check for.
  • mixed* arr - The array to check.

Returns

int - Returns 1 if all elements are of the specified type, 0 otherwise.

Description

Checks if all elements in the input array are of the specified type. If the array is of size 0, it is considered uniform.

array_fill

Synopsis

varargs mixed array_fill(mixed *arr, mixed value, int size, int start_index)

Parameters

  • mixed* arr - The array to fill.
  • mixed value - The value to fill the array with.
  • int start_index - The index at which to start filling the array. (optional)

Description

Returns an array filled with the specified value. If no array is provided, an empty array is created. If no value is provided, 0 is used as the value to fill the array with. If no start index is provided, the array is filled from the end.

pop

Synopsis

mixed pop(mixed ref *arr)

Parameters

  • mixed* arr - The array from which to pop an element.

Returns

mixed - The last element of the array.

Description

Removes and returns the last element of the array.

remove_array_element

Synopsis

varargs mixed *remove_array_element(mixed *arr, int start, int end)

Parameters

  • mixed* arr - The input array.
  • int start - The starting index of elements to be removed.
  • int end - The ending index of elements to be removed. Defaults to start if not specified.

Returns

mixed* - A new array with specified elements removed.

Description

Returns a new array containing the elements of the input array from index 0 to start-1, and from end+1 to the end of the input array. If start is greater than end, the new array will contain all the elements of the input array.

array_pad

Synopsis

varargs mixed array_pad(mixed *arr, int size, mixed value, int beginning)

Parameters

  • mixed* arr - The array to pad.
  • int size - The size of the array to create.
  • mixed value - The value to fill the array with.
  • int beginning - Whether to fill the array from the beginning. (optional)

Description

Returns a new array of the specified size, filled with the specified value. If the array is larger than the specified size, the array is truncated to the specified size.

array_merge

Synopsis

mixed *array_merge(mixed *arr1, mixed *arr2)

Parameters

  • mixed* arr1 - The first array to merge.
  • mixed* arr2 - The second array to merge.

Returns

mixed* - A new array with elements from both input arrays.

Description

Merges two arrays into a single array.

push

Synopsis

int push(mixed ref *arr, mixed value)

Parameters

  • mixed* arr - The array to which to push an element.
  • mixed value - The element to push onto the array.

Returns

int - The new size of the array.

Description

Adds a new element to the end of the array and returns the new size of the array.

distinct_array

Synopsis

mixed *distinct_array(mixed *arr)

Parameters

  • mixed* arr - An array of mixed types.

Returns

mixed* - A new array with distinct elements from the input array.

Description

Returns a new array containing the distinct elements of the input array.

array_slice

Synopsis

varargs mixed *array_slice(mixed *arr, int start, int end)

Parameters

  • mixed* arr - The array to slice.
  • int start - The starting index of the slice.
  • int end - The ending index of the slice.

Returns

mixed* - A new array with the specified elements.

Description

Returns a new array containing the elements of the input array from the start index to the end index. If the end index is negative, it will start from the end of the array.

unshift

Synopsis

int unshift(mixed ref *arr, mixed value)

Parameters

  • mixed* arr - The array to which to unshift an element.
  • mixed value - The element to unshift onto the array.

Returns

int - The new size of the array.

Description

Adds a new element to the beginning of the array and returns the new size of the array.

splice

Synopsis

varargs mixed *splice(mixed *arr, int start, int delete_count, mixed *items_to_add)

Parameters

  • mixed* arr - The array from which elements will be removed and to which new elements may be added.
  • int start - The zero-based index at which to start changing the array. If negative, it will begin that many elements from the end.
  • int delete_count - The number of elements to remove from the array, starting from the index specified by start. If delete_count is 0, no elements are removed.
  • mixed* [items_to_add] - An array of elements to add to the array at the start index. Can be omitted or passed as null if no elements are to be added.

Returns

mixed* - A new array reflecting the desired modifications.

Description

Modifies the content of an array by removing existing elements and/or adding new elements. Returns a new array with the modifications.