RDKit
Open-source cheminformatics and machine learning.
RDKit::AtomIterator_< Atom_, Mol_ > Class Template Reference

A general random access iterator. More...

#include <AtomIterators.h>

Public Types

typedef AtomIterator_< Atom_, Mol_ > ThisType
 

Public Member Functions

 AtomIterator_ ()
 
 AtomIterator_ (Mol_ *mol)
 
 AtomIterator_ (Mol_ *mol, int pos)
 
 AtomIterator_ (const ThisType &other)
 
AtomIterator_operator= (const ThisType &other)
 
AtomIterator_operator+= (int val)
 
AtomIterator_operator-= (int val)
 
AtomIterator_ operator+ (int val) const
 
AtomIterator_ operator- (int val) const
 
int operator- (ThisType &other) const
 
Atom_ * operator* () const
 
Atom_ * operator[] (const int which) const
 
bool operator== (const ThisType &other) const
 
bool operator!= (const ThisType &other) const
 
bool operator< (const ThisType &other) const
 
bool operator<= (const ThisType &other) const
 
bool operator> (const ThisType &other) const
 
bool operator>= (const ThisType &other) const
 
ThisTypeoperator++ ()
 
ThisType operator++ (int)
 
ThisTypeoperator-- ()
 
ThisType operator-- (int)
 

Detailed Description

template<class Atom_, class Mol_>
class RDKit::AtomIterator_< Atom_, Mol_ >

A general random access iterator.

Definition at line 31 of file AtomIterators.h.

Member Typedef Documentation

◆ ThisType

template<class Atom_ , class Mol_ >
typedef AtomIterator_<Atom_, Mol_> RDKit::AtomIterator_< Atom_, Mol_ >::ThisType

Definition at line 33 of file AtomIterators.h.

Constructor & Destructor Documentation

◆ AtomIterator_() [1/4]

template<class Atom_ , class Mol_ >
RDKit::AtomIterator_< Atom_, Mol_ >::AtomIterator_ ( )
inline

Definition at line 34 of file AtomIterators.h.

References RDGeom::operator*(), RDKit::operator+(), and RDKit::operator-().

◆ AtomIterator_() [2/4]

template<class Atom_ , class Mol_ >
RDKit::AtomIterator_< Atom_, Mol_ >::AtomIterator_ ( Mol_ *  mol)

◆ AtomIterator_() [3/4]

template<class Atom_ , class Mol_ >
RDKit::AtomIterator_< Atom_, Mol_ >::AtomIterator_ ( Mol_ *  mol,
int  pos 
)

◆ AtomIterator_() [4/4]

template<class Atom_ , class Mol_ >
RDKit::AtomIterator_< Atom_, Mol_ >::AtomIterator_ ( const ThisType other)

Member Function Documentation

◆ operator!=()

template<class Atom_ , class Mol_ >
bool RDKit::AtomIterator_< Atom_, Mol_ >::operator!= ( const ThisType other) const

◆ operator*()

template<class Atom_ , class Mol_ >
Atom_* RDKit::AtomIterator_< Atom_, Mol_ >::operator* ( ) const

◆ operator+()

template<class Atom_ , class Mol_ >
AtomIterator_ RDKit::AtomIterator_< Atom_, Mol_ >::operator+ ( int  val) const

◆ operator++() [1/2]

template<class Atom_ , class Mol_ >
ThisType& RDKit::AtomIterator_< Atom_, Mol_ >::operator++ ( )

◆ operator++() [2/2]

template<class Atom_ , class Mol_ >
ThisType RDKit::AtomIterator_< Atom_, Mol_ >::operator++ ( int  )

◆ operator+=()

template<class Atom_ , class Mol_ >
AtomIterator_& RDKit::AtomIterator_< Atom_, Mol_ >::operator+= ( int  val)

◆ operator-() [1/2]

template<class Atom_ , class Mol_ >
AtomIterator_ RDKit::AtomIterator_< Atom_, Mol_ >::operator- ( int  val) const

◆ operator-() [2/2]

template<class Atom_ , class Mol_ >
int RDKit::AtomIterator_< Atom_, Mol_ >::operator- ( ThisType other) const

◆ operator--() [1/2]

template<class Atom_ , class Mol_ >
ThisType& RDKit::AtomIterator_< Atom_, Mol_ >::operator-- ( )

◆ operator--() [2/2]

template<class Atom_ , class Mol_ >
ThisType RDKit::AtomIterator_< Atom_, Mol_ >::operator-- ( int  )

◆ operator-=()

template<class Atom_ , class Mol_ >
AtomIterator_& RDKit::AtomIterator_< Atom_, Mol_ >::operator-= ( int  val)

◆ operator<()

template<class Atom_ , class Mol_ >
bool RDKit::AtomIterator_< Atom_, Mol_ >::operator< ( const ThisType other) const

◆ operator<=()

template<class Atom_ , class Mol_ >
bool RDKit::AtomIterator_< Atom_, Mol_ >::operator<= ( const ThisType other) const

◆ operator=()

template<class Atom_ , class Mol_ >
AtomIterator_& RDKit::AtomIterator_< Atom_, Mol_ >::operator= ( const ThisType other)

◆ operator==()

template<class Atom_ , class Mol_ >
bool RDKit::AtomIterator_< Atom_, Mol_ >::operator== ( const ThisType other) const

◆ operator>()

template<class Atom_ , class Mol_ >
bool RDKit::AtomIterator_< Atom_, Mol_ >::operator> ( const ThisType other) const

◆ operator>=()

template<class Atom_ , class Mol_ >
bool RDKit::AtomIterator_< Atom_, Mol_ >::operator>= ( const ThisType other) const

◆ operator[]()

template<class Atom_ , class Mol_ >
Atom_* RDKit::AtomIterator_< Atom_, Mol_ >::operator[] ( const int  which) const

The documentation for this class was generated from the following file: