Skip to content

Commit 362408a

Browse files
committed
feat: add deque chapter
1 parent 4dd424d commit 362408a

5 files changed

Lines changed: 339 additions & 7 deletions

File tree

.github/workflows/docs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,21 @@ jobs:
2424
test -s docs/02-linked-list.md
2525
test -s docs/03-stack.md
2626
test -s docs/04-queue.md
27+
test -s docs/05-deque.md
2728
test -s examples/README.md
2829
test -s tests/README.md
2930
test -s benches/README.md
3031
test -s benches/vector_bench.rs
3132
test -s benches/linked_list_bench.rs
3233
test -s benches/stack_bench.rs
3334
test -s benches/queue_bench.rs
35+
test -s benches/deque_bench.rs
3436
test -s diagrams/README.md
3537
test -s diagrams/01-vector.mmd
3638
test -s diagrams/02-linked-list.mmd
3739
test -s diagrams/03-stack.mmd
3840
test -s diagrams/04-queue.mmd
41+
test -s diagrams/05-deque.mmd
3942
test -s assets/README.md
4043
4144
grep -q "Vector" docs/SUMMARY.md

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ un algoritmo sea necesario para explicar la propia estructura.
3434
| 02 | Linked List | `src/linked_list.rs` | benchmarked |
3535
| 03 | Stack | `src/stack.rs` | benchmarked |
3636
| 04 | Queue | `src/queue.rs` | benchmarked |
37-
| 05 | Deque | `src/deque.rs` | planned |
37+
| 05 | Deque | `src/deque.rs` | benchmarked |
3838
| 06 | Heap | `src/heap.rs` | planned |
3939
| 07 | Trie | `src/trie.rs` | planned |
4040
| 08 | Graph | `src/graph.rs` | planned |

ROADMAP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ El checklist detallado vive en
2323
| 02 | Linked List | benchmarked |
2424
| 03 | Stack | benchmarked |
2525
| 04 | Queue | benchmarked |
26-
| 05 | Deque | planned |
26+
| 05 | Deque | benchmarked |
2727
| 06 | Heap | planned |
2828
| 07 | Trie | planned |
2929
| 08 | Graph | planned |

docs/05-deque.md

