A Map implemented with a hash table.

var map = new HashMap[nullable String, Int]
map[null] = 0
map["one"] = 1
map["two"] = 2

assert map[null] == 0
assert map["one"] == 1
assert map.keys.has("two")
assert map.values.length == 3

Introduced properties

init from(coll: Map[K, V])

core :: HashMap :: from

Build a list filled with the items of coll.
protected fun keys=(keys: RemovableCollection[K])

core :: HashMap :: keys=

protected fun values=(values: RemovableCollection[V])

core :: HashMap :: values=

Redefined properties

redef type SELF: HashMap[K, V]

core $ HashMap :: SELF

Type of this instance, automatically specialized in every class
redef fun [](key: nullable Object): V

core $ HashMap :: []

Get the item at key
redef fun []=(key: K, v: V)

core $ HashMap :: []=

Set the value at key.
redef fun clear

core $ HashMap :: clear

Remove all items
redef fun get_or_null(key: nullable Object): nullable V

core $ HashMap :: get_or_null

Get the item at key or null if key is not in the map.
redef fun has_key(k: nullable Object): Bool

core $ HashMap :: has_key

Is there an item associated with key?
redef init init

core $ HashMap :: init

redef fun is_empty: Bool

core $ HashMap :: is_empty

Is there no item in the collection?
redef fun iterator: MapIterator[K, V]

core $ HashMap :: iterator

Get a new iterator on the map.
redef fun keys: RemovableCollection[K]

core $ HashMap :: keys

Return the point of view of self on the keys only.
redef fun length: Int

core $ HashMap :: length

Number of items in the collection.
redef fun values: RemovableCollection[V]

core $ HashMap :: values

Return the point of view of self on the values only.

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
abstract fun [](key: nullable Object): V

core :: MapRead :: []

Get the item at key
abstract fun []=(key: K, value: V)

core :: Map :: []=

Set the value at key.
protected fun accept_json_serializer(v: JsonSerializer)

serialization :: Serializable :: accept_json_serializer

Refinable service to customize the serialization of this class to JSON
protected fun accept_msgpack_attribute_counter(v: AttributeCounter)

serialization :: Serializable :: accept_msgpack_attribute_counter

Hook to customize the behavior of the AttributeCounter
protected fun accept_msgpack_serializer(v: MsgPackSerializer)

serialization :: Serializable :: accept_msgpack_serializer

Hook to customize the serialization of this class to MessagePack
fun add_all(map: MapRead[K, V])

core :: Map :: add_all

Add each (key,value) of map into self.
protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
abstract fun clear

core :: Map :: clear

Remove all items
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
fun filter_keys(keys: Collection[nullable Object]): Array[K]

core :: MapRead :: filter_keys

Return all elements of keys that have a value.
init from(coll: Map[K, V])

core :: HashMap :: from

Build a list filled with the items of coll.
init from_deserializer(deserializer: Deserializer)

serialization :: Serializable :: from_deserializer

Create an instance of this class from the deserializer
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun get_or_default(key: nullable Object, default: V): V

core :: MapRead :: get_or_default

Get the item at key or return default if not in map
fun get_or_null(key: nullable Object): nullable V

core :: MapRead :: get_or_null

Get the item at key or null if key is not in the map.
fun has_key(key: nullable Object): Bool

core :: MapRead :: has_key

Is there an item associated with key?
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
abstract fun is_empty: Bool

core :: MapRead :: is_empty

Is there no item in the collection?
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
abstract fun iterator: MapIterator[K, V]

core :: MapRead :: iterator

Get a new iterator on the map.
abstract fun join(sep: String, couple_sep: String): String

core :: Map :: join

Concatenate couples of key value.
abstract fun keys: Collection[K]

core :: MapRead :: keys

Return the point of view of self on the keys only.
protected fun keys=(keys: RemovableCollection[K])

core :: HashMap :: keys=

fun keys_sorted_by_values(comparator: Comparator): Array[K]

core :: MapRead :: keys_sorted_by_values

Return an array of all keys sorted with their values using comparator.
abstract fun length: Int

core :: MapRead :: length

Number of items in the collection.
fun lookup_all_values(pe: POSetElement[K]): Set[V]

core :: MapRead :: lookup_all_values

Search all the values in pe.greaters.
fun lookup_values(pe: POSetElement[K]): Set[V]

core :: MapRead :: lookup_values

Combine the values in pe.greaters from the most smaller elements that have a value.
protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
init new: Map[K, V]

core :: Map :: new

Get a HashMap[K, V] as default implementation
fun not_empty: Bool

core :: MapRead :: not_empty

Alias for not is_empty.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
protected fun provide_default_value(key: nullable Object): V

core :: MapRead :: provide_default_value

Called by the underling implementation of [] to provide a default value when a key has no value
fun recover_with(map: MapRead[K, V])

core :: Map :: recover_with

Alias for add_all
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun serialize_msgpack(plain: nullable Bool): Bytes

serialization :: Serializable :: serialize_msgpack

