Merge pull request #911 from ai-on-browser/main

Author: ishii-norimi

lib/util/complex.js

@@ -7,7 +7,9 @@ export default class Complex {
 	 * @param {number} [imag] Imaginary number
 	 */
 	constructor(real = 0, imag = 0) {
+		/** @private */
 		this._real = real
+		/** @private */
 		this._imag = imag
 	}
 

lib/util/graph.js

@@ -56,10 +56,12 @@ export default class Graph {
 	 */
 	constructor(nodes = 0, edges = []) {
 		if (Array.isArray(nodes)) {
+			/** @private */
 			this._nodes = nodes
 		} else {
 			this._nodes = Array(nodes)
 		}
+		/** @private */
 		this._edges = edges.map(
 			e => new Edge(e[0] | e.from, e[1] | e.to, e instanceof Edge ? e.value0 : e.value, e.direct)
 		)
@@ -988,6 +990,20 @@ export default class Graph {
 
 	/**
 	 * Return degree of the node.
+	 * @overload
+	 * @param {number} k Index of target node
+	 * @param {boolean} [undirect] Count undirected edges
+	 * @param {boolean | 'in' | 'out'} [direct] Count directed edges
+	 * @returns {number} Degree of the node
+	 */
+	/**
+	 * Return degree of the node.
+	 * @overload
+	 * @param {number} k Index of target node
+	 * @param {'in' | 'out'} direct Count only directed edges.
+	 * @returns {number} Degree of the node
+	 */
+	/**
 	 * @param {number} k Index of target node
 	 * @param {boolean | 'in' | 'out'} [undirect] Count undirected edges. If `in` or `out` is specified, only direct edges are counted and `direct` parameter is ignored.
 	 * @param {boolean | 'in' | 'out'} [direct] Count directed edges
@@ -1015,6 +1031,20 @@ export default class Graph {
 
 	/**
 	 * Return indexes of adjacency nodes.
+	 * @overload
+	 * @param {number} k Index of target node
+	 * @param {boolean} [undirect] Check undirected edges
+	 * @param {boolean | 'in' | 'out'} [direct] Check directed edges
+	 * @returns {number[]} Indexes of adjacency nodes
+	 */
+	/**
+	 * Return indexes of adjacency nodes.
+	 * @overload
+	 * @param {number} k Index of target node
+	 * @param {'in' | 'out'} direct Check only directed edges
+	 * @returns {number[]} Indexes of adjacency nodes
+	 */
+	/**
 	 * @param {number} k Index of target node
 	 * @param {boolean | 'in' | 'out'} [undirect] Check undirected edges. If `in` or `out` is specified, only direct edges are checked and `direct` parameter is ignored.
 	 * @param {boolean | 'in' | 'out'} [direct] Check directed edges
@@ -1246,8 +1276,18 @@ export default class Graph {
 		return min_loop
 	}
 
+	/**
+	 * Returns index of all cliques.
+	 * @overload
+	 * @returns {number[][][]} Index of cliques
+	 */
 	/**
 	 * Returns index of cliques.
+	 * @overload
+	 * @param {number} k Size of clique
+	 * @returns {number[][]} Index of cliques
+	 */
+	/**
 	 * @param {number} [k] Size of clique
 	 * @returns {number[][] | number[][][]} Index of cliques
 	 */
@@ -1524,6 +1564,17 @@ export default class Graph {
 
 	/**
 	 * Returns the node value.
+	 * @overload
+	 * @param {number} k Index of the node
+	 * @returns {unknown} Node value
+	 */
+	/**
+	 * Returns the node value.
+	 * @overload
+	 * @param {number[]} [k] Index of the node
+	 * @returns {unknown[]} Node value
+	 */
+	/**
 	 * @param {number | number[]} [k] Index of the node
 	 * @returns {unknown | unknown[]} Node value
 	 */
@@ -1591,6 +1642,22 @@ export default class Graph {
 
 	/**
 	 * Returns the edges.
+	 * @overload
+	 * @param {number} from Index of the starting node of the edge
+	 * @param {number} to Index of the end node of the edge
+	 * @param {boolean} [undirect] Get undirected edges or not
+	 * @param {boolean | 'forward' | 'backward'} [direct] Get directed edges or not
+	 * @returns {Edge[]} Edges between `from` and `to`
+	 */
+	/**
+	 * Returns the edges.
+	 * @overload
+	 * @param {number} from Index of the starting node of the edge
+	 * @param {number} to Index of the end node of the edge
+	 * @param {'forward' | 'backward'} direct Get only directed edges
+	 * @returns {Edge[]} Edges between `from` and `to`
+	 */
+	/**
 	 * @param {number} from Index of the starting node of the edge
 	 * @param {number} to Index of the end node of the edge
 	 * @param {boolean | 'forward' | 'backward'} [undirect] Get undirected edges or not. If `forward` or `backward` is specified, only direct edges are get and `direct` parameter is ignored.
@@ -3215,6 +3282,17 @@ export default class Graph {
 
 	/**
 	 * Returns shortest path.
+	 * @overload
+	 * @param {null} [from] Index of start nodes
+	 * @returns {{length: number, path: number[]}[][]} Shortest length and path for all nodes
+	 */
+	/**
+	 * Returns shortest path.
+	 * @overload
+	 * @param {number} from Index of start nodes
+	 * @returns {{length: number, prev: number, path: number[]}[]} Shortest length and path for all nodes
+	 */
+	/**
 	 * @param {number} [from] Index of start nodes
 	 * @returns {{length: number, prev: number, path: number[]}[] | {length: number, path: number[]}[][]} Shortest length and path for all nodes
 	 */