2 Deques

8.6

2 Deques

Double ended queues (or deque) are queues where elements can be added or removed from either end. The deque data structures provided by this library implement and provide the following operations: deque, empty?, enqueue, enqueue-front, head, tail, last, init and deque->list.

2.1 Bankers Deque

2.2 Implicit Deque

2.3 Real-Time Deque

2.1 Bankers Deque

(require pfds/deque/bankers)

package: pfds

Bankers deques are amortized double ended deques developed using the Bankers method. They provide an amortized running time of O(1) for the operations head, tail, last, init, enqueue-front and enqueue. They use lazy evaluation and memoization to achieve the amortized running time.

syntax
(Deque A)

A banker’s deque of type A.

procedure
(deque a ...) → (Deque A)
a : A

Function deque creates a Bankers Deque with the given inputs.

Example:

> (deque 1 2 3 4 5 6)
- : #(struct:Deque
      ((Rec
        g352919
        (U (Boxof (U (-> (Boxof g352919)) (Boxof g352919)))
           (Pairof Positive-Byte g352919)
           Null))
       Integer
       (Rec
        g352922
        (U (Boxof (U (-> (Boxof g352922)) (Boxof g352922)))
           (Pairof Positive-Byte g352922)
           Null))
       Integer))
#<Deque>

In the above example, the deque obtained will have 1 as its head element.

procedure
(empty t) → (Deque A)
t : A

An empty deque of type t.

Examples:

> (empty Nothing)
- : (Deque Nothing)
#<Deque>
> (empty Integer)
- : (Deque Integer)
#<Deque>

procedure
(empty? dq) → Boolean
dq : (Deque A)

Function empty? checks if the given deque is empty.

Examples:

> (empty? (empty Natural))
- : Boolean
#t
> (empty? (deque 1 2))
- : Boolean
#f

procedure
(enqueue a deq) → (Deque A)
a : A
deq : (Deque A)

Function enqueue takes an element and a deque and enqueues the given element in the deque.

Example:

> (enqueue 10 (deque 3 2 4))
- : #(struct:Deque
      ((Rec
        g352993
        (U (Boxof (U (-> (Boxof g352993)) (Boxof g352993)))
           (Pairof Positive-Byte g352993)
           Null))
       Integer
       (Rec
        g352996
        (U (Boxof (U (-> (Boxof g352996)) (Boxof g352996)))
           (Pairof Positive-Byte g352996)
           Null))
       Integer))
#<Deque>

In the above example, (enqueue 10 deq) adds the element 10 to (deque 3 2 4). 10 will be the last element in the deque.

procedure
(enqueue-front a deq) → (Deque A)
a : A
deq : (Deque A)

Function enqueue-front takes an element and a deque and puts the given element to the front of the given deque.

Example:

> (enqueue-front 10 (deque 5 6 3 4))
- : #(struct:Deque
      ((Rec
        g353015
        (U (Boxof (U (-> (Boxof g353015)) (Boxof g353015)))
           (Pairof Positive-Byte g353015)
           Null))
       Integer
       (Rec
        g353018
        (U (Boxof (U (-> (Boxof g353018)) (Boxof g353018)))
           (Pairof Positive-Byte g353018)
           Null))
       Integer))
#<Deque>

In the above example, (enqueue-front 10 (deque 5 6 3 4)) adds 10 to the front of the (deque 5 6 3 4). 10 will be the head element.

procedure
(head deq) → A
deq : (Deque A)

Function head takes a deque and gives the first element in the deque if deque is not empty else throws an error.

Examples:

> (head (deque 5 2 3))
- : Integer [more precisely: Positive-Byte]
5
> (head (empty Integer))
head: given deque is empty

In the above example, (head (empty Integer)) throws an error since the given deque is empty.

procedure
(last deq) → A
deq : (Deque A)

Function last takes a deque and gives the last element in the deque if deque is not empty else throws an error.

Examples:

> (last (deque 1 2 3 4 5 6))
- : Integer [more precisely: Positive-Byte]
6
> (last (empty Integer))
last: given deque is empty

In the above example, (last (empty Integer))throws an error since the given deque is empty.

procedure
(tail deq) → (Deque A)
deq : (Deque A)

Function tail takes a deque and returns the given deque without the first element if the given deque is non empty else throws an error.

Examples:

> (tail (deque 1 2 3 4 5 6))
- : #(struct:Deque
      ((Rec
        g353106
        (U (Boxof (U (-> (Boxof g353106)) (Boxof g353106)))
           (Pairof Positive-Byte g353106)
           Null))
       Integer
       (Rec
        g353109
        (U (Boxof (U (-> (Boxof g353109)) (Boxof g353109)))
           (Pairof Positive-Byte g353109)
           Null))
       Integer))
