OrderedMap.d.ts 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. import TreeContainer from './Base';
  2. import TreeIterator from './Base/TreeIterator';
  3. import { initContainer } from "../ContainerBase";
  4. export declare class OrderedMapIterator<K, V> extends TreeIterator<K, V> {
  5. get pointer(): [K, V];
  6. copy(): OrderedMapIterator<K, V>;
  7. }
  8. declare class OrderedMap<K, V> extends TreeContainer<K, V> {
  9. /**
  10. * @param container The initialization container.
  11. * @param cmp The compare function.
  12. * @param enableIndex Whether to enable iterator indexing function.
  13. */
  14. constructor(container?: initContainer<[K, V]>, cmp?: (x: K, y: K) => number, enableIndex?: boolean);
  15. begin(): OrderedMapIterator<K, V>;
  16. end(): OrderedMapIterator<K, V>;
  17. rBegin(): OrderedMapIterator<K, V>;
  18. rEnd(): OrderedMapIterator<K, V>;
  19. front(): [K, V] | undefined;
  20. back(): [K, V] | undefined;
  21. forEach(callback: (element: [K, V], index: number) => void): void;
  22. lowerBound(_key: K): OrderedMapIterator<K, V>;
  23. upperBound(_key: K): OrderedMapIterator<K, V>;
  24. reverseLowerBound(_key: K): OrderedMapIterator<K, V>;
  25. reverseUpperBound(_key: K): OrderedMapIterator<K, V>;
  26. /**
  27. * @description Insert a _key-_value pair or set _value by the given _key.
  28. * @param _key The _key want to insert.
  29. * @param _value The _value want to set.
  30. * @param hint You can give an iterator hint to improve insertion efficiency.
  31. */
  32. setElement(_key: K, _value: V, hint?: OrderedMapIterator<K, V>): void;
  33. find(_key: K): OrderedMapIterator<K, V>;
  34. /**
  35. * @description Get the _value of the element of the specified _key.
  36. */
  37. getElementByKey(_key: K): V | undefined;
  38. getElementByPos(pos: number): [K, V];
  39. union(other: OrderedMap<K, V>): void;
  40. [Symbol.iterator](): Generator<[K, V], void, undefined>;
  41. }
  42. export default OrderedMap;