@itwin/core-bentley 3.5.0-dev.8 → 3.5.1

package/lib/cjs/OrderedId64Iterable.js.map

@@ -1 +1 @@
-{"version":3,"file":"OrderedId64Iterable.js","sourceRoot":"","sources":["../../src/OrderedId64Iterable.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qCAAkC;AAOlC;;;;;;;GAOG;AACH,IAAiB,mBAAmB,CAwOnC;AAxOD,WAAiB,mBAAmB;IAClC;;;;;;OAMG;IACH,SAAgB,OAAO,CAAC,GAAe,EAAE,GAAe;QACtD,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM;YAC3B,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE1C,+GAA+G;QAC/G,0BAA0B;QAC1B,IAAI,GAAG,KAAK,GAAG;YACb,OAAO,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5B,OAAO,CAAC,CAAC;IACX,CAAC;IAVe,2BAAO,UAUtB,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,SAAS,CAAC,GAAc;QACtC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAClC,OAAO,GAAG,CAAC;IACb,CAAC;IAHe,6BAAS,YAGxB,CAAA;IAED;;OAEG;IACH,SAAgB,YAAY,CAAC,IAAyB,EAAE,IAAyB;QAC/E,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;QAElC,OAAO,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YAC1C,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC;YAC7B,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;YAC/B,IAAI,CAAC,KAAK,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;gBAC5B,OAAO,KAAK,CAAC;YAEf,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC5B,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;SAC/B;QAED,IAAI,SAAS,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI;YACnC,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IApBe,gCAAY,eAoB3B,CAAA;IAED;;;OAGG;IACH,SAAgB,UAAU,CAAC,GAA4C;QACrE,IAAI,OAAO,GAAG,KAAK,QAAQ;YACzB,OAAO,EAAE,KAAK,GAAG,CAAC;QAEpB,OAAO,IAAI,KAAK,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC;IACrD,CAAC;IALe,8BAAU,aAKzB,CAAA;IAED;;OAEG;IACH,SAAgB,MAAM,CAAC,GAAwB;QAC7C,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;IAC1D,CAAC;IAFe,0BAAM,SAErB,CAAA;IAED;;OAEG;IACH,QAAe,CAAC,CAAC,cAAc,CAAC,GAAwB;QACtD,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpC,IAAI,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QACxB,IAAI,IAA4B,CAAC;QAEjC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE;YAClB,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC;YACvB,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACpB,IAAI,EAAE,KAAK,IAAI,EAAE;gBACf,IAAI,GAAG,EAAE,CAAC;gBACV,MAAM,EAAE,CAAC;aACV;SACF;IACH,CAAC;IAbgB,kCAAc,iBAa9B,CAAA;IAED;;OAEG;IACH,SAAgB,KAAK,CAAC,IAAyB,EAAE,IAAyB;QACxE,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;IAChE,CAAC;IAFe,yBAAK,QAEpB,CAAA;IAED;;OAEG;IACH,SAAgB,YAAY,CAAC,IAAyB,EAAE,IAAyB;QAC/E,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;IACvE,CAAC;IAFe,gCAAY,eAE3B,CAAA;IAED;;OAEG;IACH,SAAgB,UAAU,CAAC,IAAyB,EAAE,IAAyB;QAC7E,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;IACrE,CAAC;IAFe,8BAAU,aAEzB,CAAA;IAED;;OAEG;IACH,QAAe,CAAC,CAAC,aAAa,CAAC,IAAyB,EAAE,IAAyB;QACjF,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1C,IAAI,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;QAElC,IAAI,IAAwB,CAAC;QAC7B,OAAO,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YAC1C,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC;YAC1D,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC;YAE7D,IAAA,eAAM,EAAC,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC;YAClD,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,KAAK;gBAC3C,MAAM;YAER,IAAI,IAAgB,CAAC;YACrB,IAAI,SAAS,KAAK,IAAI,EAAE;gBACtB,IAAA,eAAM,EAAC,SAAS,KAAK,KAAK,CAAC,CAAC;gBAC5B,IAAI,GAAG,KAAK,CAAC;gBACb,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;aAC/B;iBAAM,IAAI,SAAS,KAAK,KAAK,EAAE;gBAC9B,IAAI,GAAG,IAAI,CAAC;gBACZ,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;aAC7B;iBAAM;gBACL,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACjC,IAAI,GAAG,IAAI,CAAC,EAAE;oBACZ,IAAI,GAAG,IAAI,CAAC;oBACZ,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAC5B,IAAI,CAAC,KAAK,GAAG;wBACX,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;iBACjC;qBAAM;oBACL,IAAI,GAAG,KAAK,CAAC;oBACb,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;iBAC/B;aACF;YAED,IAAI,IAAI,KAAK,IAAI;gBACf,SAAS;YAEX,IAAI,GAAG,IAAI,CAAC;YACZ,MAAM,IAAI,CAAC;SACZ;IACH,CAAC;IA1CgB,iCAAa,gBA0C7B,CAAA;IAED;;OAEG;IACH,QAAe,CAAC,CAAC,oBAAoB,CAAC,IAAyB,EAAE,IAAyB;QACxF,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1C,IAAI,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;QAElC,IAAI,IAAwB,CAAC;QAC7B,OAAO,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YAC1C,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC;YAC7B,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC5B,IAAI,IAAI,KAAK,IAAI;gBACf,SAAS;YAEX,IAAI,GAAG,IAAI,CAAC;YAEZ,IAAI,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;YAC7B,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC/B,OAAO,GAAG,GAAG,CAAC,EAAE;gBACd,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;gBAC9B,IAAI,UAAU,CAAC,IAAI;oBACjB,OAAO;gBAET,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;gBACzB,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;aAC5B;YAED,IAAI,CAAC,KAAK,GAAG;gBACX,MAAM,IAAI,CAAC;SACd;IACH,CAAC;IA7BgB,wCAAoB,uBA6BpC,CAAA;IAED;;OAEG;IACH,QAAe,CAAC,CAAC,kBAAkB,CAAC,IAAyB,EAAE,IAAyB;QACtF,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1C,IAAI,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;QAElC,IAAI,IAAwB,CAAC;QAC7B,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE;YACtB,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC;YAC7B,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC5B,IAAI,IAAI,KAAK,IAAI;gBACf,SAAS;iBACN,IAAI,UAAU,CAAC,IAAI,EAAE;gBACxB,MAAM,IAAI,GAAG,IAAI,CAAC;gBAClB,SAAS;aACV;YAED,IAAI,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;YAC7B,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC/B,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;gBAClC,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;gBAC9B,IAAI,UAAU,CAAC,IAAI,EAAE;oBACnB,MAAM,IAAI,GAAG,IAAI,CAAC;oBAClB,SAAS;iBACV;gBAED,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;gBACzB,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;aAC5B;YAED,IAAI,GAAG,GAAG,CAAC;gBACT,MAAM,IAAI,GAAG,IAAI,CAAC;SACrB;IACH,CAAC;IAjCgB,sCAAkB,qBAiClC,CAAA;AACH,CAAC,EAxOgB,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAwOnC","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/** @packageDocumentation\r\n * @module Ids\r\n */\r\n\r\nimport { assert } from \"./Assert\";\r\nimport { CompressedId64Set } from \"./CompressedId64Set\";\r\nimport { Id64Array, Id64String } from \"./Id\";\r\n\r\n/** @public */\r\nexport type OrderedId64Iterable = Iterable<Id64String>;\r\n\r\n/** A collection of **valid** [[Id64String]]s sorted in ascending order by the unsigned 64-bit integer value of the Ids.\r\n * This ordering is a requirement for several groups of APIs including [[CompressedId64Set]].\r\n * When used as input to a function, duplicate Ids are ignored; when returned as a function output, no duplicates are present.\r\n * @see [[CompressedId64Set]] for a compact string representation of such an ordered collection.\r\n * @see [[OrderedId64Iterable.compare]] for a function that compares Ids based on this criterion.\r\n * @see [[OrderedId64Array]] for a mutable implementation.\r\n * @public\r\n */\r\nexport namespace OrderedId64Iterable { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  /** An ordered comparison of [[Id64String]]s suitable for use with sorting routines like\r\n   * [Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) and sorted containers\r\n   * like [[SortedArray]] and [[Dictionary]]. The comparison compares the 64-bit numerical values of the two Ids, returning a negative number if lhs < rhs,\r\n   * a positive number if lhs > rhs, or zero if lhs == rhs.\r\n   * The default string comparison is fine (and more efficient) when numerical ordering is not required; use this instead if you want e.g., \"0x100\" to be greater than \"0xf\".\r\n   * @see [[OrderedId64Iterable.sortArray]] for a convenient way to sort an array of Id64Strings.\r\n   */\r\n  export function compare(lhs: Id64String, rhs: Id64String): number {\r\n    if (lhs.length !== rhs.length)\r\n      return lhs.length < rhs.length ? -1 : 1;\r\n\r\n    // This is faster than localeCompare(). Unclear why there is no string.compare() - would be generally useful in\r\n    // array sort functions...\r\n    if (lhs !== rhs)\r\n      return lhs < rhs ? -1 : 1;\r\n\r\n    return 0;\r\n  }\r\n\r\n  /** Sort an array of [[Id64String]]s **in-place** in ascending order by their 64-bit numerical values.\r\n   * @see [[OrderedId64Iterable.compare]] for the comparison routine used.\r\n   * @returns the input array.\r\n   * @note This function returns its input for consistency with Javascript's\r\n   * [Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) method.\r\n   * It **does not** create a **new** array.\r\n   */\r\n  export function sortArray(ids: Id64Array): Id64Array {\r\n    ids.sort((x, y) => compare(x, y));\r\n    return ids;\r\n  }\r\n\r\n  /** Given two ordered collections of [[Id64String]]s, determine whether they are identical sets. Duplicate Ids are ignored.\r\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\r\n   */\r\n  export function areEqualSets(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable): boolean {\r\n    const leftIter = uniqueIterator(ids1);\r\n    const rightIter = uniqueIterator(ids2);\r\n    let leftState = leftIter.next();\r\n    let rightState = rightIter.next();\r\n\r\n    while (!leftState.done && !rightState.done) {\r\n      const left = leftState.value;\r\n      const right = rightState.value;\r\n      if (0 !== compare(left, right))\r\n        return false;\r\n\r\n      leftState = leftIter.next();\r\n      rightState = rightIter.next();\r\n    }\r\n\r\n    if (leftState.done && rightState.done)\r\n      return true;\r\n\r\n    return false;\r\n  }\r\n\r\n  /** Given an ordered collection of [[Id64String]]s, determine if it contains any Ids.\r\n   * @param ids A well-formed, ordered collection of zero or more valid Ids.\r\n   * @returns true if the input represents an empty set of Ids. The result is unspecified if the input does not meet the criteria for the input type.\r\n   */\r\n  export function isEmptySet(ids: OrderedId64Iterable | CompressedId64Set): boolean {\r\n    if (typeof ids === \"string\")\r\n      return \"\" === ids;\r\n\r\n    return true === ids[Symbol.iterator]().next().done;\r\n  }\r\n\r\n  /** Given an ordered collection of [[Id64String]]s possibly containing duplicates, produce an ordered collection containing no duplicates.\r\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\r\n   */\r\n  export function unique(ids: OrderedId64Iterable): OrderedId64Iterable {\r\n    return { [Symbol.iterator]: () => uniqueIterator(ids) };\r\n  }\r\n\r\n  /** Given an ordered collection of [[Id64String]]s possibly containing duplicates, produce an ordered iterator over the distinct Ids, eliminating duplicates.\r\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\r\n   */\r\n  export function* uniqueIterator(ids: OrderedId64Iterable) {\r\n    const iter = ids[Symbol.iterator]();\r\n    let state = iter.next();\r\n    let prev: Id64String | undefined;\r\n\r\n    while (!state.done) {\r\n      const id = state.value;\r\n      state = iter.next();\r\n      if (id !== prev) {\r\n        prev = id;\r\n        yield id;\r\n      }\r\n    }\r\n  }\r\n\r\n  /** Given two ordered collections of [[Id64String]]s, produce a collection representing their union - i.e., the Ids that are present in either or both collections.\r\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\r\n   */\r\n  export function union(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable): OrderedId64Iterable {\r\n    return { [Symbol.iterator]: () => unionIterator(ids1, ids2) };\r\n  }\r\n\r\n  /** Given two ordered collections of [[Id64String]]s, produce an iterator representing their intersection - i.e., the Ids that are present in both collections.\r\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\r\n   */\r\n  export function intersection(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable): OrderedId64Iterable {\r\n    return { [Symbol.iterator]: () => intersectionIterator(ids1, ids2) };\r\n  }\r\n\r\n  /** Given two ordered collections of [[Id64String]]s, produce an iterator representing their difference - i.e., the Ids that are present in `ids1` but not present in `ids2`.\r\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\r\n   */\r\n  export function difference(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable): OrderedId64Iterable {\r\n    return { [Symbol.iterator]: () => differenceIterator(ids1, ids2) };\r\n  }\r\n\r\n  /** Given two ordered collections of [[Id64String]]s, produce an iterator representing their union - i.e., the Ids that are present in either or both collections.\r\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\r\n   */\r\n  export function* unionIterator(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable) {\r\n    const leftIter = ids1[Symbol.iterator]();\r\n    const rightIter = ids2[Symbol.iterator]();\r\n    let leftState = leftIter.next();\r\n    let rightState = rightIter.next();\r\n\r\n    let prev: string | undefined;\r\n    while (!leftState.done || !rightState.done) {\r\n      const left = leftState.done ? undefined : leftState.value;\r\n      const right = rightState.done ? undefined : rightState.value;\r\n\r\n      assert(undefined !== left || undefined !== right);\r\n      if (undefined === left && undefined === right)\r\n        break;\r\n\r\n      let next: Id64String;\r\n      if (undefined === left) {\r\n        assert(undefined !== right);\r\n        next = right;\r\n        rightState = rightIter.next();\r\n      } else if (undefined === right) {\r\n        next = left;\r\n        leftState = leftIter.next();\r\n      } else {\r\n        const cmp = compare(left, right);\r\n        if (cmp <= 0) {\r\n          next = left;\r\n          leftState = leftIter.next();\r\n          if (0 === cmp)\r\n            rightState = rightIter.next();\r\n        } else {\r\n          next = right;\r\n          rightState = rightIter.next();\r\n        }\r\n      }\r\n\r\n      if (prev === next)\r\n        continue;\r\n\r\n      prev = next;\r\n      yield next;\r\n    }\r\n  }\r\n\r\n  /** Given two ordered collections of [[Id64String]]s, produce an iterator representing their intersection - i.e., the Ids that are present in both collections.\r\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\r\n   */\r\n  export function* intersectionIterator(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable) {\r\n    const leftIter = ids1[Symbol.iterator]();\r\n    const rightIter = ids2[Symbol.iterator]();\r\n    let leftState = leftIter.next();\r\n    let rightState = rightIter.next();\r\n\r\n    let prev: string | undefined;\r\n    while (!leftState.done && !rightState.done) {\r\n      const left = leftState.value;\r\n      leftState = leftIter.next();\r\n      if (left === prev)\r\n        continue;\r\n\r\n      prev = left;\r\n\r\n      let right = rightState.value;\r\n      let cmp = compare(left, right);\r\n      while (cmp > 0) {\r\n        rightState = rightIter.next();\r\n        if (rightState.done)\r\n          return;\r\n\r\n        right = rightState.value;\r\n        cmp = compare(left, right);\r\n      }\r\n\r\n      if (0 === cmp)\r\n        yield left;\r\n    }\r\n  }\r\n\r\n  /** Given two ordered collections of [[Id64String]]s, produce an iterator representing their difference - i.e., the Ids that are present in `ids1` but not present in `ids2`.\r\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\r\n   */\r\n  export function* differenceIterator(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable) {\r\n    const leftIter = ids1[Symbol.iterator]();\r\n    const rightIter = ids2[Symbol.iterator]();\r\n    let leftState = leftIter.next();\r\n    let rightState = rightIter.next();\r\n\r\n    let prev: string | undefined;\r\n    while (!leftState.done) {\r\n      const left = leftState.value;\r\n      leftState = leftIter.next();\r\n      if (left === prev)\r\n        continue;\r\n      else if (rightState.done) {\r\n        yield prev = left;\r\n        continue;\r\n      }\r\n\r\n      let right = rightState.value;\r\n      let cmp = compare(left, right);\r\n      while (cmp > 0 && !rightState.done) {\r\n        rightState = rightIter.next();\r\n        if (rightState.done) {\r\n          yield prev = left;\r\n          continue;\r\n        }\r\n\r\n        right = rightState.value;\r\n        cmp = compare(left, right);\r\n      }\r\n\r\n      if (cmp < 0)\r\n        yield prev = left;\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"OrderedId64Iterable.js","sourceRoot":"","sources":["../../src/OrderedId64Iterable.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qCAAkC;AAOlC;;;;;;;GAOG;AACH,IAAiB,mBAAmB,CAwOnC;AAxOD,WAAiB,mBAAmB;IAClC;;;;;;OAMG;IACH,SAAgB,OAAO,CAAC,GAAe,EAAE,GAAe;QACtD,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM;YAC3B,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE1C,+GAA+G;QAC/G,0BAA0B;QAC1B,IAAI,GAAG,KAAK,GAAG;YACb,OAAO,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5B,OAAO,CAAC,CAAC;IACX,CAAC;IAVe,2BAAO,UAUtB,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,SAAS,CAAC,GAAc;QACtC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAClC,OAAO,GAAG,CAAC;IACb,CAAC;IAHe,6BAAS,YAGxB,CAAA;IAED;;OAEG;IACH,SAAgB,YAAY,CAAC,IAAyB,EAAE,IAAyB;QAC/E,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;QAElC,OAAO,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YAC1C,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC;YAC7B,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;YAC/B,IAAI,CAAC,KAAK,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;gBAC5B,OAAO,KAAK,CAAC;YAEf,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC5B,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;SAC/B;QAED,IAAI,SAAS,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI;YACnC,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IApBe,gCAAY,eAoB3B,CAAA;IAED;;;OAGG;IACH,SAAgB,UAAU,CAAC,GAA4C;QACrE,IAAI,OAAO,GAAG,KAAK,QAAQ;YACzB,OAAO,EAAE,KAAK,GAAG,CAAC;QAEpB,OAAO,IAAI,KAAK,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC;IACrD,CAAC;IALe,8BAAU,aAKzB,CAAA;IAED;;OAEG;IACH,SAAgB,MAAM,CAAC,GAAwB;QAC7C,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;IAC1D,CAAC;IAFe,0BAAM,SAErB,CAAA;IAED;;OAEG;IACH,QAAe,CAAC,CAAC,cAAc,CAAC,GAAwB;QACtD,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpC,IAAI,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QACxB,IAAI,IAA4B,CAAC;QAEjC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE;YAClB,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC;YACvB,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACpB,IAAI,EAAE,KAAK,IAAI,EAAE;gBACf,IAAI,GAAG,EAAE,CAAC;gBACV,MAAM,EAAE,CAAC;aACV;SACF;IACH,CAAC;IAbgB,kCAAc,iBAa9B,CAAA;IAED;;OAEG;IACH,SAAgB,KAAK,CAAC,IAAyB,EAAE,IAAyB;QACxE,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;IAChE,CAAC;IAFe,yBAAK,QAEpB,CAAA;IAED;;OAEG;IACH,SAAgB,YAAY,CAAC,IAAyB,EAAE,IAAyB;QAC/E,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;IACvE,CAAC;IAFe,gCAAY,eAE3B,CAAA;IAED;;OAEG;IACH,SAAgB,UAAU,CAAC,IAAyB,EAAE,IAAyB;QAC7E,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;IACrE,CAAC;IAFe,8BAAU,aAEzB,CAAA;IAED;;OAEG;IACH,QAAe,CAAC,CAAC,aAAa,CAAC,IAAyB,EAAE,IAAyB;QACjF,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1C,IAAI,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;QAElC,IAAI,IAAwB,CAAC;QAC7B,OAAO,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YAC1C,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC;YAC1D,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC;YAE7D,IAAA,eAAM,EAAC,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC;YAClD,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,KAAK;gBAC3C,MAAM;YAER,IAAI,IAAgB,CAAC;YACrB,IAAI,SAAS,KAAK,IAAI,EAAE;gBACtB,IAAA,eAAM,EAAC,SAAS,KAAK,KAAK,CAAC,CAAC;gBAC5B,IAAI,GAAG,KAAK,CAAC;gBACb,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;aAC/B;iBAAM,IAAI,SAAS,KAAK,KAAK,EAAE;gBAC9B,IAAI,GAAG,IAAI,CAAC;gBACZ,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;aAC7B;iBAAM;gBACL,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACjC,IAAI,GAAG,IAAI,CAAC,EAAE;oBACZ,IAAI,GAAG,IAAI,CAAC;oBACZ,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAC5B,IAAI,CAAC,KAAK,GAAG;wBACX,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;iBACjC;qBAAM;oBACL,IAAI,GAAG,KAAK,CAAC;oBACb,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;iBAC/B;aACF;YAED,IAAI,IAAI,KAAK,IAAI;gBACf,SAAS;YAEX,IAAI,GAAG,IAAI,CAAC;YACZ,MAAM,IAAI,CAAC;SACZ;IACH,CAAC;IA1CgB,iCAAa,gBA0C7B,CAAA;IAED;;OAEG;IACH,QAAe,CAAC,CAAC,oBAAoB,CAAC,IAAyB,EAAE,IAAyB;QACxF,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1C,IAAI,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;QAElC,IAAI,IAAwB,CAAC;QAC7B,OAAO,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YAC1C,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC;YAC7B,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC5B,IAAI,IAAI,KAAK,IAAI;gBACf,SAAS;YAEX,IAAI,GAAG,IAAI,CAAC;YAEZ,IAAI,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;YAC7B,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC/B,OAAO,GAAG,GAAG,CAAC,EAAE;gBACd,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;gBAC9B,IAAI,UAAU,CAAC,IAAI;oBACjB,OAAO;gBAET,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;gBACzB,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;aAC5B;YAED,IAAI,CAAC,KAAK,GAAG;gBACX,MAAM,IAAI,CAAC;SACd;IACH,CAAC;IA7BgB,wCAAoB,uBA6BpC,CAAA;IAED;;OAEG;IACH,QAAe,CAAC,CAAC,kBAAkB,CAAC,IAAyB,EAAE,IAAyB;QACtF,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1C,IAAI,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;QAElC,IAAI,IAAwB,CAAC;QAC7B,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE;YACtB,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC;YAC7B,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC5B,IAAI,IAAI,KAAK,IAAI;gBACf,SAAS;iBACN,IAAI,UAAU,CAAC,IAAI,EAAE;gBACxB,MAAM,IAAI,GAAG,IAAI,CAAC;gBAClB,SAAS;aACV;YAED,IAAI,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;YAC7B,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC/B,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;gBAClC,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;gBAC9B,IAAI,UAAU,CAAC,IAAI,EAAE;oBACnB,MAAM,IAAI,GAAG,IAAI,CAAC;oBAClB,SAAS;iBACV;gBAED,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;gBACzB,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;aAC5B;YAED,IAAI,GAAG,GAAG,CAAC;gBACT,MAAM,IAAI,GAAG,IAAI,CAAC;SACrB;IACH,CAAC;IAjCgB,sCAAkB,qBAiClC,CAAA;AACH,CAAC,EAxOgB,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAwOnC","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/** @packageDocumentation\n * @module Ids\n */\n\nimport { assert } from \"./Assert\";\nimport { CompressedId64Set } from \"./CompressedId64Set\";\nimport { Id64Array, Id64String } from \"./Id\";\n\n/** @public */\nexport type OrderedId64Iterable = Iterable<Id64String>;\n\n/** A collection of **valid** [[Id64String]]s sorted in ascending order by the unsigned 64-bit integer value of the Ids.\n * This ordering is a requirement for several groups of APIs including [[CompressedId64Set]].\n * When used as input to a function, duplicate Ids are ignored; when returned as a function output, no duplicates are present.\n * @see [[CompressedId64Set]] for a compact string representation of such an ordered collection.\n * @see [[OrderedId64Iterable.compare]] for a function that compares Ids based on this criterion.\n * @see [[OrderedId64Array]] for a mutable implementation.\n * @public\n */\nexport namespace OrderedId64Iterable { // eslint-disable-line @typescript-eslint/no-redeclare\n  /** An ordered comparison of [[Id64String]]s suitable for use with sorting routines like\n   * [Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) and sorted containers\n   * like [[SortedArray]] and [[Dictionary]]. The comparison compares the 64-bit numerical values of the two Ids, returning a negative number if lhs < rhs,\n   * a positive number if lhs > rhs, or zero if lhs == rhs.\n   * The default string comparison is fine (and more efficient) when numerical ordering is not required; use this instead if you want e.g., \"0x100\" to be greater than \"0xf\".\n   * @see [[OrderedId64Iterable.sortArray]] for a convenient way to sort an array of Id64Strings.\n   */\n  export function compare(lhs: Id64String, rhs: Id64String): number {\n    if (lhs.length !== rhs.length)\n      return lhs.length < rhs.length ? -1 : 1;\n\n    // This is faster than localeCompare(). Unclear why there is no string.compare() - would be generally useful in\n    // array sort functions...\n    if (lhs !== rhs)\n      return lhs < rhs ? -1 : 1;\n\n    return 0;\n  }\n\n  /** Sort an array of [[Id64String]]s **in-place** in ascending order by their 64-bit numerical values.\n   * @see [[OrderedId64Iterable.compare]] for the comparison routine used.\n   * @returns the input array.\n   * @note This function returns its input for consistency with Javascript's\n   * [Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) method.\n   * It **does not** create a **new** array.\n   */\n  export function sortArray(ids: Id64Array): Id64Array {\n    ids.sort((x, y) => compare(x, y));\n    return ids;\n  }\n\n  /** Given two ordered collections of [[Id64String]]s, determine whether they are identical sets. Duplicate Ids are ignored.\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\n   */\n  export function areEqualSets(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable): boolean {\n    const leftIter = uniqueIterator(ids1);\n    const rightIter = uniqueIterator(ids2);\n    let leftState = leftIter.next();\n    let rightState = rightIter.next();\n\n    while (!leftState.done && !rightState.done) {\n      const left = leftState.value;\n      const right = rightState.value;\n      if (0 !== compare(left, right))\n        return false;\n\n      leftState = leftIter.next();\n      rightState = rightIter.next();\n    }\n\n    if (leftState.done && rightState.done)\n      return true;\n\n    return false;\n  }\n\n  /** Given an ordered collection of [[Id64String]]s, determine if it contains any Ids.\n   * @param ids A well-formed, ordered collection of zero or more valid Ids.\n   * @returns true if the input represents an empty set of Ids. The result is unspecified if the input does not meet the criteria for the input type.\n   */\n  export function isEmptySet(ids: OrderedId64Iterable | CompressedId64Set): boolean {\n    if (typeof ids === \"string\")\n      return \"\" === ids;\n\n    return true === ids[Symbol.iterator]().next().done;\n  }\n\n  /** Given an ordered collection of [[Id64String]]s possibly containing duplicates, produce an ordered collection containing no duplicates.\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\n   */\n  export function unique(ids: OrderedId64Iterable): OrderedId64Iterable {\n    return { [Symbol.iterator]: () => uniqueIterator(ids) };\n  }\n\n  /** Given an ordered collection of [[Id64String]]s possibly containing duplicates, produce an ordered iterator over the distinct Ids, eliminating duplicates.\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\n   */\n  export function* uniqueIterator(ids: OrderedId64Iterable) {\n    const iter = ids[Symbol.iterator]();\n    let state = iter.next();\n    let prev: Id64String | undefined;\n\n    while (!state.done) {\n      const id = state.value;\n      state = iter.next();\n      if (id !== prev) {\n        prev = id;\n        yield id;\n      }\n    }\n  }\n\n  /** Given two ordered collections of [[Id64String]]s, produce a collection representing their union - i.e., the Ids that are present in either or both collections.\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\n   */\n  export function union(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable): OrderedId64Iterable {\n    return { [Symbol.iterator]: () => unionIterator(ids1, ids2) };\n  }\n\n  /** Given two ordered collections of [[Id64String]]s, produce an iterator representing their intersection - i.e., the Ids that are present in both collections.\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\n   */\n  export function intersection(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable): OrderedId64Iterable {\n    return { [Symbol.iterator]: () => intersectionIterator(ids1, ids2) };\n  }\n\n  /** Given two ordered collections of [[Id64String]]s, produce an iterator representing their difference - i.e., the Ids that are present in `ids1` but not present in `ids2`.\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\n   */\n  export function difference(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable): OrderedId64Iterable {\n    return { [Symbol.iterator]: () => differenceIterator(ids1, ids2) };\n  }\n\n  /** Given two ordered collections of [[Id64String]]s, produce an iterator representing their union - i.e., the Ids that are present in either or both collections.\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\n   */\n  export function* unionIterator(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable) {\n    const leftIter = ids1[Symbol.iterator]();\n    const rightIter = ids2[Symbol.iterator]();\n    let leftState = leftIter.next();\n    let rightState = rightIter.next();\n\n    let prev: string | undefined;\n    while (!leftState.done || !rightState.done) {\n      const left = leftState.done ? undefined : leftState.value;\n      const right = rightState.done ? undefined : rightState.value;\n\n      assert(undefined !== left || undefined !== right);\n      if (undefined === left && undefined === right)\n        break;\n\n      let next: Id64String;\n      if (undefined === left) {\n        assert(undefined !== right);\n        next = right;\n        rightState = rightIter.next();\n      } else if (undefined === right) {\n        next = left;\n        leftState = leftIter.next();\n      } else {\n        const cmp = compare(left, right);\n        if (cmp <= 0) {\n          next = left;\n          leftState = leftIter.next();\n          if (0 === cmp)\n            rightState = rightIter.next();\n        } else {\n          next = right;\n          rightState = rightIter.next();\n        }\n      }\n\n      if (prev === next)\n        continue;\n\n      prev = next;\n      yield next;\n    }\n  }\n\n  /** Given two ordered collections of [[Id64String]]s, produce an iterator representing their intersection - i.e., the Ids that are present in both collections.\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\n   */\n  export function* intersectionIterator(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable) {\n    const leftIter = ids1[Symbol.iterator]();\n    const rightIter = ids2[Symbol.iterator]();\n    let leftState = leftIter.next();\n    let rightState = rightIter.next();\n\n    let prev: string | undefined;\n    while (!leftState.done && !rightState.done) {\n      const left = leftState.value;\n      leftState = leftIter.next();\n      if (left === prev)\n        continue;\n\n      prev = left;\n\n      let right = rightState.value;\n      let cmp = compare(left, right);\n      while (cmp > 0) {\n        rightState = rightIter.next();\n        if (rightState.done)\n          return;\n\n        right = rightState.value;\n        cmp = compare(left, right);\n      }\n\n      if (0 === cmp)\n        yield left;\n    }\n  }\n\n  /** Given two ordered collections of [[Id64String]]s, produce an iterator representing their difference - i.e., the Ids that are present in `ids1` but not present in `ids2`.\n   * @note If the inputs are not ordered as required by [[OrderedId64Iterable]], the results are unpredictable.\n   */\n  export function* differenceIterator(ids1: OrderedId64Iterable, ids2: OrderedId64Iterable) {\n    const leftIter = ids1[Symbol.iterator]();\n    const rightIter = ids2[Symbol.iterator]();\n    let leftState = leftIter.next();\n    let rightState = rightIter.next();\n\n    let prev: string | undefined;\n    while (!leftState.done) {\n      const left = leftState.value;\n      leftState = leftIter.next();\n      if (left === prev)\n        continue;\n      else if (rightState.done) {\n        yield prev = left;\n        continue;\n      }\n\n      let right = rightState.value;\n      let cmp = compare(left, right);\n      while (cmp > 0 && !rightState.done) {\n        rightState = rightIter.next();\n        if (rightState.done) {\n          yield prev = left;\n          continue;\n        }\n\n        right = rightState.value;\n        cmp = compare(left, right);\n      }\n\n      if (cmp < 0)\n        yield prev = left;\n    }\n  }\n}\n"]}