#<Deque>
> (tail (empty Integer))
tail: given deque is empty

In the above example, (tail (deque 1 2 3 4 5 6)), removes the head of the given deque returns (deque 2 3 4 5 6).

procedure
(init deq) → (Deque A)
deq : (Deque A)

Function init takes a deque and returns the given deque without the last element if the given deque is not empty else throws an error.

Examples:

> (init (deque 1 2 3 4 5 6))
- : #(struct:Deque
      ((Rec
        g353151
        (U (Boxof (U (-> (Boxof g353151)) (Boxof g353151)))
           (Pairof Positive-Byte g353151)
           Null))
       Integer
       (Rec
        g353154
        (U (Boxof (U (-> (Boxof g353154)) (Boxof g353154)))
           (Pairof Positive-Byte g353154)
           Null))
       Integer))
#<Deque>
> (init (empty Integer))
init: given deque is empty

In the above example, (init (deque 1 2 3 4 5 6)), removes the last element 6 and returns (deque 1 2 3 4 5).

procedure
(deque->list deq) → (Listof A)
deq : (Deque A)

Function deque->list takes a deque and returns a list of elements. The list will have head of the given deque as its first element. If the given deque is empty, then it returns an empty list.

Examples:

> (deque->list (deque 10 2 34 4 15 6))
- : (Listof Positive-Byte)
'(10 2 34 4 15 6)
> (deque->list (empty Integer))
- : (Listof Integer)
'()

procedure
(map func deq1 deq2 ...) → (Deque A)
  func : (A B ... B -> C)
  deq1 : (Deque A)
  deq2 : (Deque B)

Function map is similar to map for lists.

Examples:

> (deque->list (map add1 (deque 1 2 3 4 5 6)))
- : (Listof Positive-Index)
'(2 3 4 5 6 7)
> (deque->list (map * (deque 1 2 3 4 5 6) (deque 1 2 3 4 5 6)))
- : (Listof Positive-Index)
'(1 4 9 16 25 36)

procedure
(foldl func init deq1 deq2 ...) → C
  func : (C A B ... B -> C)
  init : C
  deq1 : (Deque A)
  deq2 : (Deque B)

Function foldl is similar to foldl

foldl currently does not produce correct results when the given function is non-commutative.

Examples:

> (foldl + 0 (deque 1 2 3 4 5 6))
- : Integer [more precisely: Nonnegative-Integer]
21
> (foldl * 1 (deque 1 2 3 4 5 6) (deque 1 2 3 4 5 6))
- : Integer [more precisely: Positive-Integer]
518400

procedure
(foldr func init deq1 deq2 ...) → C
  func : (C A B ... B -> C)
  init : C
  deq1 : (Deque A)
  deq2 : (Deque B)

Function foldr is similar to foldr

foldr currently does not produce correct results when the given function is non-commutative.

Examples:

> (foldr + 0 (deque 1 2 3 4 5 6))
- : Integer [more precisely: Nonnegative-Integer]
21
> (foldr * 1 (deque 1 2 3 4 5 6) (deque 1 2 3 4 5 6))
- : Integer [more precisely: Positive-Integer]
518400

procedure
(filter func que) → (Deque A)
func : (A -> Boolean)
que : (Deque A)

Function filter is similar to filter.

Examples:

> (define que (deque 1 2 3 4 5 6))
> (deque->list (filter (λ: ([x : Integer]) (> x 5)) que))
- : (Listof Positive-Byte)
'(6)
> (deque->list (filter (λ: ([x : Integer]) (< x 5)) que))
- : (Listof Positive-Byte)
'(1 2 3 4)
> (deque->list (filter (λ: ([x : Integer]) (<= x 5)) que))
- : (Listof Positive-Byte)
'(1 2 3 4 5)

procedure
(remove func que) → (Deque A)
func : (A -> Boolean)
que : (Deque A)

Function remove is similar to filter but remove removes the elements which match the predicate.

Examples:

> (deque->list (remove (λ: ([x : Integer]) (> x 5))
                       (deque 1 2 3 4 5 6)))
- : (Listof Positive-Byte)
'(1 2 3 4 5)
> (deque->list (remove (λ: ([x : Integer]) (< x 5))
                       (deque 1 2 3 4 5 6)))
- : (Listof Positive-Byte)
'(5 6)
> (deque->list (remove (λ: ([x : Integer]) (<= x 5))
                       (deque 1 2 3 4 5 6)))
- : (Listof Positive-Byte)
'(6)

procedure
(andmap func deq1 deq2 ...) → Boolean
  func : (A B ... B -> Boolean)
  deq1 : (Deque A)
  deq2 : (Deque B)

