Coursera Algorithms Programming Assignment 2: Deque and Randomized Queue （100分）

作業原文：http://coursera.cs.princeton.edu/algs4/assignments/queues.html

這次作業與第一周作業相比，稍微簡單一些。有三個編程練習：雙端隊列（Deque）設計、隨機隊列（Randomized Queue）設計，還有一個排列組合類Permutation。

一、雙端隊列Deque

設計要求：A double-ended queue or deque (pronounced "deck") is a generalization of a stack and a queue that supports adding and removing items from either the front or the back of the data structure.

異常處理要求：Throw a java.lang.IllegalArgumentException if the client attempts to add a null item; throw a java.util.NoSuchElementException if the client attempts to remove an item from an empty deque; throw a java.lang.UnsupportedOperationException if the client calls the remove() method in the iterator; throw a java.util.NoSuchElementException if the client calls the next() method in the iterator and there are no more items to return.

性能要求：Your deque implementation must support each deque operation (including construction) in constant worst-case time. A deque containing n items must use at most 48n + 192 bytes of memory and use space proportional to the number of items currently in the deque. Additionally, your iterator implementation must support each operation (including construction) in constant worst-case time.

分析：

要求可以同時從頭尾移除元素，那么該隊列內部采用鏈表更合適，代碼如下

import java.util.Iterator;
import java.util.NoSuchElementException;

public class Deque<Item> implements Iterable<Item> {
    private Node first; // 8 bytes
    private Node last; // 8 bytes
    private int size; // 4 bytes

    private class Node { // 16字節對象開銷+8字節內部類額外開銷+8+8+8=48 bytes, n個節點就是48n bytes
        private Node preNode; // 前一個節點的引用
        private Item item;
        private Node nextNode; // 后一個節點的引用
    }

    private class ListIterator implements Iterator<Item> { 
        // 16字節對象開銷+8字節內部類額外開銷+8=32 bytes
        private Node curr = first;

        @Override
        public boolean hasNext() {
            // TODO Auto-generated method stub
            return curr != null;
        }

        @Override
        public Item next() {
            // TODO Auto-generated method stub
            if (curr == null)
                throw new NoSuchElementException("there are no more items!");
            Item item = curr.item;
            curr = curr.nextNode;
            return item;
        }
        //remove不用設計，父類Iterator的remove方法就拋出UnsupportedOperationException("remove");
    }

    public Deque() {
        // construct an empty deque
        size = 0;
        first = null;
        last = null;
    }

    public boolean isEmpty() {
        // is the deque empty?
        return (size == 0);
    }

    public int size() {
        // return the number of items on the deque
        return size;
    }

    public void addFirst(Item item) {
        // add the item to the front
        valivate(item);
        Node newNode = new Node();
        newNode.item = item;
        if (size == 0) { // 空隊列的情況
            newNode.preNode = null;
            newNode.nextNode = null;
            first = newNode;
            last = newNode;
        } else {
            newNode.preNode = null;
            newNode.nextNode = first;
            first.preNode = newNode;
            first = newNode;
        }
        size++;
    }

    public void addLast(Item item) {
        // add the item to the end
        valivate(item);
        Node newNode = new Node();
        newNode.item = item;
        if (size == 0) { // 空隊列的情況
            newNode.preNode = null;
            newNode.nextNode = null;
            first = newNode;
            last = newNode;
        } else {
            last.nextNode = newNode;
            newNode.preNode = last;
            newNode.nextNode = null;
            last = newNode;
        }
        size++;
    }

    public Item removeFirst() {
        // remove and return the item from the front
        if (size == 0)
            throw new NoSuchElementException("the deque is empty!");
        Item returnItem = null;
        if (size == 1) {
            returnItem = first.item;
            first = null;
            last = null;
        } else {
            Node oldfirst = first;
            returnItem = oldfirst.item;
            first = oldfirst.nextNode;
            first.preNode = null;
            oldfirst.nextNode = null;
            oldfirst.item = null;
        }
        size--;
        return returnItem;
    }

    public Item removeLast() {
        // remove and return the item from the end
        if (size == 0)
            throw new NoSuchElementException("the deque is empty!");
        Item returnItem = null;
        if (size == 1) {
            returnItem = first.item;
            first = null;
            last = null;
        } else {
            Node oldlast = last;
            returnItem = oldlast.item;
            last = oldlast.preNode;
            last.nextNode = null;
            oldlast.preNode = null;
            oldlast.item = null;
        }
        size--;
        return returnItem;
    }

    public Iterator<Item> iterator() {
        // return an iterator over items in order from front to end
        return new ListIterator();
    }

    private void valivate(Item item) {
        if (item == null)
            throw new IllegalArgumentException("the item is null!");
    }

    public static void main(String[] args) {
        // unit testing (optional)
        Deque<String> queue = new Deque<String>();
        System.out.println(queue.size);
        queue.addFirst("a");
        queue.addFirst("b");
        queue.addLast("c");
        queue.addFirst("d");
        queue.addLast("e");
        System.out.println(queue.size);
        Iterator<String> iter = queue.iterator();
        while (iter.hasNext()) {
            System.out.println(iter.next());
        }
    }
}

二、隨機隊列Randomized Queue

設計要求：A randomized queue is similar to a stack or queue, except that the item removed is chosen uniformly at random from items in the data structure.

異常處理：The order of two or more iterators to the same randomized queue must be mutually independent; each iterator must maintain its own random order. Throw a java.lang.IllegalArgumentException if the client attempts to add a null item; throw a java.util.NoSuchElementException if the client attempts to sample or dequeue an item from an empty randomized queue; throw a java.lang.UnsupportedOperationException if the client calls the remove() method in the iterator; throw a java.util.NoSuchElementException if the client calls the next() method in the iterator and there are no more items to return.

