Update type doc

ivmartel · Feb 18, 2025 · c49af19 · c49af19
1 parent c9f635d
commit c49af19
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/src/image/geometry.js b/src/image/geometry.js
@@ -176,8 +176,8 @@ export class Geometry {
    * Check if a point is in the origin list.
    *
    * @param {Point3D} point3D The point to check.
-   * @param {number} tol The comparison tolerance
-   *   default to Number.EPSILON.
+   * @param {number} [tol] Optional number comparison tolerance
+   *   defaults to Number.EPSILON.
    * @returns {boolean} True if in list.
    */
   includesOrigin(point3D, tol) {

diff --git a/src/math/matrix.js b/src/math/matrix.js
@@ -16,8 +16,8 @@ export const REAL_WORLD_EPSILON = 1e-4;
  *
  * @param {number} a The first number.
  * @param {number} b The second number.
- * @param {number} tol The comparison tolerance,
- *   default to Number.EPSILON.
+ * @param {number} [tol] Optional comparison tolerance,
+ *   defaults to Number.EPSILON.
  * @returns {boolean} True if similar.
  */
 export function isSimilar(a, b, tol) {
@@ -81,16 +81,16 @@ export class Matrix33 {
    * Check for Matrix33 equality.
    *
    * @param {Matrix33} rhs The other matrix to compare to.
-   * @param {number} [p] A numeric expression for the precision to use in check
-   *   (ex: 0.001). Defaults to Number.EPSILON if not provided.
+   * @param {number} [tol] Optional number comparison tolerance,
+   *   defaults to Number.EPSILON.
    * @returns {boolean} True if both matrices are equal.
    */
-  equals(rhs, p) {
+  equals(rhs, tol) {
     // TODO: add type check
     // check values
     for (let i = 0; i < 3; ++i) {
       for (let j = 0; j < 3; ++j) {
-        if (!isSimilar(this.get(i, j), rhs.get(i, j), p)) {
+        if (!isSimilar(this.get(i, j), rhs.get(i, j), tol)) {
           return false;
         }
       }

diff --git a/src/math/point.js b/src/math/point.js
@@ -191,8 +191,8 @@ export class Point3D {
    * Check for Point3D similarity.
    *
    * @param {Point3D} rhs The other point to compare to.
-   * @param {number} tol Optional comparison tolerance,
-   *   default to Number.EPSILON.
+   * @param {number} [tol] Optional number comparison tolerance,
+   *   defaults to Number.EPSILON.
    * @returns {boolean} True if both points are equal.
    */
   isSimilar(rhs, tol) {