Package schrodinger :: Package application :: Package desmond :: Module fepdiff :: Class ConstraintTupleDict
[hide private]
[frames] | no frames]

Class ConstraintTupleDict

object --+            
         |            
      dict --+        
             |        
     IndexDict --+    
                 |    
         TupleDict --+
                     |
                    ConstraintTupleDict

A dictionary class that uses tuple as its key. For the key used in ConstraintTupleDict, the trailing zeros in the tuple are useless. For two equivalent keys. The first element of the tuple must be equal to each other. And the order from second element to the last none-zero element does not matter as long as all of the elements are the same. For instance, (1, 2, 3, 4, 0, 0), (1, 3, 2, 4, 0, 0) and (1, 4, 3, 2, 0, 0) are the same. However, (1, 2, 3, 4, 0, 0) is not the same as (2, 2, 3, 4, 0, 0)

Instance Methods [hide private]
new empty dictionary

__init__(self, *args, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature
 
_reorder(self, key)
Reorder the key and return it as a tuple If first lement is greater than last element, the key will be reversed.

Inherited from TupleDict: __getitem__, __setitem__, add, index

Inherited from IndexDict: __repr__

Inherited from dict: __cmp__, __contains__, __delitem__, __eq__, __ge__, __getattribute__, __gt__, __iter__, __le__, __len__, __lt__, __ne__, __new__, __sizeof__, clear, copy, fromkeys, get, has_key, items, iteritems, iterkeys, itervalues, keys, pop, popitem, setdefault, update, values, viewitems, viewkeys, viewvalues

Inherited from object: __delattr__, __format__, __reduce__, __reduce_ex__, __setattr__, __str__, __subclasshook__

Class Variables [hide private]

Inherited from dict: __hash__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, *args, **kwargs)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Returns:
new empty dictionary

Overrides: object.__init__
(inherited documentation)

_reorder(self, key)

 

Reorder the key and return it as a tuple If first lement is greater than last element, the key will be reversed.

Overrides: TupleDict._reorder