Function andmap is similar to andmap.

Examples:

> (andmap even? (deque 1 2 3 4 5 6))
- : Boolean
#f
> (andmap odd? (deque 1 2 3 4 5 6))
- : Boolean
#f
> (andmap positive? (deque 1 2 3 4 5 6))
- : Boolean
#t
> (andmap negative? (deque -1 -2))
- : Boolean
#t

procedure
(ormap func deq1 deq2 ...) → Boolean
  func : (A B ... B -> Boolean)
  deq1 : (Deque A)
  deq2 : (Deque B)

Function ormap is similar to ormap.

Examples:

> (ormap even? (deque 1 2 3 4 5 6))
- : Boolean
#t
> (ormap odd? (deque 1 2 3 4 5 6))
- : Boolean
#t
> (ormap positive? (deque -1 -2 3 4 -5 6))
- : Boolean
#t
> (ormap negative? (deque 1 -2))
- : Boolean
#t

procedure
(build-deque size func) → (Deque A)
size : Natural
func : (Natural -> A)

Function build-deque is similar to build-list.

Examples:

> (deque->list (build-deque 5 (λ:([x : Integer]) (add1 x))))
- : (Listof Integer)
'(1 2 3 4 5)
> (deque->list (build-deque 5 (λ:([x : Integer]) (* x x))))
- : (Listof Integer)
'(0 1 4 9 16)

procedure
(head+tail deq) → (Pair A (Deque A))
deq : (Deque A)

Function head+tail returns a pair containing the head and the tail of the given deque.

Examples:

> (head+tail (deque 1 2 3 4 5))
- : (Pairof
     Positive-Byte
     #(struct:Deque
       ((Rec
         g353792
         (U (Boxof (U (-> (Boxof g353792)) (Boxof g353792)))
            (Pairof Positive-Byte g353792)
            Null))
        Integer
        (Rec
         g353795
         (U (Boxof (U (-> (Boxof g353795)) (Boxof g353795)))
            (Pairof Positive-Byte g353795)
            Null))
        Integer)))
'(1 . #<Deque>)
> (head+tail (build-deque 5 (λ:([x : Integer]) (* x x))))
- : (Pairof
     Integer
     #(struct:Deque
       ((Rec
         g353819
         (U (Boxof (U (-> (Boxof g353819)) (Boxof g353819)))
            (Pairof Integer g353819)
            Null))
        Integer
        (Rec
         g353822
         (U (Boxof (U (-> (Boxof g353822)) (Boxof g353822)))
            (Pairof Integer g353822)
            Null))
        Integer)))
'(0 . #<Deque>)
> (head+tail (empty Integer))
head+tail: given deque is empty

procedure
(last+init deq) → (Pair A (Deque A))
deq : (Deque A)

Function last+init returns a pair containing the last element and the init of the given deque.

Examples:

> (last+init (deque 1 2 3 4 5))
- : (Pairof
     Positive-Byte
     #(struct:Deque
       ((Rec
         g353864
         (U (Boxof (U (-> (Boxof g353864)) (Boxof g353864)))
            (Pairof Positive-Byte g353864)
            Null))
        Integer
        (Rec
         g353867
         (U (Boxof (U (-> (Boxof g353867)) (Boxof g353867)))
            (Pairof Positive-Byte g353867)
            Null))
        Integer)))
'(5 . #<Deque>)
> (last+init (build-deque 5 (λ:([x : Integer]) (* x x))))
- : (Pairof
     Integer
     #(struct:Deque
       ((Rec
         g353891
         (U (Boxof (U (-> (Boxof g353891)) (Boxof g353891)))
            (Pairof Integer g353891)
            Null))
        Integer
        (Rec
         g353894
         (U (Boxof (U (-> (Boxof g353894)) (Boxof g353894)))
            (Pairof Integer g353894)
            Null))
        Integer)))
'(16 . #<Deque>)
> (last+init (empty Integer))
last+init: given deque is empty

2.2 Implicit Deque

(require pfds/deque/implicit)

package: pfds

Deques obtained by applying Implicit Recursive Slowdown. Provides amortized running time of O(1) for the operations head, tail, last, init, enqueue-front and enqueue. Implicit Recursive Slowdown combines laziness and technique called Recursive Slow-Down developed by Kaplan and Tarjan in their paper Persistant Lists with Catenation via Recursive Slow-Down.

syntax
(Deque A)

Implicit double ended queue of type A.

procedure
(deque a ...) → (Deque A)
a : A

Function deque creates a Implicit Deque with the given inputs.

Example:

> (deque 1 2 3 4 5 6)
- : (U (Deep Positive-Byte) (Shallow Positive-Byte))
#<Deep>

