♻️ refactor: Improve docstrings and simplify some trivial generators.

Author: make-github-pseudonymous-again

src/_bitreversal.js

@@ -5,7 +5,7 @@
  * power of <code>2</code>.
  *
  * @param {Array} array The array to fill.
- * @param {Number} n The size of the permutation, must be a power of 2.
+ * @param {number} n The size of the permutation, must be a power of 2.
  */
 export function _bitreversal(array, n) {
 	let i = 1;

src/_compose.js

@@ -4,7 +4,7 @@
  *
  * @param {Array} sigma The first input permutation.
  * @param {Array} tau The second input permutation.
- * @returns {Iterator} An iterator over the items of the resulting permutation.
+ * @returns {IterableIterator} An iterator over the items of the resulting permutation.
  */
 export function* _compose(sigma, tau) {
 	for (const t of tau) yield sigma[t];

src/_copy.js

@@ -2,7 +2,7 @@
  * Copy an input permutation to an output array.
  *
  * @param {Array} sigma The input permutation.
- * @param {Number} n The size of the input permutation to copy.
+ * @param {number} n The size of the input permutation to copy.
  * @param {Array} tau The output array.
  */
 export function _copy(sigma, n, tau) {

src/_cycles.js

@@ -14,7 +14,7 @@
  *
  * @param {Array} sigma The input permutation.
  * @param {Array} used The helper array.
- * @returns {Iterator} The cycles <code>[a, [b, c, ...]]</code> for sigma.
+ * @returns {IterableIterator} The cycles <code>[a, [b, c, ...]]</code> for sigma.
  */
 export function* _cycles(sigma, used) {
 	for (const s of sigma) {

src/_identity.js

@@ -3,7 +3,7 @@
  * elements.
  *
  * @param {Array} sigma The input array.
- * @param {Number} n The size to use for the permutation.
+ * @param {number} n The size to use for the permutation.
  */
 export function _identity(sigma, n) {
 	for (let i = 0; i < n; ++i) sigma[i] = i;

src/_invert.js

@@ -6,7 +6,7 @@
  * API.
  *
  * @param {Array} sigma The input permutation.
- * @param {Number} n The size of the input permutation.
+ * @param {number} n The size of the input permutation.
  * @param {Array} tau The array where to put the inverse of the input permutation.
  */
 export function _invert(sigma, n, tau) {

src/_itranspositions.js

@@ -6,7 +6,7 @@
  *
  * @param {Array} sigma Input permutation.
  * @param {Array} used Helper array.
- * @return {Iterator} Iterator over the transpositions.
+ * @return {IterableIterator} Iterator over the transpositions.
  */
 export function* _itranspositions(sigma, used) {
 	for (const s of sigma) {

src/_next.js

@@ -7,7 +7,7 @@ import {_reverse} from './_reverse.js';
  * input permutation remains untouched.
  *
  * @param {Array} sigma The input permutation (modified in-place).
- * @param {Number} n The size of the input permutation.
+ * @param {number} n The size of the input permutation.
  * @returns {Boolean} Whether the input permutation is
  * __NOT__ the last for its elements.
  */

src/_permutations.js

@@ -5,8 +5,8 @@ import {_next} from './_next.js';
  * permutation.
  *
  * @param {Array} sigma The starting permutation.
- * @param {Number} n The size of the permutation.
- * @returns {Iterator} Iterator over all permutations between the starting one
+ * @param {number} n The size of the permutation.
+ * @returns {IterableIterator} Iterator over all permutations between the starting one
  * and the last permutation on its elements.
  */
 export function* _permutations(sigma, n) {

src/_reverse.js

@@ -5,8 +5,8 @@ import {_transpose} from './_transpose.js';
  * (include) to input index <code>j</code> (excluded).
  *
  * @param {Array} sigma The input permutation to reverse (modified in-place).
- * @param {Number} i The left bound (included).
- * @param {Number} j The right bound (excluded).
+ * @param {number} i The left bound (included).
+ * @param {number} j The right bound (excluded).
  */
 export function _reverse(sigma, i, j) {
 	while (i < --j) _transpose(i++, j, sigma);