Package rdkit :: Package Chem :: Module rdChemReactions :: Class EnumerationStrategyBase
[hide private]
[frames] | no frames]

Class EnumerationStrategyBase

 object --+    
          |    
??.instance --+
              |
             EnumerationStrategyBase
Known Subclasses:

Instance Methods [hide private]
 
GetNumPermutations(...)
GetNumPermutations( (EnumerationStrategyBase)arg1) -> int : Returns the total number of results for this enumeration strategy.
 
GetPosition(...)
GetPosition( (EnumerationStrategyBase)arg1) -> VectSizeT : Return the current indices into the arrays of reagents
 
Initialize(...)
Initialize( (EnumerationStrategyBase)arg1, (ChemicalReaction)arg2, (list)arg3) -> None :
 
Skip(...)
Skip( (EnumerationStrategyBase)arg1, (int)skipCount) -> bool : Skip the next Nth results.
 
Type(...)
Type( (EnumerationStrategyBase)arg1) -> str : Returns the enumeration strategy type as a string.
 
__bool__(...)
__bool__( (EnumerationStrategyBase)arg1) -> bool :
 
__copy__(...)
__copy__( (EnumerationStrategyBase)arg1) -> EnumerationStrategyBase :
 
__init__(...)
Raises an exception...
 
__next__(...)
__next__( (EnumerationStrategyBase)arg1) -> VectSizeT : Return the next indices into the arrays of reagents
 
__nonzero__(...)
__nonzero__( (EnumerationStrategyBase)arg1) -> bool :
 
__reduce__(...)
helper for pickle
 
next(...)
next( (EnumerationStrategyBase)arg1) -> VectSizeT : Return the next indices into the arrays of reagents

Inherited from unreachable.instance: __new__

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

GetNumPermutations(...)

 

GetNumPermutations( (EnumerationStrategyBase)arg1) -> int :
    Returns the total number of results for this enumeration strategy.
    Note that some strategies are effectively infinite.

    C++ signature :
        unsigned long GetNumPermutations(RDKit::EnumerationStrategyBase {lvalue})

GetPosition(...)

 

GetPosition( (EnumerationStrategyBase)arg1) -> VectSizeT :
    Return the current indices into the arrays of reagents

    C++ signature :
        std::vector<unsigned long, std::allocator<unsigned long> > GetPosition(RDKit::EnumerationStrategyBase {lvalue})

Initialize(...)

 

Initialize( (EnumerationStrategyBase)arg1, (ChemicalReaction)arg2, (list)arg3) -> None :

    C++ signature :
        void Initialize(RDKit::EnumerationStrategyBase {lvalue},RDKit::ChemicalReaction {lvalue},boost::python::list)

Skip(...)

 

Skip( (EnumerationStrategyBase)arg1, (int)skipCount) -> bool :
    Skip the next Nth results. note: this may be an expensive operation
    depending on the enumeration strategy used. It is recommended to use
    the enumerator state to advance to a known position

    C++ signature :
        bool Skip(RDKit::EnumerationStrategyBase {lvalue},unsigned long)

Type(...)

 

Type( (EnumerationStrategyBase)arg1) -> str :
    Returns the enumeration strategy type as a string.

    C++ signature :
        char const* Type(RDKit::EnumerationStrategyBase {lvalue})

__bool__(...)

 

__bool__( (EnumerationStrategyBase)arg1) -> bool :

    C++ signature :
        bool __bool__(RDKit::EnumerationStrategyBase*)

__copy__(...)

 

__copy__( (EnumerationStrategyBase)arg1) -> EnumerationStrategyBase :

    C++ signature :
        RDKit::EnumerationStrategyBase* __copy__(RDKit::EnumerationStrategyBase {lvalue})

__copy__( (EnumerationStrategyBase)arg1) -> None :

    C++ signature :
        void __copy__(RDKit::EnumerationStrategyBase* {lvalue})

__init__(...)
(Constructor)

 
Raises an exception
This class cannot be instantiated from Python

Overrides: object.__init__

__next__(...)

 

__next__( (EnumerationStrategyBase)arg1) -> VectSizeT :
    Return the next indices into the arrays of reagents

    C++ signature :
        std::vector<unsigned long, std::allocator<unsigned long> > __next__(RDKit::EnumerationStrategyBase {lvalue})

__next__( (EnumerationStrategyBase)arg1) -> None :

    C++ signature :
        void __next__(RDKit::EnumerationStrategyBase* {lvalue})

__nonzero__(...)
(Boolean test operator)

 

__nonzero__( (EnumerationStrategyBase)arg1) -> bool :

    C++ signature :
        bool __nonzero__(RDKit::EnumerationStrategyBase*)

__reduce__(...)

 
helper for pickle

Overrides: object.__reduce__
(inherited documentation)

next(...)

 

next( (EnumerationStrategyBase)arg1) -> VectSizeT :
    Return the next indices into the arrays of reagents

    C++ signature :
        std::vector<unsigned long, std::allocator<unsigned long> > next(RDKit::EnumerationStrategyBase {lvalue})

next( (EnumerationStrategyBase)arg1) -> None :

    C++ signature :
        void next(RDKit::EnumerationStrategyBase* {lvalue})