File: BondIterators.h

package info (click to toggle)
rdkit 201203-3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 37,840 kB
  • sloc: cpp: 93,902; python: 51,897; java: 5,192; ansic: 3,497; xml: 2,499; sql: 1,641; yacc: 1,518; lex: 1,076; makefile: 325; fortran: 183; sh: 153; cs: 51
file content (74 lines) | stat: -rw-r--r-- 2,320 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
//
//  Copyright (C) 2002-2006 Greg Landrum and Rational Discovery LLC
//
//   @@ All Rights Reserved @@
//  This file is part of the RDKit.
//  The contents are covered by the terms of the BSD license
//  which is included in the file license.txt, found at the root
//  of the RDKit source tree.
//
/*! \file BondIterators.h

  \brief various tools for iterating over a molecule's Bonds

   <b>WARNING:</b> If you go changing the molecule underneath one of
   these iterators you will be sad...
*/  
#ifndef _RD_BOND_ITERATORS_H
#define _RD_BOND_ITERATORS_H

#include "ROMol.h"

namespace RDKit{

  //! \brief iterator for a molecule's bonds, currently BiDirectional,
  //! but it theoretically ought to be RandomAccess.
  class BondIterator_ {
    //FIX: I'm not pleased with the lack of internal testing code
    //  (PREs and the like) in here
  public:
    BondIterator_() : _mol(NULL) {}; 
    BondIterator_(ROMol *mol);
    BondIterator_(ROMol *mol,ROMol::EDGE_ITER pos);
    BondIterator_(const BondIterator_ &other);
    BondIterator_ &operator=(const BondIterator_ &other);
    bool operator==(const BondIterator_ &other);
    bool operator!=(const BondIterator_ &other);
    Bond *operator*();
    // pre-increment
    BondIterator_ &operator++();
    BondIterator_ operator++(int);
    // pre-decrement
    BondIterator_ &operator--();
    BondIterator_ operator--(int);
  private:
    ROMol::EDGE_ITER _beg,_end,_pos;
    ROMol *_mol;
  };
  //! \brief const iterator for a molecule's bonds, currently BiDirectional,
  //! but it theoretically ought to be RandomAccess.
  class ConstBondIterator_ {
  public:
    ConstBondIterator_() : _mol(NULL) {}; 
    ConstBondIterator_(ROMol const *mol);
    ConstBondIterator_(ROMol const *mol,ROMol::EDGE_ITER pos);
    ConstBondIterator_(const ConstBondIterator_ &other);
    ConstBondIterator_ &operator=(const ConstBondIterator_ &other);
    bool operator==(const ConstBondIterator_ &other);
    bool operator!=(const ConstBondIterator_ &other);
    Bond const *operator*();
    // pre-increment
    ConstBondIterator_ &operator++();
    ConstBondIterator_ operator++(int);
    // pre-decrement
    ConstBondIterator_ &operator--();
    ConstBondIterator_ operator--(int);
  private:
    ROMol::EDGE_ITER _beg,_end,_pos;
    ROMol const *_mol;
  };

}  


#endif