RDKit
Open-source cheminformatics and machine learning.
EnumerationPickler.h
Go to the documentation of this file.
1 //
2 // Copyright (c) 2015, Novartis Institutes for BioMedical Research Inc.
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 // * Redistributions in binary form must reproduce the above
12 // copyright notice, this list of conditions and the following
13 // disclaimer in the documentation and/or other materials provided
14 // with the distribution.
15 // * Neither the name of Novartis Institutes for BioMedical Research Inc.
16 // nor the names of its contributors may be used to endorse or promote
17 // products derived from this software without specific prior written
18 // permission.
19 //
20 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 //
32 #ifndef ENUMERATIONPICKLER_H
33 #define ENUMERATIONPICKLER_H
34 
36 
37 namespace RDKit {
38 namespace EnumerationStrategyPickler {
39 //! pickles a EnumerationStrategy and adds the results to a stream \c ss
40 void pickle(const boost::shared_ptr<EnumerationStrategyBase> &enumerator,
41  std::ostream &ss);
42 void pickle(const boost::shared_ptr<EnumerationStrategyBase> &enumerator,
43  std::string &s);
44 
45 //! constructs a EnumerationStrategy from a pickle stored in a string
46 //! Since an EnumerationStrategyBase is polymorphic, this must return
47 //! a shared pointer to the EnumerationStrategyBase
48 boost::shared_ptr<EnumerationStrategyBase> fromPickle(std::istream &pickle);
49 
50 //! a pointer to the EnumerationStrategyBase
51 boost::shared_ptr<EnumerationStrategyBase> fromPickle(
52  const std::string &pickle);
53 }
54 }
55 
56 #endif
boost::shared_ptr< EnumerationStrategyBase > fromPickle(std::istream &pickle)
Includes a bunch of functionality for handling Atom and Bond queries.
Definition: Atom.h:29
void pickle(const boost::shared_ptr< EnumerationStrategyBase > &enumerator, std::ostream &ss)
pickles a EnumerationStrategy and adds the results to a stream ss