Lines changed: 329 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,329 @@
1+
# Deque
2+
3+
> **Curso:** rust-data-structures · **Capitulo:** 05 · **Prerequisitos:** Capitulo 01, Vector; Capitulo 02, Linked List; Capitulo 04, Queue
4+
> **Codigo:** [`src/deque.rs`](../src/deque.rs) · **Video:** pendiente
5+
> **Leccion en el sitio:** pendiente
6+
7+
## Introduccion
8+
9+
Un deque (*double-ended queue*) es una cola de doble extremo. Permite insertar y
10+
remover por el frente y por el fondo: `push_front`, `push_back`, `pop_front` y
11+
`pop_back`.
12+
13+
La idea importante no es "hacer de todo". Un deque sigue siendo una estructura
14+
con contrato claro: optimiza trabajo en los extremos y, si ofrece acceso por
15+
indice, ese indice se interpreta desde el frente logico, no desde la memoria
16+
fisica.
17+
18+
En este capitulo implementamos `Deque<T>` como buffer circular seguro. Es una
19+
extension natural de `Queue<T>`: donde la cola mueve un solo extremo de lectura,
20+
el deque permite que ambos extremos participen en el flujo.
21+
22+
## Motivacion
23+
24+
Hay problemas donde una pila o una cola son demasiado estrechas. Un algoritmo de
25+
ventana deslizante necesita sacar valores vencidos por el frente y eliminar
26+
candidatos peores por el fondo. Un historial de navegador puede tratar el fondo
27+
como pagina actual y el frente como elementos fijados. Una cola de trabajo puede
28+
poner tareas urgentes al frente y tareas normales al fondo.
29+
30+
Usar un vector para eso puede ser costoso si insertas o remueves del frente: los
31+
elementos deben desplazarse. Usar una lista enlazada evita desplazamientos, pero
32+
paga asignaciones y pierde localidad. Un deque con buffer circular busca el
33+
punto medio: extremos baratos y memoria contigua.
34+
35+
## Teoria
36+
37+
### Historia
38+
39+
Los deques aparecen como generalizacion practica de pilas y colas. En sistemas,
40+
se usan para work stealing, scheduling, buffers de eventos y caches. En
41+
algoritmos, son centrales para ventanas monotonicamente ordenadas y para BFS 0-1,
42+
donde algunas aristas se agregan al frente y otras al fondo.
43+
44+
La leccion historica es la misma del curso: la estructura no es solo una bolsa
45+
de operaciones. Es una forma de expresar que los extremos importan mas que el
46+
centro.
47+
48+
### Fundamentos
49+
50+
El deque expone estas operaciones:
51+
52+
- `push_front(value)`: agrega un valor al frente.
53+
- `push_back(value)`: agrega un valor al fondo.
54+
- `pop_front()`: remueve el frente.
55+
- `pop_back()`: remueve el fondo.
56+
- `front()` / `back()`: leen extremos sin remover.
57+
- `get(index)`: lee por indice logico desde el frente.
58+
- `clear()`: vacia el deque.
59+
- `iter()`: recorre del frente al fondo.
60+
61+
La invariante de representacion es:
62+
63+
```text
64+
indice_fisico = (head + indice_logico) % capacity
65+
```
66+
67+
`head` apunta al frente logico. `len` dice cuantos valores validos hay. El fondo
68+
se calcula con `head + len - 1`. `push_front` mueve `head` hacia atras; `push_back`
69+
escribe despues del ultimo elemento logico.
70+
71+
### Casos de uso
72+
73+
Usos clasicos:
74+
75+
- Ventanas deslizantes.
76+
- Work queues con tareas urgentes y normales.
77+
- Historiales de navegacion.
78+
- Buffers de eventos.
79+
- BFS 0-1.
80+
- Simulaciones donde entran y salen entidades por ambos extremos.
81+
82+
### Ventajas y limitaciones
83+
84+
Ventajas:
85+
86+
- Operaciones O(1) amortizadas en ambos extremos.
87+
- Memoria contigua y mejor localidad que una lista enlazada.
88+
- Underflow representado con `Option<T>`.
89+
- Acceso por indice logico O(1).
90+
- Reutiliza ranuras liberadas por ambos lados.
91+
92+
Limitaciones:
93+
94+
- Insertar o remover en medio no forma parte del contrato.
95+
- El crecimiento puede mover valores.
96+
- La aritmetica modular hace mas delicada la implementacion.
97+
- `get(index)` es rapido, pero no convierte al deque en reemplazo universal de
98+
un vector; el modelo mental principal siguen siendo los extremos.
99+
100+
### Comparacion con alternativas
101+
102+
Una pila es un deque usado por un solo extremo. Una cola es un deque con entrada
103+
por el fondo y salida por el frente. Un vector ofrece acceso contiguo simple,
104+
pero insertar/remover al frente cuesta O(n). Una lista enlazada hace extremos
105+
baratos, pero asigna nodos y no tiene acceso indexado eficiente.
106+
107+
La biblioteca estandar ofrece `VecDeque<T>` para uso real de produccion. Nuestro
108+
`Deque<T>` existe para estudiar las invariantes: `head`, `len`, wraparound,
109+
crecimiento y lectura logica sobre memoria fisica no lineal.
110+
111+
## Diagramas
112+
113+
El diagrama principal vive en [`diagrams/05-deque.mmd`](../diagrams/05-deque.mmd).
114+
115+
```mermaid
116+
flowchart LR
117+
title["Deque: dos extremos sobre buffer circular"]
118+
119+
subgraph metadata["Metadatos"]
120+
head["head = 4"]
121+
len["len = 5"]
122+
cap["capacity = 8"]
123+
end
124+
125+
subgraph buffer["Buffer fisico"]
126+
slot0["0: D"]
127+
slot1["1: E (back)"]
128+
slot2["2: libre"]
129+
slot3["3: libre"]
130+
slot4["4: A (front)"]
131+
slot5["5: B"]
132+
slot6["6: C"]
133+
slot7["7: libre"]
134+
end
135+
136+
head --> slot4
137+
len --> slot1
138+
cap --> slot7
139+
140+
push_front["push_front(Z)<br/>mueve head hacia atras"]
141+
pop_front["pop_front()<br/>toma front y avanza head"]
142+
push_back["push_back(F)<br/>escribe en (head + len) % capacity"]
143+
pop_back["pop_back()<br/>toma (head + len - 1) % capacity"]
144+
145+
push_front --> slot3
146+
pop_front --> head
147+
push_back --> slot2
148+
pop_back --> slot1
149+
```
150+
151+
## Analisis de complejidad
152+
153+
| Operacion | Mejor caso | Caso promedio | Peor caso | Espacio |
154+
|-----------|------------|---------------|-----------|---------|
155+
| `new` | O(1) | O(1) | O(1) | O(1) |
156+
| `with_capacity(n)` | O(n) | O(n) | O(n) | O(n) |
157+
| `len` / `capacity` / `is_empty` | O(1) | O(1) | O(1) | O(1) |
158+
| `push_front` / `push_back` | O(1) | O(1) amortizado | O(n) si crece | O(n) si crece |
159+
| `pop_front` / `pop_back` | O(1) | O(1) | O(1) | O(1) |
160+
| `front` / `back` / `get` | O(1) | O(1) | O(1) | O(1) |
161+
| `clear` | O(n) | O(n) | O(n) | O(1) |
162+
| `iter` | O(1) crear, O(n) consumir | O(n) | O(n) | O(1) |
163+
164+
Cuando el buffer crece, los valores se copian en orden logico a un nuevo arreglo
165+
y `head` vuelve a `0`. Ese paso convierte temporalmente el costo en O(n), pero
166+
mantiene O(1) amortizado para inserciones en los extremos.
167+
168+
## Visualizacion interactiva (opcional)
169+
170+
No aplica todavia. El wraparound del deque se entiende con el diagrama, los
171+
tests y los ejemplos; se agregara playground cuando `academy-web` defina el
172+
mecanismo de visualizacion.
173+
174+
## Implementacion
175+
176+
La implementacion vive en [`src/deque.rs`](../src/deque.rs).
177+
178+
El tipo guarda la misma base conceptual que `Queue<T>`:
179+
180+
```rust
181+
pub struct Deque<T> {
182+
items: Box<[Option<T>]>,
183+
head: usize,
184+
len: usize,
185+
}
186+
```
187+
188+
`push_back` escribe al final logico:
189+
190+
```rust
191+
let index = self.physical_index(self.len);
192+
self.items[index] = Some(value);
193+
self.len += 1;
194+
```
195+
196+
`push_front` mueve `head` hacia atras antes de escribir:
197+
198+
```rust
199+
self.head = (self.head + self.capacity() - 1) % self.capacity();
200+
self.items[self.head] = Some(value);
201+
self.len += 1;
202+
```
203+
204+
`pop_front` avanza `head`; `pop_back` calcula el ultimo indice logico y toma el
205+
valor. En ambos casos, si `len` queda en cero, `head` vuelve a `0` para mantener
206+
un estado vacio simple.
207+
208+
## Pruebas
209+
210+
Las pruebas viven en [`tests/deque_test.rs`](../tests/deque_test.rs) y dentro de
211+
[`src/deque.rs`](../src/deque.rs).
212+
213+
Cubren:
214+
215+
- Underflow en ambos extremos.
216+
- `push_front`, `push_back`, `pop_front` y `pop_back`.
217+
- Reutilizacion de ranuras por ambos extremos.
218+
- Crecimiento despues de wraparound.
219+
- Preservacion del orden logico.
220+
- `get(index)` sobre indices logicos.
221+
- `clear` conservando capacidad.
222+
- Movimiento de ownership con `pop_*`.
223+
- Destruccion de valores restantes con `clear`.
224+
225+
Los doc-comments se validan con `cargo test --doc`.
226+
227+
## Benchmarks
228+
229+
El benchmark vive en [`benches/deque_bench.rs`](../benches/deque_bench.rs) y se
230+
ejecuta con:
231+
232+
```bash
233+
cargo bench --bench deque_bench
234+
```
235+
236+
Mide:
237+
238+
- `push_front/pop_front`;
239+
- `push_back/pop_back`;
240+
- `get(index)` por indice logico;
241+
- lista enlazada como comparacion de frente;
242+
- vector con remocion frontal ingenua.
243+
244+
La comparacion no busca coronar una estructura universal. Busca mostrar donde
245+
cada contrato paga: el deque hace baratos ambos extremos; el vector castiga el
246+
frente; la lista evita desplazamientos pero renuncia a localidad e indexado
247+
barato.
248+
249+
## Ejercicios
250+
251+
### Ejercicio 1: Trazar extremos `[Nivel 1]`
252+
253+
Ejecuta `push_back(B)`, `push_front(A)`, `push_back(C)`, `pop_front()`,
254+
`pop_back()`, `pop_front()` y registra los valores devueltos.
255+
256+
**Entrada/Salida esperada:** `[Some("A"), Some("C"), Some("B")]`.
257+
258+
<details>
259+
<summary>Pista</summary>
260+
El frente y el fondo pueden cambiar sin mover los valores intermedios.
261+
</details>
262+
263+
### Ejercicio 2: Maximo de ventana deslizante `[Nivel 2]`
264+
265+
Usa un deque de indices para calcular el maximo de cada ventana de tamano `k`.
266+
267+
**Entrada/Salida esperada:** `[4, 2, 12, 3, 8]` con `k = 3` produce
268+
`[12, 12, 12]`.
269+
270+
<details>
271+
<summary>Pista</summary>
272+
Manten en el deque solo indices candidatos cuyo valor pueda seguir siendo maximo.
273+
</details>
274+
275+
### Ejercicio 3: Historial de navegador `[Nivel 3]`
276+
277+
Modela un historial donde el fondo representa la pagina actual y el frente puede
278+
recibir paginas fijadas. Implementa una funcion `go_back`.
279+
280+
**Entrada/Salida esperada:** despues de volver desde `"capitulo"`, el historial
281+
con pin `"pin-roadmap"` queda como `["pin-roadmap", "inicio", "curso"]`.
282+
283+
<details>
284+
<summary>Pista</summary>
285+
`pop_back` representa salir de la pagina actual; `push_front` representa fijar
286+
algo por delante del recorrido normal.
287+
</details>
288+
289+
### Ejercicio 4: Work stealing `[Nivel 4]`
290+
291+
Disena una cola de trabajo donde el trabajador local toma del fondo y otros
292+
trabajadores roban del frente. Explica que invariantes hacen que esa politica
293+
sea razonable.
294+
295+
**Entrada/Salida esperada:** no hay una unica solucion; se evalua el diseno y
296+
la claridad de sus invariantes.
297+
298+
<details>
299+
<summary>Pista</summary>
300+
Separar extremos puede reducir contencion conceptual: un lado expresa trabajo
301+
local reciente y el otro trabajo disponible para repartir.
302+
</details>
303+
304+
## Soluciones
305+
306+
Soluciones ejecutables de niveles 1 a 3:
307+
308+
- [`examples/soluciones/deque_trace_ends.rs`](../examples/soluciones/deque_trace_ends.rs)
309+
- [`examples/soluciones/deque_sliding_window.rs`](../examples/soluciones/deque_sliding_window.rs)
310+
- [`examples/soluciones/deque_browser_history.rs`](../examples/soluciones/deque_browser_history.rs)
311+
312+
Discusion para el nivel 4:
313+
314+
Work stealing usa el deque para dar significados distintos a cada extremo. El
315+
trabajador local puede tomar trabajo reciente del fondo, mientras que otros
316+
trabajadores roban unidades mas antiguas desde el frente. La invariante clave es
317+
que cada tarea vive una sola vez en el deque y que cada extraccion transfiere
318+
ownership logico de esa tarea.
319+
320+
## Referencias
321+
322+
- Thomas H. Cormen, Charles E. Leiserson, Ronald L. Rivest, Clifford Stein,
323+
*Introduction to Algorithms*, secciones sobre colas, BFS y estructuras
324+
elementales.
325+
- Robert Sedgewick y Kevin Wayne, *Algorithms*, secciones sobre queues, deques y
326+
ventanas de procesamiento.
327+
- Rust Standard Library, `VecDeque<T>`, como deque circular de produccion.
328+
- Rust Book, capitulos de ownership y borrowing, para entender por que `pop_*`
329+
transfiere valores.

docs/superpowers/plans/2026-07-14-rust-data-structures-course.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -220,11 +220,11 @@ For each chapter, complete the following checklist before moving to the next str
220220
- Create: `examples/deque_advanced.rs`
221221
- Create: `examples/deque_real_case.rs`
222222

223-
- [ ] Teach double-ended queues, ring buffers, push/pop front/back, indexing tradeoffs, and growth.
224-
- [ ] Compare against stack, queue, vector, and linked list.
225-
- [ ] Include real cases: sliding-window algorithms, work queues, browser navigation.
226-
- [ ] Include tests for all four end operations, wraparound, growth, and order preservation.
227-
- [ ] Include benchmarks for front/back operations and indexed access where supported.
223+
- [x] Teach double-ended queues, ring buffers, push/pop front/back, indexing tradeoffs, and growth.
224+
- [x] Compare against stack, queue, vector, and linked list.
225+
- [x] Include real cases: sliding-window algorithms, work queues, browser navigation.
226+
- [x] Include tests for all four end operations, wraparound, growth, and order preservation.
227+
- [x] Include benchmarks for front/back operations and indexed access where supported.
228228

229229
### Task 10: Heap
230230

0 commit comments

Comments
 (0)