From b2ef42afec0a664a7c61a4d5a61aef23860d9b65 Mon Sep 17 00:00:00 2001
From: Cédric Bonhomme <kimble.mandel@gmail.com>
Date: Mon, 18 Mar 2013 21:46:44 +0100
Subject: Updated comments in binary tree.py.

---
 source/binarytree.py | 62 +++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 44 insertions(+), 18 deletions(-)

(limited to 'source')

diff --git a/source/binarytree.py b/source/binarytree.py
index a83016e0..036e89ba 100644
--- a/source/binarytree.py
+++ b/source/binarytree.py
@@ -1,26 +1,40 @@
-# -*- coding: utf-8 -*-
+#! /usr/bin/env python
+#-*- coding: utf-8 -*-
+
 # A binary ordered tree example
 
 class CNode(object):
-    left , right, data = None, None, 0
-
+    """
+    Represent a node.
+    """
     def __init__(self, data):
-        # initializes the data members
+        """
+        Initialization.
+        """
         self.left = None
         self.right = None
         self.data = data
 
 class CBOrdTree(object):
+    """
+    Represent a binary ordered tree.
+    """
     def __init__(self):
-        # initializes the root member
+        """
+        Initializes the root member.
+        """
         self.root = None
 
     def addNode(self, data):
-        # creates a new node and returns it
+        """
+        Creates a new node and returns it.
+        """
         return CNode(data)
 
     def insert(self, root, data):
-        # inserts a new data
+        """
+        Inserts a new data.
+        """
         if root == None:
             # it there isn't any data
             # adds it and returns
@@ -37,7 +51,9 @@ class CBOrdTree(object):
             return root
 
     def lookup(self, root, target):
-        # looks for a value into the tree
+        """
+        Looks for a value into the tree.
+        """
         if root == None:
             return 0
         else:
@@ -53,20 +69,27 @@ class CBOrdTree(object):
                     return self.lookup(root.right, target)
 
     def minValue(self, root):
-        # goes down into the left
-        # arm and returns the last value
+        """
+        Goes down into the left
+        arm and returns the last value.
+        """
         while(root.left != None):
             root = root.left
         return root.data
 
     def maxValue(self, root):
-        # goes down into the left
-        # arm and returns the last value
+        """
+        Goes down into the right
+        arm and returns the last value.
+        """
         while(root.right != None):
             root = root.right
         return root.data
 
     def maxDepth(self, root):
+        """
+        Return the maximum depth.
+        """
         if root == None:
             return 0
         else:
@@ -83,7 +106,9 @@ class CBOrdTree(object):
             return self.size(root.left) + 1 + self.size(root.right)
 
     def printTree(self, root):
-        # prints the tree path
+        """
+        Prints the tree path.
+        """
         if root == None:
             pass
         else:
@@ -92,8 +117,9 @@ class CBOrdTree(object):
             self.printTree(root.right)
 
     def printRevTree(self, root):
-        # prints the tree path in reverse
-        # order
+        """
+        Prints the tree path in reverse order.
+        """
         if root == None:
             pass
         else:
@@ -102,6 +128,7 @@ class CBOrdTree(object):
             self.printRevTree(root.left)
 
 if __name__ == "__main__":
+    # Point of entry in execution mode.
     # create the binary tree
     BTree = CBOrdTree()
     # add the root node
@@ -111,13 +138,12 @@ if __name__ == "__main__":
         data = int(input("insert the node value nr %d: " % i))
         # insert values
         BTree.insert(root, data)
-    print()
 
     BTree.printTree(root)
     print()
     BTree.printRevTree(root)
     print()
-    data = int(input("insert a value to find: "))
+    data = int(input("Insert a value to find: "))
     if BTree.lookup(root, data):
         print("found")
     else:
@@ -125,4 +151,4 @@ if __name__ == "__main__":
 
     print(BTree.minValue(root))
     print(BTree.maxDepth(root))
-    print(BTree.size(root))
\ No newline at end of file
+    print(BTree.size(root))
-- 
cgit