Tags

  • AWS (7)
  • Apigee (3)
  • ArchLinux (5)
  • Array (6)
  • Backtracking (6)
  • BinarySearch (6)
  • C++ (19)
  • CI&CD (3)
  • Calculus (2)
  • DesignPattern (43)
  • DisasterRecovery (1)
  • Docker (8)
  • DynamicProgramming (20)
  • FileSystem (11)
  • Frontend (2)
  • FunctionalProgramming (1)
  • GCP (1)
  • Gentoo (6)
  • Git (15)
  • Golang (1)
  • Graph (10)
  • GraphQL (1)
  • Hardware (1)
  • Hash (1)
  • Kafka (1)
  • LinkedList (13)
  • Linux (27)
  • Lodash (2)
  • MacOS (3)
  • Makefile (1)
  • Map (5)
  • MathHistory (1)
  • MySQL (21)
  • Neovim (10)
  • Network (66)
  • Nginx (6)
  • Node.js (33)
  • OpenGL (6)
  • PriorityQueue (1)
  • ProgrammingLanguage (9)
  • Python (10)
  • RealAnalysis (20)
  • Recursion (3)
  • Redis (1)
  • RegularExpression (1)
  • Ruby (19)
  • SQLite (1)
  • Sentry (3)
  • Set (4)
  • Shell (3)
  • SoftwareEngineering (12)
  • Sorting (2)
  • Stack (4)
  • String (2)
  • SystemDesign (13)
  • Terraform (2)
  • Tree (24)
  • Trie (2)
  • TwoPointers (16)
  • TypeScript (3)
  • Ubuntu (4)
  • Home

    [Behavioral] Iterator

    Published Apr 12, 2022 [  DesignPattern  ]

    Real world example

    An old radio set will be a good example of iterator, where user could start at some channel and then use next or previous buttons to go through the respective channels. Or take an example of MP3 player or a TV set where you could press the next and previous buttons to go through the consecutive channels or in other words they all provide an interface to iterate through the respective channels, songs or radio stations.

    In plain words

    It presents a way to access the elements of an object without exposing the underlying presentation.

    Wikipedia says

    In object-oriented programming, the iterator pattern is a design pattern in which an iterator is used to traverse a container and access the container’s elements. The iterator pattern decouples algorithms from containers; in some cases, algorithms are necessarily container-specific and thus cannot be decoupled.

    Programmatic example

    First of all we have RadioStation

    export class RadioStation {
        protected frequency
    
        constructor(frquency: number) {
            this.frequency = frquency
        }
    
        getFrequency(): number {
            return this.frequency
        }
    }
    

    Then we have our iterator

    export class StationList implements IterableIterator<RadioStation> {
        protected pointer: number = 0;
        protected stations: RadioStation[] = [];
    
        addStation(station: RadioStation) {
            this.stations.push(station)
        }
    
        next(): IteratorResult<RadioStation>{
            if(this.pointer < this.stations.length) {
                return {
                    done: false,
                    value: this.stations[this.pointer++]
                }
            } else {
                return {
                    done: true,
                    value: null
                }
            }
        }
    
        [Symbol.iterator](): IterableIterator<RadioStation>{
            return this;
        }
    }
    

    And then it can be used as

    test('IterableIterator next() interface', () => {
        const stationList = new StationList()
        const res = [89, 101, 102, 103.2];
        for(let value of res) {
            stationList.addStation(new RadioStation(value))
        }
    
        let count = 0;
        while(true){
            let station = stationList.next();
            if(station.done){
                break
            }
            expect(station.value.frequency).toEqual(res[count++])
        }
    })
    
    test('IterableIterator let...of interface', () => {
        const stationList = new StationList()
        const res = [89, 101, 102, 103.2];
        for(let value of res) {
            stationList.addStation(new RadioStation(value))
        }
    
        let count = 0;
        for(let station of stationList){
            expect(station.getFrequency()).toEqual(res[count++]);
        }
    })
    

    References