Skip to content

Commit 579b75d

Browse files
docs:
add missing types
1 parent 67dfbd5 commit 579b75d

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

src/_apply.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import { _transpose } from './_transpose' ;
44
* Applies a given sequence (in the given order) of transpositions (given as
55
* index tuples) to a given permutation. The permutation is modified in place.
66
*
7-
* @param transpositions The given transpositions to apply.
8-
* @param sigma The permutation to apply the transpositions to.
7+
* @param {Iterable} transpositions The given transpositions to apply.
8+
* @param {Array} sigma The permutation to apply the transpositions to.
99
*/
1010
export function _apply ( transpositions , sigma ) {
1111

src/_identity.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
* Fills an input array with the identity permutation on input <code>n</code>
44
* elements.
55
*
6-
* @param sigma The input array.
7-
* @param n The size to use for the permutation.
6+
* @param {Array} sigma The input array.
7+
* @param {Number} n The size to use for the permutation.
88
*/
99
export function _identity ( sigma , n ) {
1010

src/_used.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
* example, for computing the cycle decomposition of an input permutation (see
77
* {@link _cycles}, {@link cycles}).
88
*
9-
* @param n The given size.
10-
* @param array The input array.
9+
* @param {Number} n The given size.
10+
* @param {Array} array The input array.
1111
*/
1212
export function _used ( n , array ) {
1313

src/apply.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ import { _apply } from './_apply' ;
55
* Apply a given sequence (in the given order) of transpositions (given as
66
* index tuples) to the identity permutation over input <code>n</code> elements.
77
*
8-
* @param n The size of the identity permutation to apply the transpositions
8+
* @param {Number} n The size of the identity permutation to apply the transpositions
99
* to.
10-
* @param transpositions The given transpositions to apply.
10+
* @param {Iterable} transpositions The given transpositions to apply.
1111
* @returns {Array} The resulting permutation.
1212
*/
1313
export function apply ( n , transpositions ) {

0 commit comments

Comments
 (0)