package/lib/cjs/OrderedSet.d.ts

@@ -1,41 +1,41 @@
-/** @packageDocumentation
- * @module Collections
- */
-import { OrderedComparator } from "./Compare";
-import { CloneFunction, SortedArray } from "./SortedArray";
-/** A read-only equivalent of `Set<T>` that maintains its elements in sorted order as specified by a comparison function.
- * Iteration returns elements in the order specified by the comparison function, as opposed to `Set` which returns elements in insertion order.
- * Implemented in terms of [[SortedArray]].
- * @public
- */
-export declare class ReadonlyOrderedSet<T> implements Iterable<T> {
-    protected readonly _array: SortedArray<T>;
-    /** Construct a new ReadonlyOrderedSet<T>.
-     * @param compare The function used to compare elements within the set, determining their ordering.
-     * @param clone The function invoked to clone a new element for insertion into the set. The default implementation simply returns its input.
-     */
-    constructor(compare: OrderedComparator<T>, clone?: CloneFunction<T>);
-    /** The number of elements in the set. */
-    get size(): number;
-    /** Returns true if `value` is present in the set. */
-    has(value: T): boolean;
-    /** Iterate over the elements in sorted order (as opposed to `Set`'s iterator, which returns elements in insertion order). */
-    [Symbol.iterator](): Iterator<T>;
-}
-/** A mutable [[ReadonlyOrderedSet]].
- * @public
- */
-export declare class OrderedSet<T> extends ReadonlyOrderedSet<T> {
-    /** Construct a new OrderedSet<T>.
-     * @param compare The function used to compare elements within the set, determining their ordering.
-     * @param clone The function invoked to clone a new element for insertion into the set. The default implementation simply returns its input.
-     */
-    constructor(compare: OrderedComparator<T>, clone?: CloneFunction<T>);
-    /** Remove all elements from the set. */
-    clear(): void;
-    /** Add the specified element to the set. Returns this set. */
-    add(value: T): this;
-    /** Removes the specified element from the set. Returns `true` if the element was present. */
-    delete(value: T): boolean;
-}
+/** @packageDocumentation
+ * @module Collections
+ */
+import { OrderedComparator } from "./Compare";
+import { CloneFunction, SortedArray } from "./SortedArray";
+/** A read-only equivalent of `Set<T>` that maintains its elements in sorted order as specified by a comparison function.
+ * Iteration returns elements in the order specified by the comparison function, as opposed to `Set` which returns elements in insertion order.
+ * Implemented in terms of [[SortedArray]].
+ * @public
+ */
+export declare class ReadonlyOrderedSet<T> implements Iterable<T> {
+    protected readonly _array: SortedArray<T>;
+    /** Construct a new ReadonlyOrderedSet<T>.
+     * @param compare The function used to compare elements within the set, determining their ordering.
+     * @param clone The function invoked to clone a new element for insertion into the set. The default implementation simply returns its input.
+     */
+    constructor(compare: OrderedComparator<T>, clone?: CloneFunction<T>);
+    /** The number of elements in the set. */
+    get size(): number;
+    /** Returns true if `value` is present in the set. */
+    has(value: T): boolean;
+    /** Iterate over the elements in sorted order (as opposed to `Set`'s iterator, which returns elements in insertion order). */
+    [Symbol.iterator](): Iterator<T>;
+}
+/** A mutable [[ReadonlyOrderedSet]].
+ * @public
+ */
+export declare class OrderedSet<T> extends ReadonlyOrderedSet<T> {
+    /** Construct a new OrderedSet<T>.
+     * @param compare The function used to compare elements within the set, determining their ordering.
+     * @param clone The function invoked to clone a new element for insertion into the set. The default implementation simply returns its input.
+     */
+    constructor(compare: OrderedComparator<T>, clone?: CloneFunction<T>);
+    /** Remove all elements from the set. */
+    clear(): void;
+    /** Add the specified element to the set. Returns this set. */
+    add(value: T): this;
+    /** Removes the specified element from the set. Returns `true` if the element was present. */
+    delete(value: T): boolean;
+}
 //# sourceMappingURL=OrderedSet.d.ts.map