In the above example, the deque obtained will have 1 as its head element.

value
empty : (Deque Nothing)

An empty deque

procedure
(empty? dq) → Boolean
dq : (Deque A)

Function empty? checks if the given deque is empty or not.

Examples:

> (empty? (deque 1 2 3 4 5 6))
- : Boolean
#f
> (empty? empty)
- : Boolean
#t

procedure
(enqueue a deq) → (Deque A)
a : A
deq : (Deque A)

Function enqueue takes an element and a deque and enqueues the given element into the deque.

Example:

> (enqueue 10 (deque 1 2 3 4 5 6))
- : (U (Deep Positive-Byte) (Shallow Positive-Byte))
#<Deep>

In the above example, enqueue adds the element 10 to (deque 1 2 3 4 5 6 10).

procedure
(enqueue-front a deq) → (Deque A)
a : A
deq : (Deque A)

Function enqueue-front takes an element and a deque and puts the given element to the front of the given deque.

Example:

> (enqueue-front 10 (deque 5 6 3 4))
- : (U (Deep Positive-Byte) (Shallow Positive-Byte))
#<Deep>

In the above example, (enqueue-front 10 (deque 5 6 3 4)) adds 10 to the front of the (deque 5 6 3 4). 10 will be the head element.

procedure
(head deq) → A
deq : (Deque A)

Function head takes a deque and gives the first element in the deque if deque is not empty else throws an error.

Examples:

> (head (deque 1 2 3 4 5 6))
- : Integer [more precisely: Positive-Byte]
1
> (head empty)
head: given deque is empty

procedure
(last deq) → A
deq : (Deque A)

Function last takes a deque and gives the last element in the queue if deque is not empty else throws an error.

Examples:

> (last (deque 1 2 3 4 5 6))
- : Integer [more precisely: Positive-Byte]
6
> (last empty)
last: given deque is empty

procedure
(tail deq) → (Deque A)
deq : (Deque A)

Function tail takes a deque and returns a deque with rest elements if its a non empty deque else throws an error.

Examples:

> (tail (deque 1 2 3 4 5 6))
- : (U (Deep Positive-Byte) (Shallow Positive-Byte))
#<Deep>
> (tail empty)
tail: given deque is empty

In the above example, (tail (deque 1 2 3 4 5 6)), removes 1 and returns (tail (deque 2 3 4 5 6)).

procedure
(init deq) → (Deque A)
deq : (Deque A)

Function init takes a deque and returns a deque without the last element if its a non empty deque else throws an error.

Examples:

> (init (deque 1 2 3 4 5 6))
- : (U (Deep Positive-Byte) (Shallow Positive-Byte))
#<Deep>
> (init empty)
init: given deque is empty

In the above example, (init (deque 1 2 3 4 5 6)), removes the last element 6 and returns (deque 1 2 3 4 5)

procedure
(deque->list deq) → (Listof A)
deq : (Deque A)

Function deque->list takes a deque and returns a list of elements. The list will have head of the given deque as its first element. If the given deque is empty, then it returns an empty list.

Example:

> (deque->list (deque 10 2 34 4 15 6))
- : (Listof Positive-Byte)
'(10 2 34 4 15 6)

procedure
(map func deq1 deq2 ...) → (Deque A)
  func : (A B ... B -> C)
  deq1 : (Deque A)
  deq2 : (Deque B)

Function map is similar to map for lists.

Examples:

> (deque->list (map add1 (deque 1 2 3 4 5 6)))
- : (Listof Positive-Index)
'(2 3 4 5 6 7)
> (deque->list (map * (deque 1 2 3 4 5 6) (deque 1 2 3 4 5 6)))
- : (Listof Positive-Index)
'(1 4 9 16 25 36)

procedure
(foldl func init deq1 deq2 ...) → C
  func : (C A B ... B -> C)
  init : C
  deq1 : (Deque A)
  deq2 : (Deque B)

Function foldl is similar to foldl

foldl currently does not produce correct results when the given function is non-commutative.

Examples:

> (foldl + 0 (deque 1 2 3 4 5 6))
- : Integer [more precisely: Nonnegative-Integer]
21
> (foldl * 1 (deque 1 2 3 4 5 6) (deque 1 2 3 4 5 6))
- : Integer [more precisely: Positive-Integer]
518400

procedure
(foldr func init deq1 deq2 ...) → C
  func : (C A B ... B -> C)
  init : C
  deq1 : (Deque A)
  deq2 : (Deque B)

Function foldr is similar to foldr

foldr currently does not produce correct results when the given function is non-commutative.

Examples:

