@itwin/core-geometry 5.3.0-dev.12 → 5.3.0-dev.15

package/lib/cjs/geometry3d/IndexedXYCollection.js

@@ -4,13 +4,13 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IndexedXYCollection = void 0;
+exports.IndexedReadWriteXYCollection = exports.IndexedXYCollection = void 0;
 /** @packageDocumentation
  * @module ArraysAndInterfaces
  */
 const Point2dVector2d_1 = require("./Point2dVector2d");
 /**
- * abstract base class for access to XY data with indexed reference.
+ * Abstract base class for access to XY data with indexed reference.
  * * This allows algorithms to work with Point2d[] or GrowableXY.
  *   * GrowableXYArray implements these for its data.
  *   * Point2dArrayCarrier carries a (reference to) a Point2d[] and implements the methods with calls on that array reference.
@@ -20,7 +20,8 @@ const Point2dVector2d_1 = require("./Point2dVector2d");
  */
 class IndexedXYCollection {
     static _workPoint;
-    /** access x of indexed point
+    /**
+     * Access x of indexed point.
      * * Subclasses may wish to override with a more efficient implementation.
      */
     getXAtUncheckedPointIndex(pointIndex) {
@@ -29,7 +30,8 @@ class IndexedXYCollection {
             IndexedXYCollection._workPoint = pt; // allocate the cache
         return pt ? pt.x : 0.0;
     }
-    /** access y of indexed point
+    /**
+     * Access y of indexed point.
      * * Subclasses may wish to override with a more efficient implementation.
      */
     getYAtUncheckedPointIndex(pointIndex) {
@@ -38,9 +40,10 @@ class IndexedXYCollection {
             IndexedXYCollection._workPoint = pt; // allocate the cache
         return pt ? pt.y : 0.0;
     }
-    /** Compute the linear combination s of the indexed p_i and given scales s_i.
+    /**
+     * Compute the linear combination s of the indexed p_i and given scales s_i.
      * @param scales array of scales. For best results, scales should have same length as the instance.
-     * @param result optional pre-allocated object to fill and return
+     * @param result optional pre-allocated object to fill and return.
      * @return s = sum(p_i * s_i), where i ranges from 0 to min(this.length, scales.length).
      */
     linearCombination(scales, result) {
@@ -54,4 +57,11 @@ class IndexedXYCollection {
     }
 }
 exports.IndexedXYCollection = IndexedXYCollection;
+/**
+ * Abstract base class extends [[IndexedXYCollection]] with methods that modify the collection.
+ * @public
+ */
+class IndexedReadWriteXYCollection extends IndexedXYCollection {
+}
+exports.IndexedReadWriteXYCollection = IndexedReadWriteXYCollection;
 //# sourceMappingURL=IndexedXYCollection.js.map

package/lib/cjs/geometry3d/IndexedXYCollection.js.map

@@ -1 +1 @@
-{"version":3,"file":"IndexedXYCollection.js","sourceRoot":"","sources":["../../../src/geometry3d/IndexedXYCollection.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,uDAA0D;AAG1D;;;;;;;;GAQG;AACH,MAAsB,mBAAmB;IAwD/B,MAAM,CAAC,UAAU,CAAW;IAEpC;;OAEG;IACI,yBAAyB,CAAC,UAAkB;QACjD,MAAM,EAAE,GAAG,IAAI,CAAC,6BAA6B,CAAC,UAAU,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAC1F,IAAI,SAAS,KAAK,mBAAmB,CAAC,UAAU;YAC9C,mBAAmB,CAAC,UAAU,GAAG,EAAE,CAAC,CAAE,qBAAqB;QAC7D,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACzB,CAAC;IAED;;OAEG;IACI,yBAAyB,CAAC,UAAkB;QACjD,MAAM,EAAE,GAAG,IAAI,CAAC,6BAA6B,CAAC,UAAU,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAC1F,IAAI,SAAS,KAAK,mBAAmB,CAAC,UAAU;YAC9C,mBAAmB,CAAC,UAAU,GAAG,EAAE,CAAC,CAAE,qBAAqB;QAC7D,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,MAAgB,EAAE,MAA2B;QACpE,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,GAAG,GAAG,CAAC,MAAM,YAAY,0BAAQ,CAAC,CAAC,CAAC,CAAC,0BAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,yBAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACpG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;YAC3B,GAAG,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;YACvD,GAAG,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AA5FD,kDA4FC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module ArraysAndInterfaces\r\n */\r\n\r\nimport { Point2d, Vector2d, XY } from \"./Point2dVector2d\";\r\nimport { XAndY } from \"./XYZProps\";\r\n\r\n/**\r\n * abstract base class for access to XY data with indexed reference.\r\n * * This allows algorithms to work with Point2d[] or GrowableXY.\r\n *   * GrowableXYArray implements these for its data.\r\n *   * Point2dArrayCarrier carries a (reference to) a Point2d[] and implements the methods with calls on that array reference.\r\n * * In addition to \"point by point\" accessors, other abstract members compute commonly useful vector data \"between points\".\r\n * * Methods that create vectors among multiple indices allow callers to avoid creating temporaries.\r\n * @public\r\n */\r\nexport abstract class IndexedXYCollection {\r\n  /**\r\n   * Get from `index` as a `Point2d`\r\n   * @param index index of point within the array\r\n   * @param result optional caller-allocated destination\r\n   * @returns undefined if the index is out of bounds\r\n   */\r\n  public abstract getPoint2dAtCheckedPointIndex(index: number, result?: Point2d): Point2d | undefined;\r\n  /**\r\n   * Get from `index` as a `Vector2d`\r\n   * @param index index of point within the array\r\n   * @param result optional caller-allocated destination\r\n   * @returns undefined if the index is out of bounds\r\n   */\r\n  public abstract getVector2dAtCheckedVectorIndex(index: number, result?: Vector2d): Vector2d | undefined;\r\n  /**\r\n   * Return a vector from the point at `indexA` to the point at `indexB`\r\n   * @param indexA index of point within the array\r\n   * @param indexB index of point within the array\r\n   * @param result optional caller-allocated vector.\r\n   * @returns undefined if either index is out of bounds\r\n   */\r\n  public abstract vectorIndexIndex(indexA: number, indexB: number, result?: Vector2d): Vector2d | undefined;\r\n  /**\r\n   * Return a vector from given origin to the point at `indexB`\r\n   * @param origin origin for vector\r\n   * @param indexB index of point within the array\r\n   * @param result optional caller-allocated vector.\r\n   * @returns undefined if index is out of bounds\r\n   */\r\n  public abstract vectorXAndYIndex(origin: XAndY, indexB: number, result?: Vector2d): Vector2d | undefined;\r\n\r\n  /**\r\n   * Return the cross product of vectors from `origin` to points at `indexA` and `indexB`\r\n   * @param origin origin for vector\r\n   * @param indexA index of first target within the array\r\n   * @param indexB index of second target within the array\r\n   * @param result optional caller-allocated vector.\r\n   * @returns undefined if either index is out of bounds\r\n   */\r\n  public abstract crossProductXAndYIndexIndex(origin: XAndY, indexA: number, indexB: number): number | undefined;\r\n  /**\r\n   * Return the cross product of vectors from origin point at `indexA` to target points at `indexB` and `indexC`\r\n   * @param origin index of origin\r\n   * @param indexA index of first target within the array\r\n   * @param indexB index of second target within the array\r\n   * @param result optional caller - allocated vector.\r\n   * @returns return true if indexA, indexB both valid\r\n   */\r\n  public abstract crossProductIndexIndexIndex(origin: number, indexA: number, indexB: number): number | undefined;\r\n\r\n  /**\r\n   * read-only property for number of XY in the collection.\r\n   */\r\n  public abstract get length(): number;\r\n\r\n  private static _workPoint?: Point2d;\r\n\r\n  /** access x of indexed point\r\n   * * Subclasses may wish to override with a more efficient implementation.\r\n   */\r\n  public getXAtUncheckedPointIndex(pointIndex: number): number {\r\n    const pt = this.getPoint2dAtCheckedPointIndex(pointIndex, IndexedXYCollection._workPoint);\r\n    if (undefined === IndexedXYCollection._workPoint)\r\n      IndexedXYCollection._workPoint = pt;  // allocate the cache\r\n    return pt ? pt.x : 0.0;\r\n  }\r\n\r\n  /** access y of indexed point\r\n   * * Subclasses may wish to override with a more efficient implementation.\r\n   */\r\n  public getYAtUncheckedPointIndex(pointIndex: number): number {\r\n    const pt = this.getPoint2dAtCheckedPointIndex(pointIndex, IndexedXYCollection._workPoint);\r\n    if (undefined === IndexedXYCollection._workPoint)\r\n      IndexedXYCollection._workPoint = pt;  // allocate the cache\r\n    return pt ? pt.y : 0.0;\r\n  }\r\n\r\n  /** Compute the linear combination s of the indexed p_i and given scales s_i.\r\n   * @param scales array of scales. For best results, scales should have same length as the instance.\r\n   * @param result optional pre-allocated object to fill and return\r\n   * @return s = sum(p_i * s_i), where i ranges from 0 to min(this.length, scales.length).\r\n   */\r\n  public linearCombination(scales: number[], result?: Point2d | Vector2d): XY {\r\n    const n = Math.min(this.length, scales.length);\r\n    const sum = (result instanceof Vector2d) ? Vector2d.createZero(result) : Point2d.createZero(result);\r\n    for (let i = 0; i < n; ++i) {\r\n      sum.x += scales[i] * this.getXAtUncheckedPointIndex(i);\r\n      sum.y += scales[i] * this.getYAtUncheckedPointIndex(i);\r\n    }\r\n    return sum;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"IndexedXYCollection.js","sourceRoot":"","sources":["../../../src/geometry3d/IndexedXYCollection.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,uDAA0D;AAG1D;;;;;;;;GAQG;AACH,MAAsB,mBAAmB;IAmD/B,MAAM,CAAC,UAAU,CAAW;IACpC;;;OAGG;IACI,yBAAyB,CAAC,UAAkB;QACjD,MAAM,EAAE,GAAG,IAAI,CAAC,6BAA6B,CAAC,UAAU,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAC1F,IAAI,SAAS,KAAK,mBAAmB,CAAC,UAAU;YAC9C,mBAAmB,CAAC,UAAU,GAAG,EAAE,CAAC,CAAE,qBAAqB;QAC7D,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACzB,CAAC;IACD;;;OAGG;IACI,yBAAyB,CAAC,UAAkB;QACjD,MAAM,EAAE,GAAG,IAAI,CAAC,6BAA6B,CAAC,UAAU,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAC1F,IAAI,SAAS,KAAK,mBAAmB,CAAC,UAAU;YAC9C,mBAAmB,CAAC,UAAU,GAAG,EAAE,CAAC,CAAE,qBAAqB;QAC7D,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACzB,CAAC;IACD;;;;;OAKG;IACI,iBAAiB,CAAC,MAAgB,EAAE,MAA2B;QACpE,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,GAAG,GAAG,CAAC,MAAM,YAAY,0BAAQ,CAAC,CAAC,CAAC,CAAC,0BAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,yBAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACpG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;YAC3B,GAAG,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;YACvD,GAAG,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAvFD,kDAuFC;AAED;;;GAGG;AACH,MAAsB,4BAA6B,SAAQ,mBAAmB;CAW7E;AAXD,oEAWC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module ArraysAndInterfaces\n */\n\nimport { Point2d, Vector2d, XY } from \"./Point2dVector2d\";\nimport { XAndY } from \"./XYZProps\";\n\n/**\n * Abstract base class for access to XY data with indexed reference.\n * * This allows algorithms to work with Point2d[] or GrowableXY.\n *   * GrowableXYArray implements these for its data.\n *   * Point2dArrayCarrier carries a (reference to) a Point2d[] and implements the methods with calls on that array reference.\n * * In addition to \"point by point\" accessors, other abstract members compute commonly useful vector data \"between points\".\n * * Methods that create vectors among multiple indices allow callers to avoid creating temporaries.\n * @public\n */\nexport abstract class IndexedXYCollection {\n  /**\n   * Get from `index` as a `Point2d`.\n   * @param index index of point within the array.\n   * @param result optional caller-allocated destination.\n   * @returns undefined if the index is out of bounds.\n   */\n  public abstract getPoint2dAtCheckedPointIndex(index: number, result?: Point2d): Point2d | undefined;\n  /**\n   * Get from `index` as a `Vector2d`.\n   * @param index index of point within the array.\n   * @param result optional caller-allocated destination.\n   * @returns undefined if the index is out of bounds.\n   */\n  public abstract getVector2dAtCheckedVectorIndex(index: number, result?: Vector2d): Vector2d | undefined;\n  /**\n   * Return a vector from the point at `indexA` to the point at `indexB`.\n   * @param indexA index of point within the array.\n   * @param indexB index of point within the array.\n   * @param result optional caller-allocated vector.\n   * @returns undefined if either index is out of bounds.\n   */\n  public abstract vectorIndexIndex(indexA: number, indexB: number, result?: Vector2d): Vector2d | undefined;\n  /**\n   * Return a vector from given origin to the point at `indexB`.\n   * @param origin origin for vector.\n   * @param indexB index of point within the array.\n   * @param result optional caller-allocated vector.\n   * @returns undefined if index is out of bounds.\n   */\n  public abstract vectorXAndYIndex(origin: XAndY, indexB: number, result?: Vector2d): Vector2d | undefined;\n  /**\n   * Return the cross product of vectors from `origin` to points at `indexA` and `indexB`.\n   * @param origin origin for vector.\n   * @param indexA index of first target within the array.\n   * @param indexB index of second target within the array.\n   * @param result optional caller-allocated vector.\n   * @returns undefined if either index is out of bounds.\n   */\n  public abstract crossProductXAndYIndexIndex(origin: XAndY, indexA: number, indexB: number): number | undefined;\n  /**\n   * Return the cross product of vectors from origin point at `indexA` to target points at `indexB` and `indexC`.\n   * @param origin index of origin.\n   * @param indexA index of first target within the array.\n   * @param indexB index of second target within the array.\n   * @param result optional caller - allocated vector.\n   * @returns return true if indexA, indexB both valid.\n   */\n  public abstract crossProductIndexIndexIndex(origin: number, indexA: number, indexB: number): number | undefined;\n  /** Read-only property for number of XY in the collection. */\n  public abstract get length(): number;\n  private static _workPoint?: Point2d;\n  /**\n   * Access x of indexed point.\n   * * Subclasses may wish to override with a more efficient implementation.\n   */\n  public getXAtUncheckedPointIndex(pointIndex: number): number {\n    const pt = this.getPoint2dAtCheckedPointIndex(pointIndex, IndexedXYCollection._workPoint);\n    if (undefined === IndexedXYCollection._workPoint)\n      IndexedXYCollection._workPoint = pt;  // allocate the cache\n    return pt ? pt.x : 0.0;\n  }\n  /**\n   * Access y of indexed point.\n   * * Subclasses may wish to override with a more efficient implementation.\n   */\n  public getYAtUncheckedPointIndex(pointIndex: number): number {\n    const pt = this.getPoint2dAtCheckedPointIndex(pointIndex, IndexedXYCollection._workPoint);\n    if (undefined === IndexedXYCollection._workPoint)\n      IndexedXYCollection._workPoint = pt;  // allocate the cache\n    return pt ? pt.y : 0.0;\n  }\n  /**\n   * Compute the linear combination s of the indexed p_i and given scales s_i.\n   * @param scales array of scales. For best results, scales should have same length as the instance.\n   * @param result optional pre-allocated object to fill and return.\n   * @return s = sum(p_i * s_i), where i ranges from 0 to min(this.length, scales.length).\n   */\n  public linearCombination(scales: number[], result?: Point2d | Vector2d): XY {\n    const n = Math.min(this.length, scales.length);\n    const sum = (result instanceof Vector2d) ? Vector2d.createZero(result) : Point2d.createZero(result);\n    for (let i = 0; i < n; ++i) {\n      sum.x += scales[i] * this.getXAtUncheckedPointIndex(i);\n      sum.y += scales[i] * this.getYAtUncheckedPointIndex(i);\n    }\n    return sum;\n  }\n}\n\n/**\n * Abstract base class extends [[IndexedXYCollection]] with methods that modify the collection.\n * @public\n */\nexport abstract class IndexedReadWriteXYCollection extends IndexedXYCollection {\n  /** Push a (clone of) point onto the collection. */\n  public abstract push(point: XAndY): void;\n  /** Push a new point (given by xy coordinates) onto the collection. */\n  public abstract pushXY(x?: number, y?: number): void;\n  /** Remove the final point. */\n  public abstract pop(): void;\n  /** Remove all entries. */\n  public abstract clear(): void;\n  /** Reverse the points in place. */\n  public abstract reverseInPlace(): void;\n}\n"]}

package/lib/cjs/geometry3d/IndexedXYZCollection.d.ts

@@ -14,121 +14,119 @@ import { XAndY, XYAndZ } from "./XYZProps";
 export declare abstract class IndexedXYZCollection {
     /**
      * Return the point at `index` as a strongly typed Point3d.
-     * @param index index of point within the array
-     * @param result caller-allocated destination
-     * @returns undefined if the index is out of bounds
+     * @param index index of point within the array.
+     * @param result caller-allocated destination.
+     * @returns undefined if the index is out of bounds.
      */
     abstract getPoint3dAtCheckedPointIndex(index: number, result?: Point3d): Point3d | undefined;
     /**
      * Return the point at `index` as a strongly typed Point3d, without checking the point index validity.
-     * @param index index of point within the array
-     * @param result caller-allocated destination
-     * @returns undefined if the index is out of bounds
+     * @param index index of point within the array.
+     * @param result caller-allocated destination.
+     * @returns undefined if the index is out of bounds.
      */
     abstract getPoint3dAtUncheckedPointIndex(index: number, result?: Point3d): Point3d;
     /**
      * Get from `index` as a strongly typed Vector3d.
-     * @param index index of point within the array
-     * @param result caller-allocated destination
-     * @returns undefined if the index is out of bounds
+     * @param index index of point within the array.
+     * @param result caller-allocated destination.
+     * @returns undefined if the index is out of bounds.
      */
     abstract getVector3dAtCheckedVectorIndex(index: number, result?: Vector3d): Vector3d | undefined;
     /**
-     * Return a vector from the point at `indexA` to the point at `indexB`
-     * @param indexA index of point within the array
-     * @param indexB index of point within the array
+     * Return a vector from the point at `indexA` to the point at `indexB`.
+     * @param indexA index of point within the array.
+     * @param indexB index of point within the array.
      * @param result caller-allocated vector.
-     * @returns undefined if either index is out of bounds
+     * @returns undefined if either index is out of bounds.
      */
     abstract vectorIndexIndex(indexA: number, indexB: number, result?: Vector3d): Vector3d | undefined;
     /**
-     * Return a vector from `origin` to the point at `indexB`
-     * @param origin origin for vector
-     * @param indexB index of point within the array
+     * Return a vector from `origin` to the point at `indexB`.
+     * @param origin origin for vector.
+     * @param indexB index of point within the array.
      * @param result caller-allocated vector.
-     * @returns undefined if index is out of bounds
+     * @returns undefined if index is out of bounds.
      */
     abstract vectorXYAndZIndex(origin: XYAndZ, indexB: number, result?: Vector3d): Vector3d | undefined;
     /**
-     * Return a vector from the point at `indexA` to `target`
-     * @param indexA index of point within the array
-     * @param target target for vector
+     * Return a vector from the point at `indexA` to `target`.
+     * @param indexA index of point within the array.
+     * @param target target for vector.
      * @param result caller-allocated vector.
-     * @returns undefined if index is out of bounds
+     * @returns undefined if index is out of bounds.
      */
     vectorIndexXYAndZ(indexA: number, target: XYAndZ, result?: Vector3d): Vector3d | undefined;
     /**
      * Return the dot product of the vectors from the point at `origin` to the points at `indexA` and `indexB`.
-     * @param origin index of point within the array; origin of both vectors
-     * @param indexA index of point within the array; target of the first vector
-     * @param indexA index of point within the array; target of the second vector
-     * @returns undefined if index is out of bounds
+     * @param origin index of point within the array; origin of both vectors.
+     * @param indexA index of point within the array; target of the first vector.
+     * @param indexB index of point within the array; target of the second vector.
+     * @returns undefined if index is out of bounds.
      */
     dotProductIndexIndexIndex(origin: number, indexA: number, indexB: number): number | undefined;
     /**
      * Return the dot product of the vectors from the point at `origin` to the point at `indexA` and to `targetB`.
-     * @param origin index of point within the array; origin of both vectors
-     * @param indexA index of point within the array; target of the first vector
-     * @param targetB target for second vector
-     * @returns undefined if index is out of bounds
+     * @param origin index of point within the array; origin of both vectors.
+     * @param indexA index of point within the array; target of the first vector.
+     * @param targetB target for second vector.
+     * @returns undefined if index is out of bounds.
      */
     dotProductIndexIndexXYAndZ(origin: number, indexA: number, targetB: XYAndZ): number | undefined;
     /**
-     * Return the cross product of the vectors from `origin` to points at `indexA` and `indexB`
-     * @param origin origin for vector
-     * @param indexA index of first target within the array
-     * @param indexB index of second target within the array
+     * Return the cross product of the vectors from `origin` to points at `indexA` and `indexB`.
+     * @param origin origin for vector.
+     * @param indexA index of first target within the array.
+     * @param indexB index of second target within the array.
      * @param result caller-allocated vector.
-     * @returns undefined if either index is out of bounds
+     * @returns undefined if either index is out of bounds.
      */
     abstract crossProductXYAndZIndexIndex(origin: XYAndZ, indexA: number, indexB: number, result?: Vector3d): Vector3d | undefined;
     /**
-     * Return the cross product of the vectors from `origin` to the point at `indexA` and to `targetB`
-     * @param origin index of point within the array; origin of both vectors
-     * @param indexA index of point within the array; target of the first vector
-     * @param targetB target of second vector
-     * @param result optional caller-allocated result to fill and return
-     * @returns undefined if an index is out of bounds
+     * Return the cross product of the vectors from `origin` to the point at `indexA` and to `targetB`.
+     * @param origin index of point within the array; origin of both vectors.
+     * @param indexA index of point within the array; target of the first vector.
+     * @param targetB target of second vector.
+     * @param result optional caller-allocated result to fill and return.
+     * @returns undefined if an index is out of bounds.
      */
     crossProductIndexIndexXYAndZ(origin: number, indexA: number, targetB: XYAndZ, result?: Vector3d): Vector3d | undefined;
     /**
-     * Return the cross product of vectors from `origin` to points at `indexA` and `indexB`
-     * @param origin origin for vector
-     * @param indexA index of first target within the array
-     * @param indexB index of second target within the array
+     * Return the cross product of vectors from `origin` to points at `indexA` and `indexB`.
+     * @param origin origin for vector.
+     * @param indexA index of first target within the array.
+     * @param indexB index of second target within the array.
      * @param result optional caller-allocated vector.
-     * @returns undefined if either index is out of bounds
+     * @returns undefined if either index is out of bounds.
      */
     abstract crossProductIndexIndexIndex(origin: number, indexA: number, indexB: number, result?: Vector3d): Vector3d | undefined;
     /**
-     * Return the cross product of vectors from origin point at `indexA` to target points at `indexB` and `indexC`
-     * @param origin index of origin
-     * @param indexA index of first target within the array
-     * @param indexB index of second target within the array
+     * Return the cross product of vectors from origin point at `indexA` to target points at `indexB` and `indexC`.
+     * @param origin index of origin.
+     * @param indexA index of first target within the array.
+     * @param indexB index of second target within the array.
      * @param result caller-allocated vector.
-     * @returns return true if indexA, indexB both valid
+     * @returns return true if indexA, indexB both valid.
      */
     abstract accumulateCrossProductIndexIndexIndex(origin: number, indexA: number, indexB: number, result: Vector3d): void;
-    /**
-     * read-only property for number of XYZ in the collection.
-     */
+    /** Read-only property for number of XYZ in the collection. */
     abstract get length(): number;
     /**
      * Return distance squared between indicated points.
-     * @param index0 first point index
-     * @param index1 second point index
+     * @param index0 first point index.
+     * @param index1 second point index.
      */
     abstract distanceSquaredIndexIndex(index0: number, index1: number): number | undefined;
     /**
      * Return distance squared between the point at index0 and target.
-     * @param index0 first point index
-     * @param target second point
+     * @param index0 first point index.
+     * @param target second point.
      */
     distanceSquaredIndexXYAndZ(index0: number, target: XYAndZ): number | undefined;
     /**
      * Return distance between indicated points.
-     * @param index0 first point index
-     * @param index1 second point index
+     * @param index0 first point index.
+     * @param index1 second point index.
      */
     abstract distanceIndexIndex(index0: number, index1: number): number | undefined;
     /**
@@ -144,18 +142,20 @@ export declare abstract class IndexedXYZCollection {
      * For each subset of `k` successive points within tolerance of the first point in the subset, return the indices of
      * the last `k-1` duplicates.
      * * Index `0` is never returned.
-     * @param tolerance optional distance tol for compression (default [[Geometry.smallMetricDistance]])
+     * @param tolerance optional distance tol for compression (default [[Geometry.smallMetricDistance]]).
      * @param preserveLast if the last `k < this.length` points of the instance are duplicates, whether to return the
-     * indices of the *first* `k-1` duplicates for this last run. If true, index `this.length - 1` is not returned
+     * indices of the *first* `k-1` duplicates for this last run. If true, index `this.length - 1` is not returned.
      * unless all points are duplicates, in which case all indices but `0` are returned. Default value is false.
      * @return ordered array of 0-based indices of duplicate points
      */
     findOrderedDuplicates(tolerance?: number, preserveLast?: boolean): number[];
-    /** Accumulate scale times the x,y,z values at index.
+    /**
+     * Accumulate scale times the x,y,z values at index.
      * * No action if index is out of bounds.
      */
     abstract accumulateScaledXYZ(index: number, scale: number, sum: Point3d): void;
-    /** Compute the linear combination s of the indexed p_i and given scales s_i.
+    /**
+     * Compute the linear combination s of the indexed p_i and given scales s_i.
      * @param scales array of scales. For best results, scales should have same length as the instance.
      * @param result optional pre-allocated object to fill and return
      * @return s = sum(p_i * s_i), where i ranges from 0 to min(this.length, scales.length).
@@ -163,26 +163,27 @@ export declare abstract class IndexedXYZCollection {
     linearCombination(scales: number[], result?: Point3d | Vector3d): XYZ;
     /**
      * Interpolate the points at the given indices.
-     * @param index0 index of point p0 within the array
-     * @param fraction fraction f such that returned point is p0 + f * (p1 - p0)
-     * @param index1 index of point p1 within the array
-     * @param result optional caller-allocated result to fill and return
-     * @returns undefined if an index is out of bounds
+     * @param index0 index of point p0 within the array.
+     * @param fraction fraction f such that returned point is p0 + f * (p1 - p0).
+     * @param index1 index of point p1 within the array.
+     * @param result optional caller-allocated result to fill and return.
+     * @returns undefined if an index is out of bounds.
      */
     interpolateIndexIndex(index0: number, fraction: number, index1: number, result?: Point3d): Point3d | undefined;
-    /** access x of indexed point */
+    /** Access x of indexed point. */
     abstract getXAtUncheckedPointIndex(pointIndex: number): number;
-    /** access y of indexed point */
+    /** Access y of indexed point. */
     abstract getYAtUncheckedPointIndex(pointIndex: number): number;
-    /** access z of indexed point */
+    /** Access z of indexed point. */
     abstract getZAtUncheckedPointIndex(pointIndex: number): number;
-    /** Return iterator over the points in this collection. Usage:
+    /**
+     * Return iterator over the points in this collection. Usage:
      * ```ts
      *  for (const point: Point3d of collection.points) { ... }
      * ```
      */
     get points(): Iterable<Point3d>;
-    /** convert to Point3d[] */
+    /** Convert to Point3d[]. */
     getArray(): Point3d[];
     /** Return the first point, or undefined if the array is empty. */
     front(result?: Point3d): Point3d | undefined;
@@ -190,16 +191,16 @@ export declare abstract class IndexedXYZCollection {
     back(result?: Point3d): Point3d | undefined;
     /**
      * Test whether the indexed points are equal within tolerance.
-     * @param index0 index of first point
-     * @param index1 index of second point
+     * @param index0 index of first point.
+     * @param index1 index of second point.
      * @param tolerance max coordinate difference to be considered equal. For exact test, pass 0. Defaults to `Geometry.smallMetricDistance`.
      * @returns whether the points are equal within tolerance, or `undefined` if either index is invalid.
      */
     almostEqualIndexIndex(index0: number, index1: number, tolerance?: number): boolean | undefined;
     /**
      * Test whether the xy-coordinates of the indexed points are equal within tolerance. The z-coordinates are ignored.
-     * @param index0 index of first point
-     * @param index1 index of second point
+     * @param index0 index of first point.
+     * @param index1 index of second point.
      * @param tolerance max coordinate difference to be considered equal. For exact test, pass 0. Defaults to `Geometry.smallMetricDistance`.
      * @returns whether the xy-coordinates of the points are equal within tolerance, or `undefined` if either index is invalid.
      */

package/lib/cjs/geometry3d/IndexedXYZCollection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IndexedXYZCollection.d.ts","sourceRoot":"","sources":["../../../src/geometry3d/IndexedXYZCollection.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAwB3C;;;;;;;;GAQG;AACH,8BAAsB,oBAAoB;IACxC;;;;;OAKG;aACa,6BAA6B,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IACnG;;;;;OAKG;aACa,+BAA+B,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IACzF;;;;;OAKG;aACa,+BAA+B,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IACvG;;;;;;OAMG;aACa,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IACzG;;;;;;OAMG;aACa,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IAC1G;;;;;;OAMG;IACI,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IAIjG;;;;;;OAMG;IACI,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAUpG;;;;;;OAMG;IACI,0BAA0B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAUtG;;;;;;;OAOG;aACa,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IACrI;;;;;;;OAOG;IACI,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IAa7H;;;;;;;OAOG;aACa,2BAA2B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IACpI;;;;;;;OAOG;aACa,qCAAqC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;IAE7H;;OAEG;IACH,aAAoB,MAAM,IAAI,MAAM,CAAC;IACrC;;;;OAIG;aACa,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAC7F;;;;OAIG;IACI,0BAA0B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAQrF;;;;OAIG;aACa,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IACtF;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAG3C,yDAAyD;IAClD,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAGrC,sCAAsC;IAC/B,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAejE;;;;;;;;;OASG;IACI,qBAAqB,CAAC,SAAS,GAAE,MAAqC,EAAE,YAAY,GAAE,OAAe,GAAG,MAAM,EAAE;IAmBvH;;OAEG;aACa,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI;IAErF;;;;MAIE;IACK,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,GAAG;IAW5E;;;;;;;OAOG;IACI,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAQrH,gCAAgC;aAChB,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAErE,gCAAgC;aAChB,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAErE,gCAAgC;aAChB,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAErE;;;;OAIG;IACH,IAAW,MAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,CAErC;IACD,2BAA2B;IACpB,QAAQ,IAAI,OAAO,EAAE;IAM5B,kEAAkE;IAC3D,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAKnD,iEAAiE;IAC1D,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAKlD;;;;;;OAMG;IACI,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,SAA+B,GAAG,OAAO,GAAG,SAAS;IAO3H;;;;;;OAMG;IACI,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,SAA+B,GAAG,OAAO,GAAG,SAAS;CAM9H;AACD;;;GAGG;AACH,8BAAsB,6BAA8B,SAAQ,oBAAoB;IAC9E,mDAAmD;aACnC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IACzC,uEAAuE;aACvD,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IACjE,8BAA8B;aACd,GAAG,IAAI,IAAI;IAC3B,0BAA0B;aACV,KAAK,IAAI,IAAI;IAC7B,mCAAmC;aACnB,cAAc,IAAI,IAAI;CACvC;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,GAAG,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC;AAE3F;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,qBAAqB,GAAG,qBAAqB,EAAE,CAAC"}
+{"version":3,"file":"IndexedXYZCollection.d.ts","sourceRoot":"","sources":["../../../src/geometry3d/IndexedXYZCollection.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAqB3C;;;;;;;;GAQG;AACH,8BAAsB,oBAAoB;IACxC;;;;;OAKG;aACa,6BAA6B,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IACnG;;;;;OAKG;aACa,+BAA+B,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IACzF;;;;;OAKG;aACa,+BAA+B,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IACvG;;;;;;OAMG;aACa,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IACzG;;;;;;OAMG;aACa,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IAC1G;;;;;;OAMG;IACI,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IAIjG;;;;;;OAMG;IACI,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAUpG;;;;;;OAMG;IACI,0BAA0B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAUtG;;;;;;;OAOG;aACa,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IACrI;;;;;;;OAOG;IACI,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IAgB7H;;;;;;;OAOG;aACa,2BAA2B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IACpI;;;;;;;OAOG;aACa,qCAAqC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;IAC7H,8DAA8D;IAC9D,aAAoB,MAAM,IAAI,MAAM,CAAC;IACrC;;;;OAIG;aACa,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAC7F;;;;OAIG;IACI,0BAA0B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IASrF;;;;OAIG;aACa,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IACtF;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAG3C,yDAAyD;IAClD,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAGrC,sCAAsC;IAC/B,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAcjE;;;;;;;;;OASG;IACI,qBAAqB,CAAC,SAAS,GAAE,MAAqC,EAAE,YAAY,GAAE,OAAe,GAAG,MAAM,EAAE;IAkBvH;;;OAGG;aACa,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI;IACrF;;;;;MAKE;IACK,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,GAAG;IAU5E;;;;;;;OAOG;IACI,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAOrH,iCAAiC;aACjB,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IACrE,iCAAiC;aACjB,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IACrE,iCAAiC;aACjB,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IACrE;;;;;OAKG;IACH,IAAW,MAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,CAErC;IACD,4BAA4B;IACrB,QAAQ,IAAI,OAAO,EAAE;IAM5B,kEAAkE;IAC3D,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAKnD,iEAAiE;IAC1D,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAKlD;;;;;;OAMG;IACI,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,SAA+B,GAAG,OAAO,GAAG,SAAS;IAO3H;;;;;;OAMG;IACI,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,SAA+B,GAAG,OAAO,GAAG,SAAS;CAM9H;AAED;;;GAGG;AACH,8BAAsB,6BAA8B,SAAQ,oBAAoB;IAC9E,mDAAmD;aACnC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IACzC,uEAAuE;aACvD,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IACjE,8BAA8B;aACd,GAAG,IAAI,IAAI;IAC3B,0BAA0B;aACV,KAAK,IAAI,IAAI;IAC7B,mCAAmC;aACnB,cAAc,IAAI,IAAI;CACvC;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,GAAG,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC;AAE3F;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,qBAAqB,GAAG,qBAAqB,EAAE,CAAC"}

package/lib/cjs/geometry3d/IndexedXYZCollection.js

@@ -19,7 +19,8 @@ class PointsIterator {
     }
     next() {
         if (++this._curIndex >= this._collection.length) {
-            // The ECMAScript spec states that value=undefined is valid if done=true. The TypeScript interface violates the spec hence the cast to any and back below.
+            // the ECMAScript spec states that value=undefined is valid if done=true
+            // the TypeScript interface violates the spec hence the cast to any and back below
             return { done: true };
         }
         return {
@@ -40,11 +41,11 @@ class PointsIterator {
  */
 class IndexedXYZCollection {
     /**
-     * Return a vector from the point at `indexA` to `target`
-     * @param indexA index of point within the array
-     * @param target target for vector
+     * Return a vector from the point at `indexA` to `target`.
+     * @param indexA index of point within the array.
+     * @param target target for vector.
      * @param result caller-allocated vector.
-     * @returns undefined if index is out of bounds
+     * @returns undefined if index is out of bounds.
      */
     vectorIndexXYAndZ(indexA, target, result) {
         const reversed = this.vectorXYAndZIndex(target, indexA, result);
@@ -52,10 +53,10 @@ class IndexedXYZCollection {
     }
     /**
      * Return the dot product of the vectors from the point at `origin` to the points at `indexA` and `indexB`.
-     * @param origin index of point within the array; origin of both vectors
-     * @param indexA index of point within the array; target of the first vector
-     * @param indexA index of point within the array; target of the second vector
-     * @returns undefined if index is out of bounds
+     * @param origin index of point within the array; origin of both vectors.
+     * @param indexA index of point within the array; target of the first vector.
+     * @param indexB index of point within the array; target of the second vector.
+     * @returns undefined if index is out of bounds.
      */
     dotProductIndexIndexIndex(origin, indexA, indexB) {
         if (origin < 0 || origin >= this.length || indexA < 0 || indexA >= this.length || indexB < 0 || indexB >= this.length)
@@ -69,10 +70,10 @@ class IndexedXYZCollection {
     }
     /**
      * Return the dot product of the vectors from the point at `origin` to the point at `indexA` and to `targetB`.
-     * @param origin index of point within the array; origin of both vectors
-     * @param indexA index of point within the array; target of the first vector
-     * @param targetB target for second vector
-     * @returns undefined if index is out of bounds
+     * @param origin index of point within the array; origin of both vectors.
+     * @param indexA index of point within the array; target of the first vector.
+     * @param targetB target for second vector.
+     * @returns undefined if index is out of bounds.
      */
     dotProductIndexIndexXYAndZ(origin, indexA, targetB) {
         if (origin < 0 || origin >= this.length || indexA < 0 || indexA >= this.length)
@@ -85,12 +86,12 @@ class IndexedXYZCollection {
             (this.getZAtUncheckedPointIndex(indexA) - z0) * (targetB.z - z0);
     }
     /**
-     * Return the cross product of the vectors from `origin` to the point at `indexA` and to `targetB`
-     * @param origin index of point within the array; origin of both vectors
-     * @param indexA index of point within the array; target of the first vector
-     * @param targetB target of second vector
-     * @param result optional caller-allocated result to fill and return
-     * @returns undefined if an index is out of bounds
+     * Return the cross product of the vectors from `origin` to the point at `indexA` and to `targetB`.
+     * @param origin index of point within the array; origin of both vectors.
+     * @param indexA index of point within the array; target of the first vector.
+     * @param targetB target of second vector.
+     * @param result optional caller-allocated result to fill and return.
+     * @returns undefined if an index is out of bounds.
      */
     crossProductIndexIndexXYAndZ(origin, indexA, targetB, result) {
         if (origin < 0 || origin >= this.length || indexA < 0 || indexA >= this.length)
@@ -102,8 +103,8 @@ class IndexedXYZCollection {
     }
     /**
      * Return distance squared between the point at index0 and target.
-     * @param index0 first point index
-     * @param target second point
+     * @param index0 first point index.
+     * @param target second point.
      */
     distanceSquaredIndexXYAndZ(index0, target) {
         if (index0 < 0 || index0 >= this.length)
@@ -140,9 +141,9 @@ class IndexedXYZCollection {
      * For each subset of `k` successive points within tolerance of the first point in the subset, return the indices of
      * the last `k-1` duplicates.
      * * Index `0` is never returned.
-     * @param tolerance optional distance tol for compression (default [[Geometry.smallMetricDistance]])
+     * @param tolerance optional distance tol for compression (default [[Geometry.smallMetricDistance]]).
      * @param preserveLast if the last `k < this.length` points of the instance are duplicates, whether to return the
-     * indices of the *first* `k-1` duplicates for this last run. If true, index `this.length - 1` is not returned
+     * indices of the *first* `k-1` duplicates for this last run. If true, index `this.length - 1` is not returned.
      * unless all points are duplicates, in which case all indices but `0` are returned. Default value is false.
      * @return ordered array of 0-based indices of duplicate points
      */
@@ -165,7 +166,8 @@ class IndexedXYZCollection {
         }
         return indices;
     }
-    /** Compute the linear combination s of the indexed p_i and given scales s_i.
+    /**
+     * Compute the linear combination s of the indexed p_i and given scales s_i.
      * @param scales array of scales. For best results, scales should have same length as the instance.
      * @param result optional pre-allocated object to fill and return
      * @return s = sum(p_i * s_i), where i ranges from 0 to min(this.length, scales.length).
@@ -182,18 +184,19 @@ class IndexedXYZCollection {
     }
     /**
      * Interpolate the points at the given indices.
-     * @param index0 index of point p0 within the array
-     * @param fraction fraction f such that returned point is p0 + f * (p1 - p0)
-     * @param index1 index of point p1 within the array
-     * @param result optional caller-allocated result to fill and return
-     * @returns undefined if an index is out of bounds
+     * @param index0 index of point p0 within the array.
+     * @param fraction fraction f such that returned point is p0 + f * (p1 - p0).
+     * @param index1 index of point p1 within the array.
+     * @param result optional caller-allocated result to fill and return.
+     * @returns undefined if an index is out of bounds.
      */
     interpolateIndexIndex(index0, fraction, index1, result) {
         if (index0 < 0 || index0 >= this.length || index1 < 0 || index1 >= this.length)
             return undefined;
         return Point3dVector3d_1.Point3d.create(Geometry_1.Geometry.interpolate(this.getXAtUncheckedPointIndex(index0), fraction, this.getXAtUncheckedPointIndex(index1)), Geometry_1.Geometry.interpolate(this.getYAtUncheckedPointIndex(index0), fraction, this.getYAtUncheckedPointIndex(index1)), Geometry_1.Geometry.interpolate(this.getZAtUncheckedPointIndex(index0), fraction, this.getZAtUncheckedPointIndex(index1)), result);
     }
-    /** Return iterator over the points in this collection. Usage:
+    /**
+     * Return iterator over the points in this collection. Usage:
      * ```ts
      *  for (const point: Point3d of collection.points) { ... }
      * ```
@@ -201,7 +204,7 @@ class IndexedXYZCollection {
     get points() {
         return new PointsIterator(this);
     }
-    /** convert to Point3d[] */
+    /** Convert to Point3d[]. */
     getArray() {
         const result = [];
         for (const p of this.points)
@@ -222,8 +225,8 @@ class IndexedXYZCollection {
     }
     /**
      * Test whether the indexed points are equal within tolerance.
-     * @param index0 index of first point
-     * @param index1 index of second point
+     * @param index0 index of first point.
+     * @param index1 index of second point.
      * @param tolerance max coordinate difference to be considered equal. For exact test, pass 0. Defaults to `Geometry.smallMetricDistance`.
      * @returns whether the points are equal within tolerance, or `undefined` if either index is invalid.
      */
@@ -236,8 +239,8 @@ class IndexedXYZCollection {
     }
     /**
      * Test whether the xy-coordinates of the indexed points are equal within tolerance. The z-coordinates are ignored.
-     * @param index0 index of first point
-     * @param index1 index of second point
+     * @param index0 index of first point.
+     * @param index1 index of second point.
      * @param tolerance max coordinate difference to be considered equal. For exact test, pass 0. Defaults to `Geometry.smallMetricDistance`.
      * @returns whether the xy-coordinates of the points are equal within tolerance, or `undefined` if either index is invalid.
      */