gramps/src/Lru.py

180 lines
4.9 KiB
Python
Raw Normal View History

2011-10-19 02:20:36 +05:30
#
# Gramps - a GTK+/GNOME based genealogy program
#
2006-10-30 09:39:43 +05:30
# This file is derived from the GPL program "PyPE"
#
# Copyright (C) 2003-2006 Josiah Carlson
# Copyright (C) 2009 Gary Burton
2006-10-30 09:39:43 +05:30
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
2011-10-19 02:29:32 +05:30
# $Id$
2006-10-30 09:39:43 +05:30
"""
Least recently used algorithm
"""
class Node(object):
"""
Node to be stored in the LRU structure
"""
def __init__(self, prev, value):
2006-10-30 09:39:43 +05:30
self.prev = prev
self.value = value
2006-10-30 09:39:43 +05:30
self.next = None
class LRU(object):
"""
Implementation of a length-limited O(1) LRU cache
"""
2006-10-30 09:39:43 +05:30
def __init__(self, count):
self.count = max(count, 2)
self.data = {}
2006-10-30 09:39:43 +05:30
self.first = None
self.last = None
def __contains__(self, obj):
"""
Return True if the object is contained in the LRU
"""
return obj in self.data
2006-10-30 09:39:43 +05:30
def __getitem__(self, obj):
"""
2009-08-09 22:39:32 +05:30
Return item associated with Obj
"""
return self.data[obj].value[1]
2006-10-30 09:39:43 +05:30
def __setitem__(self, obj, val):
"""
Set the item in the LRU, removing an old entry if needed
"""
if obj in self.data:
2006-10-30 09:39:43 +05:30
del self[obj]
nobj = Node(self.last, (obj, val))
if self.first is None:
self.first = nobj
if self.last:
self.last.next = nobj
self.last = nobj
self.data[obj] = nobj
if len(self.data) > self.count:
2006-10-30 09:39:43 +05:30
if self.first == self.last:
self.first = None
self.last = None
return
lnk = self.first
lnk.next.prev = None
self.first = lnk.next
lnk.next = None
if lnk.value[0] in self.data:
del self.data[lnk.value[0]]
del lnk
2006-10-30 09:39:43 +05:30
def __delitem__(self, obj):
"""
Delete the object from the LRU
"""
nobj = self.data[obj]
2006-10-30 09:39:43 +05:30
if nobj.prev:
nobj.prev.next = nobj.next
else:
self.first = nobj.next
if nobj.next:
nobj.next.prev = nobj.prev
else:
self.last = nobj.prev
del self.data[obj]
2006-10-30 09:39:43 +05:30
def __iter__(self):
"""
Iterate over the LRU
"""
2006-10-30 09:39:43 +05:30
cur = self.first
while cur is not None:
2006-10-30 09:39:43 +05:30
cur2 = cur.next
yield cur.value[1]
2006-10-30 09:39:43 +05:30
cur = cur2
raise StopIteration
def iteritems(self):
"""
Return items in the LRU using a generator
"""
2006-10-30 09:39:43 +05:30
cur = self.first
while cur is not None:
2006-10-30 09:39:43 +05:30
cur2 = cur.next
yield cur.value
2006-10-30 09:39:43 +05:30
cur = cur2
raise StopIteration
def iterkeys(self):
"""
Return keys in the LRU using a generator
"""
return iter(self.data)
2006-10-30 09:39:43 +05:30
def itervalues(self):
"""
Return items and keys in the LRU using a generator
"""
for data in self.iteritems():
yield data[1]
2006-10-30 09:39:43 +05:30
def keys(self):
"""
Return all keys
"""
return [data[0] for data in self.iteritems()]
2006-10-30 09:39:43 +05:30
def values(self):
"""
Return all values
"""
return [data[1] for data in self.iteritems()]
2006-10-30 09:39:43 +05:30
def items(self):
"""
Return all items
"""
return [data[0] for data in self.iteritems()]
def clear(self):
"""
Empties LRU
"""
# Step through the doubly linked list, setting prev and next to None.
# This ensures that each node is unreachable and therefore eligible for
# garbage collection. "del" is also called for each node, but it is
# unclear whether this actually has any effect, of just removes the
# binding to nobj
nobj = self.first
# The references first and last are removed so that the nodes are not
# reachable from these
self.first = None
self.last = None
# The references from self.data are removed
self.data.clear()
while nobj is not None and nobj.next is not None:
# each node except the last is processed
nobj.next.prev = None
nextobj = nobj.next
nobj.next = None
del nobj
nobj = nextobj
if nobj is not None:
# The last node is processed
del nobj