cocos-engine/cocos/core/algorithm/partition.ts

/*
 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.
*/

/**
 * @zh
 * 就地重新排列数组中的元素，
 * 使所有令谓词 `predicate` 返回 `true`的元素都排在所有令谓词 `predicate` 返回 `false`的元素前面。
 * 不会保留元素的相对顺序。
 * @en
 * Reorders the elements in array **in place** in such a way that
 * all elements for which the predicate `predicate` returns `true` precede
 * the elements for which predicates `predicate` returns `false`.
 * Relative order of the elements is *NOT* preserved.
 * @param array @zh 输入数组。 @en The input array.
 * @param predicate @zh 谓词，当元素应该被排列在其它元素前面时返回 `true`。
 *                  @en The predicate which returns `true` if the element should be ordered before other elements.
 * @returns @zh 第一组元素的个数。
 *          @en The number of elements in the first group.
 * @example
 * ```ts
 * const array = [7, 1, 2, 4, 3];
 * const nFirstGroupElements = partition(array, (v) => v % 2 === 0);
 * log(nFirstGroupElements); // 2
 * log(array); // [2, 4, 7, 1, 3]
 * log(array.slice(0, nFirstGroupElements)); // [2, 4]
 * log(array.slice(nFirstGroupElements)); // [7, 1, 3]
 * ```
 */
export function partition<T> (array: T[], predicate: (element: T, index: number, array: T[]) => boolean): number {
    const nElements = array.length;

    // Finds the first element to be placed into second group(predicate to false).
    let iFirstGroup2Element = 0;
    for (; iFirstGroup2Element < nElements; ++iFirstGroup2Element) {
        const element = array[iFirstGroup2Element];
        if (!predicate(element, iFirstGroup2Element, array)) {
            break;
        }
    }

    // If no element should be placed into seconds group. Do nothing.
    if (iFirstGroup2Element === nElements) {
        return nElements;
    }

    let nGroup1 = iFirstGroup2Element;
    for (let iElement = iFirstGroup2Element + 1; iElement < nElements; ++iElement) {
        const element = array[iElement];
        const isFirstGroupElement = predicate(element, iElement, array);
        if (isFirstGroupElement) {
            // Swap to front.
            const t = element;
            array[iElement] = array[nGroup1];
            array[nGroup1] = t;
            ++nGroup1;
        }
    }
    return nGroup1;
}