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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
|
//
// Copyright (C) 2002-2017 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.
//
#include <RDGeneral/export.h>
#ifndef _RD_SMILESWRITE_H
#define _RD_SMILESWRITE_H
#include <string>
#include <vector>
#include <memory>
namespace RDKit {
class Atom;
class Bond;
class ROMol;
namespace SmilesWrite {
//! \brief returns true if the atom number is in the SMILES organic subset
RDKIT_SMILESPARSE_EXPORT bool inOrganicSubset(int atomicNumber);
//! \brief returns the SMILES for an atom
/*!
\param atom : the atom to work with
\param doKekule : we're doing kekulized smiles (e.g. don't use
lower case for the atom label)
\param bondIn : the bond we came into the atom on (used for
chirality calculation
\param allHsExplicit : if true, hydrogen counts will be provided for every
atom.
\param isomericSmiles : if true, isomeric SMILES will be generated
*/
RDKIT_SMILESPARSE_EXPORT std::string GetAtomSmiles(const Atom *atom,
bool doKekule = false,
const Bond *bondIn = 0,
bool allHsExplicit = false,
bool isomericSmiles = true);
//! \brief returns the SMILES for a bond
/*!
\param bond : the bond to work with
\param atomToLeftIdx : the index of the atom preceding \c bond
in the SMILES
\param doKekule : we're doing kekulized smiles (e.g. write out
bond orders for aromatic bonds)
\param allBondsExplicit : if true, symbols will be included for all bonds.
*/
RDKIT_SMILESPARSE_EXPORT std::string GetBondSmiles(
const Bond *bond, int atomToLeftIdx = -1, bool doKekule = false,
bool allBondsExplicit = false);
} // namespace SmilesWrite
//! \brief returns canonical SMILES for a molecule
/*!
\param mol : the molecule in question.
\param doIsomericSmiles : include stereochemistry and isotope information
in the SMILES
\param doKekule : do Kekule smiles (i.e. don't use aromatic bonds)
\param rootedAtAtom : make sure the SMILES starts at the specified atom.
The resulting SMILES is not, of course, canonical.
\param canonical : if false, no attempt will be made to canonicalize the
SMILES
\param allBondsExplicit : if true, symbols will be included for all bonds.
\param allHsExplicit : if true, hydrogen counts will be provided for every
atom.
*/
RDKIT_SMILESPARSE_EXPORT std::string MolToSmiles(
const ROMol &mol, bool doIsomericSmiles = true, bool doKekule = false,
int rootedAtAtom = -1, bool canonical = true, bool allBondsExplicit = false,
bool allHsExplicit = false, bool doRandom = false);
//! \brief returns canonical SMILES for part of a molecule
/*!
\param mol : the molecule in question.
\param atomsToUse : indices of the atoms in the fragment
\param bondsToUse : indices of the bonds in the fragment. If this is not
provided,
all bonds between the atoms in atomsToUse will be included
\param atomSymbols : symbols to use for the atoms in the output SMILES
\param bondSymbols : sybmols to use for the bonds in the output SMILES
\param doIsomericSmiles : include stereochemistry and isotope information
in the SMILES
\param doKekule : do Kekule smiles (i.e. don't use aromatic bonds)
\param rootedAtAtom : make sure the SMILES starts at the specified atom.
The resulting SMILES is not, of course, canonical.
\param canonical : if false, no attempt will be made to canonicalize the
SMILES
\param allBondsExplicit : if true, symbols will be included for all bonds.
\param allHsExplicit : if true, hydrogen counts will be provided for every
atom.
\b NOTE: the bondSymbols are *not* currently used in the canonicalization.
*/
RDKIT_SMILESPARSE_EXPORT std::string MolFragmentToSmiles(
const ROMol &mol, const std::vector<int> &atomsToUse,
const std::vector<int> *bondsToUse = 0,
const std::vector<std::string> *atomSymbols = 0,
const std::vector<std::string> *bondSymbols = 0,
bool doIsomericSmiles = true, bool doKekule = false, int rootedAtAtom = -1,
bool canonical = true, bool allBondsExplicit = false,
bool allHsExplicit = false);
} // namespace RDKit
#endif
|