IntHash.hx 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. /*
  2. * Copyright (c) 2005, The haXe Project Contributors
  3. * All rights reserved.
  4. * Redistribution and use in source and binary forms, with or without
  5. * modification, are permitted provided that the following conditions are met:
  6. *
  7. * - Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * - Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. *
  13. * THIS SOFTWARE IS PROVIDED BY THE HAXE PROJECT CONTRIBUTORS "AS IS" AND ANY
  14. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16. * DISCLAIMED. IN NO EVENT SHALL THE HAXE PROJECT CONTRIBUTORS BE LIABLE FOR
  17. * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  19. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  20. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  23. * DAMAGE.
  24. */
  25. /**
  26. Hashtable over a set of elements, using [Int] as keys.
  27. On Flash and Javascript, the underlying structure is an Object.
  28. **/
  29. extern class IntHash<T> {
  30. /**
  31. Creates a new empty hashtable.
  32. **/
  33. public function new() : Void;
  34. /**
  35. Set a value for the given key.
  36. **/
  37. public function set( key : Int, value : T ) : Void;
  38. /**
  39. Get a value for the given key.
  40. **/
  41. public function get( key : Int ) : Null<T>;
  42. /**
  43. Tells if a value exists for the given key.
  44. In particular, it's useful to tells if a key has
  45. a [null] value versus no value.
  46. **/
  47. public function exists( key : Int ) : Bool;
  48. /**
  49. Removes a hashtable entry. Returns [true] if
  50. there was such entry.
  51. **/
  52. public function remove( key : Int ) : Bool;
  53. /**
  54. Returns an iterator of all keys in the hashtable.
  55. **/
  56. public function keys() : Iterator<Int>;
  57. /**
  58. Returns an iterator of all values in the hashtable.
  59. **/
  60. public function iterator() : Iterator<T>;
  61. /**
  62. Returns an displayable representation of the hashtable content.
  63. **/
  64. public function toString() : String;
  65. }