Package rdkit :: Package Chem :: Package Fingerprints :: Module SimilarityScreener :: Class ThresholdScreener
[hide private]
[frames] | no frames]

Class ThresholdScreener

source code

        object --+    
                 |    
SimilarityScreener --+
                     |
                    ThresholdScreener

Used to return all compounds that have a similarity
 to the probe beyond a threshold value

**Notes**:

  - This is as lazy as possible, so the data source isn't
    queried until the client asks for a hit.

  - In addition to being lazy, this class is as thin as possible.
    (Who'd have thought it was possible!)
    Hits are *not* stored locally, so if a client resets
    the iteration and starts over, the same amount of work must
    be done to retrieve the hits.

  - The thinness and laziness forces us to support only forward
    iteration (not random access)

Instance Methods [hide private]
 
__init__(self, threshold, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
_nextMatch(self)
*Internal use only*
source code
 
Reset(self)
used to reset our internal state so that iteration...
source code
 
__iter__(self)
returns an iterator for this screener...
source code
 
next(self)
required part of iterator interface
source code
 
__next__(self)
required part of iterator interface
source code

Inherited from SimilarityScreener: GetSingleFingerprint, SetProbe

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

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

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

Overrides: object.__init__
(inherited documentation)

Reset(self)

source code 
used to reset our internal state so that iteration
starts again from the beginning

Overrides: SimilarityScreener.Reset

__iter__(self)

source code 
returns an iterator for this screener