Why Iterator pattern in LLD? - Purpose & Use Cases

The Big Idea

What if you could flip through any collection like turning pages in a book, without losing your place or missing a page?

The Scenario

Imagine you have a big box full of different toys mixed together. You want to look at each toy one by one to decide which to play with. Without a plan, you might have to dig through the box randomly, making a mess and losing track of what you already checked.

The Problem

Going through the toys manually is slow and confusing. You might check the same toy twice or miss some. It's easy to get lost or frustrated because there's no clear way to move from one toy to the next.

The Solution

The Iterator pattern gives you a simple tool to look at each toy in order, one at a time, without worrying about how the toys are stored. It keeps track of where you are and lets you move forward smoothly.

Before vs After

✗ Before

for i in range(len(collection)):
    item = collection[i]
    process(item)

✓ After

iterator = collection.get_iterator()
while iterator.has_next():
    item = iterator.next()
    process(item)

What It Enables

It lets you explore any collection easily and safely, no matter how complex, making your code cleaner and more flexible.

Real Life Example

Think of a music playlist app that plays songs one by one. The Iterator pattern helps the app move from the current song to the next without worrying about how the playlist is organized.

Key Takeaways

Manual navigation through collections is error-prone and messy.

Iterator pattern provides a clean way to access elements sequentially.

It separates the way you access items from how they are stored.

Practice

1.

What is the main purpose of the Iterator pattern in system design?

easy

A. To manage user authentication and authorization

B. To store data in a database efficiently

C. To create multiple copies of an object

D. To provide a way to access elements of a collection sequentially without exposing its underlying structure

Solution

1. Step 1: Understand the role of Iterator pattern

   The Iterator pattern is designed to provide a way to access elements of a collection one by one without revealing the internal structure of the collection.

2. Step 2: Compare with other options

   Options B, C, and D describe unrelated design patterns or system functions such as data storage, object cloning, and security management.

3. Final Answer:

   To provide a way to access elements of a collection sequentially without exposing its underlying structure -> Option D

4. Quick Check:

   Iterator pattern = Access collection without exposing structure [OK]

Hint: Iterator = access elements without showing internal details [OK]

Common Mistakes:

• Confusing Iterator with data storage or cloning patterns
• Thinking Iterator manages security or authentication
• Assuming Iterator modifies the collection

2.

Which of the following is the correct method signature for the next() method in an iterator interface?

easy

A. def next() -> void

B. def next(self, index) -> Element

C. def next(self) -> Element

D. def next(self, element) -> bool

Solution

1. Step 1: Recall the standard iterator method signature

   The next() method typically takes no parameters except the implicit self and returns the next element in the collection.

2. Step 2: Analyze each option

   def next(self) -> Element matches the standard signature: it takes self and returns an element. Options B and D incorrectly add parameters, and C returns void which is incorrect.

3. Final Answer:

   def next(self) -> Element -> Option C

4. Quick Check:

   next() takes no args, returns element [OK]

Hint: next() returns next element, no extra parameters [OK]

Common Mistakes:

• Adding parameters to next() method
• Returning void instead of element
• Confusing next() with hasNext() method

3.

Consider the following Python code implementing a simple iterator:

class MyIterator:
    def __init__(self, data):
        self.data = data
        self.index = 0
    def __iter__(self):
        return self
    def __next__(self):
        if self.index < len(self.data):
            result = self.data[self.index]
            self.index += 1
            return result
        else:
            raise StopIteration

it = MyIterator([10, 20, 30])
print(next(it))
print(next(it))

What will be the output?

medium

A. 20\n30

B. 10\n20

C. 10\n30

D. Error at runtime

Solution

1. Step 1: Trace the iterator's next calls

   First call to next(it) returns data[0] = 10 and increments index to 1. Second call returns data[1] = 20 and increments index to 2.

2. Step 2: Confirm no errors occur

   Since index is less than length during both calls, no StopIteration is raised.

3. Final Answer:

   10 20 -> Option B

4. Quick Check:

   First two elements printed: 10 and 20 [OK]

Hint: next() returns elements in order, increments index [OK]

Common Mistakes:

• Assuming next() skips elements
• Expecting error before StopIteration
• Mixing up index increments

4.

Given this iterator implementation in Python, identify the bug:

class BuggyIterator:
    def __init__(self, data):
        self.data = data
        self.index = 0
    def __iter__(self):
        return self
    def __next__(self):
        if self.index <= len(self.data):
            result = self.data[self.index]
            self.index += 1
            return result
        else:
            raise StopIteration

What is the cause of the error when iterating?

medium

A. IndexError due to accessing out-of-range element

B. StopIteration raised too early

C. Infinite loop because index never increments

D. Syntax error in method definitions

Solution

1. Step 1: Analyze the condition in __next__

   The condition uses <= len(self.data), which allows index to equal length, causing out-of-range access.

2. Step 2: Understand the error caused

   Accessing self.data[self.index] when index == len(self.data) causes IndexError because list indices go from 0 to len-1.

3. Final Answer:

   IndexError due to accessing out-of-range element -> Option A

4. Quick Check:

   Condition allows index == length causing IndexError [OK]

Hint: Use < not <= to avoid out-of-range errors [OK]

Common Mistakes:

• Using <= instead of < in boundary check
• Assuming StopIteration triggers before error
• Ignoring index increment effects

5.

You need to design an iterator for a complex data structure that contains nested lists of integers. Which approach best follows the Iterator pattern principles to allow clients to iterate over all integers seamlessly?

1. Flatten the nested lists into a single list before iteration.
2. Implement a recursive iterator that yields integers from nested lists on demand.
3. Expose the internal nested list structure and let clients handle iteration.
4. Provide separate iterators for each nested list and require clients to manage them.

hard

A. Implement a recursive iterator that yields integers from nested lists on demand

B. Flatten the nested lists into a single list before iteration

C. Expose the internal nested list structure and let clients handle iteration

D. Provide separate iterators for each nested list and require clients to manage them

Solution

1. Step 1: Understand Iterator pattern goal

   The pattern aims to hide internal structure and provide a simple way to access elements sequentially.

2. Step 2: Evaluate each approach

   Flatten the nested lists into a single list before iteration flattens data upfront, which may be inefficient and breaks lazy access. Implement a recursive iterator that yields integers from nested lists on demand uses a recursive iterator to yield elements on demand, hiding complexity and supporting lazy iteration. Options C and D expose internal structure or complexity to clients, violating encapsulation.

3. Final Answer:

   Implement a recursive iterator that yields integers from nested lists on demand -> Option A

4. Quick Check:

   Recursive iterator hides structure, yields elements lazily [OK]

Hint: Use recursive iterator to hide nested structure [OK]

Common Mistakes:

• Flattening data upfront losing lazy iteration benefits
• Exposing internal structure breaking encapsulation
• Forcing clients to manage multiple iterators