package/lib/cjs/OrderedSet.js

@@ -1,65 +1,65 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Collections
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrderedSet = exports.ReadonlyOrderedSet = void 0;
-const SortedArray_1 = require("./SortedArray");
-/** A read-only equivalent of `Set<T>` that maintains its elements in sorted order as specified by a comparison function.
- * Iteration returns elements in the order specified by the comparison function, as opposed to `Set` which returns elements in insertion order.
- * Implemented in terms of [[SortedArray]].
- * @public
- */
-class ReadonlyOrderedSet {
-    /** Construct a new ReadonlyOrderedSet<T>.
-     * @param compare The function used to compare elements within the set, determining their ordering.
-     * @param clone The function invoked to clone a new element for insertion into the set. The default implementation simply returns its input.
-     */
-    constructor(compare, clone = SortedArray_1.shallowClone) {
-        this._array = new SortedArray_1.SortedArray(compare, false, clone);
-    }
-    /** The number of elements in the set. */
-    get size() {
-        return this._array.length;
-    }
-    /** Returns true if `value` is present in the set. */
-    has(value) {
-        return -1 !== this._array.indexOf(value);
-    }
-    /** Iterate over the elements in sorted order (as opposed to `Set`'s iterator, which returns elements in insertion order). */
-    [Symbol.iterator]() {
-        return this._array[Symbol.iterator]();
-    }
-}
-exports.ReadonlyOrderedSet = ReadonlyOrderedSet;
-/** A mutable [[ReadonlyOrderedSet]].
- * @public
- */
-class OrderedSet extends ReadonlyOrderedSet {
-    /** Construct a new OrderedSet<T>.
-     * @param compare The function used to compare elements within the set, determining their ordering.
-     * @param clone The function invoked to clone a new element for insertion into the set. The default implementation simply returns its input.
-     */
-    constructor(compare, clone = SortedArray_1.shallowClone) {
-        super(compare, clone);
-    }
-    /** Remove all elements from the set. */
-    clear() {
-        this._array.clear();
-    }
-    /** Add the specified element to the set. Returns this set. */
-    add(value) {
-        this._array.insert(value);
-        return this;
-    }
-    /** Removes the specified element from the set. Returns `true` if the element was present. */
-    delete(value) {
-        return -1 !== this._array.remove(value);
-    }
-}
-exports.OrderedSet = OrderedSet;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Collections
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderedSet = exports.ReadonlyOrderedSet = void 0;
+const SortedArray_1 = require("./SortedArray");
+/** A read-only equivalent of `Set<T>` that maintains its elements in sorted order as specified by a comparison function.
+ * Iteration returns elements in the order specified by the comparison function, as opposed to `Set` which returns elements in insertion order.
+ * Implemented in terms of [[SortedArray]].
+ * @public
+ */
+class ReadonlyOrderedSet {
+    /** Construct a new ReadonlyOrderedSet<T>.
+     * @param compare The function used to compare elements within the set, determining their ordering.
+     * @param clone The function invoked to clone a new element for insertion into the set. The default implementation simply returns its input.
+     */
+    constructor(compare, clone = SortedArray_1.shallowClone) {
+        this._array = new SortedArray_1.SortedArray(compare, false, clone);
+    }
+    /** The number of elements in the set. */
+    get size() {
+        return this._array.length;
+    }
+    /** Returns true if `value` is present in the set. */
+    has(value) {
+        return -1 !== this._array.indexOf(value);
+    }
+    /** Iterate over the elements in sorted order (as opposed to `Set`'s iterator, which returns elements in insertion order). */
+    [Symbol.iterator]() {
+        return this._array[Symbol.iterator]();
+    }
+}
+exports.ReadonlyOrderedSet = ReadonlyOrderedSet;
+/** A mutable [[ReadonlyOrderedSet]].
+ * @public
+ */
+class OrderedSet extends ReadonlyOrderedSet {
+    /** Construct a new OrderedSet<T>.
+     * @param compare The function used to compare elements within the set, determining their ordering.
+     * @param clone The function invoked to clone a new element for insertion into the set. The default implementation simply returns its input.
+     */
+    constructor(compare, clone = SortedArray_1.shallowClone) {
+        super(compare, clone);
+    }
+    /** Remove all elements from the set. */
+    clear() {
+        this._array.clear();
+    }
+    /** Add the specified element to the set. Returns this set. */
+    add(value) {
+        this._array.insert(value);
+        return this;
+    }
+    /** Removes the specified element from the set. Returns `true` if the element was present. */
+    delete(value) {
+        return -1 !== this._array.remove(value);
+    }
+}
+exports.OrderedSet = OrderedSet;
 //# sourceMappingURL=OrderedSet.js.map

