Double linked lists.

Introduced properties

init from(coll: Collection[E])

core :: List :: from

Build a list filled with the items of coll.
protected fun length=(length: Int)

core :: List :: length=

O(1)
fun slice(from: Int, to: Int): List[E]

core :: List :: slice

Return a list of elements between 'from' and 'to'.

Redefined properties

redef type CONCURRENT: ConcurrentList[E]

pthreads :: concurrent_collections $ List :: CONCURRENT

Type of the concurrent variant of this collection
redef type SELF: List[E]

core $ List :: SELF

Type of this instance, automatically specialized in every class
redef fun [](index: Int): E

core $ List :: []

Return the index-th element of the sequence.
redef fun []=(index: Int, item: E)

core $ List :: []=

Set the item at index.
redef fun clear

core $ List :: clear

Remove all items
redef fun count(e: nullable Object): Int

core $ List :: count

How many occurrences of item are in the collection?
redef fun first: E

core $ List :: first

O(1)
redef fun first=(e: E)

core $ List :: first=

O(1)
redef fun has(e: nullable Object): Bool

core $ List :: has

O(n)
redef fun has_only(e: nullable Object): Bool

core $ List :: has_only

Is the collection contain only item?
redef init init

core $ List :: init

Build an empty list.
redef fun insert(e: E, i: Int)

core $ List :: insert

O(n)
redef fun is_empty: Bool

core $ List :: is_empty

O(1)
redef fun iterator: ListIterator[E]

core $ List :: iterator

Get a new iterator on the collection.
redef fun last: E

core $ List :: last

O(1)
redef fun last=(e: E)

core $ List :: last=

O(1)
redef fun length: Int

core $ List :: length

O(1)
redef fun pop: E

core $ List :: pop

O(1)
redef fun push(e: E)

core $ List :: push

O(1)
redef fun remove(e: nullable Object)

core $ List :: remove

Remove an occurrence of item
redef fun remove_at(i: Int)

core $ List :: remove_at

Remove the item at index and shift all following elements
redef fun reverse_iterator: ListIterator[E]

core $ List :: reverse_iterator

Gets an iterator starting at the end and going backwards
redef fun shift: E

core $ List :: shift

O(1)
redef fun to_concurrent: CONCURRENT

pthreads :: concurrent_collections $ List :: to_concurrent

Wraps self in a thread-safe collection
redef fun unshift(e: E)

core $ List :: unshift

O(1)

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 CONCURRENT: ConcurrentCollection[E]

core :: Collection :: CONCURRENT

Type of the concurrent variant of this collection
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
abstract fun [](index: Int): E

core :: SequenceRead :: []

Return the index-th element of the sequence.
abstract fun []=(index: Int, item: E)

core :: Sequence :: []=

Set the item at index.
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
abstract fun add(item: E)

core :: SimpleCollection :: add

Add item to this collection.
fun add_all(coll: Collection[E])

core :: SimpleCollection :: add_all

Add each item of coll.
protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according
fun append(coll: Collection[E])

core :: Sequence :: append

Add each item of coll after the last.
fun as_fifo: Queue[E]

core :: Sequence :: as_fifo

Return a FIFO proxy queue where result.take is shift.
fun as_lifo: Queue[E]

core :: Sequence :: as_lifo

Return a LIFO proxy queue (stack) where result.take is pop.
fun as_random: Queue[E]

core :: SimpleCollection :: as_random

Return a random proxy queue where result.take is random.
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 :: RemovableCollection :: clear

Remove all items
fun combinations(r: Int): Collection[SequenceRead[E]]

core :: Collection :: combinations

All r-length combinations on self (in same order) without repeated elements.
fun combinations_with_replacement(r: Int): Collection[SequenceRead[E]]

core :: Collection :: combinations_with_replacement

All r-length combination on self (in same order) with repeated elements.
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
fun count(item: nullable Object): Int

core :: Collection :: count

How many occurrences of item are in the collection?
fun first: E

core :: Collection :: first

Return the first item of the collection
fun first=(item: E)

core :: Sequence :: first=

Set the first item.
init from(coll: Collection[E])

core :: List :: 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(index: Int, default: E): E

core :: SequenceRead :: get_or_default

Try to get an element, return default if the index is invalid.
fun get_or_null(index: Int): nullable E