性能要求： Your randomized queue implementation must support each randomized queue operation (besides creating an iterator) in constant amortized time. That is, any sequence of m randomized queue operations (starting from an empty queue) should take at most cm steps in the worst case, for some constant c. A randomized queue containing n items must use at most 48n + 192 bytes of memory. Additionally, your iterator implementation must support operations next() and hasNext() in constant worst-case time; and construction in linear time; you may (and will need to) use a linear amount of extra memory per iterator.

分析：

該隊列每次移除的元素是隨機的，性能要求提到迭代器的next方法必須是常數時間，很容易發現鏈表不容易滿足該需求，需要用數組，代碼如下：

import java.util.Iterator;
import java.util.NoSuchElementException;
import edu.princeton.cs.algs4.StdRandom;

public class RandomizedQueue<Item> implements Iterable<Item> {
    private Item[] rqArrays;
    private int size;

    private class RandomIterator implements Iterator<Item> {
        private int rank; // rank 記錄便利的次數
        private Item[] iterArrays; //兩個迭代器必須相互獨立，並且擁有自己的隨機順序
        
        public RandomIterator(){
            rank = size;
            iterArrays = (Item[]) new Object[rank];
            for(int i = 0; i<size; i++){
                iterArrays[i] = rqArrays[i];
            }
        }
        @Override
        public boolean hasNext() {
            // TODO Auto-generated method stub
            return (rank > 0);
        }
        @Override
        public Item next() {
            // TODO Auto-generated method stub
            if (rank == 0)
                throw new NoSuchElementException("there are no more items!");
            int r = StdRandom.uniform(0, rank); // 隨機選取一個位置的元素返回
            rank--;
            Item item = iterArrays[r];
            iterArrays[r] = iterArrays[rank];
            iterArrays[rank] = item; // 將已經遍歷過的元素放置隊列末尾，這樣下次迭代就不會被選到
            return item;
        }
    }

    public RandomizedQueue() {
        // construct an empty randomized queue
        rqArrays = (Item[]) new Object[1];
        size = 0;
    }

    private void valivate(Item item) {
        if (item == null)
            throw new IllegalArgumentException("the item is null!");
    }

    public boolean isEmpty() {
        // is the queue empty?
        return (size == 0);
    }

    public int size() {
        // return the number of items on the queue
        return size;
    }

    private void resize(int cap) {
        Item[] temp = (Item[]) new Object[cap];
        for (int i = 0; i < size; i++)
            temp[i] = rqArrays[i];
        rqArrays = temp;
    }

    public void enqueue(Item item) {
        // add the item
        valivate(item);
        rqArrays[size++] = item;
        if (size == rqArrays.length)
            resize(2 * rqArrays.length);
    }

    public Item dequeue() {
        // remove and return a random item
        // 隨機選取一個位置，將這個位置的元素與隊列末尾的元素交換位置
        // dequeue末尾元素時就達到隨機remove元素的目的
        if (size == 0)
            throw new NoSuchElementException("the RandomizeQueue is empty!");
        int r = StdRandom.uniform(0, size);
        size--;
        Item delItem = rqArrays[r];
        rqArrays[r] = rqArrays[size];
        rqArrays[size] = null;
        if (size > 0 && size == rqArrays.length / 4)
            resize(rqArrays.length / 2);
        return delItem;
    }

    public Item sample() {
        // return (but do not remove) a random item
        if (size == 0)
            throw new NoSuchElementException("the RandomizeQueue is empty!");
        return rqArrays[StdRandom.uniform(0, size)];
    }

    public Iterator<Item> iterator() {
        // return an independent iterator over items in random order
        return new RandomIterator();
    }

    public static void main(String[] args) {
        // unit testing (optional)
        RandomizedQueue<String> rq = new RandomizedQueue<String>();
        rq.enqueue("a");
        rq.enqueue("b");
        rq.enqueue("c");
        rq.enqueue("d");
        rq.enqueue("e");
        rq.enqueue("f");
        rq.enqueue("g");
        rq.dequeue();
        Iterator<String> iter1 = rq.iterator();
        Iterator<String> iter2 = rq.iterator();
        while (iter1.hasNext()) {
            System.out.print(iter1.next() + ",");
        }
        System.out.println();
        while (iter2.hasNext()) {
            System.out.print(iter2.next() + ",");
        }
        System.out.println();

    }
}

三、 排列組合類Permutation

設計要求：Write a client program Permutation.java that takes a command-line integer k; reads in a sequence of strings from standard input using StdIn.readString(); and prints exactly k of them, uniformly at random. Print each item from the sequence at most once.

性能要求：The running time of Permutation must be linear in the size of the input. You may use only a constant amount of memory plus either one Deque or RandomizedQueue object of maximum size at most n. (For an extra challenge, use only one Deque or RandomizedQueue object of maximum size at most k.)

輸出示例：

分析：

顯然Permutation要做的事情就是讀取一個k，並且從加載的輸入文件內容中選取k個String進行展示，故采用RandomizedQueue比較合適。將文件中所有String都放入RandomizedQueue的話其size就是n，如果只放入k個String的話，RandomizedQueue的size就會是k，目前我只實現了size==n的方法，作業提交得分100。size==k的方法需要再斟酌下，若有進展，及時更新。

import edu.princeton.cs.algs4.StdIn;

public class Permutation {
    public static void main(String[] args) {
        RandomizedQueue<String> rq = new RandomizedQueue<String>();
        int k = Integer.parseInt(args[0]);
        while (!StdIn.isEmpty()) {
            rq.enqueue(StdIn.readString());
            // System.out.println(StdIn.readString());
        }
        while (k > 0) {
            System.out.println(rq.dequeue());
            k--;
        }
    }
}