package/lib/cjs/OrderedSet.js.map

@@ -1 +1 @@
-{"version":3,"file":"OrderedSet.js","sourceRoot":"","sources":["../../src/OrderedSet.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,+CAAyE;AAEzE;;;;GAIG;AACH,MAAa,kBAAkB;IAG7B;;;OAGG;IACH,YAAmB,OAA6B,EAAE,QAA0B,0BAAY;QACtF,IAAI,CAAC,MAAM,GAAG,IAAI,yBAAW,CAAI,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED,yCAAyC;IACzC,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED,qDAAqD;IAC9C,GAAG,CAAC,KAAQ;QACjB,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,6HAA6H;IACtH,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACxC,CAAC;CACF;AAzBD,gDAyBC;AAED;;GAEG;AACH,MAAa,UAAc,SAAQ,kBAAqB;IACtD;;;OAGG;IACH,YAAmB,OAA6B,EAAE,QAA0B,0BAAY;QACtF,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACxB,CAAC;IAED,wCAAwC;IACjC,KAAK;QACV,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAED,8DAA8D;IACvD,GAAG,CAAC,KAAQ;QACjB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,6FAA6F;IACtF,MAAM,CAAC,KAAQ;QACpB,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;CACF;AAxBD,gCAwBC","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/** @packageDocumentation\r\n * @module Collections\r\n */\r\n\r\nimport { OrderedComparator } from \"./Compare\";\r\nimport { CloneFunction, shallowClone, SortedArray } from \"./SortedArray\";\r\n\r\n/** A read-only equivalent of `Set<T>` that maintains its elements in sorted order as specified by a comparison function.\r\n * Iteration returns elements in the order specified by the comparison function, as opposed to `Set` which returns elements in insertion order.\r\n * Implemented in terms of [[SortedArray]].\r\n * @public\r\n */\r\nexport class ReadonlyOrderedSet<T> implements Iterable<T> {\r\n  protected readonly _array: SortedArray<T>;\r\n\r\n  /** Construct a new ReadonlyOrderedSet<T>.\r\n   * @param compare The function used to compare elements within the set, determining their ordering.\r\n   * @param clone The function invoked to clone a new element for insertion into the set. The default implementation simply returns its input.\r\n   */\r\n  public constructor(compare: OrderedComparator<T>, clone: CloneFunction<T> = shallowClone) {\r\n    this._array = new SortedArray<T>(compare, false, clone);\r\n  }\r\n\r\n  /** The number of elements in the set. */\r\n  public get size(): number {\r\n    return this._array.length;\r\n  }\r\n\r\n  /** Returns true if `value` is present in the set. */\r\n  public has(value: T): boolean {\r\n    return -1 !== this._array.indexOf(value);\r\n  }\r\n\r\n  /** Iterate over the elements in sorted order (as opposed to `Set`'s iterator, which returns elements in insertion order). */\r\n  public [Symbol.iterator](): Iterator<T> {\r\n    return this._array[Symbol.iterator]();\r\n  }\r\n}\r\n\r\n/** A mutable [[ReadonlyOrderedSet]].\r\n * @public\r\n */\r\nexport class OrderedSet<T> extends ReadonlyOrderedSet<T> {\r\n  /** Construct a new OrderedSet<T>.\r\n   * @param compare The function used to compare elements within the set, determining their ordering.\r\n   * @param clone The function invoked to clone a new element for insertion into the set. The default implementation simply returns its input.\r\n   */\r\n  public constructor(compare: OrderedComparator<T>, clone: CloneFunction<T> = shallowClone) {\r\n    super(compare, clone);\r\n  }\r\n\r\n  /** Remove all elements from the set. */\r\n  public clear(): void {\r\n    this._array.clear();\r\n  }\r\n\r\n  /** Add the specified element to the set. Returns this set. */\r\n  public add(value: T): this {\r\n    this._array.insert(value);\r\n    return this;\r\n  }\r\n\r\n  /** Removes the specified element from the set. Returns `true` if the element was present. */\r\n  public delete(value: T): boolean {\r\n    return -1 !== this._array.remove(value);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"OrderedSet.js","sourceRoot":"","sources":["../../src/OrderedSet.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,+CAAyE;AAEzE;;;;GAIG;AACH,MAAa,kBAAkB;IAG7B;;;OAGG;IACH,YAAmB,OAA6B,EAAE,QAA0B,0BAAY;QACtF,IAAI,CAAC,MAAM,GAAG,IAAI,yBAAW,CAAI,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED,yCAAyC;IACzC,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED,qDAAqD;IAC9C,GAAG,CAAC,KAAQ;QACjB,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,6HAA6H;IACtH,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACxC,CAAC;CACF;AAzBD,gDAyBC;AAED;;GAEG;AACH,MAAa,UAAc,SAAQ,kBAAqB;IACtD;;;OAGG;IACH,YAAmB,OAA6B,EAAE,QAA0B,0BAAY;QACtF,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACxB,CAAC;IAED,wCAAwC;IACjC,KAAK;QACV,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAED,8DAA8D;IACvD,GAAG,CAAC,KAAQ;QACjB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,6FAA6F;IACtF,MAAM,CAAC,KAAQ;QACpB,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;CACF;AAxBD,gCAwBC","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/** @packageDocumentation\n * @module Collections\n */\n\nimport { OrderedComparator } from \"./Compare\";\nimport { CloneFunction, shallowClone, SortedArray } from \"./SortedArray\";\n\n/** A read-only equivalent of `Set<T>` that maintains its elements in sorted order as specified by a comparison function.\n * Iteration returns elements in the order specified by the comparison function, as opposed to `Set` which returns elements in insertion order.\n * Implemented in terms of [[SortedArray]].\n * @public\n */\nexport class ReadonlyOrderedSet<T> implements Iterable<T> {\n  protected readonly _array: SortedArray<T>;\n\n  /** Construct a new ReadonlyOrderedSet<T>.\n   * @param compare The function used to compare elements within the set, determining their ordering.\n   * @param clone The function invoked to clone a new element for insertion into the set. The default implementation simply returns its input.\n   */\n  public constructor(compare: OrderedComparator<T>, clone: CloneFunction<T> = shallowClone) {\n    this._array = new SortedArray<T>(compare, false, clone);\n  }\n\n  /** The number of elements in the set. */\n  public get size(): number {\n    return this._array.length;\n  }\n\n  /** Returns true if `value` is present in the set. */\n  public has(value: T): boolean {\n    return -1 !== this._array.indexOf(value);\n  }\n\n  /** Iterate over the elements in sorted order (as opposed to `Set`'s iterator, which returns elements in insertion order). */\n  public [Symbol.iterator](): Iterator<T> {\n    return this._array[Symbol.iterator]();\n  }\n}\n\n/** A mutable [[ReadonlyOrderedSet]].\n * @public\n */\nexport class OrderedSet<T> extends ReadonlyOrderedSet<T> {\n  /** Construct a new OrderedSet<T>.\n   * @param compare The function used to compare elements within the set, determining their ordering.\n   * @param clone The function invoked to clone a new element for insertion into the set. The default implementation simply returns its input.\n   */\n  public constructor(compare: OrderedComparator<T>, clone: CloneFunction<T> = shallowClone) {\n    super(compare, clone);\n  }\n\n  /** Remove all elements from the set. */\n  public clear(): void {\n    this._array.clear();\n  }\n\n  /** Add the specified element to the set. Returns this set. */\n  public add(value: T): this {\n    this._array.insert(value);\n    return this;\n  }\n\n  /** Removes the specified element from the set. Returns `true` if the element was present. */\n  public delete(value: T): boolean {\n    return -1 !== this._array.remove(value);\n  }\n}\n"]}

