22f6475147ad776a6ea3cac4de75ab0c0d54efc80210eb0347271fe7f2ef6b5c60cdc84ccf6810f0c86f3a59c4fcfcbebf4a59d416fa04c601e96f8f0e3adf 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. import TreeContainer from './Base';
  2. import TreeIterator from './Base/TreeIterator';
  3. import { TreeNode } from './Base/TreeNode';
  4. import { initContainer, IteratorType } from "../ContainerBase";
  5. declare class OrderedMapIterator<K, V> extends TreeIterator<K, V> {
  6. container: OrderedMap<K, V>;
  7. constructor(node: TreeNode<K, V>, header: TreeNode<K, V>, container: OrderedMap<K, V>, iteratorType?: IteratorType);
  8. get pointer(): [K, V];
  9. copy(): OrderedMapIterator<K, V>;
  10. equals(iter: OrderedMapIterator<K, V>): boolean;
  11. }
  12. export type { OrderedMapIterator };
  13. declare class OrderedMap<K, V> extends TreeContainer<K, V> {
  14. /**
  15. * @param container - The initialization container.
  16. * @param cmp - The compare function.
  17. * @param enableIndex - Whether to enable iterator indexing function.
  18. * @example
  19. * new OrderedMap();
  20. * new OrderedMap([[0, 1], [2, 1]]);
  21. * new OrderedMap([[0, 1], [2, 1]], (x, y) => x - y);
  22. * new OrderedMap([[0, 1], [2, 1]], (x, y) => x - y, true);
  23. */
  24. constructor(container?: initContainer<[K, V]>, cmp?: (x: K, y: K) => number, enableIndex?: boolean);
  25. begin(): OrderedMapIterator<K, V>;
  26. end(): OrderedMapIterator<K, V>;
  27. rBegin(): OrderedMapIterator<K, V>;
  28. rEnd(): OrderedMapIterator<K, V>;
  29. front(): [K, V] | undefined;
  30. back(): [K, V] | undefined;
  31. lowerBound(key: K): OrderedMapIterator<K, V>;
  32. upperBound(key: K): OrderedMapIterator<K, V>;
  33. reverseLowerBound(key: K): OrderedMapIterator<K, V>;
  34. reverseUpperBound(key: K): OrderedMapIterator<K, V>;
  35. /**
  36. * @description Insert a key-value pair or set value by the given key.
  37. * @param key - The key want to insert.
  38. * @param value - The value want to set.
  39. * @param hint - You can give an iterator hint to improve insertion efficiency.
  40. * @return The size of container after setting.
  41. * @example
  42. * const mp = new OrderedMap([[2, 0], [4, 0], [5, 0]]);
  43. * const iter = mp.begin();
  44. * mp.setElement(1, 0);
  45. * mp.setElement(3, 0, iter); // give a hint will be faster.
  46. */
  47. setElement(key: K, value: V, hint?: OrderedMapIterator<K, V>): number;
  48. find(key: K): OrderedMapIterator<K, V>;
  49. /**
  50. * @description Get the value of the element of the specified key.
  51. * @param key - The specified key you want to get.
  52. * @example
  53. * const val = container.getElementByKey(1);
  54. */
  55. getElementByKey(key: K): V | undefined;
  56. union(other: OrderedMap<K, V>): number;
  57. [Symbol.iterator](): Generator<[K, V], void, unknown>;
  58. eraseElementByIterator(iter: OrderedMapIterator<K, V>): OrderedMapIterator<K, V>;
  59. forEach(callback: (element: [K, V], index: number, map: OrderedMap<K, V>) => void): void;
  60. getElementByPos(pos: number): [K, V];
  61. }
  62. export default OrderedMap;