Serialize self to MessagePack bytes
fun serialize_to(serializer: Serializer)

serialization :: Serializable :: serialize_to

Serialize self to serializer
fun serialize_to_json(plain: nullable Bool, pretty: nullable Bool): String

serialization :: Serializable :: serialize_to_json

Serialize self to JSON
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun to_json: String

serialization :: Serializable :: to_json

Serialize self to plain JSON
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_map_comparator(comparator: Comparator): MapComparator[K, V]

core :: MapRead :: to_map_comparator

A comparator that compares things with their values in self.
fun to_pretty_json: String

serialization :: Serializable :: to_pretty_json

Serialize self to plain pretty JSON
fun to_s: String

core :: Object :: to_s

User readable representation of self.
abstract fun values: Collection[V]

core :: MapRead :: values

Return the point of view of self on the values only.
protected fun values=(values: RemovableCollection[V])

core :: HashMap :: values=

fun values_sorted_by_key(comparator: Comparator): Array[V]

core :: MapRead :: values_sorted_by_key

Return an array of all values sorted with their keys using comparator.
package_diagram core::HashMap HashMap core::Map Map core::HashMap->core::Map serialization::Serializable Serializable core::Map->serialization::Serializable core::MapRead MapRead core::Map->core::MapRead ...serialization::Serializable ... ...serialization::Serializable->serialization::Serializable ...core::MapRead ... ...core::MapRead->core::MapRead core::HashMap... ... core::HashMap...->core::HashMap

Ancestors

interface MapRead[K: nullable Object, V: nullable Object]

core :: MapRead

MapRead are abstract associative collections: key -> item.
interface Object

core :: Object

The root of the class hierarchy.
interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize

Parents

interface Map[K: nullable Object, V: nullable Object]

core :: Map

Maps are associative collections: key -> item.

Children

class AttributeMap

dot :: AttributeMap

Map of graph/node/edge attribute that can be rendered to dot.
class DefaultMap[K: nullable Object, V: nullable Object]

more_collections :: DefaultMap

A map with a default value.
class IniFile

ini :: IniFile

Read and write INI configuration files
class IniSection

ini :: IniSection

A section in a IniFile
class JsonObject

json :: JsonObject

A JSON Object.
class MultiHashMap[K: nullable Object, V: nullable Object]

more_collections :: MultiHashMap

Simple way to store an HashMap[K, Array[V]]
class PRMap[V: nullable Object]

graph :: PRMap

Map each Vertice of a Digraph to it's PageRank.
class PerfMap

performance_analysis :: PerfMap

Collection of statistics on many events
abstract class ShaderVariableMap[A: ShaderVariable]

gamnit :: ShaderVariableMap

Map to organize ShaderVariable instances by their name
class StrictHashMap[K: nullable Object, V: nullable Object]

serialization :: StrictHashMap

Maps instances to a value, uses is_same_serialized and serialization_hash.
class Vector

vsm :: Vector

A n-dimensions vector

Descendants

class AttributeMap

gamnit :: AttributeMap

Map to organize Attribute instances by their name
class MongoGroup

mongodb :: MongoGroup

Mongo pipeline group stage
class MongoMatch

mongodb :: MongoMatch

A basic match query
class UniformMap

gamnit :: UniformMap

Map to organize Uniform instances by their name

Class definitions

core $ HashMap
# A `Map` implemented with a hash table.
#
# ~~~
# var map = new HashMap[nullable String, Int]
# map[null] = 0
# map["one"] = 1
# map["two"] = 2
#
# assert map[null] == 0
# assert map["one"] == 1
# assert map.keys.has("two")
# assert map.values.length == 3
# ~~~
class HashMap[K, V]
	super Map[K, V]
	super HashCollection[K]

	redef type N: HashMapNode[K, V] is fixed

	redef fun [](key)
	do
		var c = node_at(key)
		if c == null then
			return provide_default_value(key)
		else
			return c._value
		end
	end

	redef fun get_or_null(key)
	do
		var c = node_at(key)
		if c == null then
			return null
		else
			return c._value
		end
	end

	redef fun iterator do return new HashMapIterator[K,V](self)

	redef fun length do return _the_length

	redef fun is_empty do return _the_length == 0

	redef fun []=(key, v)
	do
		if _capacity == 0 then enlarge(17) # 17 because magic in `store`
		var i = index_at(key)
		var c = node_at_idx(i, key)
		if c != null then
			c._key = key
			c._value = v
		else
			store(i, new HashMapNode[K, V](key, v))
		end
	end

	redef fun clear do raz

	init
	do
		_capacity = 0
		_the_length = 0
	end

	# Build a list filled with the items of `coll`.
	init from(coll: Map[K, V]) do
		init
		add_all(coll)
	end

	redef var keys: RemovableCollection[K] = new HashMapKeys[K, V](self) is lazy
	redef var values: RemovableCollection[V] = new HashMapValues[K, V](self) is lazy
	redef fun has_key(k) do return node_at(k) != null
end
lib/core/collection/hash_collection.nit:207,1--282,3