/*
 Copyright (c) 2022-2023 Xiamen Yaji Software Co., Ltd.

 https://www.cocos.com/

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights to
 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 of the Software, and to permit persons to whom the Software is furnished to do so,
 subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
*/

import { assertsArrayIndex } from '@base/debug/internal';

/**
 * @en Circle shift an array once in range [first, last]. If `first < last`, then will do left circle shift;
 * If `first > last`, then will do right circle shift; If `first == last`, there is not effect.
 * @zh 在 [first, last] 范围做一次环形移动。如果 `first < last`，进行左环形移动；如果 `first > last`，进行右环
 * 形移动；如果 `first == last`，将没有效果。
 * @param array @en The array to be rotated. @zh 被修改的数组。
 * @param first @en The beginning of the original range. @zh 移动区间的起始坐标。
 * @param last @en The end of the original range. @zh 移动区间的结束坐标。
 * @returns @en The input array. @zh 输入的数组。
 * @engineInternal
 */
export function shift<T> (array: T[], first: number, last: number): T[] {
    assertsArrayIndex(array, first);
    assertsArrayIndex(array, last);
    if (first === last) {
        return array;
    }
    const element = array[first];
    if (first < last) { // Shift left.
        for (let iElement = first + 1; iElement <= last; ++iElement) {
            array[iElement - 1] = array[iElement];
        }
    } else { // Shift right.
        for (let iElement = first; iElement !== last; --iElement) {
            array[iElement] = array[iElement - 1];
        }
    }
    array[last] = element;
    return array;
}