代码注释：机器学习实战第12章 使用FP-growth算法来高效发现频繁项集

写在开头的话：在学习《机器学习实战》的过程中发现书中很多代码并没有注释，这对新入门的同学是一个挑战，特此贴出我对代码做出的注释，仅供参考，欢迎指正。

#coding:gbk

#作用：FP树中节点的类定义
#输入：无
#输出：无
class treeNode:
    def __init__(self, nameValue, numOccur, parentNode):
        self.name = nameValue
        self.count = numOccur
        self.nodeLink = None
        self.parent = parentNode
        self.children = {}

    #对count变量增加给定值
    def inc(self, numOccur):
        self.count += numOccur

    #用于将树以文本形式显示
    def disp(self, ind = 1):
        print ' ' * ind, self.name, ' ', self.count
        #字典的.values()表示以列表的形式返回字典中的值
        for child in self.children.values():
            child.disp(ind + 1)

#作用：导入数据集
#输入：无
#输出：数据集
def loadSimpDat():
    simpDat = [['r', 'z', 'h', 'j', 'p'],
               ['z', 'y', 'x', 'w', 'v', 'u', 't', 's'],
               ['z'],
               ['r', 'x', 'n', 'o', 's'],
               #['r', 'x', 'n', 'o', 's'],
               ['y', 'r', 'x', 'z', 'q', 't', 'p'],
               ['y', 'z', 'x', 'e', 'q', 's', 't', 'm']]
    return simpDat


#作用：对数据库进行格式化处理
#输入：数据集
#输出：格式化处理的数据集
def createInitSet(dataSet):
    retDict = {}
    #好好理解这句话：假设有集合{z,x,y}和{y,z,x}，那么在FP树中，相同项会只表示一次
    #因此第一先用字典表示，不是 += 1，是 = 1。在createTree()中也会对元素进行排序
    for trans in dataSet:
        retDict[frozenset(trans)] = 1
    return retDict

#作用：创建FP树
#输入：数据集，最小支持度
#输出：树，头指针表
def createTree(dataSet, minSup = 1):
    headerTable = {}#头指针表
    #统计每个元素项出现的频度，存储在头指针表中
    for trans in dataSet:
        for item in trans:
            #get方法是个更宽松的访问字典项的方法。一般来说，如果试图访问字典中不存在的项时会出错。
            #而用get就不会，当使用get访问一个不存在的键时，没有任何异常，而得到了None值。
            #在这个方法里还是很实用的，因为第一次创建键-值时是不希望出错的
            headerTable[item] = headerTable.get(item, 0) + dataSet[trans]
    #移除不满足最小支持度的元素项
    for k in headerTable.keys():
        if headerTable[k]< minSup:
            del(headerTable[k])
    #创建集合用于存储所有符合要求的元素项
    freqItemSet = set(headerTable.keys())
    #如果没有元素项满足要求，则退出
    if len(freqItemSet) == 0:
        return None, None
    for k in headerTable:
        headerTable[k] = [headerTable[k], None]
    retTree = treeNode('Null Set', 1, None)#创建只包含空集合的根节点
    #对每个事务构建FP树
    for tranSet, count in dataSet.items():
        localD = {}#使用loacalD记录每类元素的总数
        for item in tranSet:
            if item in freqItemSet:#
                localD[item] = headerTable[item][0]
        #print localD
        if len(localD) > 0:
            #根据全局频率对每个事务中的元素进行排序
            orderedItems = [v[0] for v in sorted(localD.items(), key = lambda  p: p[1], reverse = True)]
            #print orderedItems
            #使用排序后的频率项集对树进行填充
            updateTree(orderedItems, retTree, headerTable, count)
    return retTree, headerTable

#作用：更新FP树
#输入：项集，树，头指针表，计数
#输出：无
def updateTree(items, inTree, headerTable, count):
    # 测试事务中的第一个元素项是否作为子节点存在
    if items[0] in inTree.children:#如果存在的话，则更新该元素项的计数
        inTree.children[items[0]].inc(count)
    else:#如果不存在，则创建一个新的treeNode并将其作为一个子节点添加到树中
        inTree.children[items[0]] = treeNode(items[0], count, inTree)
        #确保节点链接指向树中该元素项的每一个实例
        if headerTable[items[0]][1] == None:
            headerTable[items[0]][1] = inTree.children[items[0]]
        else:
            updateHeader(headerTable[items[0]][1], inTree.children[items[0]])
    #对剩下的元素项迭代调用updateTree函数
    if len(items) > 1:
        updateTree(items[1::], inTree.children[items[0]], headerTable, count)

#作用：确保节点链接指向树中该元素项的每一个实例
#输入：头节点，目标节点
#输出：无
def updateHeader(nodeToTest, targetNode):
    while (nodeToTest.nodeLink != None):
        nodeToTest = nodeToTest.nodeLink
    nodeToTest.nodeLink = targetNode

#作用：上溯FP树
#输入：节点，记录父节点名称列表
#输出：无
def ascendTree(leafNode, prefixPath):
    #if (leafNode.parent != None) | (leafNode.name == 'Null Set'):
    if leafNode.parent != None:
        prefixPath.append(leafNode.name)
        ascendTree(leafNode.parent, prefixPath)

#作用：为给定元素项生成一个条件模式基
#输入：给定元素项，节点
#输出：条件模式基字典
def findPrefixPath(basePat, treeNode):
    condPats = {}#条件模式基字典
    while treeNode != None:
        prefixPath = []#记录basePat父节点的名称
        ascendTree(treeNode, prefixPath)#计算它的父节点
        if len(prefixPath) > 1:#第一项为treeNode本身，第二项才是它的父节点
            condPats[frozenset(prefixPath[1:])] = treeNode.count
        treeNode = treeNode.nodeLink#节点链接的下一个节点
    return condPats

def mineTree(inTree, headerTable, minSup, preFix, freqItemList):
    #从头指针表的底端开始，sorted()顺序是按照从小到大
    bigL = [v[0] for v in sorted(headerTable.items(), key = lambda p: p[1])]
    #对每一个元素项
    for basePat in bigL:
        #print 'basePat', basePat
        #print 'preFix', preFix
        #通过.copy()函数可以保证headerTable的传递
        newFreqSet = preFix.copy()
        newFreqSet.add(basePat)
        freqItemList.append(newFreqSet)
        condPattBases = findPrefixPath(basePat, headerTable[basePat][1])#为给定元素项生成一个条件模式基
        #从条件模式基来构建条件FP树
        myCondTree, myHead = createTree(condPattBases, minSup)
        #如果树中有元素项的话，递归调用mineTree()函数
        if myHead != None:
            #print 'conditional tree for: ', newFreqSet
            #myCondTree.disp(1)
            mineTree(myCondTree, myHead, minSup, newFreqSet, freqItemList)