Reworked notebook: Added more detail to constraints and test cases. Reworked algorithm discussion and unit test.

This commit is contained in:
Donne Martin
2015-06-26 05:06:11 -04:00
parent 5a93da3dda
commit 1278eefa7f

View File

@@ -13,22 +13,27 @@
"source": [ "source": [
"## Problem: Find the start of a linked list loop.\n", "## Problem: Find the start of a linked list loop.\n",
"\n", "\n",
"* [Clarifying Questions](#Clarifying-Questions)\n", "* [Constraints and Assumptions](#Constraints-and-Assumptions)\n",
"* [Test Cases](#Test-Cases)\n", "* [Test Cases](#Test-Cases)\n",
"* [Algorithm](#Algorithm)\n", "* [Algorithm](#Algorithm)\n",
"* [Code](#Code)" "* [Code](#Code)\n",
"* [Unit Test](#Unit-Test)"
] ]
}, },
{ {
"cell_type": "markdown", "cell_type": "markdown",
"metadata": {}, "metadata": {},
"source": [ "source": [
"## Clarifying Questions\n", "## Constraints and Assumptions\n",
"\n",
"*Problem statements are often intentionally ambiguous. Identifying constraints and stating assumptions can help to ensure you code the intended solution.*\n",
"\n", "\n",
"* This is a singly linked list?\n", "* This is a singly linked list?\n",
" * Yes\n", " * Yes\n",
"* Can we assume we are always passed a circular linked list?\n", "* Can we assume we are always passed a circular linked list?\n",
" * No" " * No\n",
"* Can we assume we already have a linked list class that can be used for this problem?\n",
" * Yes"
] ]
}, },
{ {
@@ -51,10 +56,10 @@
"source": [ "source": [
"## Algorithm\n", "## Algorithm\n",
"\n", "\n",
"* Check for an empty list\n",
"* Use two pointers i, j, initialized to the head\n", "* Use two pointers i, j, initialized to the head\n",
"* j is incremented twice as fast as i\n", "* Increment i and j until they meet\n",
" * If j's next is NULL, we do not have a circular list\n", " * j is incremented twice as fast as i\n",
" * If j's next is NULL, we do not have a circular list\n",
"* When i and j meet, move j to the head\n", "* When i and j meet, move j to the head\n",
"* Increment i and j one node at a time until they meet\n", "* Increment i and j one node at a time until they meet\n",
"* Where they meet is the start of the loop\n", "* Where they meet is the start of the loop\n",
@@ -73,7 +78,7 @@
}, },
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": null, "execution_count": 1,
"metadata": { "metadata": {
"collapsed": true "collapsed": true
}, },
@@ -84,7 +89,7 @@
}, },
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": null, "execution_count": 2,
"metadata": { "metadata": {
"collapsed": false "collapsed": false
}, },
@@ -98,65 +103,103 @@
" j = self.head\n", " j = self.head\n",
" i = i.next\n", " i = i.next\n",
" j = j.next.next\n", " j = j.next.next\n",
" \n",
" # Increment i and j until they meet\n",
" # j is incremented twice as fast as i\n",
" while j != i:\n", " while j != i:\n",
" i = i.next\n", " i = i.next\n",
" if j is None or j.next is None:\n", " if j is None or j.next is None:\n",
" return\n", " return\n",
" j = j.next.next\n", " j = j.next.next\n",
" \n",
" # When i and j meet, move j to the head\n",
" j = self.head\n", " j = self.head\n",
" \n",
" # Increment i and j one node at a time until \n",
" # they meet, which is the start of the loop\n",
" while j != i:\n", " while j != i:\n",
" i = i.next\n", " i = i.next\n",
" j = j.next\n", " j = j.next\n",
" return i.data" " return i.data"
] ]
}, },
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Unit Test"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"*It is important to identify and run through general and edge cases from the [Test Cases](#Test-Cases) section by hand. You generally will not be asked to write a unit test like what is shown below.*"
]
},
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": null, "execution_count": 3,
"metadata": { "metadata": {
"collapsed": false "collapsed": false
}, },
"outputs": [], "outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Test: Empty list\n",
"Test: Not a circular linked list: One element\n",
"Test: Not a circular linked list: Two elements\n",
"Test: Not a circular linked list: Three or more elements\n",
"Test: General case: Circular linked list\n",
"Success: test_find_loop_start\n"
]
}
],
"source": [ "source": [
"print('Empty list')\n", "from nose.tools import assert_equal\n",
"linked_list = MyLinkedList()\n", "\n",
"print(linked_list.find_loop_start())\n", "class Test(object):\n",
"print('Not a circular linked list')\n", " def test_find_loop_start(self):\n",
"print('One element')\n", " print('Test: Empty list')\n",
"head = Node(1)\n", " linked_list = MyLinkedList()\n",
"linked_list = MyLinkedList(head)\n", " assert_equal(linked_list.find_loop_start(), None)\n",
"print(linked_list.find_loop_start())\n", " \n",
"print('Two elements')\n", " print('Test: Not a circular linked list: One element')\n",
"linked_list.append(2)\n", " head = Node(1)\n",
"print(linked_list.find_loop_start())\n", " linked_list = MyLinkedList(head)\n",
"print('Three or more elements')\n", " assert_equal(linked_list.find_loop_start(), None)\n",
"linked_list.append(3)\n", " \n",
"print(linked_list.find_loop_start())\n", " print('Test: Not a circular linked list: Two elements')\n",
"print('General case')\n", " linked_list.append(2)\n",
"node0 = Node(0)\n", " assert_equal(linked_list.find_loop_start(), None)\n",
"node1 = Node(1)\n", " \n",
"node2 = Node(2)\n", " print('Test: Not a circular linked list: Three or more elements')\n",
"node3 = Node(3)\n", " linked_list.append(3)\n",
"node4 = Node(4)\n", " assert_equal(linked_list.find_loop_start(), None)\n",
"node5 = Node(5)\n", " \n",
"node6 = Node(6)\n", " print('Test: General case: Circular linked list')\n",
"node7 = Node(7)\n", " node10 = Node(10)\n",
"node8 = Node(8)\n", " node9 = Node(9, node10)\n",
"node9 = Node(9)\n", " node8 = Node(8, node9)\n",
"node10 = Node(10)\n", " node7 = Node(7, node8)\n",
"node0.next = node1\n", " node6 = Node(6, node7)\n",
"node1.next = node2\n", " node5 = Node(5, node6)\n",
"node2.next = node3\n", " node4 = Node(4, node5)\n",
"node3.next = node4\n", " node3 = Node(3, node4)\n",
"node4.next = node5\n", " node2 = Node(2, node3)\n",
"node5.next = node6\n", " node1 = Node(1, node2)\n",
"node6.next = node7\n", " node0 = Node(0, node1)\n",
"node7.next = node8\n", " node10.next = node3\n",
"node8.next = node9\n", " linked_list = MyLinkedList(node0)\n",
"node9.next = node10\n", " assert_equal(linked_list.find_loop_start(), 3)\n",
"node10.next = node3\n", " \n",
"linked_list = MyLinkedList(node0)\n", " print('Success: test_find_loop_start')\n",
"print(linked_list.find_loop_start())" "\n",
"if __name__ == '__main__':\n",
" test = Test()\n",
" test.test_find_loop_start()"
] ]
} }
], ],