core :: SequenceRead :: get_or_null

Try to get an element, return null if the index is invalid.
fun has(item: nullable Object): Bool

core :: Collection :: has

Is item in the collection ?
fun has_all(other: Collection[nullable Object]): Bool

core :: Collection :: has_all

Does the collection contain at least each element of other?
fun has_any(other: Collection[nullable Object]): Bool

core :: Collection :: has_any

Does the collection contain at least one element of other?
fun has_exactly(other: Collection[nullable Object]): Bool

core :: Collection :: has_exactly

Does the collection contain exactly all the elements of other?
fun has_only(item: nullable Object): Bool

core :: Collection :: has_only

Is the collection contain only item?
fun hash: Int

core :: Object :: hash

The hash code of the object.
fun index_of(item: nullable Object): Int

core :: SequenceRead :: index_of

The index of the first occurrence of item.
fun index_of_from(item: nullable Object, pos: Int): Int

core :: SequenceRead :: index_of_from

The index of the first occurrence of item, starting from pos.
init init

core :: Object :: init

abstract fun insert(item: E, index: Int)

core :: Sequence :: insert

Insert an element at a given position, following elements are shifted.
fun insert_all(coll: Collection[E], index: Int)

core :: Sequence :: insert_all

Insert all elements at a given position, following elements are shifted.
fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

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

core :: Collection :: 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: Iterator[E]

core :: Collection :: iterator

Get a new iterator on the collection.
fun iterator_from(pos: Int): IndexedIterator[E]

core :: SequenceRead :: iterator_from

Gets a new Iterator starting at position pos
fun join(separator: nullable Text, last_separator: nullable Text): String

core :: Collection :: join

Concatenate and separate each elements with separator.
fun last: E

core :: SequenceRead :: last

Get the last item.
fun last=(item: E)

core :: Sequence :: last=

Set the last item.
fun last_index_of(item: nullable Object): Int

core :: SequenceRead :: last_index_of

The index of the last occurrence of item.
fun last_index_of_from(item: nullable Object, pos: Int): Int

core :: SequenceRead :: last_index_of_from

The index of the last occurrence of item starting from pos and decrementing.
fun length: Int

core :: Collection :: length

Number of items in the collection.
protected fun length=(length: Int)

core :: List :: length=

O(1)
fun modulo(index: Int): E

core :: SequenceRead :: modulo

Return the index-th element but wrap
fun modulo=(index: Int, value: E)

core :: Sequence :: modulo=

Set the index-th element but wrap
fun modulo_index(index: Int): Int

core :: SequenceRead :: modulo_index

Returns the real index for a modulo index.
protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
fun not_empty: Bool

core :: Collection :: 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).
fun permutations(r: Int): Collection[SequenceRead[E]]

core :: Collection :: permutations

All r-length permutations on self (all possible ordering) without repeated elements.
fun plain_to_s: String

core :: Collection :: plain_to_s

Concatenate elements without separators
abstract fun pop: E

core :: Sequence :: pop

Remove the last item.
fun prepend(coll: Collection[E])

core :: Sequence :: prepend

Add all items of coll before the first one.
fun product(r: Int): Collection[SequenceRead[E]]

core :: Collection :: product

Cartesian product, over r times self.
abstract fun push(e: E)

core :: Sequence :: push

Add an item after the last one.
fun rand: E

core :: Collection :: rand

Return a random element form the collection
abstract fun remove(item: nullable Object)

core :: RemovableCollection :: remove

Remove an occurrence of item
fun remove_all(item: nullable Object)

core :: RemovableCollection :: remove_all

Remove all occurrences of item
abstract fun remove_at(index: Int)

core :: Sequence :: remove_at

Remove the item at index and shift all following elements
abstract fun reverse_iterator: IndexedIterator[E]

core :: SequenceRead :: reverse_iterator

Gets an iterator starting at the end and going backwards
fun reverse_iterator_from(pos: Int): IndexedIterator[E]

core :: SequenceRead :: reverse_iterator_from

Gets an iterator on the chars of self starting from pos
fun rotate_left

core :: Sequence :: rotate_left

Rotates the elements of self once to the left
fun rotate_right

core :: Sequence :: rotate_right

Rotates the elements of self once to the right
fun sample(length: Int): Array[E]

