mirror of
https://github.com/Tria-plc/emaui.git
synced 2026-08-27 21:20:58 +00:00
32 lines
1.4 KiB
JavaScript
32 lines
1.4 KiB
JavaScript
import { sampleSize as sampleSize$1 } from "../../array/sampleSize.mjs";
|
|
import { toInteger } from "../util/toInteger.mjs";
|
|
import { isIterateeCall } from "../_internal/isIterateeCall.mjs";
|
|
import { clamp } from "../math/clamp.mjs";
|
|
import { toArray } from "../util/toArray.mjs";
|
|
//#region src/compat/array/sampleSize.ts
|
|
/**
|
|
* Returns a sample element array of a specified `size`.
|
|
*
|
|
* This function takes an array and a number, and returns an array containing the sampled elements using Floyd's algorithm.
|
|
*
|
|
* {@link https://www.nowherenearithaca.com/2013/05/robert-floyds-tiny-and-beautiful.html Floyd's algorithm}
|
|
*
|
|
* @template T - The type of elements in the array.
|
|
* @param {Record<string, T> | Record<number, T> | T | null | undefined} collection - The array to sample from.
|
|
* @param {number} size - The size of sample.
|
|
* @returns {Array<T[keyof T]> | T[]} A new array with sample size applied.
|
|
*
|
|
* @example
|
|
* const result = sampleSize([1, 2, 3], 2)
|
|
* // result will be an array containing two of the elements from the collection.
|
|
* // [1, 2] or [1, 3] or [2, 3]
|
|
*/
|
|
function sampleSize(collection, size, guard) {
|
|
const arrayCollection = toArray(collection);
|
|
if (guard ? isIterateeCall(collection, size, guard) : size === void 0) size = 1;
|
|
else size = clamp(toInteger(size), 0, arrayCollection.length);
|
|
return sampleSize$1(arrayCollection, size);
|
|
}
|
|
//#endregion
|
|
export { sampleSize };
|