Skip to content

Enhance type definitions in Matrix and Tensor classes #976

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ishii-norimi merged 1 commit into from
Jun 10, 2025
Merged

Enhance type definitions in Matrix and Tensor classes #976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 20 additions & 10 deletions lib/util/matrix.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1316,33 +1316,43 @@ export default class Matrix {
return r
}

/**
* Returns a matrix reduced along all element with the callback function.
* @overload
* @param {function (T, T, number[], Matrix<T>): T} cb Reducing function
* @param {undefined | null} [init] Initial value
* @returns {T} Reduced value
*/
/**
* Returns a matrix reduced along all element with the callback function.
* @template U
* @overload
* @param {function (U, T, number[], Matrix<T>): U} cb Reducing function
* @param {U} [init] Initial value
* @param {U} init Initial value
* @returns {U} Reduced value
*/
/**
* Returns a matrix reduced along the axis with the callback function.
* @template U
* @template {number | number[]} A
* @template {boolean} F
* @overload
* @param {function (U, T, number[], Matrix<T>): U} cb Reducing function
* @param {U} init Initial value
* @param {0 | 1} axis Axis to be reduced
* @param {boolean} [keepdims] Keep dimensions or not. If null, negative axis retuns number and other axis returns Matrix.
* @returns {Matrix<U>} Reduced matrix
* @param {function (T, T, number[], Matrix<T>): T} cb Reducing function
* @param {undefined | null} init Initial value
* @param {A} axis Axis to be reduced
* @param {F} [keepdims] Keep dimensions or not. If null, negative axis retuns number and other axis returns Matrix.
* @returns {Matrix<T> | (A extends 0 | 1 ? never : F extends true ? never : T)} Reduced matrix
*/
/**
* Returns a matrix reduced along the axis with the callback function.
* @template U
* @template {number | number[]} A
* @template {boolean} F
* @overload
* @param {function (U, T, number[], Matrix<T>): U} cb Reducing function
* @param {U} init Initial value
* @param {number | number[]} axis Axis to be reduced. If negative, reduce along all elements.
* @param {boolean} [keepdims] Keep dimensions or not. If null, negative axis retuns number and other axis returns Matrix.
* @returns {Matrix<U> | U} Reduced matrix or value
* @param {A} axis Axis to be reduced
* @param {F} [keepdims] Keep dimensions or not. If null, negative axis retuns number and other axis returns Matrix.
* @returns {Matrix<U> | (A extends 0 | 1 ? never : F extends true ? never : U)} Reduced matrix
*/
/**
* @template U
Expand Down
Loading