> (foldr + 0 (deque 1 2 3 4 5 6))
- : Integer [more precisely: Nonnegative-Integer]
21
> (foldr * 1 (deque 1 2 3 4 5 6) (deque 1 2 3 4 5 6))
- : Integer [more precisely: Positive-Integer]
518400

procedure
(filter func que) → (Deque A)
func : (A -> Boolean)
que : (Deque A)

Function filter is similar to filter.

Examples:

> (define que (deque 1 2 3 4 5 6))
> (deque->list (filter (λ: ([x : Integer]) (> x 5)) que))
- : (Listof Positive-Byte)
'(6)
> (deque->list (filter (λ: ([x : Integer]) (< x 5)) que))
- : (Listof Positive-Byte)
'(1 2 3 4)
> (deque->list (filter (λ: ([x : Integer]) (<= x 5)) que))
- : (Listof Positive-Byte)
'(1 2 3 4 5)

procedure
(remove func que) → (Deque A)
func : (A -> Boolean)
que : (Deque A)

Function remove is similar to filter but remove removes the elements which match the predicate.

Examples:

> (deque->list (remove (λ: ([x : Integer]) (> x 5))
                       (deque 1 2 3 4 5 6)))
- : (Listof Positive-Byte)
'(1 2 3 4 5)
> (deque->list (remove (λ: ([x : Integer]) (< x 5))
                       (deque 1 2 3 4 5 6)))
- : (Listof Positive-Byte)
'(5 6)
> (deque->list (remove (λ: ([x : Integer]) (<= x 5))
                       (deque 1 2 3 4 5 6)))
- : (Listof Positive-Byte)
'(6)

procedure
(andmap func deq1 deq2 ...) → Boolean
  func : (A B ... B -> Boolean)
  deq1 : (Deque A)
  deq2 : (Deque B)

Function andmap is similar to andmap.

Examples:

> (andmap even? (deque 1 2 3 4 5 6))
- : Boolean
#f
> (andmap odd? (deque 1 2 3 4 5 6))
- : Boolean
#f
> (andmap positive? (deque 1 2 3 4 5 6))
- : Boolean
#t
> (andmap negative? (deque -1 -2))
- : Boolean
#t

procedure
(ormap func deq1 deq2 ...) → Boolean
  func : (A B ... B -> Boolean)
  deq1 : (Deque A)
  deq2 : (Deque B)

Function ormap is similar to ormap.

Examples:

> (ormap even? (deque 1 2 3 4 5 6))
- : Boolean
#t
> (ormap odd? (deque 1 2 3 4 5 6))
- : Boolean
#t
> (ormap positive? (deque -1 -2 3 4 -5 6))
- : Boolean
#t
> (ormap negative? (deque 1 -2))
- : Boolean
#t

procedure
(build-deque size func) → (Deque A)
size : Natural
func : (Natural -> A)

Function build-deque is similar to build-list.

Examples:

> (deque->list (build-deque 5 (λ:([x : Integer]) (add1 x))))
- : (Listof Integer)
'(1 2 3 4 5)
> (deque->list (build-deque 5 (λ:([x : Integer]) (* x x))))
- : (Listof Integer)
'(0 1 4 9 16)

procedure
(head+tail deq) → (Pair A (Deque A))
deq : (Deque A)

Function head+tail returns a pair containing the head and the tail of the given deque.

Examples:

> (head+tail (deque 1 2 3 4 5))
- : (Pairof Positive-Byte (U (Deep Positive-Byte) (Shallow Positive-Byte)))
'(1 . #<Deep>)
> (head+tail (build-deque 5 (λ:([x : Integer]) (* x x))))
- : (Pairof Integer (U (Deep Integer) (Shallow Integer)))
'(0 . #<Deep>)
> (head+tail empty)
head+tail: given deque is empty

procedure
(last+init deq) → (Pair A (Deque A))
deq : (Deque A)

Function last+init returns a pair containing the last element and the init of the given deque.

Examples:

> (last+init (deque 1 2 3 4 5))
- : (Pairof Positive-Byte (U (Deep Positive-Byte) (Shallow Positive-Byte)))
'(5 . #<Deep>)
> (last+init (build-deque 5 (λ:([x : Integer]) (* x x))))
- : (Pairof Integer (U (Deep Integer) (Shallow Integer)))
'(16 . #<Deep>)
> (last+init empty)
last+init: given deque is empty

2.3 Real-Time Deque

(require pfds/deque/real-time)

package: pfds

Real-Time Deques eliminate the amortization by using two techniques Scheduling and a variant of Global Rebuilding called Lazy Rebuilding. The data structure gives a worst case running time of O(1) for the operations head, tail, last, init, enqueue-front and enqueue.

syntax
(Deque A)

Real-time double ended queue of type A.

procedure
(deque a ...) → (Deque A)
a : A

