Abstract tree map structure

K: tree node key
E: tree node value

Introduced properties

protected type N: TreeNode[K, E]

trees :: TreeMap :: N

Type of nodes used in this tree implementation

init defaultinit

trees :: TreeMap :: defaultinit

protected fun root: nullable N

trees :: TreeMap :: root

The root node of the tree (null if tree is empty)

protected fun root=(root: nullable N)

trees :: TreeMap :: root=

The root node of the tree (null if tree is empty)

abstract fun show_dot

trees :: TreeMap :: show_dot

Display the tree in a gaphical windows

Redefined properties

redef type SELF: TreeMap[K, E]

trees $ TreeMap :: SELF

Type of this instance, automatically specialized in every class

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.

protected type N: TreeNode[K, E]

trees :: TreeMap :: N

Type of nodes used in this tree implementation

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

init defaultinit

serialization :: Serializable :: defaultinit

init defaultinit

core :: Map :: defaultinit

init defaultinit

trees :: TreeMap :: defaultinit

init defaultinit

core :: Object :: defaultinit

init defaultinit

core :: MapRead :: defaultinit

fun filter_keys(keys: Collection[nullable Object]): Array[K]

core :: MapRead :: filter_keys

Return all elements of keys that have a value.

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.

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

protected fun root: nullable N

trees :: TreeMap :: root

The root node of the tree (null if tree is empty)

protected fun root=(root: nullable N)

trees :: TreeMap :: root=

The root node of the tree (null if tree is empty)

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

abstract fun show_dot

trees :: TreeMap :: show_dot

Display the tree in a gaphical windows

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.

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.

Ancestors

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

core :: MapRead

MapRead are abstract associative collections: key -> item.

interface 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]

Maps are associative collections: key -> item.

Children

class BinTreeMap[K: Comparable, E: nullable Object]

trees :: BinTreeMap

Binary Tree Map

Descendants

class RBTreeMap[K: Comparable, E: nullable Object]

trees :: RBTreeMap

Red-Black Tree Map

Class definitions

trees $ TreeMap

# Abstract tree map structure
# * `K`: tree node key
# * `E`: tree node value
abstract class TreeMap[K: Comparable, E]
	super Map[K, E]

	# Type of nodes used in this tree implementation
	protected type N: TreeNode[K, E]

	# The `root` node of the tree (null if tree is empty)
	protected var root: nullable N = null is protected writable

	# Display the tree in a gaphical windows
	# Graphviz with a working -Txlib is expected
	# Used for debugging
	fun show_dot is abstract
end

lib/trees/abstract_tree.nit:21,1--37,3