package/lib/cjs/PriorityQueue.d.ts

@@ -1,71 +1,71 @@
-/** @packageDocumentation
- * @module Collections
- */
-import { OrderedComparator } from "./Compare";
-import { CloneFunction } from "./SortedArray";
-/** @public */
-export declare type ComputePriorityFunction<T> = (value: T) => number;
-/**
- * A [priority queue](https://en.wikipedia.org/wiki/Priority_queue) implemented as a heap array.
- * The queue is ordered by an [[OrderedComparator]] function supplied by the user such that the value in the queue that compares less than all other values is always located at the front of the queue.
- * @public
- */
-export declare class PriorityQueue<T> implements Iterable<T> {
-    protected _array: T[];
-    protected readonly _compare: OrderedComparator<T>;
-    protected readonly _clone: CloneFunction<T>;
-    /**
-     * Constructor
-     * @param compare The function used to compare values in the queue. If `compare(x, y)` returns a negative value, then x is placed before y in the queue.
-     * @param clone The function used to clone a value for insertion onto the queue. The default implementation simply returns its input.
-     * @note If the criterion which control the result of the `compare` function changes, then [[PriorityQueue.sort]] should be used to reorder the queue according to the new criterion.
-     */
-    constructor(compare: OrderedComparator<T>, clone?: CloneFunction<T>);
-    /** The number of values in the queue. */
-    get length(): number;
-    /** Returns true if the queue contains no values. */
-    get isEmpty(): boolean;
-    /** Returns an iterator over the contents of the heap suitable for use in `for-of` loops. */
-    [Symbol.iterator](): Iterator<T>;
-    protected _swap(a: number, b: number): void;
-    protected _heapify(index: number): void;
-    /**
-     * Reorders the queue. This function should only (and *always*) be called when the criteria governing the ordering of items on the queue have changed.
-     * For example, a priority queue containing graphics sorted by their distance from the camera would need to be reordered when the position of the camera changes.
-     */
-    sort(): void;
-    /**
-     * Pushes a value onto the queue according to the sorting criterion.
-     * @param value The value to insert
-     * @returns The inserted value, cloned according to the [[CloneFunction]] supplied to this queue's constructor.
-     */
-    push(value: T): T;
-    /** Pushes a value onto the back of the queue without making any attempt to enforce ordering.
-     * After using this function, you must manually invoke sort() to ensure the queue is sorted again.
-     * @param value The value to append
-     * @returns The appended value, cloned according to the [[CloneFunction]] supplied to this queue's constructor.
-     */
-    append(value: T): T;
-    /** Returns the element at the front of the queue, or `undefined` if the queue is empty. */
-    get front(): T | undefined;
-    /**
-     * Removes the front-most element off of the queue and returns it.
-     * @returns The front-most element, or undefined if the queue is empty.
-     */
-    pop(): T | undefined;
-    /** Removes all values from the queue. */
-    clear(): void;
-    /**
-     * Removes the value at the specified index from the queue and reorders the queue.
-     * @param index The index of the value to remove
-     * @returns the value at the specified index, or undefined if the index is out of range.
-     */
-    protected _pop(index: number): T | undefined;
-    /**
-     * Returns the value at the specified index in the queue.
-     * @param index The index of the value to retrieve
-     * @returns the value at the specified index, or undefined if the index is out of range.
-     */
-    protected _peek(index: number): T | undefined;
-}
+/** @packageDocumentation
+ * @module Collections
+ */
+import { OrderedComparator } from "./Compare";
+import { CloneFunction } from "./SortedArray";
+/** @public */
+export declare type ComputePriorityFunction<T> = (value: T) => number;
+/**
+ * A [priority queue](https://en.wikipedia.org/wiki/Priority_queue) implemented as a heap array.
+ * The queue is ordered by an [[OrderedComparator]] function supplied by the user such that the value in the queue that compares less than all other values is always located at the front of the queue.
+ * @public
+ */
+export declare class PriorityQueue<T> implements Iterable<T> {
+    protected _array: T[];
+    protected readonly _compare: OrderedComparator<T>;
+    protected readonly _clone: CloneFunction<T>;
+    /**
+     * Constructor
+     * @param compare The function used to compare values in the queue. If `compare(x, y)` returns a negative value, then x is placed before y in the queue.
+     * @param clone The function used to clone a value for insertion onto the queue. The default implementation simply returns its input.
+     * @note If the criterion which control the result of the `compare` function changes, then [[PriorityQueue.sort]] should be used to reorder the queue according to the new criterion.
+     */
+    constructor(compare: OrderedComparator<T>, clone?: CloneFunction<T>);
+    /** The number of values in the queue. */
+    get length(): number;
+    /** Returns true if the queue contains no values. */
+    get isEmpty(): boolean;
+    /** Returns an iterator over the contents of the heap suitable for use in `for-of` loops. */
+    [Symbol.iterator](): Iterator<T>;
+    protected _swap(a: number, b: number): void;
+    protected _heapify(index: number): void;
+    /**
+     * Reorders the queue. This function should only (and *always*) be called when the criteria governing the ordering of items on the queue have changed.
+     * For example, a priority queue containing graphics sorted by their distance from the camera would need to be reordered when the position of the camera changes.
+     */
+    sort(): void;
+    /**
+     * Pushes a value onto the queue according to the sorting criterion.
+     * @param value The value to insert
+     * @returns The inserted value, cloned according to the [[CloneFunction]] supplied to this queue's constructor.
+     */
+    push(value: T): T;
+    /** Pushes a value onto the back of the queue without making any attempt to enforce ordering.
+     * After using this function, you must manually invoke sort() to ensure the queue is sorted again.
+     * @param value The value to append
+     * @returns The appended value, cloned according to the [[CloneFunction]] supplied to this queue's constructor.
+     */
+    append(value: T): T;
+    /** Returns the element at the front of the queue, or `undefined` if the queue is empty. */
+    get front(): T | undefined;
+    /**
+     * Removes the front-most element off of the queue and returns it.
+     * @returns The front-most element, or undefined if the queue is empty.
+     */
+    pop(): T | undefined;
+    /** Removes all values from the queue. */
+    clear(): void;
+    /**
+     * Removes the value at the specified index from the queue and reorders the queue.
+     * @param index The index of the value to remove
+     * @returns the value at the specified index, or undefined if the index is out of range.
+     */
+    protected _pop(index: number): T | undefined;
+    /**
+     * Returns the value at the specified index in the queue.
+     * @param index The index of the value to retrieve
+     * @returns the value at the specified index, or undefined if the index is out of range.
+     */
+    protected _peek(index: number): T | undefined;
+}
 //# sourceMappingURL=PriorityQueue.d.ts.map