Function deque creates a Real-Time Deque with the given inputs.

Example:

> (deque 1 2 3 4 5 6)
- : #(struct:Deque
      ((Rec
        g359233
        (U (Boxof (U (-> (Pairof Integer g359233)) (Pairof Integer g359233)))
           Null))
       Integer
       (Rec
        g359236
        (U (Boxof (U (-> (Pairof Integer g359236)) (Pairof Integer g359236)))
           Null))
       (Rec
        g359239
        (U (Boxof (U (-> (Pairof Integer g359239)) (Pairof Integer g359239)))
           Null))
       Integer
       (Rec
        g359242
        (U (Boxof (U (-> (Pairof Integer g359242)) (Pairof Integer g359242)))
           Null))))
#<Deque>

In the above example, the deque obtained will have 1 as its head element.

procedure
(empty t) → (Deque A)
t : A

An empty deque.

procedure
(empty? dq) → Boolean
dq : (Deque A)

Function empty? checks if the given deque is empty or not.

Examples:

> (empty? (deque 1 2 3 4 5 6))
- : Boolean
#f
> (empty? (empty Integer))
- : Boolean
#t

procedure
(enqueue a deq) → (Deque A)
a : A
deq : (Deque A)

Function enqueue takes an element and a deque and enqueues the given element into the deque.

Example:

> (enqueue 10 (deque 1 2 3 4 5 6))
- : #(struct:Deque
      ((Rec
        g359275
        (U (Boxof (U (-> (Pairof Integer g359275)) (Pairof Integer g359275)))
           Null))
       Integer
       (Rec
        g359278
        (U (Boxof (U (-> (Pairof Integer g359278)) (Pairof Integer g359278)))
           Null))
       (Rec
        g359281
        (U (Boxof (U (-> (Pairof Integer g359281)) (Pairof Integer g359281)))
           Null))
       Integer
       (Rec
        g359284
        (U (Boxof (U (-> (Pairof Integer g359284)) (Pairof Integer g359284)))
           Null))))
#<Deque>

In the above example, enqueue adds the element 10 to the end of (deque 1 2 3 4 5 6).

procedure
(enqueue-front a deq) → (Deque A)
a : A
deq : (Deque A)

Functionenqueue-front takes an element and a deque and adds the given element to the front of deque.

Example:

> (enqueue-front 10 (deque 1 2 3 4 5 6))
- : #(struct:Deque
      ((Rec
        g359296
        (U (Boxof (U (-> (Pairof Integer g359296)) (Pairof Integer g359296)))
           Null))
       Integer
       (Rec
        g359299
        (U (Boxof (U (-> (Pairof Integer g359299)) (Pairof Integer g359299)))
           Null))
       (Rec
        g359302
        (U (Boxof (U (-> (Pairof Integer g359302)) (Pairof Integer g359302)))
           Null))
       Integer
       (Rec
        g359305
        (U (Boxof (U (-> (Pairof Integer g359305)) (Pairof Integer g359305)))
           Null))))
#<Deque>

In the above example, enqueue adds the element 10 to the front of (deque 1 2 3 4 5 6) and returns (deque 10 1 2 3 4 5 6).

procedure
(head deq) → A
deq : (Deque A)

Function head takes a deque and gives the first element in the deque if deque is not empty else throws an error.

Examples:

> (head (deque 1 2 3 4 5 6))
- : Integer
1
> (head (empty Integer))
head: given deque is empty

procedure
(last deq) → A
deq : (Deque A)

Function last takes a deque and gives the last element in the queue if deque is not empty else throws an error.

Examples:

> (last (deque 1 2 3 4 5 6))
- : Integer
6
> (last (empty Integer))
last: given deque is empty

procedure
(tail deq) → (Deque A)
deq : (Deque A)

Function tail takes a deque and returns a deque with rest elements if its a non empty deque else throws an error.

Examples:

> (tail (deque 1 2 3 4 5 6))
- : #(struct:Deque
      ((Rec
        g359355
        (U (Boxof (U (-> (Pairof Integer g359355)) (Pairof Integer g359355)))
           Null))
       Integer
       (Rec
        g359358
        (U (Boxof (U (-> (Pairof Integer g359358)) (Pairof Integer g359358)))
           Null))
       (Rec
        g359361
        (U (Boxof (U (-> (Pairof Integer g359361)) (Pairof Integer g359361)))
           Null))
       Integer
       (Rec
        g359364
        (U (Boxof (U (-> (Pairof Integer g359364)) (Pairof Integer g359364)))
           Null))))
#<Deque>
> (tail (empty Integer))
tail: given deque is empty

In the above example, (tail (deque 1 2 3 4 5 6)), removes the head of the given deque returns (deque 2 3 4 5 6).

