A Deque ("double-ended queue") is a collection of objects of type T that behaves much like an Array.
Deque has a subset of Array's API. It performs better than an Array
when there are frequent insertions or deletions of items near the beginning or the end.
The most typical use case of a Deque is a queue: use #push
to add items to the end of the queue and #shift
to get and remove the item at the beginning of the queue.
This Deque is implemented with a dynamic array used as a circular buffer.
Creates a new Deque
of the given size filled with the same value in each position.
Creates a new Deque
that copies its items from an Array.
Creates a new empty Deque
backed by a buffer that is initially initial_capacity
big.
Creates a new empty Deque
Creates a new Deque
of the given size and invokes the block once for each index of the deque, assigning the block's value in that index.
Concatenation.
Alias for #push
.
Returns true
if it is passed a Deque
and equals?
returns true
for both deques, the caller and the argument.
Sets the given value at the given index.
Removes all elements from self
.
Returns a new Deque
that has this deque's elements cloned.
Appends the elements of other to self
, and returns self
.
Removes all items from self
that are equal to obj.
Deletes the item that is present at the index.
Returns a new Deque
that has exactly this deque's elements.
Yields each item in this deque, from first to last.
Insert a new item before the item at index.
Appends a String representation of this object which includes its class name, its object address and the values of all instance variables.
Removes and returns the last item, if not empty, otherwise executes the given block and returns its value.
Removes and returns the last item.
Removes the last n (at most) items in the deque.
Removes and returns the last item, if not empty, otherwise nil
.
Adds an item to the end of the deque.
Rotates this deque in place so that the element at n becomes first.
Removes the first n (at most) items in the deque.
Removes and returns the first item.
Removes and returns the first item, if not empty, otherwise executes the given block and returns its value.
Removes and returns the first item, if not empty, otherwise nil
.
Returns the number of elements in the deque.
Swaps the items at the indices i and j.
Appends a short String representation of this object which includes its class name and its object address.
Returns the element at the given index, without doing any bounds check.
Adds an item to the beginning of the deque.
Indexable(T)
Enumerable(T)
Iterable(T)
Reference
Reference
Object
Object
Creates a new Deque
of the given size filled with the same value in each position.
Deque.new(3, 'a') # => Deque{'a', 'a', 'a'}
Creates a new Deque
that copies its items from an Array.
Deque.new([1, 2, 3]) # => Deque{1, 2, 3}
Creates a new empty Deque
backed by a buffer that is initially initial_capacity
big.
The initial_capacity
is useful to avoid unnecessary reallocations of the internal buffer in case of growth. If you have an estimate of the maximum number of elements a deque will hold, you should initialize it with that capacity for improved execution performance.
deq = Deque(Int32).new(5) deq.size # => 0
Creates a new empty Deque
Creates a new Deque
of the given size and invokes the block once for each index of the deque, assigning the block's value in that index.
Deque.new(3) { |i| (i + 1) ** 2 } # => Deque{1, 4, 9}
Concatenation. Returns a new Deque
built by concatenating two deques together to create a third. The type of the new deque is the union of the types of both the other deques.
Returns true
if it is passed a Deque
and equals?
returns true
for both deques, the caller and the argument.
deq = Deque{2, 3} deq.unshift 1 deq == Deque{1, 2, 3} # => true deq == Deque{2, 3} # => false
Sets the given value at the given index.
Raises IndexError
if the deque had no previous value at the given index.
Removes all elements from self
.
Appends the elements of other to self
, and returns self
.
Removes all items from self
that are equal to obj.
a = Deque{"a", "b", "b", "b", "c"} a.delete("b") # => true a # => Deque{"a", "c"}
Deletes the item that is present at the index. Items to the right of this one will have their indices decremented. Raises IndexError
if trying to delete an element outside the deque's range.
a = Deque{1, 2, 3} a.delete_at(1) # => 2 a # => Deque{1, 3}
Returns a new Deque
that has exactly this deque's elements. That is, it returns a shallow copy of this deque.
Yields each item in this deque, from first to last.
Do not modify the deque while using this variant of #each
!
Insert a new item before the item at index. Items to the right of this one will have their indices incremented.
a = Deque{0, 1, 2} a.insert(1, 7) # => Deque{0, 7, 1, 2}
Appends a String representation of this object which includes its class name, its object address and the values of all instance variables.
class Person def initialize(@name : String, @age : Int32) end end Person.new("John", 32).inspect # => #<Person:0x10fd31f20 @name="John", @age=32>
Removes and returns the last item, if not empty, otherwise executes the given block and returns its value.
Removes and returns the last item. Raises IndexError
if empty.
a = Deque{1, 2, 3} a.pop # => 3 a # => Deque{1, 2}
Removes and returns the last item, if not empty, otherwise nil
.
Adds an item to the end of the deque.
a = Deque{1, 2} a.push 3 # => Deque{1, 2, 3}
Rotates this deque in place so that the element at n becomes first.
n.times { push(shift) }
.(-n).times { unshift(pop) }
.Removes and returns the first item. Raises IndexError
if empty.
a = Deque{1, 2, 3} a.shift # => 1 a # => Deque{2, 3}
Removes and returns the first item, if not empty, otherwise executes the given block and returns its value.
Removes and returns the first item, if not empty, otherwise nil
.
Returns the number of elements in the deque.
Deque{:foo, :bar}.size # => 2
Swaps the items at the indices i and j.
Appends a short String representation of this object which includes its class name and its object address.
class Person def initialize(@name : String, @age : Int32) end end Person.new("John", 32).to_s # => #<Person:0x10a199f20>
Returns the element at the given index, without doing any bounds check.
Indexable
makes sure to invoke this method with index in 0...size
, so converting negative indices to positive ones is not needed here.
Clients never invoke this method directly. Instead, they access elements with #[](index)
and #[]?(index)
.
This method should only be directly invoked if you are absolutely sure the index is in bounds, to avoid a bounds check for a small boost of performance.
Adds an item to the beginning of the deque.
a = Deque{1, 2} a.unshift 0 # => Deque{0, 1, 2}
© 2012–2020 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/0.35.1/Deque.html