代碼註釋：機器學習實戰第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)