procedure
(init deq) → (Deque A)
deq : (Deque A)

Function init takes a deque and returns a deque without the last element if its a non empty deque else throws an error.

Examples:

> (init (deque 1 2 3 4 5 6))
- : #(struct:Deque
      ((Rec
        g359398
        (U (Boxof (U (-> (Pairof Integer g359398)) (Pairof Integer g359398)))
           Null))
       Integer
       (Rec
        g359401
        (U (Boxof (U (-> (Pairof Integer g359401)) (Pairof Integer g359401)))
           Null))
       (Rec
        g359404
        (U (Boxof (U (-> (Pairof Integer g359404)) (Pairof Integer g359404)))
           Null))
       Integer
       (Rec
        g359407
        (U (Boxof (U (-> (Pairof Integer g359407)) (Pairof Integer g359407)))
           Null))))
#<Deque>
> (init (empty Integer))
init: given deque is empty

In the above example, (init (deque 1 2 3 4 5 6)), removes the last element 6 of the given deque and returns (deque 1 2 3 4 5).

procedure
(deque->list deq) → (Listof A)
deq : (Deque A)

Function deque->list takes a deque and returns a list of elements. The list will have head of the given deque as its first element. If the given deque is empty, then it returns an empty list.

Example:

> (deque->list (deque 10 2 34 4 15 6))
- : (Listof Integer)
'(10 2 34 4 15 6)

procedure
(map func deq1 deq2 ...) → (Deque A)
  func : (A B ... B -> C)
  deq1 : (Deque A)
  deq2 : (Deque B)

Function map is similar to map for lists.

Examples:

> (deque->list (map add1 (deque 1 2 3 4 5 6)))
- : (Listof Integer)
'(2 3 4 5 6 7)
> (deque->list (map * (deque 1 2 3 4 5 6) (deque 1 2 3 4 5 6)))
- : (Listof Integer)
'(1 4 9 16 25 36)

procedure
(foldl func init deq1 deq2 ...) → C
  func : (C A B ... B -> C)
  init : C
  deq1 : (Deque A)
  deq2 : (Deque B)

Function foldl is similar to foldl

foldl currently does not produce correct results when the given function is non-commutative.

Examples:

> (foldl + 0 (deque 1 2 3 4 5 6))
- : Integer
21
> (foldl * 1 (deque 1 2 3 4 5 6) (deque 1 2 3 4 5 6))
- : Integer
518400

procedure
(foldr func init deq1 deq2 ...) → C
  func : (C A B ... B -> C)
  init : C
  deq1 : (Deque A)
  deq2 : (Deque B)

Function foldr is similar to foldr

foldr currently does not produce correct results when the given function is non-commutative.

Examples:

> (foldr + 0 (deque 1 2 3 4 5 6))
- : Integer
21
> (foldr * 1 (deque 1 2 3 4 5 6) (deque 1 2 3 4 5 6))
- : Integer
518400

procedure
(filter func que) → (Deque A)
func : (A -> Boolean)
que : (Deque A)

Function filter is similar to filter.

Examples:

> (define que (deque 1 2 3 4 5 6))
> (deque->list (filter (λ: ([x : Integer]) (> x 5)) que))
- : (Listof Integer)
'(6)
> (deque->list (filter (λ: ([x : Integer]) (< x 5)) que))
- : (Listof Integer)
'(1 2 3 4)
> (deque->list (filter (λ: ([x : Integer]) (<= x 5)) que))
- : (Listof Integer)
'(1 2 3 4 5)

procedure
(remove func que) → (Deque A)
func : (A -> Boolean)
que : (Deque A)

Function remove is similar to filter but remove removes the elements which match the predicate.

Examples:

> (deque->list (remove (λ: ([x : Integer]) (> x 5))
                       (deque 1 2 3 4 5 6)))
- : (Listof Integer)
'(1 2 3 4 5)
> (deque->list (remove (λ: ([x : Integer]) (< x 5))
                       (deque 1 2 3 4 5 6)))
- : (Listof Integer)
'(5 6)
> (deque->list (remove (λ: ([x : Integer]) (<= x 5))
                       (deque 1 2 3 4 5 6)))
- : (Listof Integer)
'(6)

procedure
(andmap func deq1 deq2 ...) → Boolean
  func : (A B ... B -> Boolean)
  deq1 : (Deque A)
  deq2 : (Deque B)

Function andmap is similar to andmap.

Examples:

> (andmap even? (deque 1 2 3 4 5 6))
- : Boolean
#f
> (andmap odd? (deque 1 2 3 4 5 6))
- : Boolean
#f
> (andmap positive? (deque 1 2 3 4 5 6))
- : Boolean
#t
> (andmap negative? (deque -1 -2))
- : Boolean
#t

