IOTConnect-Web/node_modules/js-sdsl/dist/cjs/container/SequentialContainer/Base/index.d.ts

import { Container } from "../../ContainerBase";
declare abstract class SequentialContainer<T> extends Container<T> {
    /**
     * @description Push the element to the back.
     * @param element - The element you want to push.
     * @returns The size of container after pushing.
     */
    abstract pushBack(element: T): number;
    /**
     * @description Removes the last element.
     * @returns The element you popped.
     */
    abstract popBack(): T | undefined;
    /**
     * @description Sets element by position.
     * @param pos - The position you want to change.
     * @param element - The element's value you want to update.
     * @example
     * container.setElementByPos(-1, 1); // throw a RangeError
     */
    abstract setElementByPos(pos: number, element: T): void;
    /**
     * @description Removes the elements of the specified value.
     * @param value - The value you want to remove.
     * @returns The size of container after erasing.
     * @example
     * container.eraseElementByValue(-1);
     */
    abstract eraseElementByValue(value: T): number;
    /**
     * @description Insert several elements after the specified position.
     * @param pos - The position you want to insert.
     * @param element - The element you want to insert.
     * @param num - The number of elements you want to insert (default 1).
     * @returns The size of container after inserting.
     * @example
     * const container = new Vector([1, 2, 3]);
     * container.insert(1, 4);  // [1, 4, 2, 3]
     * container.insert(1, 5, 3); // [1, 5, 5, 5, 4, 2, 3]
     */
    abstract insert(pos: number, element: T, num?: number): number;
    /**
     * @description Reverses the container.
     * @example
     * const container = new Vector([1, 2, 3]);
     * container.reverse(); // [3, 2, 1]
     */
    abstract reverse(): void;
    /**
     * @description Removes the duplication of elements in the container.
     * @returns The size of container after inserting.
     * @example
     * const container = new Vector([1, 1, 3, 2, 2, 5, 5, 2]);
     * container.unique(); // [1, 3, 2, 5, 2]
     */
    abstract unique(): number;
    /**
     * @description Sort the container.
     * @param cmp - Comparison function to sort.
     * @example
     * const container = new Vector([3, 1, 10]);
     * container.sort();  // [1, 10, 3]
     * container.sort((x, y) => x - y); // [1, 3, 10]
     */
    abstract sort(cmp?: (x: T, y: T) => number): void;
}
export default SequentialContainer;