Package rdkit :: Package Chem :: Package Fingerprints :: Module SimilarityScreener :: Class TopNScreener

[hide private]
[frames] | no frames]

# Class TopNScreener

source code

            object --+
                     |
    SimilarityScreener --+
                         |
                        TopNScreener

    A screener that only returns the top N hits found

    **Notes**

      - supports forward iteration and getitem

Instance Methods | [hide private]

__init__(self, num, **kwargs) x.__init__(...) initializes x; see help(type(x)) for signature | source code

Reset(self) used to reset screeners that behave as iterators... | source code

__iter__(self) | source code

next(self) | source code

__next__(self) | source code

_initTopN(self) | source code

__len__(self) | source code

__getitem__(self, idx) | 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, num, **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 screeners that behave as iterators

Overrides: SimilarityScreener.Reset
  (inherited documentation)