procedure
(ormap func deq1 deq2 ...) → Boolean
  func : (A B ... B -> Boolean)
  deq1 : (Deque A)
  deq2 : (Deque B)

Function ormap is similar to ormap.

Examples:

> (ormap even? (deque 1 2 3 4 5 6))
- : Boolean
#t
> (ormap odd? (deque 1 2 3 4 5 6))
- : Boolean
#t
> (ormap positive? (deque -1 -2 3 4 -5 6))
- : Boolean
#t
> (ormap negative? (deque 1 -2))
- : Boolean
#t

procedure
(build-deque size func) → (Deque A)
size : Natural
func : (Natural -> A)

Function build-deque is similar to build-list.

Examples:

> (deque->list (build-deque 5 (λ:([x : Integer]) (add1 x))))
- : (Listof Integer)
'(1 2 3 4 5)
> (deque->list (build-deque 5 (λ:([x : Integer]) (* x x))))
- : (Listof Integer)
'(0 1 4 9 16)

procedure
(head+tail deq) → (Pair A (Deque A))
deq : (Deque A)

Function head+tail returns a pair containing the head and the tail of the given deque.

Examples:

> (head+tail (deque 1 2 3 4 5))
- : (Pairof
     Integer
     #(struct:Deque
       ((Rec
         g359781
         (U (Boxof (U (-> (Pairof Integer g359781)) (Pairof Integer g359781)))
            Null))
        Integer
        (Rec
         g359784
         (U (Boxof (U (-> (Pairof Integer g359784)) (Pairof Integer g359784)))
            Null))
        (Rec
         g359787
         (U (Boxof (U (-> (Pairof Integer g359787)) (Pairof Integer g359787)))
            Null))
        Integer
        (Rec
         g359790
         (U (Boxof (U (-> (Pairof Integer g359790)) (Pairof Integer g359790)))
            Null)))))
'(1 . #<Deque>)
> (head+tail (build-deque 5 (λ:([x : Integer]) (* x x))))
- : (Pairof
     Integer
     #(struct:Deque
       ((Rec
         g359807
         (U (Boxof (U (-> (Pairof Integer g359807)) (Pairof Integer g359807)))
            Null))
        Integer
        (Rec
         g359810
         (U (Boxof (U (-> (Pairof Integer g359810)) (Pairof Integer g359810)))
            Null))
        (Rec
         g359813
         (U (Boxof (U (-> (Pairof Integer g359813)) (Pairof Integer g359813)))
            Null))
        Integer
        (Rec
         g359816
         (U (Boxof (U (-> (Pairof Integer g359816)) (Pairof Integer g359816)))
            Null)))))
'(0 . #<Deque>)
> (head+tail (empty Integer))
head+tail: given deque is empty

procedure
(last+init deq) → (Pair A (Deque A))
deq : (Deque A)

Function last+init returns a pair containing the last element and the init of the given deque.

Examples:

> (last+init (deque 1 2 3 4 5))
- : (Pairof
     Integer
     #(struct:Deque
       ((Rec
         g359850
         (U (Boxof (U (-> (Pairof Integer g359850)) (Pairof Integer g359850)))
            Null))
        Integer
        (Rec
         g359853
         (U (Boxof (U (-> (Pairof Integer g359853)) (Pairof Integer g359853)))
            Null))
        (Rec
         g359856
         (U (Boxof (U (-> (Pairof Integer g359856)) (Pairof Integer g359856)))
            Null))
        Integer
        (Rec
         g359859
         (U (Boxof (U (-> (Pairof Integer g359859)) (Pairof Integer g359859)))
            Null)))))
'(5 . #<Deque>)
> (last+init (build-deque 5 (λ:([x : Integer]) (* x x))))
- : (Pairof
     Integer
     #(struct:Deque
       ((Rec
         g359876
         (U (Boxof (U (-> (Pairof Integer g359876)) (Pairof Integer g359876)))
            Null))
        Integer
        (Rec
         g359879
         (U (Boxof (U (-> (Pairof Integer g359879)) (Pairof Integer g359879)))
            Null))
        (Rec
         g359882
         (U (Boxof (U (-> (Pairof Integer g359882)) (Pairof Integer g359882)))
            Null))
        Integer
        (Rec
         g359885
         (U (Boxof (U (-> (Pairof Integer g359885)) (Pairof Integer g359885)))
            Null)))))
'(16 . #<Deque>)
> (last+init (empty Integer))
last+init: given deque is empty

1	Queues
2	Deques
3	Heaps
4	Random Access Lists
5	VList
6	Streams
7	Red-Black Trees
8	Tries
9	Treap