Contribute in GitHub:
Edit online
array_shift_right()
array_shift_right() shifts values inside an array to the right.
Syntax
array_shift_right(array, shift_count [, fill_value ])
Arguments
- array: Input array to shift, must be dynamic array.
- shift_count: Integer specifying the number of positions that array elements will be shifted to the right. If the value is negative, the elements will be shifted to the left.
- fill_value: scalar value that is used for inserting elements instead of the ones that were shifted and removed. Default: null value or empty string (depending on the array type).
Returns
Dynamic array containing the same amount of the elements as in the original array. Each element has been shifted according to shift_count. New elements that are added instead of the removed elements will have a value of fill_value.
See also
- For shifting array left, see array_shift_left().
- For rotating array right, see array_rotate_right().
- For rotating array left, see array_rotate_left().
Examples
Shifting to the right by two positions:
print arr=dynamic([1,2,3,4,5])
| extend arr_shift=array_shift_right(arr, 2)
<p></p>
Results
|arr |arr_shift |
|-----------|-----------------|
|[1,2,3,4,5]|[null,null,1,2,3]|
Shifting to the right by two positions and adding a default value:
print arr=dynamic([1,2,3,4,5])
| extend arr_shift=array_shift_right(arr, 2, -1)
Results
|arr |arr_shift |
|-----------|-------------|
|[1,2,3,4,5]|[-1,-1,1,2,3]|
- Shifting to the left by two positions by using a negative shift_count value:
print arr=dynamic([1,2,3,4,5])
| extend arr_shift=array_shift_right(arr, -2, -1)
Results
|arr |arr_shift |
|-----------|-------------|
|[1,2,3,4,5]|[3,4,5,-1,-1]|