core :: Collection :: sample

Return a new array made of (at most) length elements randomly chosen.
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 shift: E

core :: Sequence :: shift

Remove the first item.
fun slice(from: Int, to: Int): List[E]

core :: List :: slice

Return a list of elements between 'from' and 'to'.
fun subarray(start: Int, len: Int): Array[E]

core :: Sequence :: subarray

Copy the content of self between start and len to a new Array.
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun to_a: Array[E]

core :: Collection :: to_a

Build a new array from a collection
abstract fun to_concurrent: CONCURRENT

core :: Collection :: to_concurrent

Wraps self in a thread-safe collection
fun to_counter: Counter[E]

core :: Collection :: to_counter

Create and fill up a counter with the elements of `self.
fun to_curlslist: CURLSList

core :: Collection :: to_curlslist

Convert Collection[String] to CURLSList
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_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.
fun to_shuffle: Array[E]

core :: Collection :: to_shuffle

Return a new array made of elements in a random order.
abstract fun unshift(e: E)

core :: Sequence :: unshift

Add an item before the first one.
package_diagram core::List List core::Sequence Sequence core::List->core::Sequence core::SequenceRead SequenceRead core::Sequence->core::SequenceRead core::SimpleCollection SimpleCollection core::Sequence->core::SimpleCollection ...core::SequenceRead ... ...core::SequenceRead->core::SequenceRead ...core::SimpleCollection ... ...core::SimpleCollection->core::SimpleCollection pthreads::ConcurrentList ConcurrentList pthreads::ConcurrentList->core::List scene2d::LiveGroup LiveGroup scene2d::LiveGroup->core::List pthreads::ReverseBlockingQueue ReverseBlockingQueue pthreads::ReverseBlockingQueue->pthreads::ConcurrentList pthreads::BlockingQueue BlockingQueue pthreads::BlockingQueue->pthreads::ConcurrentList pthreads::ReverseBlockingQueue... ... pthreads::ReverseBlockingQueue...->pthreads::ReverseBlockingQueue pthreads::BlockingQueue... ... pthreads::BlockingQueue...->pthreads::BlockingQueue

Ancestors

interface Collection[E: nullable Object]

core :: Collection

The root of the collection hierarchy.
interface Object

core :: Object

The root of the class hierarchy.
interface RemovableCollection[E: nullable Object]

core :: RemovableCollection

Items can be removed from this collection
interface SequenceRead[E: nullable Object]

core :: SequenceRead

Sequences are indexed collections.
interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize
interface SimpleCollection[E: nullable Object]

core :: SimpleCollection

Items can be added to these collections.

Parents

interface Sequence[E: nullable Object]

core :: Sequence

Sequence are indexed collection.

Children

class ConcurrentList[E: nullable Object]

pthreads :: ConcurrentList

A concurrent variant to the standard List
class LiveGroup[E: LiveObject]

scene2d :: LiveGroup

Organizational class to manage groups of sprites and other live objects.

Descendants

class BlockingQueue[E: nullable Object]

pthreads :: BlockingQueue

A Blocking queue implemented from a ConcurrentList
class Mailbox[E: nullable Object]

actors :: Mailbox

A Blocking queue implemented from a ConcurrentList
class ReverseBlockingQueue[E: nullable Object]

pthreads :: ReverseBlockingQueue

A collection which is_empty method blocks until it's empty

Class definitions

core $ List
# Double linked lists.
class List[E]
	super Sequence[E]

# Access

	redef fun [](index) do return get_node(index).as(not null).item

	redef fun []=(index, item) do get_node(index).as(not null).item = item

	# O(1)
	redef fun first do return _head.as(not null).item

	# O(1)
	redef fun first=(e) do _head.as(not null).item = e

	# O(1)
	redef fun last do return _tail.as(not null).item

	# O(1)
	redef fun last=(e) do _tail.as(not null).item = e

# Queries

	# O(1)
	redef fun is_empty do return _head == null

	# O(1)
	redef var length = 0

	# O(n)
	redef fun has(e) do return search_node_after(e, _head) != null

	redef fun has_only(e)
	do
		var node = _head
		while node != null do
			if node.item != e then return false
			node = node.next
		end
		return true
	end

	redef fun count(e)
	do
		var nb = 0
		var node = _head
		while node != null do
			if node.item != e then nb += 1
			node = node.next
		end
		return nb
	end

	# Return a list of elements between 'from' and 'to'.
	fun slice(from: Int, to: Int): List[E] do
		assert from >= 0 and from < length
		assert to >= 0 and to < length and from <= to
		var list = new List[E]
		while from <= to do
			list.add(self[from])
			from += 1
		end
		return list
	end

# Add elements

	# O(1)
	redef fun push(e)
	do
		var node = new ListNode[E](e)
		var tail = _tail
		if tail == null then
			_head = node
		else
			tail.next = node
			node.prev = tail
		end
		_tail = node
		length += 1
	end

	# O(1)
	redef fun unshift(e)
	do
		var node = new ListNode[E](e)
		var head = _head
		if head == null then
			_tail = node
		else
			node.next = head
			head.prev = node
		end
		_head = node
		length += 1
	end

	# O(n)
	redef fun insert(e, i)
	do
		var node = get_node(i)
		if node == null then
			push(e)
			return
		end
		insert_before(e, node)
	end

	# Append `l` to `self` but clear `l`.
	#
	# O(1)
	fun link(l: List[E])
	do
		var tail = _tail
		if tail == null then
			_head = l._head
		else if l._head != null then
			tail.next = l._head
			tail.next.as(not null).prev = tail
		end
		_tail = l._tail
		length += l.length
		l.clear
	end

# Remove elements

	# O(1)
	redef fun pop
	do
		var node = _tail.as(not null)
		_tail = node.prev
		node.prev = null
		if _tail == null then
			_head = null
		else
			_tail.as(not null).next = null
		end
		length -= 1
		return node.item
	end

	# O(1)
	redef fun shift
	do
		var node = _head.as(not null)
		_head = node.next
		node.next = null
		if _head == null then
			_tail = null
		else
			_head.as(not null).prev = null
		end
		length -= 1
		return node.item
	end

	redef fun remove(e)
	do
		var node = search_node_after(e, _head)
		if node != null then remove_node(node)
	end

	redef fun remove_at(i)
	do
		var node = get_node(i)
		if node != null then remove_node(node)
	end

	redef fun clear
	do
		_head = null
		_tail = null
		length = 0
	end


	redef fun iterator: ListIterator[E] do return new ListIterator[E](self)
	redef fun reverse_iterator: ListIterator[E] do return new ListReverseIterator[E](self)

	# Build an empty list.
	init do end

	# Build a list filled with the items of `coll`.
	init from(coll: Collection[E]) do append(coll)

	# The first node of the list
	private var head: nullable ListNode[E] = null

	# The last node of the list
	private var tail: nullable ListNode[E] = null

	# Get the `i`th node. get `null` otherwise.
	private fun get_node(i: Int): nullable ListNode[E]
	do
		var n = _head
		if i < 0 then
			return null
		end
		while n != null and i > 0 do
			n = n.next
			i -= 1
		end
		return n
	end

	# get the first node that contains `e` after 'after', null otherwise
	private fun search_node_after(e: E, after: nullable ListNode[E]): nullable ListNode[E]
	do
		var n = after
		while n != null and n.item != e do n = n.next
		return n
	end

	# Remove the node (ie. atach prev and next)
	private fun remove_node(node: ListNode[E])
	do
		length -= 1
		if node.prev == null then
			_head = node.next
			if node.next == null then
				_tail = null
			else
				node.next.as(not null).prev = null
			end
		else if node.next == null then
			_tail = node.prev
			node.prev.as(not null).next = null
		else
			node.prev.as(not null).next = node.next
			node.next.as(not null).prev = node.prev
		end
	end

	private fun insert_before(element: E, node: ListNode[E])
	do
		length += 1
		var nnode = new ListNode[E](element)
		var prev = node.prev
		if prev == null then
			_head = nnode
		else
			prev.next = nnode
		end
		nnode.prev = prev
		nnode.next = node
		node.prev = nnode
	end
end
lib/core/collection/list.nit:18,1--267,3

pthreads :: concurrent_collections $ List
redef class List[E]
	redef type CONCURRENT: ConcurrentList[E]

	redef fun to_concurrent do return new ConcurrentList[E].wrap(self)
end
lib/pthreads/concurrent_collections.nit:62,1--66,3