# 1.2: Interfaces

- Page ID
- 8429

\( \newcommand{\vecs}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \)

\( \newcommand{\vecd}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash {#1}}} \)

\( \newcommand{\id}{\mathrm{id}}\) \( \newcommand{\Span}{\mathrm{span}}\)

( \newcommand{\kernel}{\mathrm{null}\,}\) \( \newcommand{\range}{\mathrm{range}\,}\)

\( \newcommand{\RealPart}{\mathrm{Re}}\) \( \newcommand{\ImaginaryPart}{\mathrm{Im}}\)

\( \newcommand{\Argument}{\mathrm{Arg}}\) \( \newcommand{\norm}[1]{\| #1 \|}\)

\( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\)

\( \newcommand{\Span}{\mathrm{span}}\)

\( \newcommand{\id}{\mathrm{id}}\)

\( \newcommand{\Span}{\mathrm{span}}\)

\( \newcommand{\kernel}{\mathrm{null}\,}\)

\( \newcommand{\range}{\mathrm{range}\,}\)

\( \newcommand{\RealPart}{\mathrm{Re}}\)

\( \newcommand{\ImaginaryPart}{\mathrm{Im}}\)

\( \newcommand{\Argument}{\mathrm{Arg}}\)

\( \newcommand{\norm}[1]{\| #1 \|}\)

\( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\)

\( \newcommand{\Span}{\mathrm{span}}\) \( \newcommand{\AA}{\unicode[.8,0]{x212B}}\)

\( \newcommand{\vectorA}[1]{\vec{#1}} % arrow\)

\( \newcommand{\vectorAt}[1]{\vec{\text{#1}}} % arrow\)

\( \newcommand{\vectorB}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \)

\( \newcommand{\vectorC}[1]{\textbf{#1}} \)

\( \newcommand{\vectorD}[1]{\overrightarrow{#1}} \)

\( \newcommand{\vectorDt}[1]{\overrightarrow{\text{#1}}} \)

\( \newcommand{\vectE}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash{\mathbf {#1}}}} \)

\( \newcommand{\vecs}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \)

\( \newcommand{\vecd}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash {#1}}} \)

When discussing data structures, it is important to understand the difference between a data structure's interface and its implementation. An interface describes what a data structure does, while an implementation describes how the data structure does it.

An interface, sometimes also called an abstract data type, defines the set of operations supported by a data structure and the semantics, or meaning, of those operations. An interface tells us nothing about how the data structure implements these operations; it only provides a list of supported operations along with specifications about what types of arguments each operation accepts and the value returned by each operation.

A data structure implementation, on the other hand, includes the internal representation of the data structure as well as the definitions of the algorithms that implement the operations supported by the data structure. Thus, there can be many implementations of a single interface. For example, in Chapter 2, we will see implementations of the `List` interface using arrays and in Chapter 3 we will see implementations of the `List` interface using pointer-based data structures. Each implements the same interface, `List`, but in different ways.

## \(\PageIndex{1}\) The `Queue`, `Stack`, and `Deque` Interfaces

The `Queue` interface represents a collection of elements to which we can add elements and remove the next element. More precisely, the operations supported by the `Queue` interface are

- \(\mathtt{add(x)}\): add the value \(\mathtt{x}\) to the
`Queue` - \(\mathtt{remove()}\): remove the next (previously added) value, \(\mathtt{y}\), from the
`Queue`and return \(\mathtt{y}\)

Notice that the \(\mathtt{remove()}\) operation takes no argument. The `Queue`'s queueing discipline decides which element should be removed. There are many possible queueing disciplines, the most common of which include FIFO, priority, and LIFO.

A FIFO (first-in-first-out) `Queue`, which is illustrated in Figure \(\PageIndex{1}\), removes items in the same order they were added, much in the same way a queue (or line-up) works when checking out at a cash register in a grocery store. This is the most common kind of `Queue` so the qualifier FIFO is often omitted. In other texts, the \(\mathtt{add(x)}\) and \(\mathtt{remove()}\) operations on a FIFO `Queue` are often called \(\mathtt{enqueue(x)}\) and \(\mathtt{dequeue()}\), respectively.

A priority `Queue`, illustrated in Figure \(\PageIndex{2}\), always removes the smallest element from the `Queue`, breaking ties arbitrarily. This is similar to the way in which patients are triaged in a hospital emergency room. As patients arrive they are evaluated and then placed in a waiting room. When a doctor becomes available he or she first treats the patient with the most life-threatening condition. The \(\mathtt{remove(x)}\) operation on a priority `Queue` is usually called \(\mathtt{deleteMin()}\) in other texts.

A very common queueing discipline is the LIFO (last-in-first-out) discipline, illustrated in Figure \(\PageIndex{3}\). In a LIFO Queue, the most recently added element is the next one removed. This is best visualized in terms of a stack of plates; plates are placed on the top of the stack and also removed from the top of the stack. This structure is so common that it gets its own name: `Stack`. Often, when discussing a `Stack`, the names of \(\mathtt{add(x)}\) and \(\mathtt{remove()}\) are changed to \(\mathtt{push(x)}\) and \(\mathtt{pop()}\); this is to avoid confusing the LIFO and FIFO queueing disciplines.

A `Deque` is a generalization of both the FIFO `Queue` and LIFO `Queue` (`Stack`). A `Deque` represents a sequence of elements, with a front and a back. Elements can be added at the front of the sequence or the back of the sequence. The names of the `Deque` operations are self-explanatory: \(\mathtt{addFirst(x)}\), \(\mathtt{removeFirst()}\), \(\mathtt{addLast(x)}\), and \(\mathtt{removeLast()}\). It is worth noting that a `Stack` can be implemented using only \(\mathtt{addFirst(x)}\) and \(\mathtt{removeFirst()}\) while a FIFO `Queue` can be implemented using \(\mathtt{addLast(x)}\) and \(\mathtt{removeFirst()}\).

## \(\PageIndex{2}\) The `List` Interface: Linear Sequences

This book will talk very little about the FIFO `Queue`, `Stack`, or `Deque` interfaces. This is because these interfaces are subsumed by the `List` interface. A `List`, illustrated in Figure \(\PageIndex{4}\), represents a sequence, \(\mathtt{x}_0,\ldots,\mathtt{x}_{\mathtt{n}-1}\), of values. The `List` interface includes the following operations:

- \(\mathtt{size()}\): return \(\mathtt{n}\), the length of the list
- \(\mathtt{get(i)}\): return the value \(\mathtt{x}_{\mathtt{i}}\)
- \(\mathtt{set(i,x)}\): set the value of \(\mathtt{x}_{\mathtt{i}}\) equal to \(\mathtt{x}\)
- \(\mathtt{add(i,x)}\): add \(\mathtt{x}\) at position \(\mathtt{i}\), displacing \(\mathtt{x}_{\mathtt{i}},\ldots,\mathtt{x}_{\mathtt{n}-1}\);

Set \(\mathtt{x}_{j+1}=\mathtt{x}_j\), for all \(j\in\{\mathtt{n}-1,\ldots,\mathtt{i}\}\), increment \(\mathtt{n}\), and set \(\mathtt{x}_i=\mathtt{x}\) - \(\mathtt{remove(i)}\) remove the value \(\mathtt{x}_{\mathtt{i}}\), displacing \(\mathtt{x}_{\mathtt{i+1}},\ldots,\mathtt{x}_{\mathtt{n}-1}\);

Set \(\mathtt{x}_{j}=\mathtt{x}_{j+1}\), for all \(j\in\{\mathtt{i},\ldots,\mathtt{n}-2\}\) and decrement \(\mathtt{n}\)

Notice that these operations are easily sufficient to implement the `Deque` interface:

\[\begin{align}

\mathtt{addFirst(x)} &\Rightarrow \mathtt{add(0,x)}\nonumber\\

\mathtt{removeFirst()} &\Rightarrow \mathtt{remove(0)}\nonumber\\

\mathtt{addLast(x)} &\Rightarrow \mathtt{add(size(),x)}\nonumber\\

\mathtt{removeLast()} &\Rightarrow \mathtt{remove(size()-1)}\nonumber

\end{align}\nonumber\]

Although we will normally not discuss the `Stack`, `Deque` and FIFO `Queue` interfaces in subsequent chapters, the terms `Stack` and `Deque` are sometimes used in the names of data structures that implement the `List` interface. When this happens, it highlights the fact that these data structures can be used to implement the `Stack` or `Deque` interface very efficiently. For example, the `ArrayDeque` class is an implementation of the `List` interface that implements all the `Deque` operations in constant time per operation.

## \(\PageIndex{3}\) The `USet` Interface: Unordered Sets

The `USet` interface represents an unordered set of unique elements, which mimics a mathematical set. A `USet` contains \(\mathtt{n}\) distinct elements; no element appears more than once; the elements are in no specific order. A `USet` supports the following operations:

- \(\mathtt{size()}\): return the number, \(\mathtt{n}\), of elements in the set
- \(\mathtt{add(x)}\): add the element \(\mathtt{x}\) to the set if not already present;

Add \(\mathtt{x}\) to the set provided that there is no element \(\mathtt{y}\) in the set such that \(\mathtt{x}\) equals \(\mathtt{y}\). Return \(\mathtt{true}\) if \(\mathtt{x}\) was added to the set and \(\mathtt{false}\) otherwise. - \(\mathtt{remove(x)}\): remove \(\mathtt{x}\) from the set;

Find an element \(\mathtt{y}\) in the set such that \(\mathtt{x}\) equals \(\mathtt{y}\) and remove \(\mathtt{y}\). Return \(\mathtt{y}\), or \(\mathtt{null}\) if no such element exists. - \(\mathtt{find(x)}\): find \(\mathtt{x}\) in the set if it exists;

Find an element \(\mathtt{y}\) in the set such that \(\mathtt{y}\) equals \(\mathtt{x}\). Return \(\mathtt{y}\), or \(\mathtt{null}\) if no such element exists.

These definitions are a bit fussy about distinguishing \(\mathtt{x}\), the element we are removing or finding, from \(\mathtt{y}\), the element we may remove or find. This is because \(\mathtt{x}\) and \(\mathtt{y}\) might actually be distinct objects that are nevertheless treated as equal.^{2} Such a distinction is useful because it allows for the creation of dictionaries or maps that map keys onto values.

To create a dictionary/map, one forms compound objects called `Pair`s, each of which contains a key and a value. Two `Pair`s are treated as equal if their keys are equal. If we store some pair \((\mathtt{k},\mathtt{v})\) in a `USet` and then later call the \(\mathtt{find(x)}\) method using the pair \(\mathtt{x}=(\mathtt{k},\mathtt{null})\) the result will be \(\mathtt{y}=(\mathtt{k},\mathtt{v})\). In other words, it is possible to recover the value, \(\mathtt{v}\), given only the key, \(\mathtt{k}\).

##

\(\PageIndex{4}\) The `SSet` Interface: Sorted Sets

The `SSet` interface represents a sorted set of elements. An `SSet` stores elements from some total order, so that any two elements \(\mathtt{x}\) and \(\mathtt{y}\) can be compared. In code examples, this will be done with a method called \(\mathtt{compare(x,y)}\) in which

\[\mathtt{compare(x,y)}

\begin{cases}

<0 & \text{if }\mathtt{x}<\mathtt{y}\\

>0 & \text{if }\mathtt{x}>\mathtt{y}\\

=0 & \text{if }\mathtt{x}=\mathtt{y}

\end{cases}\nonumber\]

An `SSet` supports the \(\mathtt{size()}\), \(\mathtt{add(x)}\), and \(\mathtt{remove(x)}\) methods with exactly the same semantics as in the `USet` interface. The difference between a `USet` and an `SSet` is in the \(\mathtt{find(x)}\) method:

- \(\mathtt{find(x)}\): locate \(\mathtt{x}\) in the sorted set;

Find the smallest element \(\mathtt{y}\) in the set such that \(\mathtt{y} \ge \mathtt{x}\). Return \(\mathtt{y}\) or \(\mathtt{null}\) if no such element exists.

This version of the \(\mathtt{find(x)}\) operation is sometimes referred to as a successor search. It differs in a fundamental way from \(\mathtt{USet.find(x)}\) since it returns a meaningful result even when there is no element equal to \(\mathtt{x}\) in the set.

The distinction between the `USet` and `SSet` \(\mathtt{find(x)}\) operations is very important and often missed. The extra functionality provided by an `SSet` usually comes with a price that includes both a larger running time and a higher implementation complexity. For example, most of the `SSet` implementations discussed in this book all have \(\mathtt{find(x)}\) operations with running times that are logarithmic in the size of the set. On the other hand, the implementation of a `USet` as a `ChainedHashTable` in Chapter 5 has a \(\mathtt{find(x)}\) operation that runs in constant expected time. When choosing which of these structures to use, one should always use a `USet` unless the extra functionality offered by an `SSet` is truly needed.