Chemical Data Processing Library C++ API - Version 1.4.0
Namespaces | Classes | Typedefs | Functions
CDPL::Chem Namespace Reference

Contains classes and functions related to chemistry. More...

Namespaces

 AtomConfiguration
 Provides constants that are used to specify the configuration of stereogenic atoms.
 
 AtomMatchConstraint
 Provides numerical identifiers for built-in Chem::Atom matching constraints.
 
 AtomProperty
 Provides keys for built-in Chem::Atom properties.
 
 AtomPropertyDefault
 Provides default values for built-in Chem::Atom properties.
 
 AtomPropertyFlag
 Provides flags for the specification of basic Chem::Atom properties.
 
 AtomType
 Provides constants for the specification of the chemical element or generic type of an atom.
 
 BondConfiguration
 Provides constants that are used to specify the cis/trans configuration of bonds.
 
 BondDirection
 Provides constants for the specification of directional bonds in Daylight SMILES and SMARTS strings.
 
 BondMatchConstraint
 Provides numerical identifiers for built-in Chem::Bond matching constraints and flags for the specification of bond orders.
 
 BondProperty
 Provides keys for built-in Chem::Bond properties.
 
 BondPropertyDefault
 Provides default values for built-in Chem::Bond properties.
 
 BondPropertyFlag
 Provides flags for the specification of basic Chem::Bond properties.
 
 BondStereoFlag
 Provides constants for the specification of stereo bonds in 2D depictions of chemical structures.
 
 BRICSAtomLabel
 Provides constants for the labeling of atoms of bonds matched by a BRICS fragmentation rule.
 
 BRICSRuleID
 Provides constants for the identification of BRICS fragmentation rules.
 
 CIPDescriptor
 Provides constants for the specification of stereogenic atom/bond configurations determined by the Cahn-Ingold-Prelog (CIP) sequence rules.
 
 ControlParameter
 Provides keys for built-in control-parameters.
 
 ControlParameterDefault
 Provides default values for built-in control-parameters.
 
 DataFormat
 Provides preinitialized Base::DataFormat objects for all supported chemical data formats.
 
 Entity3DProperty
 Provides keys for built-in Chem::Entity3D properties.
 
 HybridizationState
 Provides constants for the specification of atom hybridization states.
 
 INCHIReturnCode
 Provides constants that are used to describe the status of an InChI [INCHI] output or input operation.
 
 MDLDataFormatVersion
 Provides constants that are used to specify the connection table (CTAB) and Rxn-File version for the I/O of molecular graphs and reactions in an MDL CTFile based data format.
 
 MDLParity
 Provides constants that are used to specify the MDL stereo parity of atoms.
 
 MOL2ChargeType
 Provides constants for the specification of the atom charge type in Sybyl MOL2 files.
 
 MOL2MoleculeType
 Provides constants for the specification of the molecule type in Sybyl MOL2 files.
 
 MolecularGraphMatchConstraint
 Provides numerical identifiers for built-in Chem::MolecularGraph matching constraints.
 
 MolecularGraphProperty
 Provides keys for built-in Chem::MolecularGraph properties.
 
 MolecularGraphPropertyDefault
 Provides default values for built-in Chem::MolecularGraph properties.
 
 RadicalType
 Provides constants that are used to specify the degeneracy of the electronic state of radical atoms.
 
 ReactionCenterStatus
 Provides flags that are used to describe state changes of atoms and bonds in a reaction center.
 
 ReactionMatchConstraint
 Provides numerical identifiers for built-in Chem::Reaction matching constraints.
 
 ReactionProperty
 Provides keys for built-in Chem::Reaction properties.
 
 ReactionPropertyDefault
 Provides default values for built-in Chem::Reaction properties.
 
 ReactionRole
 Provides constants that are used to specify the role of molecules (components) in a chemical reaction.
 
 RECAPAtomLabel
 Provides constants for the labeling of atoms of bonds matched by a RECAP fragmentation rule.
 
 RECAPRuleID
 Provides constants for the identification of RECAP fragmentation rules.
 
 SybylAtomType
 Provides constants for the specification of the Tripos Sybyl atom type.
 
 SybylBondType
 Provides constants for the specification of the Tripos Sybyl bond type.
 
 TautomerizationType
 Provides constants serving as identifiers for built-in Chem::TautomerizationRule implementations.
 

Classes

class  AmideImidicAcidTautomerization
 Implementation of the amide ↔ imidic-acid tautomerization rule. More...
 
class  ANDMatchExpressionList
 Chem::MatchExpressionList specialization that evaluates the stored expressions as a logical conjunction (AND). More...
 
class  ANDMatchExpressionList< ObjType, void >
 Chem::MatchExpressionList specialization (single-object form) that evaluates the stored expressions as a logical conjunction (AND). More...
 
class  AromaticRingSet
 Implements the perception of aromatic rings in a molecular graph. More...
 
class  AromaticSSSRSubset
 Implements the extraction of the aromatic rings in the SSSR of a molecular graph. More...
 
class  AromaticSubstructure
 Implements the perception of aromatic atoms and bonds in a molecular graph. More...
 
class  Atom
 Abstract base class representing a chemical atom and its bonded neighborhood. More...
 
class  Atom2DCoordinatesCalculator
 Generates 2D coordinates for the atoms of a molecular graph using a layout algorithm that combines ring-system templates, chain extension, and substituent placement. More...
 
struct  Atom3DCoordinatesFunctor
 Helper-functor for retrieving the 3D coordinates of an atom (via the Chem::AtomProperty::COORDINATES_3D property). More...
 
class  AtomArray3DCoordinatesFunctor
 Helper-functor for retrieving the 3D coordinates of an atom from a separately-stored coordinates array, indexed by the atom's position in the underlying molecular graph. More...
 
class  AtomBondMapping
 Data structure for the common storage of related atom to atom and bond to bond mappings. More...
 
class  AtomConfigurationMatchExpression
 Chem::MatchExpression that constrains target atoms by their stereo configuration relative to a query atom. More...
 
class  AtomConformer3DCoordinatesFunctor
 Helper-functor for retrieving the 3D coordinates of an atom for a specific conformer (via the Chem::AtomProperty::CONFORMER_COORDINATES_3D conformer-array property). More...
 
class  AtomContainer
 Common interface for data structures that support a random access to stored Chem::Atom instances. More...
 
class  AtomDictionary
 A global dictionary for the lookup of data associated with the atom types defined in namespace Chem::AtomType. More...
 
class  AtomEnvironmentMatchExpression
 Chem::MatchExpression that constrains target atoms by the structural environment encoded as a SMARTS substructure pattern. More...
 
class  AtomMapping
 Data type for the storage and lookup of arbitrary atom to atom mappings. More...
 
class  AtomSSSRRingSizeMatchExpression
 Chem::MatchExpression that constrains target atoms by the size of the SSSR ring(s) containing them. More...
 
class  AtomTypeMatchExpression
 MatchExpression that checks the atom type of a target atom against a query atom type. More...
 
class  AutomorphismGroupSearch
 Enumerates the atom/bond automorphisms of a molecular graph. More...
 
class  BasicAtom
 Concrete Chem::Atom implementation used as the atom type of Chem::BasicMolecule. More...
 
class  BasicBond
 Default implementation of the Chem::Bond interface. More...
 
class  BasicMolecule
 Concrete Chem::Molecule implementation that owns Chem::BasicAtom and Chem::BasicBond instances. More...
 
class  BasicReaction
 Default concrete implementation of the Chem::Reaction abstract interface. More...
 
class  BemisMurckoAnalyzer
 Decomposes a molecular graph into its Bemis-Murcko framework, ring systems, linkers and side chains. More...
 
class  Bond
 Abstract base class representing a chemical bond between two Chem::Atom instances. More...
 
class  BondConfigurationMatchExpression
 Chem::MatchExpression that constrains target bonds by their stereo configuration relative to a query bond. More...
 
class  BondContainer
 Common interface for data structures that support a random access to stored Chem::Bond instances. More...
 
class  BondDirectionMatchExpression
 Chem::MatchExpression that constrains target bonds by their SMILES/SMARTS bond direction. More...
 
class  BondMapping
 Data type for the storage and lookup of arbitrary bond to bond mappings. More...
 
class  BondOrderCalculator
 Perceives bond orders of a molecular graph from its 3D structure and atom connectivity. More...
 
class  BondReactionCenterStatusMatchExpression
 Chem::MatchExpression that constrains target bonds by their reaction-center status (see Chem::ReactionCenterStatus). More...
 
class  BondStereoFlagCalculator
 Calculator that derives 2D wedge/hash bond stereo flags from atom 2D coordinates and stereochemical descriptors of a molecular graph. More...
 
class  BondSubstituentDirectionMatchExpression
 Chem::MatchExpression that constrains target double bond geometry via the per-substituent bond-direction annotations carried by the query (in the style of Daylight SMARTS [SMARTS] cis/trans patterns). More...
 
class  BRICSFragmentGenerator
 Chem::FragmentGenerator preconfigured with the 16 BRICS bond-cleavage rules and the associated exclude patterns for combinatorial fragmentation of organic molecules. More...
 
class  CanonicalNumberingCalculator
 Calculation of canonical atom numberings for molecular graphs using McKay's algorithm. More...
 
class  CDFMolecularGraphWriter
 Writer for molecular graph data in the native I/O format of the CDPL. More...
 
class  CDFMoleculeReader
 Reader for molecule data in the native I/O format of the CDPL. More...
 
class  CDFReactionReader
 Reader for reaction data in the native I/O format of the CDPL. More...
 
class  CDFReactionWriter
 Writer for reaction data in the native I/O format of the CDPL. More...
 
class  ChEMBLStandardizer
 Implementation of the ChEMBL structure preprocessing pipeline. More...
 
class  CIPConfigurationLabeler
 Assigns Cahn-Ingold-Prelog (CIP) configuration labels to stereogenic atoms and bonds of a molecular graph. More...
 
class  CIPPriorityCalculator
 Computes a topological approximation of CIP (Cahn-Ingold-Prelog) priorities for the atoms of a molecular graph. More...
 
class  CMLMolecularGraphWriter
 Writer for molecular graph data in the Chemical Markup Language [CML] format. More...
 
class  CMLMoleculeReader
 Reader for molecule data in the Chemical Markup Language [CML] format. More...
 
class  CommonConnectedSubstructureSearch
 Enumerates all maximal common connected substructures shared between a query and a target molecular graph. More...
 
class  CompleteRingSet
 Implements the exhaustive perception of rings in a molecular graph. More...
 
class  ComponentSet
 Implements the perception of molecular graph components. More...
 
class  ConjugatedRingBondPatternSwitching
 Chem::TautomerizationRule implementation that enumerates tautomers obtained by switching the single/double bond pattern of conjugated rings (e.g. the two KekulĂ© forms of benzene). More...
 
class  ConnectedSubstructureSet
 Enumerates the connected substructures of a molecular graph of a specified bond count. More...
 
class  CyclicSubstructure
 Implements the perception of ring atoms and bonds in a molecular graph. More...
 
class  DefaultMultiConfMoleculeInputProcessor
 Default Chem::MultiConfMoleculeInputProcessor implementation that detects multi-conformer input by comparing atom and bond properties (and optionally molecule names) between successive input molecules. More...
 
class  DefaultTautomerGenerator
 Chem::TautomerGenerator preconfigured with the standard CDPKit tautomerization rules. More...
 
class  ElectronSystem
 Describes an electron system of a molecule in terms of involved atoms and their electron contributions. More...
 
class  ElectronSystemList
 Data structure for the storage of Chem::ElectronSystem objects. More...
 
class  Entity3D
 Base class for objects that have a position in 3D space (e.g. Chem::Atom and Chem::Feature). More...
 
class  Entity3DContainer
 Common interface for data structures that support a random access to stored Chem::Entity3D instances. More...
 
struct  Entity3DCoordinatesFunctor
 Helper-functor for retrieving the 3D coordinates of an Chem::Entity3D object (via the Chem::Entity3DProperty::COORDINATES_3D property). More...
 
class  Entity3DMapping
 Data type for the storage and lookup of arbitrary entity to entity mappings. More...
 
class  ExtendedSSSR
 Implements the perception of the Extended Smallest Set of Smallest Rings (ESSSR) of a molecular graph. More...
 
class  Fragment
 Concrete Chem::MolecularGraph implementation that stores references to a selectable subset of atoms and bonds (typically of a parent Chem::Molecule). More...
 
class  FragmentGenerator
 Generic rule-based molecule fragmentation engine that splits a molecular graph along bonds matching user-defined fragmentation rules. More...
 
class  FragmentList
 Data structure for the storage of Chem::Fragment objects. More...
 
class  GenericHydrogen13ShiftTautomerization
 Chem::TautomerizationRule implementation that enumerates tautomers obtained by a generic 1,3-hydrogen shift (a proton migrates between atoms separated by two bonds, with the corresponding single/double bond pattern flipping). More...
 
class  GenericHydrogen15ShiftTautomerization
 Chem::TautomerizationRule implementation that enumerates tautomers obtained by a generic 1,5-hydrogen shift (a proton migrates between atoms separated by four bonds along a conjugated path, with the corresponding single/double bond pattern flipping). More...
 
class  HashCodeCalculator
 Computes a 64-bit hash code that identifies a molecular graph up to a configurable set of atom and bond properties. More...
 
class  Hydrogen3DCoordinatesCalculator
 Generates 3D coordinates for the hydrogen atoms of a molecular graph from the existing positions of their heavy atom neighbors. More...
 
class  ImineEnamineTautomerization
 Chem::TautomerizationRule implementation that enumerates the imine/enamine tautomers of an \( R_2C=N{-}CHR_2 \rightleftharpoons R_2CH{-}N=CR_2 \) system. More...
 
class  INCHIMolecularGraphWriter
 Writer for molecular graph data in the IUPAC International Chemical Identifier (InChI) [INCHI] format. More...
 
class  INCHIMoleculeReader
 Reader for molecule data in the IUPAC International Chemical Identifier (InChI) [INCHI] format. More...
 
class  JMEMolecularGraphWriter
 Writer for molecular graph data in the native I/O format of the JME Molecular Editor [JME] Java applet. More...
 
class  JMEMoleculeReader
 Reader for molecule data in the native I/O format of the JME Molecular Editor [JME] Java applet. More...
 
class  JMEReactionReader
 Reader for reaction data in the native I/O format of the JME Molecular Editor [JME] Java applet. More...
 
class  JMEReactionWriter
 Writer for reaction data in the native I/O format of the JME Molecular Editor [JME] Java applet. More...
 
class  KekuleStructureCalculator
 Assigns an alternating single/double bond pattern (KekulĂ© structure) to the previously undefined bonds of a molecular graph (typically used to convert aromatic-bond annotations into explicit single/double bonds). More...
 
class  KeteneYnolTautomerization
 Chem::PatternBasedTautomerizationRule implementation that enumerates ketene/ynol tautomers (Chem::TautomerizationType::KETENE_YNOL). More...
 
class  KetoEnolTautomerization
 Chem::TautomerizationRule implementation that enumerates the keto/enol tautomers of an \( R_2C{-}C(=O)R' \rightleftharpoons RC=C(OH)R' \) system. More...
 
class  LactamLactimTautomerization
 Chem::TautomerizationRule implementation that enumerates the lactam/lactim tautomers of a cyclic amide \( {-}NH{-}C(=O){-} \rightleftharpoons {-}N=C(OH){-} \) system. More...
 
class  MatchConstraint
 Describes a single attribute-comparison constraint between a query and a target object used by molecular graph matching algorithms. More...
 
class  MatchConstraintList
 List of Chem::MatchConstraint instances combined with a logical Type (AND_LIST, NOT_AND_LIST, OR_LIST, or NOT_OR_LIST) that controls how the contained constraints are aggregated during query/target evaluation. More...
 
class  MatchExpression
 Generic boolean expression interface for the implementation of query/target object equivalence tests in molecular graph matching algorithms. More...
 
class  MatchExpression< ObjType, void >
 Generic boolean expression interface for the implementation of query/target object equivalence tests in molecular graph matching algorithms. More...
 
class  MatchExpressionList
 Container for the storage and evaluation of logical match expression lists. More...
 
class  MaxCommonAtomSubstructureSearch
 Computes the maximum common atom substructure between a query and a target molecular graph by reducing the problem to maximum-clique enumeration on an association (modular product) graph. More...
 
class  MaxCommonBondSubstructureSearch
 Computes the maximum common bond substructure between a query and a target molecular graph by reducing the problem to maximum-clique enumeration on a bond-based association graph. More...
 
class  MOL2MolecularGraphWriter
 Writer for molecular graph data in the Sybyl MOL2 format. More...
 
class  MOL2MoleculeReader
 Reader for molecule data in the Sybyl MOL2 format. More...
 
class  MolecularGraph
 Abstract base class for representations of a chemical structure as a graph of bonded atoms. More...
 
class  MolecularGraphComponentGroupingMatchExpression
 Chem::MatchExpression that constrains the substructure mapping by the query's component-level groupings (typically derived from the parenthesization of a Daylight SMARTS [SMARTS] pattern). More...
 
class  Molecule
 Abstract base class representing a mutable molecular graph that owns its atoms and bonds. More...
 
class  MOLMolecularGraphWriter
 Writer for molecular graph data in the MDL Mol-File [CTFILE] format. More...
 
class  MOLMoleculeReader
 Reader for molecule data in the MDL Mol-File [CTFILE] format. More...
 
class  MorganNumberingCalculator
 Computes a canonical atom numbering of a molecular graph using a modified Morgan algorithm. More...
 
class  MultiConfMoleculeInputProcessor
 Abstract base interface for processors that detect and assemble multi-conformer molecules from a stream of successive single-conformer input molecules. More...
 
class  MultiSubstructureSearch
 Evaluates a boolean expression over multiple substructure queries against a target molecular graph. More...
 
class  NitroAciTautomerization
 Implementation of the nitro ↔ aci-nitro tautomerization rule. More...
 
class  NitrosoOximeTautomerization
 Chem::PatternBasedTautomerizationRule implementation that enumerates nitroso/oxime tautomers (Chem::TautomerizationType::NITROSO_OXIME). More...
 
class  NOTMatchExpression
 Chem::MatchExpression decorator that negates the result of a wrapped Chem::MatchExpression instance. More...
 
class  NOTMatchExpression< ObjType, void >
 Chem::MatchExpression decorator that negates the result of a wrapped Chem::MatchExpression instance. More...
 
class  ORMatchExpressionList
 Chem::MatchExpressionList specialization that evaluates the stored expressions as a logical disjunction (OR). More...
 
class  ORMatchExpressionList< ObjType, void >
 Chem::MatchExpressionList specialization that evaluates the stored expressions as a logical disjunction (OR). More...
 
class  PatternAtomTyper
 Assigns numeric labels to specific atoms of a molecular graph that are described by substructure patterns. More...
 
class  PatternBasedTautomerizationRule
 Match pattern-based implementation of the Chem::TautomerizationRule interface. More...
 
class  PhosphinicAcidTautomerization
 Chem::PatternBasedTautomerizationRule implementation that enumerates phosphinic-acid tautomers (Chem::TautomerizationType::PHOSPHINIC_ACID). More...
 
class  PiElectronSystemList
 Implements the perception of all π-electron systems present in a molecule. More...
 
class  PropertyMatchExpression
 Generic Chem::MatchExpression specialisation that evaluates a binary comparison between a query- and a target-derived property value retrieved through a user-supplied accessor function. More...
 
class  PropertyMatchExpression< ValueType, MatchFunc, ObjType, void >
 Single-object specialisation of Chem::PropertyMatchExpression for query/target equivalence tests on a single attribute retrieved from a single object via the user-supplied accessor. More...
 
class  ProtonationStateStandardizer
 Adjusts the protonation state of a molecule (atom formal charges and bonded hydrogen counts) according to one of several pre-defined objectives. More...
 
class  RDFReactionReader
 Reader for reaction data in the MDL RD-File [CTFILE] format. More...
 
class  RDFReactionWriter
 Writer for reaction data in the MDL RD-File [CTFILE] format. More...
 
class  Reaction
 Abstract base class for chemical reactions composed of role-tagged Chem::Molecule components. More...
 
class  ReactionAtomMappingMatchExpression
 Chem::MatchExpression that constrains reaction substructure matches by a required reactant-to-product atom mapping. More...
 
class  ReactionComponentGroupingMatchExpression
 Chem::MatchExpression that constrains reaction substructure matches by the query's component-level groupings (typically derived from the parenthesization of a Daylight SMARTS [SMARTS] pattern). More...
 
class  ReactionSubstructureSearch
 Reaction-level analogue of Chem::SubstructureSearch that locates atom/bond mappings of a query reaction pattern in a target reaction. More...
 
class  Reactor
 Applies a Chem::Reaction template to the reactant components of a target Chem::Reaction to generate the corresponding product molecules. More...
 
class  RECAPFragmentGenerator
 Chem::FragmentGenerator implementation applying the RECAP [RECAP] cleavage rules (see Chem::RECAPRuleID) to produce a set of fragment building blocks from a molecular graph. More...
 
class  ResonanceStructureGenerator
 Enumerates the resonance structures of a molecular graph by redistributing π-electrons across the resonance-active bonds. More...
 
class  RXNReactionReader
 Reader for reaction data in the MDL Rxn-File [CTFILE] format. More...
 
class  RXNReactionWriter
 Writer for reaction data in the MDL Rxn-File [CTFILE] format. More...
 
class  SDFMolecularGraphWriter
 Writer for molecular graph data in the MDL SD-File [CTFILE] format. More...
 
class  SDFMoleculeReader
 Reader for molecule data in the MDL SD-File [CTFILE] format. More...
 
class  SmallestSetOfSmallestRings
 Implements the perception of the Smallest Set of Smallest Rings (SSSR) of a molecular graphs. More...
 
class  SMARTSMolecularGraphWriter
 Writer for molecular graph data in the Daylight SMARTS [SMARTS] format. More...
 
class  SMARTSMoleculeReader
 Reader for molecule data in the Daylight SMARTS [SMARTS] format. More...
 
class  SMARTSReactionReader
 Reader for reaction data in the Daylight SMARTS [SMARTS] format. More...
 
class  SMARTSReactionWriter
 Writer for reaction data in the Daylight SMARTS [SMARTS] format. More...
 
class  SMILESMolecularGraphWriter
 Writer for molecular graph data in the Daylight SMILES [SMILES] format. More...
 
class  SMILESMoleculeReader
 Reader for molecule data in the Daylight SMILES [SMILES] format. More...
 
class  SMILESReactionReader
 Reader for reaction data in the Daylight SMILES [SMILES] format. More...
 
class  SMILESReactionWriter
 Writer for reaction data in the Daylight SMILES [SMILES] format. More...
 
class  SpatialEntityAlignment
 Computes a spatial alignment between two sets of entities (with 3D coordinates) by composing topological entity matching with Kabsch-style 3D superposition. More...
 
class  StereoDescriptor
 Data structure for the storage and retrieval of stereochemical information about atoms and bonds. More...
 
class  StereoisomerGenerator
 Enumerates the stereoisomers of a molecular graph by flipping the configurations of selected atom and bond stereocenters. More...
 
class  StringDataBlockEntry
 Represents a data item consisting of a header and a data payload. More...
 
class  StringDataBlock
 Array of Chem::StringDataBlockEntry objects. More...
 
class  SubstructureEditor
 Pattern-driven editor that rewrites matched substructures of a Chem::Molecule using a result template, with optional exclude patterns guarding sites that must not be touched. More...
 
class  SubstructureHistogramCalculator
 Counts occurrences of registered substructure patterns in a molecular graph, emitting the per-pattern hit counts into a user-supplied histogram container. More...
 
class  SubstructureSearch
 Subgraph-isomorphism search of a query molecular graph against a target molecular graph, implemented after the VF2 algorithm. More...
 
class  SulfenicAcidTautomerization
 Chem::TautomerizationRule implementation that enumerates the sulfenic-acid tautomers of an \( R{-}S{-}OH \rightleftharpoons R{-}S(=O)H \) system. More...
 
class  SurfaceAtomExtractor
 Extracts the solvent-accessible surface atoms of a set of atoms. More...
 
class  SymmetryClassCalculator
 Perceives topological-symmetry classes of the atoms in a molecular graph. More...
 
class  TautomerGenerator
 Enumerates the tautomers of a molecular graph by iteratively applying a configurable set of Chem::TautomerizationRule instances and reporting each accepted tautomer to a user-supplied callback. More...
 
class  TautomerizationRule
 Abstract base class for all tautomerization rule implementations used by the Chem::TautomerGenerator. More...
 
class  TautomerScore
 Functor for the calculation of a heuristic stability score of a tautomeric form represented as a molecular graph. More...
 
class  TopologicalEntityAlignment
 Computes a topological alignment between two sets of entities by reducing the alignment problem to a maximum-common-subgraph search on a compatibility graph. More...
 
class  XYZMolecularGraphWriter
 Writer for molecular graph data in XYZ format to an output stream. More...
 
class  XYZMoleculeReader
 Reader for molecule data in XYZ format from an input stream. More...
 

Typedefs

typedef std::function< const Math::Vector3D &(const Chem::Atom &)> Atom3DCoordinatesFunction
 Generic wrapper class used to store a user-defined Chem::Atom 3D-coordinates function. More...
 
typedef std::function< bool(const Atom &, const Atom &)> AtomCompareFunction
 Generic wrapper class used to store a user-defined atom compare function. More...
 
typedef std::function< bool(const Chem::Atom &)> AtomPredicate
 Generic wrapper class used to store a user-defined atom predicate. More...
 
typedef std::function< std::size_t(const Chem::Atom &)> AtomPriorityFunction
 Generic wrapper class used to store a user-defined atom priority function. More...
 
typedef std::function< bool(const Chem::Bond &, const Chem::Bond &)> BondCompareFunction
 Generic wrapper class used to store a user-defined bond compare function. More...
 
typedef std::function< bool(const Chem::Bond &)> BondPredicate
 Generic wrapper class used to store a user-defined bond predicate. More...
 
typedef Util::DefaultDataOutputHandler< CDFBZ2MolecularGraphWriter, DataFormat::CDF_BZ2CDFBZ2MolecularGraphOutputHandler
 Handler for the output of bzip2-compressed molecular graph data in the native I/O format of the CDPL. More...
 
typedef Util::CompressedDataWriter< CDFMolecularGraphWriter, Util::BZip2OStreamCDFBZ2MolecularGraphWriter
 Writer for molecular graph data in the bzip2-compressed native I/O format of the CDPL. More...
 
typedef Util::DefaultDataInputHandler< CDFBZ2MoleculeReader, DataFormat::CDF_BZ2CDFBZ2MoleculeInputHandler
 Handler for the input of bzip2-compressed molecule data in the native I/O format of the CDPL. More...
 
typedef Util::CompressedDataReader< CDFMoleculeReader, Util::BZip2IStreamCDFBZ2MoleculeReader
 Reader for molecule data in the bzip2-compressed native I/O format of the CDPL. More...
 
typedef Util::DefaultDataInputHandler< CDFBZ2ReactionReader, DataFormat::CDF_BZ2CDFBZ2ReactionInputHandler
 Handler for the input of bzip2-compressed reaction data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataOutputHandler< CDFBZ2ReactionWriter, DataFormat::CDF_BZ2CDFBZ2ReactionOutputHandler
 Handler for the output of bzip2-compressed reaction data in the native I/O format of the CDPL. More...
 
typedef Util::CompressedDataReader< CDFReactionReader, Util::BZip2IStreamCDFBZ2ReactionReader
 Reader for reaction data in the bzip2-compressed native I/O format of the CDPL. More...
 
typedef Util::CompressedDataWriter< CDFReactionWriter, Util::BZip2OStreamCDFBZ2ReactionWriter
 Writer for reaction data in the bzip2-compressed native I/O format of the CDPL. More...
 
typedef Util::DefaultDataOutputHandler< CDFGZMolecularGraphWriter, DataFormat::CDF_GZCDFGZMolecularGraphOutputHandler
 Handler for the output of gzip-compressed molecular graph data in the native I/O format of the CDPL. More...
 
typedef Util::CompressedDataWriter< CDFMolecularGraphWriter, Util::GZipOStreamCDFGZMolecularGraphWriter
 Writer for molecular graph data in the gzip-compressed native I/O format of the CDPL. More...
 
typedef Util::DefaultDataInputHandler< CDFGZMoleculeReader, DataFormat::CDF_GZCDFGZMoleculeInputHandler
 Handler for the input of gzip-compressed molecule data in the native I/O format of the CDPL. More...
 
typedef Util::CompressedDataReader< CDFMoleculeReader, Util::GZipIStreamCDFGZMoleculeReader
 Reader for molecule data in the gzip-compressed native I/O format of the CDPL. More...
 
typedef Util::DefaultDataInputHandler< CDFGZReactionReader, DataFormat::CDF_GZCDFGZReactionInputHandler
 Handler for the input of gzip-compressed reaction data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataOutputHandler< CDFGZReactionWriter, DataFormat::CDF_GZCDFGZReactionOutputHandler
 Handler for the output of gzip-compressed reaction data in the native I/O format of the CDPL. More...
 
typedef Util::CompressedDataReader< CDFReactionReader, Util::GZipIStreamCDFGZReactionReader
 Reader for reaction data in the gzip-compressed native I/O format of the CDPL. More...
 
typedef Util::CompressedDataWriter< CDFReactionWriter, Util::GZipOStreamCDFGZReactionWriter
 Writer for reaction data in the gzip-compressed native I/O format of the CDPL. More...
 
typedef Util::DefaultDataOutputHandler< CDFMolecularGraphWriter, DataFormat::CDFCDFMolecularGraphOutputHandler
 Handler for the output of molecular graph data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataInputHandler< CDFMoleculeReader, DataFormat::CDFCDFMoleculeInputHandler
 Handler for the input of molecule data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataInputHandler< CDFReactionReader, DataFormat::CDFCDFReactionInputHandler
 Handler for the input of reaction data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataOutputHandler< CDFReactionWriter, DataFormat::CDFCDFReactionOutputHandler
 Handler for the output of reaction data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataOutputHandler< CMLBZ2MolecularGraphWriter, DataFormat::CML_BZ2CMLBZ2MolecularGraphOutputHandler
 Handler for the output of bzip2-compressed molecular graph data in the Chemical Markup Language [CML] format. More...
 
typedef Util::CompressedDataWriter< CMLMolecularGraphWriter, Util::BZip2OStreamCMLBZ2MolecularGraphWriter
 Writer for molecular graph data in the bzip2-compressed Chemical Markup Language [CML] format. More...
 
typedef Util::DefaultDataInputHandler< CMLBZ2MoleculeReader, DataFormat::CML_BZ2CMLBZ2MoleculeInputHandler
 Handler for the input of bzip2-compressed molecule data in the Chemical Markup Language [CML] format. More...
 
typedef Util::CompressedDataReader< CMLMoleculeReader, Util::BZip2IStreamCMLBZ2MoleculeReader
 Reader for molecule data in the bzip2-compressed Chemical Markup Language [CML] format. More...
 
typedef Util::DefaultDataOutputHandler< CMLGZMolecularGraphWriter, DataFormat::CML_GZCMLGZMolecularGraphOutputHandler
 Handler for the output of gzip-compressed molecular graph data in the Chemical Markup Language [CML] format. More...
 
typedef Util::CompressedDataWriter< CMLMolecularGraphWriter, Util::GZipOStreamCMLGZMolecularGraphWriter
 Writer for molecular graph data in the gzip-compressed Chemical Markup Language [CML] format. More...
 
typedef Util::DefaultDataInputHandler< CMLGZMoleculeReader, DataFormat::CML_GZCMLGZMoleculeInputHandler
 Handler for the input of gzip-compressed molecule data in the Chemical Markup Language [CML] format. More...
 
typedef Util::CompressedDataReader< CMLMoleculeReader, Util::GZipIStreamCMLGZMoleculeReader
 Reader for molecule data in the gzip-compressed Chemical Markup Language [CML] format. More...
 
typedef Util::DefaultDataOutputHandler< CMLMolecularGraphWriter, DataFormat::CMLCMLMolecularGraphOutputHandler
 Handler for the output of molecular graph data in the Chemical Markup Language [CML] format. More...
 
typedef Util::DefaultDataInputHandler< CMLMoleculeReader, DataFormat::CMLCMLMoleculeInputHandler
 Handler for the input of molecule data in the Chemical Markup Language [CML] format. More...
 
typedef std::function< const Math::Vector3D &(const Chem::Entity &)> Entity3DCoordinatesFunction
 Generic wrapper class used to store a user-defined Chem::Entity3D coordinates function. More...
 
typedef Util::DefaultDataOutputHandler< INCHIMolecularGraphWriter, DataFormat::INCHIINCHIMolecularGraphOutputHandler
 Handler for the output of molecular graph data in the IUPAC International Chemical Identifier (InChI) [INCHI] format. More...
 
typedef Util::DefaultDataInputHandler< INCHIMoleculeReader, DataFormat::INCHIINCHIMoleculeInputHandler
 Handler for the input of molecule data in the IUPAC International Chemical Identifier (InChI) [INCHI] format. More...
 
typedef Util::DefaultDataOutputHandler< JMEMolecularGraphWriter, DataFormat::JMEJMEMolecularGraphOutputHandler
 Handler for the output of molecular graph data in the native I/O format of the JME Molecular Editor [JME] java applet. More...
 
typedef Util::DefaultDataInputHandler< JMEMoleculeReader, DataFormat::JMEJMEMoleculeInputHandler
 Handler for the input of molecule data in the native I/O format of the JME Molecular Editor [JME] java applet. More...
 
typedef Util::DefaultDataInputHandler< JMEReactionReader, DataFormat::JMEJMEReactionInputHandler
 Handler for the input of reaction data in the native I/O format of the JME Molecular Editor [JME] java applet. More...
 
typedef Util::DefaultDataOutputHandler< JMEReactionWriter, DataFormat::JMEJMEReactionOutputHandler
 Handler for the output of reaction data in the native I/O format of the JME Molecular Editor [JME] java applet. More...
 
typedef Util::DefaultDataOutputHandler< MOL2BZ2MolecularGraphWriter, DataFormat::MOL2_BZ2MOL2BZ2MolecularGraphOutputHandler
 Handler for the output of bzip2-compressed molecular graph data in the Sybyl MOL2 format. More...
 
typedef Util::CompressedDataWriter< MOL2MolecularGraphWriter, Util::BZip2OStreamMOL2BZ2MolecularGraphWriter
 Writer for molecular graph data in the bzip2-compressed Sybyl MOL2 format. More...
 
typedef Util::DefaultDataInputHandler< MOL2BZ2MoleculeReader, DataFormat::MOL2_BZ2MOL2BZ2MoleculeInputHandler
 Handler for the input of bzip2-compressed molecule data in the Sybyl MOL2 format. More...
 
typedef Util::CompressedDataReader< MOL2MoleculeReader, Util::BZip2IStreamMOL2BZ2MoleculeReader
 Reader for molecule data in the bzip2-compressed Sybyl MOL2 format. More...
 
typedef Util::DefaultDataOutputHandler< MOL2GZMolecularGraphWriter, DataFormat::MOL2_GZMOL2GZMolecularGraphOutputHandler
 Handler for the output of gzip-compressed molecular graph data in the Sybyl MOL2 format. More...
 
typedef Util::CompressedDataWriter< MOL2MolecularGraphWriter, Util::GZipOStreamMOL2GZMolecularGraphWriter
 Writer for molecular graph data in the gzip-compressed Sybyl MOL2 format. More...
 
typedef Util::DefaultDataInputHandler< MOL2GZMoleculeReader, DataFormat::MOL2_GZMOL2GZMoleculeInputHandler
 Handler for the input of gzip-compressed molecule data in the Sybyl MOL2 format. More...
 
typedef Util::CompressedDataReader< MOL2MoleculeReader, Util::GZipIStreamMOL2GZMoleculeReader
 Reader for molecule data in the gzip-compressed Sybyl MOL2 format. More...
 
typedef Util::DefaultDataOutputHandler< MOL2MolecularGraphWriter, DataFormat::MOL2MOL2MolecularGraphOutputHandler
 Handler for the output of molecular graph data in the Sybyl MOL2 format. More...
 
typedef Util::DefaultDataInputHandler< MOL2MoleculeReader, DataFormat::MOL2MOL2MoleculeInputHandler
 Handler for the input of molecule data in the Sybyl MOL2 format. More...
 
typedef Util::MultiFormatDataWriter< MolecularGraphMolecularGraphWriter
 Writer for molecule data in any supported format. More...
 
typedef Util::MultiFormatDataReader< MoleculeMoleculeReader
 Reader for molecule data in any supported format. More...
 
typedef Util::DefaultDataOutputHandler< MOLMolecularGraphWriter, DataFormat::MOLMOLMolecularGraphOutputHandler
 Handler for the output of molecular graph data in the MDL Mol-File [CTFILE] format. More...
 
typedef Util::DefaultDataInputHandler< MOLMoleculeReader, DataFormat::MOLMOLMoleculeInputHandler
 Handler for the input of molecule data in the MDL Mol-File [CTFILE] format. More...
 
typedef Util::DefaultDataInputHandler< RDFBZ2ReactionReader, DataFormat::RDF_BZ2RDFBZ2ReactionInputHandler
 Handler for the input of bzip2-compressed reaction data in the MDL RD-File [CTFILE] format. More...
 
typedef Util::DefaultDataOutputHandler< RDFBZ2ReactionWriter, DataFormat::RDF_BZ2RDFBZ2ReactionOutputHandler
 Handler for the output of bzip2-compressed reaction data in the MDL RD-File [CTFILE] format. More...
 
typedef Util::CompressedDataReader< RDFReactionReader, Util::BZip2IStreamRDFBZ2ReactionReader
 Reader for reaction data in the bzip2-compressed MDL RD-File [CTFILE] format. More...
 
typedef Util::CompressedDataWriter< RDFReactionWriter, Util::BZip2OStreamRDFBZ2ReactionWriter
 Writer for reaction data in the bzip2-compressed MDL RD-File [CTFILE] format. More...
 
typedef Util::DefaultDataInputHandler< RDFGZReactionReader, DataFormat::RDF_GZRDFGZReactionInputHandler
 Handler for the input of gzip-compressed reaction data in the MDL RD-File [CTFILE] format. More...
 
typedef Util::DefaultDataOutputHandler< RDFGZReactionWriter, DataFormat::RDF_GZRDFGZReactionOutputHandler
 Handler for the output of gzip-compressed reaction data in the MDL RD-File [CTFILE] format. More...
 
typedef Util::CompressedDataReader< RDFReactionReader, Util::GZipIStreamRDFGZReactionReader
 Reader for reaction data in the gzip-compressed MDL RD-File [CTFILE] format. More...
 
typedef Util::CompressedDataWriter< RDFReactionWriter, Util::GZipOStreamRDFGZReactionWriter
 Writer for reaction data in the gzip-compressed MDL RD-File [CTFILE] format. More...
 
typedef Util::DefaultDataInputHandler< RDFReactionReader, DataFormat::RDFRDFReactionInputHandler
 Handler for the input of reaction data in the MDL RD-File [CTFILE] format. More...
 
typedef Util::DefaultDataOutputHandler< RDFReactionWriter, DataFormat::RDFRDFReactionOutputHandler
 Handler for the output of reaction data in the MDL RD-File [CTFILE] format. More...
 
typedef Util::MultiFormatDataReader< ReactionReactionReader
 Reader for reaction data in any supported format. More...
 
typedef Util::MultiFormatDataWriter< ReactionReactionWriter
 Writer for reaction data in any supported format. More...
 
typedef Util::DefaultDataInputHandler< RXNReactionReader, DataFormat::RXNRXNReactionInputHandler
 Handler for the input of reaction data in the MDL Rxn-File [CTFILE] format. More...
 
typedef Util::DefaultDataOutputHandler< RXNReactionWriter, DataFormat::RXNRXNReactionOutputHandler
 Handler for the output of reaction data in the MDL Rxn-File [CTFILE] format. More...
 
typedef Util::DefaultDataOutputHandler< SDFBZ2MolecularGraphWriter, DataFormat::SDF_BZ2SDFBZ2MolecularGraphOutputHandler
 Handler for the output of bzip2-compressed molecular graph data in the MDL SD-File [CTFILE] format. More...
 
typedef Util::CompressedDataWriter< SDFMolecularGraphWriter, Util::BZip2OStreamSDFBZ2MolecularGraphWriter
 Writer for molecular graph data in the bzip2-compressed MDL SD-File [CTFILE] format. More...
 
typedef Util::DefaultDataInputHandler< SDFBZ2MoleculeReader, DataFormat::SDF_BZ2SDFBZ2MoleculeInputHandler
 Handler for the input of bzip2-compressed molecule data in the MDL SD-File [CTFILE] format. More...
 
typedef Util::CompressedDataReader< SDFMoleculeReader, Util::BZip2IStreamSDFBZ2MoleculeReader
 Reader for molecule data in the bzip2-compressed MDL SD-File [CTFILE] format. More...
 
typedef Util::DefaultDataOutputHandler< SDFGZMolecularGraphWriter, DataFormat::SDF_GZSDFGZMolecularGraphOutputHandler
 Handler for the output of gzip-compressed molecular graph data in the MDL SD-File [CTFILE] format. More...
 
typedef Util::CompressedDataWriter< SDFMolecularGraphWriter, Util::GZipOStreamSDFGZMolecularGraphWriter
 Writer for molecular graph data in the gzip-compressed MDL SD-File [CTFILE] format. More...
 
typedef Util::DefaultDataInputHandler< SDFGZMoleculeReader, DataFormat::SDF_GZSDFGZMoleculeInputHandler
 Handler for the input of gzip-compressed molecule data in the MDL SD-File [CTFILE] format. More...
 
typedef Util::CompressedDataReader< SDFMoleculeReader, Util::GZipIStreamSDFGZMoleculeReader
 Reader for molecule data in the gzip-compressed MDL SD-File [CTFILE] format. More...
 
typedef Util::DefaultDataOutputHandler< SDFMolecularGraphWriter, DataFormat::SDFSDFMolecularGraphOutputHandler
 Handler for the output of molecular graph data in the MDL SD-File [CTFILE] format. More...
 
typedef Util::DefaultDataInputHandler< SDFMoleculeReader, DataFormat::SDFSDFMoleculeInputHandler
 Handler for the input of molecule data in the MDL SD-File [CTFILE] format. More...
 
typedef Util::DefaultDataOutputHandler< SMARTSMolecularGraphWriter, DataFormat::SMARTSSMARTSMolecularGraphOutputHandler
 Handler for the output of molecular graph data in the Daylight SMARTS [SMARTS] format. More...
 
typedef Util::DefaultDataInputHandler< SMARTSMoleculeReader, DataFormat::SMARTSSMARTSMoleculeInputHandler
 Handler for the input of molecule data in the Daylight SMARTS [SMARTS] format. More...
 
typedef Util::DefaultDataInputHandler< SMARTSReactionReader, DataFormat::SMARTSSMARTSReactionInputHandler
 Handler for the input of reaction data in the Daylight SMARTS [SMARTS] format. More...
 
typedef Util::DefaultDataOutputHandler< SMARTSReactionWriter, DataFormat::SMARTSSMARTSReactionOutputHandler
 Handler for the output of reaction data in the Daylight SMARTS [SMARTS] format. More...
 
typedef Util::DefaultDataOutputHandler< SMILESBZ2MolecularGraphWriter, DataFormat::SMILES_BZ2SMILESBZ2MolecularGraphOutputHandler
 Handler for the output of bzip2-compressed molecular graph data in the Daylight SMILES [SMILES] format. More...
 
typedef Util::CompressedDataWriter< SMILESMolecularGraphWriter, Util::BZip2OStreamSMILESBZ2MolecularGraphWriter
 Writer for molecular graph data in the bzip2-compressed Daylight SMILES [SMILES] format. More...
 
typedef Util::DefaultDataInputHandler< SMILESBZ2MoleculeReader, DataFormat::SMILES_BZ2SMILESBZ2MoleculeInputHandler
 Handler for the input of bzip2-compressed molecule data in the Daylight SMILES [SMILES] format. More...
 
typedef Util::CompressedDataReader< SMILESMoleculeReader, Util::BZip2IStreamSMILESBZ2MoleculeReader
 Reader for molecule data in the bzip2-compressed Daylight SMILES [SMILES] format. More...
 
typedef Util::DefaultDataInputHandler< SMILESBZ2ReactionReader, DataFormat::SMILES_BZ2SMILESBZ2ReactionInputHandler
 Handler for the input of bzip2-compressed reaction data in the Daylight SMILES [SMILES] format. More...
 
typedef Util::DefaultDataOutputHandler< SMILESBZ2ReactionWriter, DataFormat::SMILES_BZ2SMILESBZ2ReactionOutputHandler
 Handler for the output of bzip2-compressed reaction data in the Daylight SMILES [SMILES] format. More...
 
typedef Util::CompressedDataReader< SMILESReactionReader, Util::BZip2IStreamSMILESBZ2ReactionReader
 Reader for reaction data in the bzip2-compressed Daylight SMILES [SMILES] format. More...
 
typedef Util::CompressedDataWriter< SMILESReactionWriter, Util::BZip2OStreamSMILESBZ2ReactionWriter
 Writer for reaction data in the bzip2-compressed Daylight SMILES [SMILES] format. More...
 
typedef Util::DefaultDataOutputHandler< SMILESGZMolecularGraphWriter, DataFormat::SMILES_GZSMILESGZMolecularGraphOutputHandler
 Handler for the output of gzip-compressed molecular graph data in the Daylight SMILES [SMILES] format. More...
 
typedef Util::CompressedDataWriter< SMILESMolecularGraphWriter, Util::GZipOStreamSMILESGZMolecularGraphWriter
 Writer for molecular graph data in the gzip-compressed Daylight SMILES [SMILES] format. More...
 
typedef Util::DefaultDataInputHandler< SMILESGZMoleculeReader, DataFormat::SMILES_GZSMILESGZMoleculeInputHandler
 Handler for the input of gzip-compressed molecule data in Daylight SMILES [SMILES] format. More...
 
typedef Util::CompressedDataReader< SMILESMoleculeReader, Util::GZipIStreamSMILESGZMoleculeReader
 Reader for molecule data in the gzip-compressed Daylight SMILES [SMILES] format. More...
 
typedef Util::DefaultDataInputHandler< SMILESGZReactionReader, DataFormat::SMILES_GZSMILESGZReactionInputHandler
 Handler for the input of gzip-compressed reaction data in the Daylight SMILES [SMILES] format. More...
 
typedef Util::DefaultDataOutputHandler< SMILESGZReactionWriter, DataFormat::SMILES_GZSMILESGZReactionOutputHandler
 Handler for the output of gzip-compressed reaction data in the Daylight SMILES [SMILES] format. More...
 
typedef Util::CompressedDataReader< SMILESReactionReader, Util::GZipIStreamSMILESGZReactionReader
 Reader for reaction data in the gzip-compressed Daylight SMILES [SMILES] format. More...
 
typedef Util::CompressedDataWriter< SMILESReactionWriter, Util::GZipOStreamSMILESGZReactionWriter
 Writer for reaction data in the gzip-compressed Daylight SMILES [SMILES] format. More...
 
typedef Util::DefaultDataOutputHandler< SMILESMolecularGraphWriter, DataFormat::SMILESSMILESMolecularGraphOutputHandler
 Handler for the output of molecular graph data in the Daylight SMILES [SMILES] format. More...
 
typedef Util::DefaultDataInputHandler< SMILESMoleculeReader, DataFormat::SMILESSMILESMoleculeInputHandler
 Handler for the input of molecule data in the Daylight SMILES [SMILES] format. More...
 
typedef Util::DefaultDataInputHandler< SMILESReactionReader, DataFormat::SMILESSMILESReactionInputHandler
 Handler for the input of reaction data in the Daylight SMILES [SMILES] format. More...
 
typedef Util::DefaultDataOutputHandler< SMILESReactionWriter, DataFormat::SMILESSMILESReactionOutputHandler
 Handler for the output of reaction data in the Daylight SMILES [SMILES] format. More...
 
typedef Util::DefaultDataOutputHandler< XYZBZ2MolecularGraphWriter, DataFormat::XYZ_BZ2XYZBZ2MolecularGraphOutputHandler
 Handler for the output of bzip2-compressed molecular graph data in the XYZ format. More...
 
typedef Util::CompressedDataWriter< XYZMolecularGraphWriter, Util::BZip2OStreamXYZBZ2MolecularGraphWriter
 Writer for molecular graph data in the bzip2-compressed XYZ format. More...
 
typedef Util::DefaultDataInputHandler< XYZBZ2MoleculeReader, DataFormat::XYZ_BZ2XYZBZ2MoleculeInputHandler
 Handler for the input of bzip2-compressed molecule data in the XYZ format. More...
 
typedef Util::CompressedDataReader< XYZMoleculeReader, Util::BZip2IStreamXYZBZ2MoleculeReader
 Reader for molecule data in the bzip2-compressed XYZ format. More...
 
typedef Util::DefaultDataOutputHandler< XYZGZMolecularGraphWriter, DataFormat::XYZ_GZXYZGZMolecularGraphOutputHandler
 Handler for the output of gzip-compressed molecular graph data in the XYZ format. More...
 
typedef Util::CompressedDataWriter< XYZMolecularGraphWriter, Util::GZipOStreamXYZGZMolecularGraphWriter
 Writer for molecular graph data in the gzip-compressed XYZ format. More...
 
typedef Util::DefaultDataInputHandler< XYZGZMoleculeReader, DataFormat::XYZ_GZXYZGZMoleculeInputHandler
 Handler for the input of gzip-compressed molecule data in the XYZ format. More...
 
typedef Util::CompressedDataReader< XYZMoleculeReader, Util::GZipIStreamXYZGZMoleculeReader
 Reader for molecule data in the gzip-compressed XYZ format. More...
 
typedef Util::DefaultDataOutputHandler< XYZMolecularGraphWriter, DataFormat::XYZXYZMolecularGraphOutputHandler
 Handler for the output of molecular graph data in the XYZ format. More...
 
typedef Util::DefaultDataInputHandler< XYZMoleculeReader, DataFormat::XYZXYZMoleculeInputHandler
 Handler for the input of molecule data in the XYZ format. More...
 

Functions

CDPL_CHEM_API bool hasCoordinates (const AtomContainer &cntnr, std::size_t dim)
 Tells whether all atoms of cntnr carry coordinates of the given dimensionality. More...
 
CDPL_CHEM_API void get2DCoordinates (const AtomContainer &cntnr, Math::Vector2DArray &coords, bool append=false)
 Extracts the 2D coordinates of all atoms in cntnr into coords. More...
 
CDPL_CHEM_API void set2DCoordinates (AtomContainer &cntnr, const Math::Vector2DArray &coords)
 Writes the 2D coordinates in coords back to the corresponding atoms of cntnr. More...
 
CDPL_CHEM_API void transform2DCoordinates (AtomContainer &cntnr, const Math::Matrix3D &mtx)
 Transforms the 2D coordinates of all atoms in cntnr by the affine 3×3 matrix mtx. More...
 
CDPL_CHEM_API void get3DCoordinates (const AtomContainer &cntnr, Math::Vector3DArray &coords, const Atom3DCoordinatesFunction &coords_func, bool append=false)
 Extracts the 3D coordinates of all atoms in cntnr into coords using the per-atom coordinate lookup function coords_func. More...
 
CDPL_CHEM_API void clearConformations (AtomContainer &cntnr)
 Removes all stored conformations from the atoms of cntnr. More...
 
CDPL_CHEM_API std::size_t getNumConformations (const AtomContainer &cntnr)
 Returns the number of conformations stored on the atoms of cntnr. More...
 
CDPL_CHEM_API void applyConformation (AtomContainer &cntnr, std::size_t conf_idx)
 Promotes the stored conformation at index conf_idx to the active per-atom 3D coordinates. More...
 
CDPL_CHEM_API void getConformation (const AtomContainer &cntnr, std::size_t conf_idx, Math::Vector3DArray &coords, bool append=false)
 Extracts the conformation at index conf_idx into coords. More...
 
CDPL_CHEM_API void setConformation (AtomContainer &cntnr, std::size_t conf_idx, const Math::Vector3DArray &coords)
 Overwrites the conformation at index conf_idx with the supplied 3D coordinates. More...
 
CDPL_CHEM_API void addConformation (AtomContainer &cntnr, const Math::Vector3DArray &coords)
 Appends a new conformation built from the supplied 3D coordinates to the atoms of cntnr. More...
 
CDPL_CHEM_API void transformConformation (AtomContainer &cntnr, std::size_t conf_idx, const Math::Matrix4D &mtx)
 Transforms the conformation at index conf_idx by the homogeneous 4×4 matrix mtx. More...
 
CDPL_CHEM_API void transformConformations (AtomContainer &cntnr, const Math::Matrix4D &mtx)
 Transforms every stored conformation of the atoms in cntnr by the homogeneous 4×4 matrix mtx. More...
 
CDPL_CHEM_API bool alignConformations (AtomContainer &cntnr, const Util::BitSet &ref_atoms, const Math::Vector3DArray &ref_coords)
 Aligns each stored conformation of cntnr onto the supplied reference coordinates using the atoms flagged in ref_atoms as alignment anchors. More...
 
CDPL_CHEM_API bool alignConformations (AtomContainer &cntnr, const AtomContainer &ref_atoms, const Math::Vector3DArray &ref_coords)
 Aligns each stored conformation of cntnr onto the supplied reference coordinates using the atoms of ref_atoms as alignment anchors. More...
 
CDPL_CHEM_API bool alignConformations (AtomContainer &cntnr, const Util::BitSet &ref_atoms)
 Aligns each stored conformation of cntnr to the first conformation using the atoms flagged in ref_atoms as alignment anchors. More...
 
CDPL_CHEM_API bool alignConformations (AtomContainer &cntnr, const AtomContainer &ref_atoms)
 Aligns each stored conformation of cntnr to the first conformation using the atoms of ref_atoms as alignment anchors. More...
 
CDPL_CHEM_API std::size_t getMaxComponentGroupID (const AtomContainer &cntnr)
 Returns the largest component-group ID assigned to any atom of cntnr. More...
 
CDPL_CHEM_API std::size_t getMaxAtomMappingID (const AtomContainer &cntnr)
 Returns the largest atom mapping ID assigned to any atom of cntnr. More...
 
CDPL_CHEM_API std::size_t createAtomTypeMask (const AtomContainer &cntnr, Util::BitSet &mask, unsigned int type, bool reset=true, bool strict=true)
 Sets bits in mask corresponding to atoms of cntnr whose atom type matches type. More...
 
CDPL_CHEM_API void copyAtomsIf (const AtomContainer &cntnr, Molecule &mol, const AtomPredicate &pred, bool append=false)
 Copies every atom of cntnr that satisfies pred into the molecule mol. More...
 
CDPL_CHEM_API void copyAtomsIf (const AtomContainer &cntnr, Fragment &frag, const AtomPredicate &pred, bool append=false)
 Copies every atom of cntnr that satisfies pred into the fragment frag. More...
 
CDPL_CHEM_API void copyAtomsIfNot (const AtomContainer &cntnr, Molecule &mol, const AtomPredicate &pred, bool append=false)
 Copies every atom of cntnr that does not satisfy pred into the molecule mol. More...
 
CDPL_CHEM_API void copyAtomsIfNot (const AtomContainer &cntnr, Fragment &frag, const AtomPredicate &pred, bool append=false)
 Copies every atom of cntnr that does not satisfy pred into the fragment frag. More...
 
CDPL_CHEM_API bool calcCenterOfMass (const AtomContainer &cntnr, const Atom3DCoordinatesFunction &coords_func, Math::Vector3D &ctr)
 Computes the mass-weighted center of mass of the atoms in cntnr. More...
 
CDPL_CHEM_API bool calcCentroid (const AtomContainer &cntnr, const Atom3DCoordinatesFunction &coords_func, Math::Vector3D &ctr)
 Computes the unweighted centroid (arithmetic mean of atom coordinates) of cntnr. More...
 
CDPL_CHEM_API void calcBoundingBox (const AtomContainer &cntnr, Math::Vector3D &min, Math::Vector3D &max, const Atom3DCoordinatesFunction &coords_func, bool reset=true)
 Computes the axis-aligned bounding box enclosing the atoms of cntnr. More...
 
CDPL_CHEM_API bool insideBoundingBox (const AtomContainer &cntnr, const Math::Vector3D &min, const Math::Vector3D &max, const Atom3DCoordinatesFunction &coords_func)
 Tells whether every atom of cntnr lies inside the axis-aligned bounding box defined by min and max. More...
 
CDPL_CHEM_API bool intersectsBoundingBox (const AtomContainer &cntnr, const Math::Vector3D &min, const Math::Vector3D &max, const Atom3DCoordinatesFunction &coords_func)
 Tells whether at least one atom of cntnr lies inside the axis-aligned bounding box defined by min and max. More...
 
CDPL_CHEM_API const std::string & getName (const Atom &atom)
 Returns the value of the Chem::AtomProperty::NAME property of the atom atom. More...
 
CDPL_CHEM_API void setName (Atom &atom, const std::string &name)
 Sets the value of the Chem::AtomProperty::NAME property of the atom atom to name. More...
 
CDPL_CHEM_API void clearName (Atom &atom)
 Clears the value of the Chem::AtomProperty::NAME property of the atom atom. More...
 
CDPL_CHEM_API bool hasName (const Atom &atom)
 Tells whether the Chem::AtomProperty::NAME property of the atom atom is set. More...
 
CDPL_CHEM_API const std::string & getSymbol (const Atom &atom)
 Returns the value of the Chem::AtomProperty::SYMBOL property of the atom atom. More...
 
CDPL_CHEM_API void setSymbol (Atom &atom, const std::string &symbol)
 Sets the value of the Chem::AtomProperty::SYMBOL property of the atom atom to symbol. More...
 
CDPL_CHEM_API void clearSymbol (Atom &atom)
 Clears the value of the Chem::AtomProperty::SYMBOL property of the atom atom. More...
 
CDPL_CHEM_API bool hasSymbol (const Atom &atom)
 Tells whether the Chem::AtomProperty::SYMBOL property of the atom atom is set. More...
 
CDPL_CHEM_API const std::string & getSymbolForType (const Atom &atom)
 Returns the element symbol that corresponds to the Chem::AtomProperty::TYPE property of the atom atom. More...
 
CDPL_CHEM_API unsigned int getType (const Atom &atom)
 Returns the value of the Chem::AtomProperty::TYPE property of the atom atom. More...
 
CDPL_CHEM_API void setType (Atom &atom, unsigned int type)
 Sets the value of the Chem::AtomProperty::TYPE property of the atom atom to type. More...
 
CDPL_CHEM_API void clearType (Atom &atom)
 Clears the value of the Chem::AtomProperty::TYPE property of the atom atom. More...
 
CDPL_CHEM_API bool hasType (const Atom &atom)
 Tells whether the Chem::AtomProperty::TYPE property of the atom atom is set. More...
 
CDPL_CHEM_API unsigned int getTypeForSymbol (const Atom &atom)
 Returns the atom type that corresponds to the Chem::AtomProperty::SYMBOL property of the atom atom. More...
 
CDPL_CHEM_API unsigned int getGenericType (const Atom &atom)
 Returns the generic atom type that the atom's Chem::AtomProperty::TYPE property value belongs to. More...
 
CDPL_CHEM_API long getFormalCharge (const Atom &atom)
 Returns the value of the Chem::AtomProperty::FORMAL_CHARGE property of the atom atom. More...
 
CDPL_CHEM_API void setFormalCharge (Atom &atom, long charge)
 Sets the value of the Chem::AtomProperty::FORMAL_CHARGE property of the atom atom to charge. More...
 
CDPL_CHEM_API void clearFormalCharge (Atom &atom)
 Clears the value of the Chem::AtomProperty::FORMAL_CHARGE property of the atom atom. More...
 
CDPL_CHEM_API bool hasFormalCharge (const Atom &atom)
 Tells whether the Chem::AtomProperty::FORMAL_CHARGE property of the atom atom is set. More...
 
CDPL_CHEM_API long calcFormalCharge (const Atom &atom, const MolecularGraph &molgraph)
 Computes the formal charge of the atom atom from its valence environment in the molecular graph molgraph. More...
 
CDPL_CHEM_API std::size_t getIsotope (const Atom &atom)
 Returns the value of the Chem::AtomProperty::ISOTOPE property of the atom atom. More...
 
CDPL_CHEM_API void setIsotope (Atom &atom, std::size_t isotope)
 Sets the value of the Chem::AtomProperty::ISOTOPE property of the atom atom to isotope. More...
 
CDPL_CHEM_API void clearIsotope (Atom &atom)
 Clears the value of the Chem::AtomProperty::ISOTOPE property of the atom atom. More...
 
CDPL_CHEM_API bool hasIsotope (const Atom &atom)
 Tells whether the Chem::AtomProperty::ISOTOPE property of the atom atom is set. More...
 
CDPL_CHEM_API unsigned int getRadicalType (const Atom &atom)
 Returns the value of the Chem::AtomProperty::RADICAL_TYPE property of the atom atom. More...
 
CDPL_CHEM_API void setRadicalType (Atom &atom, unsigned int type)
 Sets the value of the Chem::AtomProperty::RADICAL_TYPE property of the atom atom to type. More...
 
CDPL_CHEM_API void clearRadicalType (Atom &atom)
 Clears the value of the Chem::AtomProperty::RADICAL_TYPE property of the atom atom. More...
 
CDPL_CHEM_API bool hasRadicalType (const Atom &atom)
 Tells whether the Chem::AtomProperty::RADICAL_TYPE property of the atom atom is set. More...
 
CDPL_CHEM_API unsigned int getHybridizationState (const Atom &atom)
 Returns the value of the Chem::AtomProperty::HYBRIDIZATION property of the atom atom. More...
 
CDPL_CHEM_API void setHybridizationState (Atom &atom, unsigned int state)
 Sets the value of the Chem::AtomProperty::HYBRIDIZATION property of the atom atom to state. More...
 
CDPL_CHEM_API void clearHybridizationState (Atom &atom)
 Clears the value of the Chem::AtomProperty::HYBRIDIZATION property of the atom atom. More...
 
CDPL_CHEM_API bool hasHybridizationState (const Atom &atom)
 Tells whether the Chem::AtomProperty::HYBRIDIZATION property of the atom atom is set. More...
 
CDPL_CHEM_API unsigned int perceiveHybridizationState (const Atom &atom, const MolecularGraph &molgraph)
 Derives the hybridization state of the atom atom from its valence environment in the molecular graph molgraph. More...
 
CDPL_CHEM_API bool getRingFlag (const Atom &atom)
 Returns the value of the Chem::AtomProperty::RING_FLAG property of the atom atom. More...
 
CDPL_CHEM_API void setRingFlag (Atom &atom, bool in_ring)
 Sets the value of the Chem::AtomProperty::RING_FLAG property of the atom atom to in_ring. More...
 
CDPL_CHEM_API void clearRingFlag (Atom &atom)
 Clears the value of the Chem::AtomProperty::RING_FLAG property of the atom atom. More...
 
CDPL_CHEM_API bool hasRingFlag (const Atom &atom)
 Tells whether the Chem::AtomProperty::RING_FLAG property of the atom atom is set. More...
 
CDPL_CHEM_API bool isInFragmentOfSize (const Atom &atom, const FragmentList &frag_list, std::size_t size)
 Tells whether the atom atom is a member of any fragment in frag_list whose size matches size. More...
 
CDPL_CHEM_API std::size_t getSizeOfSmallestContainingFragment (const Atom &atom, const FragmentList &frag_list)
 Returns the size (in atoms) of the smallest fragment in frag_list that contains the atom atom. More...
 
CDPL_CHEM_API std::size_t getSizeOfLargestContainingFragment (const Atom &atom, const FragmentList &frag_list)
 Returns the size (in atoms) of the largest fragment in frag_list that contains the atom atom. More...
 
CDPL_CHEM_API std::size_t getNumContainingFragments (const Atom &atom, const FragmentList &frag_list)
 Returns the number of fragments in frag_list that contain the atom atom. More...
 
CDPL_CHEM_API void getContainingFragments (const Atom &atom, const FragmentList &frag_list, FragmentList &cont_frag_list, bool append=false)
 Collects the fragments in frag_list that contain the atom atom into cont_frag_list. More...
 
CDPL_CHEM_API bool getAromaticityFlag (const Atom &atom)
 Returns the value of the Chem::AtomProperty::AROMATICITY_FLAG property of the atom atom. More...
 
CDPL_CHEM_API void setAromaticityFlag (Atom &atom, bool aromatic)
 Sets the value of the Chem::AtomProperty::AROMATICITY_FLAG property of the atom atom to aromatic. More...
 
CDPL_CHEM_API void clearAromaticityFlag (Atom &atom)
 Clears the value of the Chem::AtomProperty::AROMATICITY_FLAG property of the atom atom. More...
 
CDPL_CHEM_API bool hasAromaticityFlag (const Atom &atom)
 Tells whether the Chem::AtomProperty::AROMATICITY_FLAG property of the atom atom is set. More...
 
CDPL_CHEM_API std::size_t getUnpairedElectronCount (const Atom &atom)
 Returns the value of the Chem::AtomProperty::UNPAIRED_ELECTRON_COUNT property of the atom atom. More...
 
CDPL_CHEM_API void setUnpairedElectronCount (Atom &atom, std::size_t count)
 Sets the value of the Chem::AtomProperty::UNPAIRED_ELECTRON_COUNT property of the atom atom to count. More...
 
CDPL_CHEM_API void clearUnpairedElectronCount (Atom &atom)
 Clears the value of the Chem::AtomProperty::UNPAIRED_ELECTRON_COUNT property of the atom atom. More...
 
CDPL_CHEM_API bool hasUnpairedElectronCount (const Atom &atom)
 Tells whether the Chem::AtomProperty::UNPAIRED_ELECTRON_COUNT property of the atom atom is set. More...
 
CDPL_CHEM_API std::size_t getImplicitHydrogenCount (const Atom &atom)
 Returns the value of the Chem::AtomProperty::IMPLICIT_HYDROGEN_COUNT property of the atom atom. More...
 
CDPL_CHEM_API void setImplicitHydrogenCount (Atom &atom, std::size_t count)
 Sets the value of the Chem::AtomProperty::IMPLICIT_HYDROGEN_COUNT property of the atom atom to count. More...
 
CDPL_CHEM_API void clearImplicitHydrogenCount (Atom &atom)
 Clears the value of the Chem::AtomProperty::IMPLICIT_HYDROGEN_COUNT property of the atom atom. More...
 
CDPL_CHEM_API bool hasImplicitHydrogenCount (const Atom &atom)
 Tells whether the Chem::AtomProperty::IMPLICIT_HYDROGEN_COUNT property of the atom atom is set. More...
 
CDPL_CHEM_API std::size_t calcImplicitHydrogenCount (const Atom &atom, const MolecularGraph &molgraph)
 Computes the implicit hydrogen count of the atom atom from its valence environment in the molecular graph molgraph. More...
 
CDPL_CHEM_API const Math::Vector2Dget2DCoordinates (const Atom &atom)
 Returns the value of the Chem::AtomProperty::COORDINATES_2D property of the atom atom. More...
 
CDPL_CHEM_API void set2DCoordinates (Atom &atom, const Math::Vector2D &coords)
 Sets the value of the Chem::AtomProperty::COORDINATES_2D property of the atom atom to coords. More...
 
CDPL_CHEM_API void clear2DCoordinates (Atom &atom)
 Clears the value of the Chem::AtomProperty::COORDINATES_2D property of the atom atom. More...
 
CDPL_CHEM_API bool has2DCoordinates (const Atom &atom)
 Tells whether the Chem::AtomProperty::COORDINATES_2D property of the atom atom is set. More...
 
CDPL_CHEM_API const Math::Vector3DgetConformer3DCoordinates (const Atom &atom, std::size_t conf_idx)
 Returns the 3D coordinates of the atom atom for conformer conf_idx (from the Chem::AtomProperty::COORDINATES_3D_ARRAY property). More...
 
CDPL_CHEM_API const Math::Vector3DArray::SharedPointer & get3DCoordinatesArray (const Atom &atom)
 Returns the value of the Chem::AtomProperty::COORDINATES_3D_ARRAY property of the atom atom. More...
 
CDPL_CHEM_API void set3DCoordinatesArray (Atom &atom, const Math::Vector3DArray::SharedPointer &coords_array)
 Sets the value of the Chem::AtomProperty::COORDINATES_3D_ARRAY property of the atom atom to coords_array. More...
 
CDPL_CHEM_API void clear3DCoordinatesArray (Atom &atom)
 Clears the value of the Chem::AtomProperty::COORDINATES_3D_ARRAY property of the atom atom. More...
 
CDPL_CHEM_API bool has3DCoordinatesArray (const Atom &atom)
 Tells whether the Chem::AtomProperty::COORDINATES_3D_ARRAY property of the atom atom is set. More...
 
CDPL_CHEM_API std::size_t getMorganNumber (const Atom &atom)
 Returns the value of the Chem::AtomProperty::MORGAN_NUMBER property of the atom atom. More...
 
CDPL_CHEM_API void setMorganNumber (Atom &atom, std::size_t num)
 Sets the value of the Chem::AtomProperty::MORGAN_NUMBER property of the atom atom to num. More...
 
CDPL_CHEM_API void clearMorganNumber (Atom &atom)
 Clears the value of the Chem::AtomProperty::MORGAN_NUMBER property of the atom atom. More...
 
CDPL_CHEM_API bool hasMorganNumber (const Atom &atom)
 Tells whether the Chem::AtomProperty::MORGAN_NUMBER property of the atom atom is set. More...
 
CDPL_CHEM_API std::size_t getCanonicalNumber (const Atom &atom)
 Returns the value of the Chem::AtomProperty::CANONICAL_NUMBER property of the atom atom. More...
 
CDPL_CHEM_API void setCanonicalNumber (Atom &atom, std::size_t num)
 Sets the value of the Chem::AtomProperty::CANONICAL_NUMBER property of the atom atom to num. More...
 
CDPL_CHEM_API void clearCanonicalNumber (Atom &atom)
 Clears the value of the Chem::AtomProperty::CANONICAL_NUMBER property of the atom atom. More...
 
CDPL_CHEM_API bool hasCanonicalNumber (const Atom &atom)
 Tells whether the Chem::AtomProperty::CANONICAL_NUMBER property of the atom atom is set. More...
 
CDPL_CHEM_API std::size_t getCIPPriority (const Atom &atom)
 Returns the value of the Chem::AtomProperty::CIP_PRIORITY property of the atom atom. More...
 
CDPL_CHEM_API void setCIPPriority (Atom &atom, std::size_t priority)
 Sets the value of the Chem::AtomProperty::CIP_PRIORITY property of the atom atom to priority. More...
 
CDPL_CHEM_API void clearCIPPriority (Atom &atom)
 Clears the value of the Chem::AtomProperty::CIP_PRIORITY property of the atom atom. More...
 
CDPL_CHEM_API bool hasCIPPriority (const Atom &atom)
 Tells whether the Chem::AtomProperty::CIP_PRIORITY property of the atom atom is set. More...
 
CDPL_CHEM_API std::size_t getSymmetryClass (const Atom &atom)
 Returns the value of the Chem::AtomProperty::SYMMETRY_CLASS property of the atom atom. More...
 
CDPL_CHEM_API void setSymmetryClass (Atom &atom, std::size_t class_id)
 Sets the value of the Chem::AtomProperty::SYMMETRY_CLASS property of the atom atom to class_id. More...
 
CDPL_CHEM_API void clearSymmetryClass (Atom &atom)
 Clears the value of the Chem::AtomProperty::SYMMETRY_CLASS property of the atom atom. More...
 
CDPL_CHEM_API bool hasSymmetryClass (const Atom &atom)
 Tells whether the Chem::AtomProperty::SYMMETRY_CLASS property of the atom atom is set. More...
 
CDPL_CHEM_API unsigned int getCIPConfiguration (const Atom &atom)
 Returns the value of the Chem::AtomProperty::CIP_CONFIGURATION property of the atom atom. More...
 
CDPL_CHEM_API void setCIPConfiguration (Atom &atom, unsigned int config)
 Sets the value of the Chem::AtomProperty::CIP_CONFIGURATION property of the atom atom to config. More...
 
CDPL_CHEM_API void clearCIPConfiguration (Atom &atom)
 Clears the value of the Chem::AtomProperty::CIP_CONFIGURATION property of the atom atom. More...
 
CDPL_CHEM_API bool hasCIPConfiguration (const Atom &atom)
 Tells whether the Chem::AtomProperty::CIP_CONFIGURATION property of the atom atom is set. More...
 
CDPL_CHEM_API const StereoDescriptorgetStereoDescriptor (const Atom &atom)
 Returns the value of the Chem::AtomProperty::STEREO_DESCRIPTOR property of the atom atom. More...
 
CDPL_CHEM_API void setStereoDescriptor (Atom &atom, const StereoDescriptor &descr)
 Sets the value of the Chem::AtomProperty::STEREO_DESCRIPTOR property of the atom atom to descr. More...
 
CDPL_CHEM_API void clearStereoDescriptor (Atom &atom)
 Clears the value of the Chem::AtomProperty::STEREO_DESCRIPTOR property of the atom atom. More...
 
CDPL_CHEM_API bool hasStereoDescriptor (const Atom &atom)
 Tells whether the Chem::AtomProperty::STEREO_DESCRIPTOR property of the atom atom is set. More...
 
CDPL_CHEM_API StereoDescriptor calcStereoDescriptor (const Atom &atom, const MolecularGraph &molgraph, std::size_t dim=1)
 Computes the stereo descriptor for the atom atom based on the geometry of the molecular graph molgraph. More...
 
CDPL_CHEM_API StereoDescriptor calcStereoDescriptorFromMDLParity (const Atom &atom, const MolecularGraph &molgraph)
 Derives the stereo descriptor of the atom atom from its MDL parity in the molecular graph molgraph. More...
 
CDPL_CHEM_API unsigned int calcConfiguration (const Atom &atom, const MolecularGraph &molgraph, const StereoDescriptor &descr, const Math::Vector3DArray &coords)
 Derives the atom configuration label from the supplied descriptor and 3D coordinates. More...
 
CDPL_CHEM_API bool getStereoCenterFlag (const Atom &atom)
 Returns the value of the Chem::AtomProperty::STEREO_CENTER_FLAG property of the atom atom. More...
 
CDPL_CHEM_API void setStereoCenterFlag (Atom &atom, bool is_center)
 Sets the value of the Chem::AtomProperty::STEREO_CENTER_FLAG property of the atom atom to is_center. More...
 
CDPL_CHEM_API void clearStereoCenterFlag (Atom &atom)
 Clears the value of the Chem::AtomProperty::STEREO_CENTER_FLAG property of the atom atom. More...
 
CDPL_CHEM_API bool hasStereoCenterFlag (const Atom &atom)
 Tells whether the Chem::AtomProperty::STEREO_CENTER_FLAG property of the atom atom is set. More...
 
CDPL_CHEM_API bool isStereoCenter (const Atom &atom, const MolecularGraph &molgraph, bool check_asym=true, bool check_inv_n=true, bool check_quart_n=true, bool check_plan_n=true, bool check_amide_n=true, bool check_res_ctrs=true)
 Tells whether the atom atom qualifies as a stereo center in the context of the molecular graph molgraph. More...
 
CDPL_CHEM_API unsigned int getSybylType (const Atom &atom)
 Returns the value of the Chem::AtomProperty::SYBYL_TYPE property of the atom atom. More...
 
CDPL_CHEM_API void setSybylType (Atom &atom, unsigned int type)
 Sets the value of the Chem::AtomProperty::SYBYL_TYPE property of the atom atom to type. More...
 
CDPL_CHEM_API void clearSybylType (Atom &atom)
 Clears the value of the Chem::AtomProperty::SYBYL_TYPE property of the atom atom. More...
 
CDPL_CHEM_API bool hasSybylType (const Atom &atom)
 Tells whether the Chem::AtomProperty::SYBYL_TYPE property of the atom atom is set. More...
 
CDPL_CHEM_API unsigned int perceiveSybylType (const Atom &atom, const MolecularGraph &molgraph)
 Derives the Sybyl MOL2 atom type of the atom atom from its valence environment in the molecular graph molgraph. More...
 
CDPL_CHEM_API const std::string & getMOL2Name (const Atom &atom)
 Returns the value of the Chem::AtomProperty::MOL2_NAME property of the atom atom. More...
 
CDPL_CHEM_API void setMOL2Name (Atom &atom, const std::string &name)
 Sets the value of the Chem::AtomProperty::MOL2_NAME property of the atom atom to name. More...
 
CDPL_CHEM_API void clearMOL2Name (Atom &atom)
 Clears the value of the Chem::AtomProperty::MOL2_NAME property of the atom atom. More...
 
CDPL_CHEM_API bool hasMOL2Name (const Atom &atom)
 Tells whether the Chem::AtomProperty::MOL2_NAME property of the atom atom is set. More...
 
CDPL_CHEM_API double getMOL2Charge (const Atom &atom)
 Returns the value of the Chem::AtomProperty::MOL2_CHARGE property of the atom atom. More...
 
CDPL_CHEM_API void setMOL2Charge (Atom &atom, double charge)
 Sets the value of the Chem::AtomProperty::MOL2_CHARGE property of the atom atom to charge. More...
 
CDPL_CHEM_API void clearMOL2Charge (Atom &atom)
 Clears the value of the Chem::AtomProperty::MOL2_CHARGE property of the atom atom. More...
 
CDPL_CHEM_API bool hasMOL2Charge (const Atom &atom)
 Tells whether the Chem::AtomProperty::MOL2_CHARGE property of the atom atom is set. More...
 
CDPL_CHEM_API std::size_t getMOL2SubstructureID (const Atom &atom)
 Returns the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_ID property of the atom atom. More...
 
CDPL_CHEM_API void setMOL2SubstructureID (Atom &atom, std::size_t id)
 Sets the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_ID property of the atom atom to id. More...
 
CDPL_CHEM_API void clearMOL2SubstructureID (Atom &atom)
 Clears the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_ID property of the atom atom. More...
 
CDPL_CHEM_API bool hasMOL2SubstructureID (const Atom &atom)
 Tells whether the Chem::AtomProperty::MOL2_SUBSTRUCTURE_ID property of the atom atom is set. More...
 
CDPL_CHEM_API const std::string & getMOL2SubstructureName (const Atom &atom)
 Returns the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_NAME property of the atom atom. More...
 
CDPL_CHEM_API void setMOL2SubstructureName (Atom &atom, const std::string &id)
 Sets the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_NAME property of the atom atom to id. More...
 
CDPL_CHEM_API void clearMOL2SubstructureName (Atom &atom)
 Clears the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_NAME property of the atom atom. More...
 
CDPL_CHEM_API bool hasMOL2SubstructureName (const Atom &atom)
 Tells whether the Chem::AtomProperty::MOL2_SUBSTRUCTURE_NAME property of the atom atom is set. More...
 
CDPL_CHEM_API const std::string & getMOL2SubstructureSubtype (const Atom &atom)
 Returns the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_SUBTYPE property of the atom atom. More...
 
CDPL_CHEM_API void setMOL2SubstructureSubtype (Atom &atom, const std::string &subtype)
 Sets the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_SUBTYPE property of the atom atom to subtype. More...
 
CDPL_CHEM_API void clearMOL2SubstructureSubtype (Atom &atom)
 Clears the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_SUBTYPE property of the atom atom. More...
 
CDPL_CHEM_API bool hasMOL2SubstructureSubtype (const Atom &atom)
 Tells whether the Chem::AtomProperty::MOL2_SUBSTRUCTURE_SUBTYPE property of the atom atom is set. More...
 
CDPL_CHEM_API const std::string & getMOL2SubstructureChain (const Atom &atom)
 Returns the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_CHAIN property of the atom atom. More...
 
CDPL_CHEM_API void setMOL2SubstructureChain (Atom &atom, const std::string &chain)
 Sets the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_CHAIN property of the atom atom to chain. More...
 
CDPL_CHEM_API void clearMOL2SubstructureChain (Atom &atom)
 Clears the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_CHAIN property of the atom atom. More...
 
CDPL_CHEM_API bool hasMOL2SubstructureChain (const Atom &atom)
 Tells whether the Chem::AtomProperty::MOL2_SUBSTRUCTURE_CHAIN property of the atom atom is set. More...
 
CDPL_CHEM_API unsigned int getMDLParity (const Atom &atom)
 Returns the value of the Chem::AtomProperty::MDL_PARITY property of the atom atom. More...
 
CDPL_CHEM_API void setMDLParity (Atom &atom, unsigned int parity)
 Sets the value of the Chem::AtomProperty::MDL_PARITY property of the atom atom to parity. More...
 
CDPL_CHEM_API void clearMDLParity (Atom &atom)
 Clears the value of the Chem::AtomProperty::MDL_PARITY property of the atom atom. More...
 
CDPL_CHEM_API bool hasMDLParity (const Atom &atom)
 Tells whether the Chem::AtomProperty::MDL_PARITY property of the atom atom is set. More...
 
CDPL_CHEM_API unsigned int calcMDLParity (const Atom &atom, const MolecularGraph &molgraph)
 Computes the MDL parity of the atom atom from its 2D layout and stereo flags in the molecular graph molgraph. More...
 
CDPL_CHEM_API bool getMDLStereoCareFlag (const Atom &atom)
 Returns the value of the Chem::AtomProperty::MDL_DB_STEREO_CARE_FLAG property of the atom atom. More...
 
CDPL_CHEM_API void setMDLStereoCareFlag (Atom &atom, bool flag)
 Sets the value of the Chem::AtomProperty::MDL_DB_STEREO_CARE_FLAG property of the atom atom to flag. More...
 
CDPL_CHEM_API void clearMDLStereoCareFlag (Atom &atom)
 Clears the value of the Chem::AtomProperty::MDL_DB_STEREO_CARE_FLAG property of the atom atom. More...
 
CDPL_CHEM_API bool hasMDLStereoCareFlag (const Atom &atom)
 Tells whether the Chem::AtomProperty::MDL_DB_STEREO_CARE_FLAG property of the atom atom is set. More...
 
CDPL_CHEM_API unsigned int getReactionCenterStatus (const Atom &atom)
 Returns the value of the Chem::AtomProperty::REACTION_CENTER_STATUS property of the atom atom. More...
 
CDPL_CHEM_API void setReactionCenterStatus (Atom &atom, unsigned int status)
 Sets the value of the Chem::AtomProperty::REACTION_CENTER_STATUS property of the atom atom to status. More...
 
CDPL_CHEM_API void clearReactionCenterStatus (Atom &atom)
 Clears the value of the Chem::AtomProperty::REACTION_CENTER_STATUS property of the atom atom. More...
 
CDPL_CHEM_API bool hasReactionCenterStatus (const Atom &atom)
 Tells whether the Chem::AtomProperty::REACTION_CENTER_STATUS property of the atom atom is set. More...
 
CDPL_CHEM_API std::size_t getAtomMappingID (const Atom &atom)
 Returns the value of the Chem::AtomProperty::ATOM_MAPPING_ID property of the atom atom. More...
 
CDPL_CHEM_API void setAtomMappingID (Atom &atom, std::size_t id)
 Sets the value of the Chem::AtomProperty::ATOM_MAPPING_ID property of the atom atom to id. More...
 
CDPL_CHEM_API void clearAtomMappingID (Atom &atom)
 Clears the value of the Chem::AtomProperty::ATOM_MAPPING_ID property of the atom atom. More...
 
CDPL_CHEM_API bool hasAtomMappingID (const Atom &atom)
 Tells whether the Chem::AtomProperty::ATOM_MAPPING_ID property of the atom atom is set. More...
 
CDPL_CHEM_API std::size_t getComponentGroupID (const Atom &atom)
 Returns the value of the Chem::AtomProperty::COMPONENT_GROUP_ID property of the atom atom. More...
 
CDPL_CHEM_API void setComponentGroupID (Atom &atom, std::size_t id)
 Sets the value of the Chem::AtomProperty::COMPONENT_GROUP_ID property of the atom atom to id. More...
 
CDPL_CHEM_API void clearComponentGroupID (Atom &atom)
 Clears the value of the Chem::AtomProperty::COMPONENT_GROUP_ID property of the atom atom. More...
 
CDPL_CHEM_API bool hasComponentGroupID (const Atom &atom)
 Tells whether the Chem::AtomProperty::COMPONENT_GROUP_ID property of the atom atom is set. More...
 
CDPL_CHEM_API const MatchConstraintList::SharedPointergetMatchConstraints (const Atom &atom)
 Returns the value of the Chem::AtomProperty::MATCH_CONSTRAINTS property of the atom atom. More...
 
CDPL_CHEM_API void setMatchConstraints (Atom &atom, const MatchConstraintList::SharedPointer &constr)
 Sets the value of the Chem::AtomProperty::MATCH_CONSTRAINTS property of the atom atom to constr. More...
 
CDPL_CHEM_API void clearMatchConstraints (Atom &atom)
 Clears the value of the Chem::AtomProperty::MATCH_CONSTRAINTS property of the atom atom. More...
 
CDPL_CHEM_API bool hasMatchConstraints (const Atom &atom)
 Tells whether the Chem::AtomProperty::MATCH_CONSTRAINTS property of the atom atom is set. More...
 
CDPL_CHEM_API const MatchExpression< Atom, MolecularGraph >::SharedPointer & getMatchExpression (const Atom &atom)
 Returns the value of the Chem::AtomProperty::MATCH_EXPRESSION property of the atom atom. More...
 
CDPL_CHEM_API void setMatchExpression (Atom &atom, const MatchExpression< Atom, MolecularGraph >::SharedPointer &expr)
 Sets the value of the Chem::AtomProperty::MATCH_EXPRESSION property of the atom atom to expr. More...
 
CDPL_CHEM_API void clearMatchExpression (Atom &atom)
 Clears the value of the Chem::AtomProperty::MATCH_EXPRESSION property of the atom atom. More...
 
CDPL_CHEM_API bool hasMatchExpression (const Atom &atom)
 Tells whether the Chem::AtomProperty::MATCH_EXPRESSION property of the atom atom is set. More...
 
CDPL_CHEM_API MatchExpression< Atom, MolecularGraph >::SharedPointer generateMatchExpression (const Atom &atom, const MolecularGraph &molgraph)
 Builds an atom-level match expression from the match constraint list attached to the atom atom. More...
 
CDPL_CHEM_API const std::string & getMatchExpressionString (const Atom &atom)
 Returns the value of the Chem::AtomProperty::MATCH_EXPRESSION_STRING property of the atom atom. More...
 
CDPL_CHEM_API void setMatchExpressionString (Atom &atom, const std::string &expr_str)
 Sets the value of the Chem::AtomProperty::MATCH_EXPRESSION_STRING property of the atom atom to expr_str. More...
 
CDPL_CHEM_API void clearMatchExpressionString (Atom &atom)
 Clears the value of the Chem::AtomProperty::MATCH_EXPRESSION_STRING property of the atom atom. More...
 
CDPL_CHEM_API bool hasMatchExpressionString (const Atom &atom)
 Tells whether the Chem::AtomProperty::MATCH_EXPRESSION_STRING property of the atom atom is set. More...
 
CDPL_CHEM_API void generateMatchExpressionString (const Atom &atom, const MolecularGraph &molgraph, std::string &expr_str)
 Writes a textual representation of the atom-level match expression of the atom atom into expr_str. More...
 
CDPL_CHEM_API void markReachableAtoms (const Atom &atom, const MolecularGraph &molgraph, Util::BitSet &atom_mask, bool reset=true)
 Sets bits in atom_mask for every atom of the molecular graph molgraph that is reachable from the atom atom through the bonds of molgraph. More...
 
CDPL_CHEM_API std::size_t getTopologicalDistance (const Atom &atom1, const Atom &atom2, const MolecularGraph &molgraph)
 Returns the topological distance between two atoms of the molecular graph molgraph. More...
 
CDPL_CHEM_API std::size_t getEnvironment (const Atom &atom, const MolecularGraph &molgraph, std::size_t max_dist, Fragment &env, bool append=false)
 Collects every atom of the molecular graph molgraph that is within max_dist bonds of the atom atom into the fragment env. More...
 
template<typename AtomType , typename OutputIterator >
std::size_t getConnectedAtoms (AtomType &atom, const MolecularGraph &molgraph, OutputIterator it, AtomType *excl_atom=0)
 Writes every neighbor of the atom atom (with bonds belonging to the molecular graph molgraph) into it, skipping excl_atom. More...
 
template<typename AtomType , typename OutputIterator >
std::size_t getIncidentBonds (AtomType &atom, const MolecularGraph &molgraph, OutputIterator it, AtomType *excl_atom=0)
 Writes every bond incident to the atom atom (with both endpoints belonging to the molecular graph molgraph) into it, skipping bonds to excl_atom. More...
 
template<typename AtomType , typename AtomOutputIterator , typename BondOutputIterator >
std::size_t getConnectedAtomsAndBonds (AtomType &atom, const MolecularGraph &molgraph, AtomOutputIterator ao_it, BondOutputIterator bo_it, AtomType *excl_atom=0)
 Writes every neighbor of the atom atom and the corresponding incident bond (both filtered by the molecular graph molgraph) into the supplied output iterators. More...
 
CDPL_CHEM_API std::size_t getOrder (const Bond &bond)
 Returns the value of the Chem::BondProperty::ORDER property of the bond bond. More...
 
CDPL_CHEM_API void setOrder (Bond &bond, std::size_t order)
 Sets the value of the Chem::BondProperty::ORDER property of the bond bond to order. More...
 
CDPL_CHEM_API void clearOrder (Bond &bond)
 Clears the value of the Chem::BondProperty::ORDER property of the bond bond. More...
 
CDPL_CHEM_API bool hasOrder (const Bond &bond)
 Tells whether the Chem::BondProperty::ORDER property of the bond bond is set. More...
 
CDPL_CHEM_API bool getRingFlag (const Bond &bond)
 Returns the value of the Chem::BondProperty::RING_FLAG property of the bond bond. More...
 
CDPL_CHEM_API void setRingFlag (Bond &bond, bool in_ring)
 Sets the value of the Chem::BondProperty::RING_FLAG property of the bond bond to in_ring. More...
 
CDPL_CHEM_API void clearRingFlag (Bond &bond)
 Clears the value of the Chem::BondProperty::RING_FLAG property of the bond bond. More...
 
CDPL_CHEM_API bool hasRingFlag (const Bond &bond)
 Tells whether the Chem::BondProperty::RING_FLAG property of the bond bond is set. More...
 
CDPL_CHEM_API bool isInFragmentOfSize (const Bond &bond, const FragmentList &frag_list, std::size_t size)
 Tells whether the bond bond is a member of any fragment in frag_list whose size matches size. More...
 
CDPL_CHEM_API std::size_t getSizeOfSmallestContainingFragment (const Bond &bond, const FragmentList &frag_list)
 Returns the size (in atoms) of the smallest fragment in frag_list that contains the bond bond. More...
 
CDPL_CHEM_API std::size_t getSizeOfLargestContainingFragment (const Bond &bond, const FragmentList &frag_list)
 Returns the size (in atoms) of the largest fragment in frag_list that contains the bond bond. More...
 
CDPL_CHEM_API std::size_t getNumContainingFragments (const Bond &bond, const FragmentList &frag_list)
 Returns the number of fragments in frag_list that contain the bond bond. More...
 
CDPL_CHEM_API void getContainingFragments (const Bond &bond, const FragmentList &frag_list, FragmentList &cont_frag_list, bool append=false)
 Collects the fragments in frag_list that contain the bond bond into cont_frag_list. More...
 
CDPL_CHEM_API bool getAromaticityFlag (const Bond &bond)
 Returns the value of the Chem::BondProperty::AROMATICITY_FLAG property of the bond bond. More...
 
CDPL_CHEM_API void setAromaticityFlag (Bond &bond, bool aromatic)
 Sets the value of the Chem::BondProperty::AROMATICITY_FLAG property of the bond bond to aromatic. More...
 
CDPL_CHEM_API void clearAromaticityFlag (Bond &bond)
 Clears the value of the Chem::BondProperty::AROMATICITY_FLAG property of the bond bond. More...
 
CDPL_CHEM_API bool hasAromaticityFlag (const Bond &bond)
 Tells whether the Chem::BondProperty::AROMATICITY_FLAG property of the bond bond is set. More...
 
CDPL_CHEM_API unsigned int get2DStereoFlag (const Bond &bond)
 Returns the value of the Chem::BondProperty::STEREO_2D_FLAG property of the bond bond. More...
 
CDPL_CHEM_API void set2DStereoFlag (Bond &bond, unsigned int flag)
 Sets the value of the Chem::BondProperty::STEREO_2D_FLAG property of the bond bond to flag. More...
 
CDPL_CHEM_API void clear2DStereoFlag (Bond &bond)
 Clears the value of the Chem::BondProperty::STEREO_2D_FLAG property of the bond bond. More...
 
CDPL_CHEM_API bool has2DStereoFlag (const Bond &bond)
 Tells whether the Chem::BondProperty::STEREO_2D_FLAG property of the bond bond is set. More...
 
CDPL_CHEM_API unsigned int getCIPConfiguration (const Bond &bond)
 Returns the value of the Chem::BondProperty::CIP_CONFIGURATION property of the bond bond. More...
 
CDPL_CHEM_API void setCIPConfiguration (Bond &bond, unsigned int config)
 Sets the value of the Chem::BondProperty::CIP_CONFIGURATION property of the bond bond to config. More...
 
CDPL_CHEM_API void clearCIPConfiguration (Bond &bond)
 Clears the value of the Chem::BondProperty::CIP_CONFIGURATION property of the bond bond. More...
 
CDPL_CHEM_API bool hasCIPConfiguration (const Bond &bond)
 Tells whether the Chem::BondProperty::CIP_CONFIGURATION property of the bond bond is set. More...
 
CDPL_CHEM_API const StereoDescriptorgetStereoDescriptor (const Bond &bond)
 Returns the value of the Chem::BondProperty::STEREO_DESCRIPTOR property of the bond bond. More...
 
CDPL_CHEM_API void setStereoDescriptor (Bond &bond, const StereoDescriptor &descr)
 Sets the value of the Chem::BondProperty::STEREO_DESCRIPTOR property of the bond bond to descr. More...
 
CDPL_CHEM_API void clearStereoDescriptor (Bond &bond)
 Clears the value of the Chem::BondProperty::STEREO_DESCRIPTOR property of the bond bond. More...
 
CDPL_CHEM_API bool hasStereoDescriptor (const Bond &bond)
 Tells whether the Chem::BondProperty::STEREO_DESCRIPTOR property of the bond bond is set. More...
 
CDPL_CHEM_API StereoDescriptor calcStereoDescriptor (const Bond &bond, const MolecularGraph &molgraph, std::size_t dim=1)
 Computes the stereo descriptor for the bond bond based on the geometry of the molecular graph molgraph. More...
 
CDPL_CHEM_API unsigned int calcConfiguration (const Bond &bond, const MolecularGraph &molgraph, const StereoDescriptor &descr, const Math::Vector3DArray &coords)
 Derives the bond configuration label from the supplied descriptor and 3D coordinates. More...
 
CDPL_CHEM_API bool getStereoCenterFlag (const Bond &bond)
 Returns the value of the Chem::BondProperty::STEREO_CENTER_FLAG property of the bond bond. More...
 
CDPL_CHEM_API void setStereoCenterFlag (Bond &bond, bool is_center)
 Sets the value of the Chem::BondProperty::STEREO_CENTER_FLAG property of the bond bond to is_center. More...
 
CDPL_CHEM_API void clearStereoCenterFlag (Bond &bond)
 Clears the value of the Chem::BondProperty::STEREO_CENTER_FLAG property of the bond bond. More...
 
CDPL_CHEM_API bool hasStereoCenterFlag (const Bond &bond)
 Tells whether the Chem::BondProperty::STEREO_CENTER_FLAG property of the bond bond is set. More...
 
CDPL_CHEM_API bool isStereoCenter (const Bond &bond, const MolecularGraph &molgraph, bool check_asym=true, bool check_term_n=true, bool check_order=true, std::size_t min_ring_size=8)
 Tells whether the bond bond qualifies as a stereo center in the context of the molecular graph molgraph. More...
 
CDPL_CHEM_API unsigned int getDirection (const Bond &bond)
 Returns the value of the Chem::BondProperty::DIRECTION property of the bond bond. More...
 
CDPL_CHEM_API void setDirection (Bond &bond, unsigned int dir)
 Sets the value of the Chem::BondProperty::DIRECTION property of the bond bond to dir. More...
 
CDPL_CHEM_API void clearDirection (Bond &bond)
 Clears the value of the Chem::BondProperty::DIRECTION property of the bond bond. More...
 
CDPL_CHEM_API bool hasDirection (const Bond &bond)
 Tells whether the Chem::BondProperty::DIRECTION property of the bond bond is set. More...
 
CDPL_CHEM_API unsigned int getReactionCenterStatus (const Bond &bond)
 Returns the value of the Chem::BondProperty::REACTION_CENTER_STATUS property of the bond bond. More...
 
CDPL_CHEM_API void setReactionCenterStatus (Bond &bond, unsigned int status)
 Sets the value of the Chem::BondProperty::REACTION_CENTER_STATUS property of the bond bond to status. More...
 
CDPL_CHEM_API void clearReactionCenterStatus (Bond &bond)
 Clears the value of the Chem::BondProperty::REACTION_CENTER_STATUS property of the bond bond. More...
 
CDPL_CHEM_API bool hasReactionCenterStatus (const Bond &bond)
 Tells whether the Chem::BondProperty::REACTION_CENTER_STATUS property of the bond bond is set. More...
 
CDPL_CHEM_API const MatchConstraintList::SharedPointergetMatchConstraints (const Bond &bond)
 Returns the value of the Chem::BondProperty::MATCH_CONSTRAINTS property of the bond bond. More...
 
CDPL_CHEM_API void setMatchConstraints (Bond &bond, const MatchConstraintList::SharedPointer &constr)
 Sets the value of the Chem::BondProperty::MATCH_CONSTRAINTS property of the bond bond to constr. More...
 
CDPL_CHEM_API void clearMatchConstraints (Bond &bond)
 Clears the value of the Chem::BondProperty::MATCH_CONSTRAINTS property of the bond bond. More...
 
CDPL_CHEM_API bool hasMatchConstraints (const Bond &bond)
 Tells whether the Chem::BondProperty::MATCH_CONSTRAINTS property of the bond bond is set. More...
 
CDPL_CHEM_API const MatchExpression< Bond, MolecularGraph >::SharedPointer & getMatchExpression (const Bond &bond)
 Returns the value of the Chem::BondProperty::MATCH_EXPRESSION property of the bond bond. More...
 
CDPL_CHEM_API void setMatchExpression (Bond &bond, const MatchExpression< Bond, MolecularGraph >::SharedPointer &expr)
 Sets the value of the Chem::BondProperty::MATCH_EXPRESSION property of the bond bond to expr. More...
 
CDPL_CHEM_API void clearMatchExpression (Bond &bond)
 Clears the value of the Chem::BondProperty::MATCH_EXPRESSION property of the bond bond. More...
 
CDPL_CHEM_API bool hasMatchExpression (const Bond &bond)
 Tells whether the Chem::BondProperty::MATCH_EXPRESSION property of the bond bond is set. More...
 
CDPL_CHEM_API MatchExpression< Bond, MolecularGraph >::SharedPointer generateMatchExpression (const Bond &bond, const MolecularGraph &molgraph)
 Builds a bond-level match expression from the match constraint list attached to the bond bond. More...
 
CDPL_CHEM_API const std::string & getMatchExpressionString (const Bond &bond)
 Returns the value of the Chem::BondProperty::MATCH_EXPRESSION_STRING property of the bond bond. More...
 
CDPL_CHEM_API void setMatchExpressionString (Bond &bond, const std::string &expr_str)
 Sets the value of the Chem::BondProperty::MATCH_EXPRESSION_STRING property of the bond bond to expr_str. More...
 
CDPL_CHEM_API void clearMatchExpressionString (Bond &bond)
 Clears the value of the Chem::BondProperty::MATCH_EXPRESSION_STRING property of the bond bond. More...
 
CDPL_CHEM_API bool hasMatchExpressionString (const Bond &bond)
 Tells whether the Chem::BondProperty::MATCH_EXPRESSION_STRING property of the bond bond is set. More...
 
CDPL_CHEM_API void generateMatchExpressionString (const Bond &bond, const MolecularGraph &molgraph, std::string &str)
 Writes a textual representation of the bond-level match expression of the bond bond into str. More...
 
CDPL_CHEM_API unsigned int getSybylType (const Bond &bond)
 Returns the value of the Chem::BondProperty::SYBYL_TYPE property of the bond bond. More...
 
CDPL_CHEM_API void setSybylType (Bond &bond, unsigned int type)
 Sets the value of the Chem::BondProperty::SYBYL_TYPE property of the bond bond to type. More...
 
CDPL_CHEM_API void clearSybylType (Bond &bond)
 Clears the value of the Chem::BondProperty::SYBYL_TYPE property of the bond bond. More...
 
CDPL_CHEM_API bool hasSybylType (const Bond &bond)
 Tells whether the Chem::BondProperty::SYBYL_TYPE property of the bond bond is set. More...
 
CDPL_CHEM_API unsigned int perceiveSybylType (const Bond &bond, const MolecularGraph &molgraph)
 Derives the Sybyl MOL2 bond type of the bond bond from its bond order, aromaticity and ligand environment in the molecular graph molgraph. More...
 
CDPL_CHEM_API bool getOrdinaryHydrogenDepleteParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::ORDINARY_HYDROGEN_DEPLETE parameter stored in cntnr. More...
 
CDPL_CHEM_API void setOrdinaryHydrogenDepleteParameter (Base::ControlParameterContainer &cntnr, bool deplete)
 Sets the value of the Chem::ControlParameter::ORDINARY_HYDROGEN_DEPLETE parameter of cntnr to deplete. More...
 
CDPL_CHEM_API bool hasOrdinaryHydrogenDepleteParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::ORDINARY_HYDROGEN_DEPLETE parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearOrdinaryHydrogenDepleteParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::ORDINARY_HYDROGEN_DEPLETE parameter from cntnr. More...
 
CDPL_CHEM_API std::size_t getCoordinatesDimensionParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::COORDINATES_DIMENSION parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCoordinatesDimensionParameter (Base::ControlParameterContainer &cntnr, std::size_t dim)
 Sets the value of the Chem::ControlParameter::COORDINATES_DIMENSION parameter of cntnr to dim. More...
 
CDPL_CHEM_API bool hasCoordinatesDimensionParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::COORDINATES_DIMENSION parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCoordinatesDimensionParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::COORDINATES_DIMENSION parameter from cntnr. More...
 
CDPL_CHEM_API bool getStrictErrorCheckingParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::STRICT_ERROR_CHECKING parameter stored in cntnr. More...
 
CDPL_CHEM_API void setStrictErrorCheckingParameter (Base::ControlParameterContainer &cntnr, bool strict)
 Sets the value of the Chem::ControlParameter::STRICT_ERROR_CHECKING parameter of cntnr to strict. More...
 
CDPL_CHEM_API bool hasStrictErrorCheckingParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::STRICT_ERROR_CHECKING parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearStrictErrorCheckingParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::STRICT_ERROR_CHECKING parameter from cntnr. More...
 
CDPL_CHEM_API const std::string & getRecordSeparatorParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::RECORD_SEPARATOR parameter stored in cntnr. More...
 
CDPL_CHEM_API void setRecordSeparatorParameter (Base::ControlParameterContainer &cntnr, const std::string &sep)
 Sets the value of the Chem::ControlParameter::RECORD_SEPARATOR parameter of cntnr to sep. More...
 
CDPL_CHEM_API bool hasRecordSeparatorParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::RECORD_SEPARATOR parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearRecordSeparatorParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::RECORD_SEPARATOR parameter from cntnr. More...
 
CDPL_CHEM_API bool getBondMemberSwapStereoFixParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::BOND_MEMBER_SWAP_STEREO_FIX parameter stored in cntnr. More...
 
CDPL_CHEM_API void setBondMemberSwapStereoFixParameter (Base::ControlParameterContainer &cntnr, bool fix)
 Sets the value of the Chem::ControlParameter::BOND_MEMBER_SWAP_STEREO_FIX parameter of cntnr to fix. More...
 
CDPL_CHEM_API bool hasBondMemberSwapStereoFixParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::BOND_MEMBER_SWAP_STEREO_FIX parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearBondMemberSwapStereoFixParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::BOND_MEMBER_SWAP_STEREO_FIX parameter from cntnr. More...
 
CDPL_CHEM_API bool getCheckLineLengthParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CHECK_LINE_LENGTH parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCheckLineLengthParameter (Base::ControlParameterContainer &cntnr, bool check)
 Sets the value of the Chem::ControlParameter::CHECK_LINE_LENGTH parameter of cntnr to check. More...
 
CDPL_CHEM_API bool hasCheckLineLengthParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CHECK_LINE_LENGTH parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCheckLineLengthParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CHECK_LINE_LENGTH parameter from cntnr. More...
 
CDPL_CHEM_API unsigned int getMDLCTABVersionParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MDL_CTAB_VERSION parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMDLCTABVersionParameter (Base::ControlParameterContainer &cntnr, unsigned int version)
 Sets the value of the Chem::ControlParameter::MDL_CTAB_VERSION parameter of cntnr to version. More...
 
CDPL_CHEM_API bool hasMDLCTABVersionParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MDL_CTAB_VERSION parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMDLCTABVersionParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MDL_CTAB_VERSION parameter from cntnr. More...
 
CDPL_CHEM_API bool getMDLIgnoreParityParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MDL_IGNORE_PARITY parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMDLIgnoreParityParameter (Base::ControlParameterContainer &cntnr, bool ignore)
 Sets the value of the Chem::ControlParameter::MDL_IGNORE_PARITY parameter of cntnr to ignore. More...
 
CDPL_CHEM_API bool hasMDLIgnoreParityParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MDL_IGNORE_PARITY parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMDLIgnoreParityParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MDL_IGNORE_PARITY parameter from cntnr. More...
 
CDPL_CHEM_API bool getMDLUpdateTimestampParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MDL_UPDATE_TIMESTAMP parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMDLUpdateTimestampParameter (Base::ControlParameterContainer &cntnr, bool update)
 Sets the value of the Chem::ControlParameter::MDL_UPDATE_TIMESTAMP parameter of cntnr to update. More...
 
CDPL_CHEM_API bool hasMDLUpdateTimestampParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MDL_UPDATE_TIMESTAMP parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMDLUpdateTimestampParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MDL_UPDATE_TIMESTAMP parameter from cntnr. More...
 
CDPL_CHEM_API bool getMDLTrimStringsParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MDL_TRIM_STRINGS parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMDLTrimStringsParameter (Base::ControlParameterContainer &cntnr, bool trim)
 Sets the value of the Chem::ControlParameter::MDL_TRIM_STRINGS parameter of cntnr to trim. More...
 
CDPL_CHEM_API bool hasMDLTrimStringsParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MDL_TRIM_STRINGS parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMDLTrimStringsParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MDL_TRIM_STRINGS parameter from cntnr. More...
 
CDPL_CHEM_API bool getMDLTrimLinesParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MDL_TRIM_LINES parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMDLTrimLinesParameter (Base::ControlParameterContainer &cntnr, bool trim)
 Sets the value of the Chem::ControlParameter::MDL_TRIM_LINES parameter of cntnr to trim. More...
 
CDPL_CHEM_API bool hasMDLTrimLinesParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MDL_TRIM_LINES parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMDLTrimLinesParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MDL_TRIM_LINES parameter from cntnr. More...
 
CDPL_CHEM_API bool getMDLTruncateStringsParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MDL_TRUNCATE_STRINGS parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMDLTruncateStringsParameter (Base::ControlParameterContainer &cntnr, bool trunc)
 Sets the value of the Chem::ControlParameter::MDL_TRUNCATE_STRINGS parameter of cntnr to trunc. More...
 
CDPL_CHEM_API bool hasMDLTruncateStringsParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MDL_TRUNCATE_STRINGS parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMDLTruncateStringsParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MDL_TRUNCATE_STRINGS parameter from cntnr. More...
 
CDPL_CHEM_API bool getMDLTruncateLinesParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MDL_TRUNCATE_LINES parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMDLTruncateLinesParameter (Base::ControlParameterContainer &cntnr, bool trunc)
 Sets the value of the Chem::ControlParameter::MDL_TRUNCATE_LINES parameter of cntnr to trunc. More...
 
CDPL_CHEM_API bool hasMDLTruncateLinesParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MDL_TRUNCATE_LINES parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMDLTruncateLinesParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MDL_TRUNCATE_LINES parameter from cntnr. More...
 
CDPL_CHEM_API unsigned int getMDLRXNFileVersionParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MDL_RXN_FILE_VERSION parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMDLRXNFileVersionParameter (Base::ControlParameterContainer &cntnr, unsigned int version)
 Sets the value of the Chem::ControlParameter::MDL_RXN_FILE_VERSION parameter of cntnr to version. More...
 
CDPL_CHEM_API bool hasMDLRXNFileVersionParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MDL_RXN_FILE_VERSION parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMDLRXNFileVersionParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MDL_RXN_FILE_VERSION parameter from cntnr. More...
 
CDPL_CHEM_API bool getMDLOutputConfEnergyToEnergyFieldParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_TO_ENERGY_FIELD parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMDLOutputConfEnergyToEnergyFieldParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_TO_ENERGY_FIELD parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasMDLOutputConfEnergyToEnergyFieldParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_TO_ENERGY_FIELD parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMDLOutputConfEnergyToEnergyFieldParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_TO_ENERGY_FIELD parameter from cntnr. More...
 
CDPL_CHEM_API bool getMDLOutputConfEnergyAsSDEntryParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_AS_SD_ENTRY parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMDLOutputConfEnergyAsSDEntryParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_AS_SD_ENTRY parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasMDLOutputConfEnergyAsSDEntryParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_AS_SD_ENTRY parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMDLOutputConfEnergyAsSDEntryParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_AS_SD_ENTRY parameter from cntnr. More...
 
CDPL_CHEM_API bool getMDLEnableAromaticBondTypesParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MDL_ENABLE_AROMATIC_BOND_TYPES parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMDLEnableAromaticBondTypesParameter (Base::ControlParameterContainer &cntnr, bool enable)
 Sets the value of the Chem::ControlParameter::MDL_ENABLE_AROMATIC_BOND_TYPES parameter of cntnr to enable. More...
 
CDPL_CHEM_API bool hasMDLEnableAromaticBondTypesParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MDL_ENABLE_AROMATIC_BOND_TYPES parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMDLEnableAromaticBondTypesParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MDL_ENABLE_AROMATIC_BOND_TYPES parameter from cntnr. More...
 
CDPL_CHEM_API const std::string & getMDLConfEnergySDTagParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MDL_CONF_ENERGY_SD_TAG parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMDLConfEnergySDTagParameter (Base::ControlParameterContainer &cntnr, const std::string &tag)
 Sets the value of the Chem::ControlParameter::MDL_CONF_ENERGY_SD_TAG parameter of cntnr to tag. More...
 
CDPL_CHEM_API bool hasMDLConfEnergySDTagParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MDL_CONF_ENERGY_SD_TAG parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMDLConfEnergySDTagParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MDL_CONF_ENERGY_SD_TAG parameter from cntnr. More...
 
CDPL_CHEM_API bool getJMESeparateComponentsParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::JME_SEPARATE_COMPONENTS parameter stored in cntnr. More...
 
CDPL_CHEM_API void setJMESeparateComponentsParameter (Base::ControlParameterContainer &cntnr, bool separate)
 Sets the value of the Chem::ControlParameter::JME_SEPARATE_COMPONENTS parameter of cntnr to separate. More...
 
CDPL_CHEM_API bool hasJMESeparateComponentsParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::JME_SEPARATE_COMPONENTS parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearJMESeparateComponentsParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::JME_SEPARATE_COMPONENTS parameter from cntnr. More...
 
CDPL_CHEM_API const std::string & getSMILESRecordFormatParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_RECORD_FORMAT parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESRecordFormatParameter (Base::ControlParameterContainer &cntnr, const std::string &format)
 Sets the value of the Chem::ControlParameter::SMILES_RECORD_FORMAT parameter of cntnr to format. More...
 
CDPL_CHEM_API bool hasSMILESRecordFormatParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_RECORD_FORMAT parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESRecordFormatParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_RECORD_FORMAT parameter from cntnr. More...
 
CDPL_CHEM_API bool getSMILESOutputCanonicalFormParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_CANONICAL_FORM parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESOutputCanonicalFormParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_CANONICAL_FORM parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasSMILESOutputCanonicalFormParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_OUTPUT_CANONICAL_FORM parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESOutputCanonicalFormParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_OUTPUT_CANONICAL_FORM parameter from cntnr. More...
 
CDPL_CHEM_API bool getSMILESOutputKekuleFormParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_KEKULE_FORM parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESOutputKekuleFormParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_KEKULE_FORM parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasSMILESOutputKekuleFormParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_OUTPUT_KEKULE_FORM parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESOutputKekuleFormParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_OUTPUT_KEKULE_FORM parameter from cntnr. More...
 
CDPL_CHEM_API bool getSMILESOutputAtomStereoParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_ATOM_STEREO parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESOutputAtomStereoParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_ATOM_STEREO parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasSMILESOutputAtomStereoParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_OUTPUT_ATOM_STEREO parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESOutputAtomStereoParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_OUTPUT_ATOM_STEREO parameter from cntnr. More...
 
CDPL_CHEM_API bool getSMILESOutputBondStereoParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_BOND_STEREO parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESOutputBondStereoParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_BOND_STEREO parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasSMILESOutputBondStereoParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_OUTPUT_BOND_STEREO parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESOutputBondStereoParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_OUTPUT_BOND_STEREO parameter from cntnr. More...
 
CDPL_CHEM_API bool getSMILESOutputRingBondStereoParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_RING_BOND_STEREO parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESOutputRingBondStereoParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_RING_BOND_STEREO parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasSMILESOutputRingBondStereoParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_OUTPUT_RING_BOND_STEREO parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESOutputRingBondStereoParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_OUTPUT_RING_BOND_STEREO parameter from cntnr. More...
 
CDPL_CHEM_API std::size_t getSMILESMinStereoBondRingSizeParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_MIN_STEREO_BOND_RING_SIZE parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESMinStereoBondRingSizeParameter (Base::ControlParameterContainer &cntnr, std::size_t min_size)
 Sets the value of the Chem::ControlParameter::SMILES_MIN_STEREO_BOND_RING_SIZE parameter of cntnr to min_size. More...
 
CDPL_CHEM_API bool hasSMILESMinStereoBondRingSizeParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_MIN_STEREO_BOND_RING_SIZE parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESMinStereoBondRingSizeParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_MIN_STEREO_BOND_RING_SIZE parameter from cntnr. More...
 
CDPL_CHEM_API bool getSMILESOutputIsotopeParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_ISOTOPE parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESOutputIsotopeParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_ISOTOPE parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasSMILESOutputIsotopeParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_OUTPUT_ISOTOPE parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESOutputIsotopeParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_OUTPUT_ISOTOPE parameter from cntnr. More...
 
CDPL_CHEM_API bool getSMILESOutputHydrogenCountParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_HYDROGEN_COUNT parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESOutputHydrogenCountParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_HYDROGEN_COUNT parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasSMILESOutputHydrogenCountParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_OUTPUT_HYDROGEN_COUNT parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESOutputHydrogenCountParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_OUTPUT_HYDROGEN_COUNT parameter from cntnr. More...
 
CDPL_CHEM_API bool getSMILESMolOutputAtomMappingIDParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_MOL_OUTPUT_ATOM_MAPPING_ID parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESMolOutputAtomMappingIDParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::SMILES_MOL_OUTPUT_ATOM_MAPPING_ID parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasSMILESMolOutputAtomMappingIDParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_MOL_OUTPUT_ATOM_MAPPING_ID parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESMolOutputAtomMappingIDParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_MOL_OUTPUT_ATOM_MAPPING_ID parameter from cntnr. More...
 
CDPL_CHEM_API bool getSMILESRxnOutputAtomMappingIDParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_RXN_OUTPUT_ATOM_MAPPING_ID parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESRxnOutputAtomMappingIDParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::SMILES_RXN_OUTPUT_ATOM_MAPPING_ID parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasSMILESRxnOutputAtomMappingIDParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_RXN_OUTPUT_ATOM_MAPPING_ID parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESRxnOutputAtomMappingIDParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_RXN_OUTPUT_ATOM_MAPPING_ID parameter from cntnr. More...
 
CDPL_CHEM_API bool getSMILESOutputSingleBondsParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_SINGLE_BONDS parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESOutputSingleBondsParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_SINGLE_BONDS parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasSMILESOutputSingleBondsParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_OUTPUT_SINGLE_BONDS parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESOutputSingleBondsParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_OUTPUT_SINGLE_BONDS parameter from cntnr. More...
 
CDPL_CHEM_API bool getSMILESOutputAromaticBondsParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_AROMATIC_BONDS parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESOutputAromaticBondsParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_AROMATIC_BONDS parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasSMILESOutputAromaticBondsParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_OUTPUT_AROMATIC_BONDS parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESOutputAromaticBondsParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_OUTPUT_AROMATIC_BONDS parameter from cntnr. More...
 
CDPL_CHEM_API bool getSMILESNoOrganicSubsetParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::SMILES_NO_ORGANIC_SUBSET parameter stored in cntnr. More...
 
CDPL_CHEM_API void setSMILESNoOrganicSubsetParameter (Base::ControlParameterContainer &cntnr, bool no_subset)
 Sets the value of the Chem::ControlParameter::SMILES_NO_ORGANIC_SUBSET parameter of cntnr to no_subset. More...
 
CDPL_CHEM_API bool hasSMILESNoOrganicSubsetParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::SMILES_NO_ORGANIC_SUBSET parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearSMILESNoOrganicSubsetParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::SMILES_NO_ORGANIC_SUBSET parameter from cntnr. More...
 
CDPL_CHEM_API const std::string & getINCHIInputOptionsParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::INCHI_INPUT_OPTIONS parameter stored in cntnr. More...
 
CDPL_CHEM_API void setINCHIInputOptionsParameter (Base::ControlParameterContainer &cntnr, const std::string &opts)
 Sets the value of the Chem::ControlParameter::INCHI_INPUT_OPTIONS parameter of cntnr to opts. More...
 
CDPL_CHEM_API bool hasINCHIInputOptionsParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::INCHI_INPUT_OPTIONS parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearINCHIInputOptionsParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::INCHI_INPUT_OPTIONS parameter from cntnr. More...
 
CDPL_CHEM_API const std::string & getINCHIOutputOptionsParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::INCHI_OUTPUT_OPTIONS parameter stored in cntnr. More...
 
CDPL_CHEM_API void setINCHIOutputOptionsParameter (Base::ControlParameterContainer &cntnr, const std::string &opts)
 Sets the value of the Chem::ControlParameter::INCHI_OUTPUT_OPTIONS parameter of cntnr to opts. More...
 
CDPL_CHEM_API bool hasINCHIOutputOptionsParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::INCHI_OUTPUT_OPTIONS parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearINCHIOutputOptionsParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::INCHI_OUTPUT_OPTIONS parameter from cntnr. More...
 
CDPL_CHEM_API bool getMultiConfImportParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MULTI_CONF_IMPORT parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMultiConfImportParameter (Base::ControlParameterContainer &cntnr, bool multi_conf)
 Sets the value of the Chem::ControlParameter::MULTI_CONF_IMPORT parameter of cntnr to multi_conf. More...
 
CDPL_CHEM_API bool hasMultiConfImportParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MULTI_CONF_IMPORT parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMultiConfImportParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MULTI_CONF_IMPORT parameter from cntnr. More...
 
CDPL_CHEM_API bool getMultiConfExportParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MULTI_CONF_EXPORT parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMultiConfExportParameter (Base::ControlParameterContainer &cntnr, bool multi_conf)
 Sets the value of the Chem::ControlParameter::MULTI_CONF_EXPORT parameter of cntnr to multi_conf. More...
 
CDPL_CHEM_API bool hasMultiConfExportParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MULTI_CONF_EXPORT parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMultiConfExportParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MULTI_CONF_EXPORT parameter from cntnr. More...
 
CDPL_CHEM_API bool getOutputConfEnergyAsCommentParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::OUTPUT_CONF_ENERGY_AS_COMMENT parameter stored in cntnr. More...
 
CDPL_CHEM_API void setOutputConfEnergyAsCommentParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::OUTPUT_CONF_ENERGY_AS_COMMENT parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasOutputConfEnergyAsCommentParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::OUTPUT_CONF_ENERGY_AS_COMMENT parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearOutputConfEnergyAsCommentParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::OUTPUT_CONF_ENERGY_AS_COMMENT parameter from cntnr. More...
 
CDPL_CHEM_API const std::string & getConfIndexNameSuffixPatternParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CONF_INDEX_NAME_SUFFIX_PATTERN parameter stored in cntnr. More...
 
CDPL_CHEM_API void setConfIndexNameSuffixPatternParameter (Base::ControlParameterContainer &cntnr, const std::string &pattern)
 Sets the value of the Chem::ControlParameter::CONF_INDEX_NAME_SUFFIX_PATTERN parameter of cntnr to pattern. More...
 
CDPL_CHEM_API bool hasConfIndexNameSuffixPatternParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CONF_INDEX_NAME_SUFFIX_PATTERN parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearConfIndexNameSuffixPatternParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CONF_INDEX_NAME_SUFFIX_PATTERN parameter from cntnr. More...
 
CDPL_CHEM_API const MultiConfMoleculeInputProcessor::SharedPointergetMultiConfInputProcessorParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MULTI_CONF_INPUT_PROCESSOR parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMultiConfInputProcessorParameter (Base::ControlParameterContainer &cntnr, const MultiConfMoleculeInputProcessor::SharedPointer &proc)
 Sets the value of the Chem::ControlParameter::MULTI_CONF_INPUT_PROCESSOR parameter of cntnr to proc. More...
 
CDPL_CHEM_API bool hasMultiConfInputProcessorParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MULTI_CONF_INPUT_PROCESSOR parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMultiConfInputProcessorParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MULTI_CONF_INPUT_PROCESSOR parameter from cntnr. More...
 
CDPL_CHEM_API bool getCDFOutputSinglePrecisionFloatsParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCDFOutputSinglePrecisionFloatsParameter (Base::ControlParameterContainer &cntnr, bool single_prec)
 Sets the value of the Chem::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter of cntnr to single_prec. More...
 
CDPL_CHEM_API bool hasCDFOutputSinglePrecisionFloatsParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCDFOutputSinglePrecisionFloatsParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter from cntnr. More...
 
CDPL_CHEM_API bool getMOL2EnableExtendedAtomTypesParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MOL2_ENABLE_EXTENDED_ATOM_TYPES parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMOL2EnableExtendedAtomTypesParameter (Base::ControlParameterContainer &cntnr, bool enable)
 Sets the value of the Chem::ControlParameter::MOL2_ENABLE_EXTENDED_ATOM_TYPES parameter of cntnr to enable. More...
 
CDPL_CHEM_API bool hasMOL2EnableExtendedAtomTypesParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MOL2_ENABLE_EXTENDED_ATOM_TYPES parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMOL2EnableExtendedAtomTypesParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MOL2_ENABLE_EXTENDED_ATOM_TYPES parameter from cntnr. More...
 
CDPL_CHEM_API bool getMOL2EnableAromaticBondTypesParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MOL2_ENABLE_AROMATIC_BOND_TYPES parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMOL2EnableAromaticBondTypesParameter (Base::ControlParameterContainer &cntnr, bool enable)
 Sets the value of the Chem::ControlParameter::MOL2_ENABLE_AROMATIC_BOND_TYPES parameter of cntnr to enable. More...
 
CDPL_CHEM_API bool hasMOL2EnableAromaticBondTypesParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MOL2_ENABLE_AROMATIC_BOND_TYPES parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMOL2EnableAromaticBondTypesParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MOL2_ENABLE_AROMATIC_BOND_TYPES parameter from cntnr. More...
 
CDPL_CHEM_API bool getMOL2ReadPartialAsFormalChargesParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MOL2_READ_PARTIAL_AS_FORMAL_CHARGES parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMOL2ReadPartialAsFormalChargesParameter (Base::ControlParameterContainer &cntnr, bool read)
 Sets the value of the Chem::ControlParameter::MOL2_READ_PARTIAL_AS_FORMAL_CHARGES parameter of cntnr to read. More...
 
CDPL_CHEM_API bool hasMOL2ReadPartialAsFormalChargesParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MOL2_READ_PARTIAL_AS_FORMAL_CHARGES parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMOL2ReadPartialAsFormalChargesParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MOL2_READ_PARTIAL_AS_FORMAL_CHARGES parameter from cntnr. More...
 
CDPL_CHEM_API bool getMOL2CalcFormalChargesParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MOL2_CALC_FORMAL_CHARGES parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMOL2CalcFormalChargesParameter (Base::ControlParameterContainer &cntnr, bool calc)
 Sets the value of the Chem::ControlParameter::MOL2_CALC_FORMAL_CHARGES parameter of cntnr to calc. More...
 
CDPL_CHEM_API bool hasMOL2CalcFormalChargesParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MOL2_CALC_FORMAL_CHARGES parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMOL2CalcFormalChargesParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MOL2_CALC_FORMAL_CHARGES parameter from cntnr. More...
 
CDPL_CHEM_API unsigned int getMOL2ChargeTypeParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MOL2_CHARGE_TYPE parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMOL2ChargeTypeParameter (Base::ControlParameterContainer &cntnr, unsigned int type)
 Sets the value of the Chem::ControlParameter::MOL2_CHARGE_TYPE parameter of cntnr to type. More...
 
CDPL_CHEM_API bool hasMOL2ChargeTypeParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MOL2_CHARGE_TYPE parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMOL2ChargeTypeParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MOL2_CHARGE_TYPE parameter from cntnr. More...
 
CDPL_CHEM_API unsigned int getMOL2MoleculeTypeParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MOL2_MOLECULE_TYPE parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMOL2MoleculeTypeParameter (Base::ControlParameterContainer &cntnr, unsigned int type)
 Sets the value of the Chem::ControlParameter::MOL2_MOLECULE_TYPE parameter of cntnr to type. More...
 
CDPL_CHEM_API bool hasMOL2MoleculeTypeParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MOL2_MOLECULE_TYPE parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMOL2MoleculeTypeParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MOL2_MOLECULE_TYPE parameter from cntnr. More...
 
CDPL_CHEM_API bool getMOL2OutputSubstructuresParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MOL2_OUTPUT_SUBSTRUCTURES parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMOL2OutputSubstructuresParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::MOL2_OUTPUT_SUBSTRUCTURES parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasMOL2OutputSubstructuresParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MOL2_OUTPUT_SUBSTRUCTURES parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMOL2OutputSubstructuresParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MOL2_OUTPUT_SUBSTRUCTURES parameter from cntnr. More...
 
CDPL_CHEM_API bool getMOL2OutputFormalChargesParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::MOL2_OUTPUT_FORMAL_CHARGES parameter stored in cntnr. More...
 
CDPL_CHEM_API void setMOL2OutputFormalChargesParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::MOL2_OUTPUT_FORMAL_CHARGES parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasMOL2OutputFormalChargesParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::MOL2_OUTPUT_FORMAL_CHARGES parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearMOL2OutputFormalChargesParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::MOL2_OUTPUT_FORMAL_CHARGES parameter from cntnr. More...
 
CDPL_CHEM_API bool getXYZCommentIsNameParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::XYZ_COMMENT_IS_NAME parameter stored in cntnr. More...
 
CDPL_CHEM_API void setXYZCommentIsNameParameter (Base::ControlParameterContainer &cntnr, bool is_name)
 Sets the value of the Chem::ControlParameter::XYZ_COMMENT_IS_NAME parameter of cntnr to is_name. More...
 
CDPL_CHEM_API bool hasXYZCommentIsNameParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::XYZ_COMMENT_IS_NAME parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearXYZCommentIsNameParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::XYZ_COMMENT_IS_NAME parameter from cntnr. More...
 
CDPL_CHEM_API bool getXYZPerceiveConnectivityParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::XYZ_PERCEIVE_CONNECTIVITY parameter stored in cntnr. More...
 
CDPL_CHEM_API void setXYZPerceiveConnectivityParameter (Base::ControlParameterContainer &cntnr, bool perceive)
 Sets the value of the Chem::ControlParameter::XYZ_PERCEIVE_CONNECTIVITY parameter of cntnr to perceive. More...
 
CDPL_CHEM_API bool hasXYZPerceiveConnectivityParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::XYZ_PERCEIVE_CONNECTIVITY parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearXYZPerceiveConnectivityParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::XYZ_PERCEIVE_CONNECTIVITY parameter from cntnr. More...
 
CDPL_CHEM_API bool getXYZPerceiveBondOrdersParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::XYZ_PERCEIVE_BOND_ORDERS parameter stored in cntnr. More...
 
CDPL_CHEM_API void setXYZPerceiveBondOrdersParameter (Base::ControlParameterContainer &cntnr, bool perceive)
 Sets the value of the Chem::ControlParameter::XYZ_PERCEIVE_BOND_ORDERS parameter of cntnr to perceive. More...
 
CDPL_CHEM_API bool hasXYZPerceiveBondOrdersParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::XYZ_PERCEIVE_BOND_ORDERS parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearXYZPerceiveBondOrdersParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::XYZ_PERCEIVE_BOND_ORDERS parameter from cntnr. More...
 
CDPL_CHEM_API bool getXYZCalcFormalChargesParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::XYZ_CALC_FORMAL_CHARGES parameter stored in cntnr. More...
 
CDPL_CHEM_API void setXYZCalcFormalChargesParameter (Base::ControlParameterContainer &cntnr, bool calc)
 Sets the value of the Chem::ControlParameter::XYZ_CALC_FORMAL_CHARGES parameter of cntnr to calc. More...
 
CDPL_CHEM_API bool hasXYZCalcFormalChargesParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::XYZ_CALC_FORMAL_CHARGES parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearXYZCalcFormalChargesParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::XYZ_CALC_FORMAL_CHARGES parameter from cntnr. More...
 
CDPL_CHEM_API bool getCMLOutputXMLDeclarationParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CML_OUTPUT_XML_DECLARATION parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCMLOutputXMLDeclarationParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::CML_OUTPUT_XML_DECLARATION parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasCMLOutputXMLDeclarationParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CML_OUTPUT_XML_DECLARATION parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCMLOutputXMLDeclarationParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CML_OUTPUT_XML_DECLARATION parameter from cntnr. More...
 
CDPL_CHEM_API const std::string & getCMLOutputElementNamespaceParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CML_OUTPUT_ELEMENT_NAMESPACE parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCMLOutputElementNamespaceParameter (Base::ControlParameterContainer &cntnr, const std::string &ns)
 Sets the value of the Chem::ControlParameter::CML_OUTPUT_ELEMENT_NAMESPACE parameter of cntnr to ns. More...
 
CDPL_CHEM_API bool hasCMLOutputElementNamespaceParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CML_OUTPUT_ELEMENT_NAMESPACE parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCMLOutputElementNamespaceParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CML_OUTPUT_ELEMENT_NAMESPACE parameter from cntnr. More...
 
CDPL_CHEM_API bool getCMLOutputAtomParityParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CML_OUTPUT_ATOM_PARITY parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCMLOutputAtomParityParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::CML_OUTPUT_ATOM_PARITY parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasCMLOutputAtomParityParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CML_OUTPUT_ATOM_PARITY parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCMLOutputAtomParityParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CML_OUTPUT_ATOM_PARITY parameter from cntnr. More...
 
CDPL_CHEM_API bool getCMLOutputSingleBondStereoParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CML_OUTPUT_SINGLE_BOND_STEREO parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCMLOutputSingleBondStereoParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::CML_OUTPUT_SINGLE_BOND_STEREO parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasCMLOutputSingleBondStereoParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CML_OUTPUT_SINGLE_BOND_STEREO parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCMLOutputSingleBondStereoParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CML_OUTPUT_SINGLE_BOND_STEREO parameter from cntnr. More...
 
CDPL_CHEM_API bool getCMLOutputDoubleBondStereoParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CML_OUTPUT_DOUBLE_BOND_STEREO parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCMLOutputDoubleBondStereoParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::CML_OUTPUT_DOUBLE_BOND_STEREO parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasCMLOutputDoubleBondStereoParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CML_OUTPUT_DOUBLE_BOND_STEREO parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCMLOutputDoubleBondStereoParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CML_OUTPUT_DOUBLE_BOND_STEREO parameter from cntnr. More...
 
CDPL_CHEM_API bool getCMLEnableAromaticBondTypesParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CML_ENABLE_AROMATIC_BOND_TYPES parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCMLEnableAromaticBondTypesParameter (Base::ControlParameterContainer &cntnr, bool enable)
 Sets the value of the Chem::ControlParameter::CML_ENABLE_AROMATIC_BOND_TYPES parameter of cntnr to enable. More...
 
CDPL_CHEM_API bool hasCMLEnableAromaticBondTypesParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CML_ENABLE_AROMATIC_BOND_TYPES parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCMLEnableAromaticBondTypesParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CML_ENABLE_AROMATIC_BOND_TYPES parameter from cntnr. More...
 
CDPL_CHEM_API bool getCMLOutputMoleculeNameParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CML_OUTPUT_MOLECULE_NAME parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCMLOutputMoleculeNameParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::CML_OUTPUT_MOLECULE_NAME parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasCMLOutputMoleculeNameParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CML_OUTPUT_MOLECULE_NAME parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCMLOutputMoleculeNameParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CML_OUTPUT_MOLECULE_NAME parameter from cntnr. More...
 
CDPL_CHEM_API bool getCMLOutputStructureDataParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CML_OUTPUT_STRUCTURE_DATA parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCMLOutputStructureDataParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::CML_OUTPUT_STRUCTURE_DATA parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasCMLOutputStructureDataParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CML_OUTPUT_STRUCTURE_DATA parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCMLOutputStructureDataParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CML_OUTPUT_STRUCTURE_DATA parameter from cntnr. More...
 
CDPL_CHEM_API bool getCMLOutputIsotopeParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CML_OUTPUT_ISOTOPE parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCMLOutputIsotopeParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::CML_OUTPUT_ISOTOPE parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasCMLOutputIsotopeParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CML_OUTPUT_ISOTOPE parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCMLOutputIsotopeParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CML_OUTPUT_ISOTOPE parameter from cntnr. More...
 
CDPL_CHEM_API bool getCMLOutputSpinMultiplicityParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CML_OUTPUT_SPIN_MULTIPLICITY parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCMLOutputSpinMultiplicityParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::CML_OUTPUT_SPIN_MULTIPLICITY parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasCMLOutputSpinMultiplicityParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CML_OUTPUT_SPIN_MULTIPLICITY parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCMLOutputSpinMultiplicityParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CML_OUTPUT_SPIN_MULTIPLICITY parameter from cntnr. More...
 
CDPL_CHEM_API bool getCMLOutputCompactAtomDataParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CML_OUTPUT_COMPACT_ATOM_DATA parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCMLOutputCompactAtomDataParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::CML_OUTPUT_COMPACT_ATOM_DATA parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasCMLOutputCompactAtomDataParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CML_OUTPUT_COMPACT_ATOM_DATA parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCMLOutputCompactAtomDataParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CML_OUTPUT_COMPACT_ATOM_DATA parameter from cntnr. More...
 
CDPL_CHEM_API bool getCMLOutputCompactBondDataParameter (const Base::ControlParameterContainer &cntnr)
 Returns the value of the Chem::ControlParameter::CML_OUTPUT_COMPACT_BOND_DATA parameter stored in cntnr. More...
 
CDPL_CHEM_API void setCMLOutputCompactBondDataParameter (Base::ControlParameterContainer &cntnr, bool output)
 Sets the value of the Chem::ControlParameter::CML_OUTPUT_COMPACT_BOND_DATA parameter of cntnr to output. More...
 
CDPL_CHEM_API bool hasCMLOutputCompactBondDataParameter (const Base::ControlParameterContainer &cntnr)
 Tells whether the Chem::ControlParameter::CML_OUTPUT_COMPACT_BOND_DATA parameter of cntnr is set. More...
 
CDPL_CHEM_API void clearCMLOutputCompactBondDataParameter (Base::ControlParameterContainer &cntnr)
 Removes the Chem::ControlParameter::CML_OUTPUT_COMPACT_BOND_DATA parameter from cntnr. More...
 
CDPL_CHEM_API void calcGeometricalDistanceMatrix (const Entity3DContainer &cntnr, Math::DMatrix &mtx)
 Calculates the inter-entity geometric distance matrix for the entities of cntnr. More...
 
CDPL_CHEM_API void get3DCoordinates (const Entity3DContainer &cntnr, Math::Vector3DArray &coords, bool append=false)
 Stores the 3D coordinates of the entities of cntnr in coords. More...
 
CDPL_CHEM_API void set3DCoordinates (Entity3DContainer &cntnr, const Math::Vector3DArray &coords)
 Sets the 3D coordinates of the entities of cntnr from coords. More...
 
CDPL_CHEM_API void transform3DCoordinates (Entity3DContainer &cntnr, const Math::Matrix4D &mtx)
 Transforms the 3D coordinates of the entities of cntnr by the affine matrix mtx. More...
 
CDPL_CHEM_API bool align3DCoordinates (Entity3DContainer &cntnr, const Entity3DContainer &ref_entities, const Math::Vector3DArray &ref_coords)
 Transforms the 3D coordinates of the entities of cntnr by the affine matrix that is calculated for the rigid-body alignment of the 3D coordinates of the entities of ref_entities with the given reference coordinates ref_coords. More...
 
CDPL_CHEM_API bool calcCentroid (const Entity3DContainer &cntnr, Math::Vector3D &ctr)
 Calculates the geometric centroid of the 3D coordinates of the entities of cntnr. More...
 
CDPL_CHEM_API void calcBoundingBox (const Entity3DContainer &cntnr, Math::Vector3D &min, Math::Vector3D &max, bool reset=true)
 Calculates the axis-aligned bounding box of the 3D coordinates of the entities of cntnr. More...
 
CDPL_CHEM_API bool insideBoundingBox (const Entity3DContainer &cntnr, const Math::Vector3D &min, const Math::Vector3D &max)
 Tells whether all 3D coordinates of the entities of cntnr lie within the axis-aligned bounding box defined by min and max. More...
 
CDPL_CHEM_API bool intersectsBoundingBox (const Entity3DContainer &cntnr, const Math::Vector3D &min, const Math::Vector3D &max)
 Tells whether at least one entity of cntnr lies within the axis-aligned bounding box defined by min and max. More...
 
CDPL_CHEM_API const Math::Vector3Dget3DCoordinates (const Entity3D &entity)
 Returns the value of the Chem::Entity3DProperty::COORDINATES_3D property of the 3D entity entity. More...
 
CDPL_CHEM_API void set3DCoordinates (Entity3D &entity, const Math::Vector3D &coords)
 Sets the value of the Chem::Entity3DProperty::COORDINATES_3D property of the 3D entity entity to coords. More...
 
CDPL_CHEM_API void clear3DCoordinates (Entity3D &entity)
 Clears the value of the Chem::Entity3DProperty::COORDINATES_3D property of the 3D entity entity. More...
 
CDPL_CHEM_API bool has3DCoordinates (const Entity3D &entity)
 Tells whether the Chem::Entity3DProperty::COORDINATES_3D property of the 3D entity entity is set. More...
 
CDPL_CHEM_API bool makeHydrogenDeplete (Fragment &frag)
 Removes all explicit hydrogen atoms from the fragment frag. More...
 
CDPL_CHEM_API bool makeOrdinaryHydrogenDeplete (Fragment &frag, unsigned int flags)
 Removes all explicit ordinary hydrogen atoms from the fragment frag. More...
 
CDPL_CHEM_API void removeAtomsIf (Fragment &frag, const AtomPredicate &pred)
 Removes all atoms of the fragment frag for which the predicate pred returns true. More...
 
CDPL_CHEM_API void removeAtomsIfNot (Fragment &frag, const AtomPredicate &pred)
 Removes all atoms of the fragment frag for which the predicate pred returns false. More...
 
CDPL_CHEM_API const std::string & getName (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::NAME property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setName (MolecularGraph &molgraph, const std::string &name)
 Sets the value of the Chem::MolecularGraphProperty::NAME property of the molecular graph molgraph to name. More...
 
CDPL_CHEM_API void clearName (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::NAME property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasName (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::NAME property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API std::time_t getTimestamp (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::TIMESTAMP property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setTimestamp (MolecularGraph &molgraph, std::time_t time)
 Sets the value of the Chem::MolecularGraphProperty::TIMESTAMP property of the molecular graph molgraph to time. More...
 
CDPL_CHEM_API void clearTimestamp (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::TIMESTAMP property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasTimestamp (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::TIMESTAMP property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API const std::string & getComment (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::COMMENT property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setComment (MolecularGraph &molgraph, const std::string &comment)
 Sets the value of the Chem::MolecularGraphProperty::COMMENT property of the molecular graph molgraph to comment. More...
 
CDPL_CHEM_API void clearComment (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::COMMENT property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasComment (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::COMMENT property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API const MatchConstraintList::SharedPointergetMatchConstraints (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::MATCH_CONSTRAINTS property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setMatchConstraints (MolecularGraph &molgraph, const MatchConstraintList::SharedPointer &constr)
 Sets the value of the Chem::MolecularGraphProperty::MATCH_CONSTRAINTS property of the molecular graph molgraph to constr. More...
 
CDPL_CHEM_API void clearMatchConstraints (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::MATCH_CONSTRAINTS property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasMatchConstraints (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::MATCH_CONSTRAINTS property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API const MatchExpression< MolecularGraph >::SharedPointer & getMatchExpression (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::MATCH_EXPRESSION property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setMatchExpression (MolecularGraph &molgraph, const MatchExpression< MolecularGraph >::SharedPointer &expr)
 Sets the value of the Chem::MolecularGraphProperty::MATCH_EXPRESSION property of the molecular graph molgraph to expr. More...
 
CDPL_CHEM_API void clearMatchExpression (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::MATCH_EXPRESSION property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasMatchExpression (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::MATCH_EXPRESSION property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API MatchExpression< MolecularGraph >::SharedPointer generateMatchExpression (const MolecularGraph &molgraph)
 Builds a top-level match expression from the match constraints currently attached to the molecular graph molgraph. More...
 
CDPL_CHEM_API MatchExpression< MolecularGraph >::SharedPointer generateMatchExpression (MolecularGraph &molgraph, bool overwrite)
 Builds and (optionally) stores the top-level match expression of the molecular graph molgraph. More...
 
CDPL_CHEM_API const FragmentList::SharedPointergetRings (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::RINGS property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setRings (MolecularGraph &molgraph, const FragmentList::SharedPointer &rings)
 Sets the value of the Chem::MolecularGraphProperty::RINGS property of the molecular graph molgraph to rings. More...
 
CDPL_CHEM_API void clearRings (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::RINGS property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasRings (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::RINGS property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API FragmentList::SharedPointer perceiveRings (const MolecularGraph &molgraph)
 Perceives the full set of rings of the molecular graph molgraph. More...
 
CDPL_CHEM_API FragmentList::SharedPointer perceiveRings (MolecularGraph &molgraph, bool overwrite)
 Perceives and (optionally) stores the full set of rings of the molecular graph molgraph. More...
 
CDPL_CHEM_API const FragmentList::SharedPointergetSSSR (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::SSSR property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setSSSR (MolecularGraph &molgraph, const FragmentList::SharedPointer &sssr)
 Sets the value of the Chem::MolecularGraphProperty::SSSR property of the molecular graph molgraph to sssr. More...
 
CDPL_CHEM_API void clearSSSR (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::SSSR property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasSSSR (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::SSSR property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API FragmentList::SharedPointer perceiveSSSR (const MolecularGraph &molgraph)
 Perceives the Smallest Set of Smallest Rings of the molecular graph molgraph. More...
 
CDPL_CHEM_API FragmentList::SharedPointer perceiveSSSR (MolecularGraph &molgraph, bool overwrite)
 Perceives and (optionally) stores the Smallest Set of Smallest Rings of the molecular graph molgraph. More...
 
CDPL_CHEM_API FragmentList::SharedPointer extractSSSRSubset (const MolecularGraph &src_molgraph, const MolecularGraph &tgt_molgraph)
 Extracts the subset of the SSSR of the molecular graph src_molgraph whose rings consist of atoms and bonds of tgt_molgraph. More...
 
CDPL_CHEM_API FragmentList::SharedPointer extractSSSRSubset (const MolecularGraph &src_molgraph, MolecularGraph &tgt_molgraph, bool overwrite)
 Extracts the SSSR subset of the molecular graph src_molgraph that fits within tgt_molgraph and (optionally) stores it on the latter. More...
 
CDPL_CHEM_API const Fragment::SharedPointergetCyclicSubstructure (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::CYCLIC_SUBSTRUCTURE property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setCyclicSubstructure (MolecularGraph &molgraph, const Fragment::SharedPointer &substruct)
 Sets the value of the Chem::MolecularGraphProperty::CYCLIC_SUBSTRUCTURE property of the molecular graph molgraph to substruct. More...
 
CDPL_CHEM_API void clearCyclicSubstructure (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::CYCLIC_SUBSTRUCTURE property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasCyclicSubstructure (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::CYCLIC_SUBSTRUCTURE property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API Fragment::SharedPointer perceiveCyclicSubstructure (const MolecularGraph &molgraph)
 Perceives the cyclic substructure (union of all rings) of the molecular graph molgraph. More...
 
CDPL_CHEM_API Fragment::SharedPointer perceiveCyclicSubstructure (MolecularGraph &molgraph, bool overwrite)
 Perceives and (optionally) stores the cyclic substructure of the molecular graph molgraph. More...
 
CDPL_CHEM_API const FragmentList::SharedPointergetComponents (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::COMPONENTS property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setComponents (MolecularGraph &molgraph, const FragmentList::SharedPointer &comps)
 Sets the value of the Chem::MolecularGraphProperty::COMPONENTS property of the molecular graph molgraph to comps. More...
 
CDPL_CHEM_API void clearComponents (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::COMPONENTS property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasComponents (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::COMPONENTS property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API FragmentList::SharedPointer perceiveComponents (const MolecularGraph &molgraph)
 Perceives the connected components of the molecular graph molgraph. More...
 
CDPL_CHEM_API FragmentList::SharedPointer perceiveComponents (MolecularGraph &molgraph, bool overwrite)
 Perceives and (optionally) stores the connected components of the molecular graph molgraph. More...
 
CDPL_CHEM_API const FragmentList::SharedPointergetComponentGroups (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::COMPONENT_GROUPS property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setComponentGroups (MolecularGraph &molgraph, const FragmentList::SharedPointer &comp_groups)
 Sets the value of the Chem::MolecularGraphProperty::COMPONENT_GROUPS property of the molecular graph molgraph to comp_groups. More...
 
CDPL_CHEM_API void clearComponentGroups (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::COMPONENT_GROUPS property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasComponentGroups (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::COMPONENT_GROUPS property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API FragmentList::SharedPointer perceiveComponentGroups (const MolecularGraph &molgraph)
 Perceives the component groups of the molecular graph molgraph (from atom-level Chem::AtomProperty::COMPONENT_GROUP_ID values). More...
 
CDPL_CHEM_API FragmentList::SharedPointer perceiveComponentGroups (MolecularGraph &molgraph, bool overwrite)
 Perceives and (optionally) stores the component groups of the molecular graph molgraph. More...
 
CDPL_CHEM_API std::size_t getConformationIndex (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::CONFORMATION_INDEX property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setConformationIndex (MolecularGraph &molgraph, std::size_t index)
 Sets the value of the Chem::MolecularGraphProperty::CONFORMATION_INDEX property of the molecular graph molgraph to index. More...
 
CDPL_CHEM_API void clearConformationIndex (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::CONFORMATION_INDEX property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasConformationIndex (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::CONFORMATION_INDEX property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API const Util::DArray::SharedPointer & getConformerEnergies (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::CONFORMER_ENERGIES property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setConformerEnergies (MolecularGraph &molgraph, const Util::DArray::SharedPointer &energies)
 Sets the value of the Chem::MolecularGraphProperty::CONFORMER_ENERGIES property of the molecular graph molgraph to energies. More...
 
CDPL_CHEM_API void clearConformerEnergies (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::CONFORMER_ENERGIES property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasConformerEnergies (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::CONFORMER_ENERGIES property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API void setConformation (MolecularGraph &molgraph, std::size_t conf_idx, const Math::Vector3DArray &coords, double energy)
 Overwrites the conformation at index conf_idx with the supplied coordinates and energy. More...
 
CDPL_CHEM_API void addConformation (MolecularGraph &molgraph, const Math::Vector3DArray &coords, double energy)
 Appends a new conformation built from the supplied coordinates and energy. More...
 
CDPL_CHEM_API double getConformationEnergy (const MolecularGraph &molgraph, std::size_t conf_idx)
 Returns the energy of the conformation at index conf_idx. More...
 
CDPL_CHEM_API std::uint64_t getHashCode (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::HASH_CODE property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setHashCode (MolecularGraph &molgraph, std::uint64_t hash_code)
 Sets the value of the Chem::MolecularGraphProperty::HASH_CODE property of the molecular graph molgraph to hash_code. More...
 
CDPL_CHEM_API void clearHashCode (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::HASH_CODE property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasHashCode (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::HASH_CODE property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API std::uint64_t calcHashCode (const MolecularGraph &molgraph, unsigned int atom_flags=AtomPropertyFlag::DEFAULT, unsigned int bond_flags=BondPropertyFlag::DEFAULT, bool ord_h_deplete=true)
 Computes a 64-bit hash code for the molecular graph molgraph taking into account the specified atom and bond properties. More...
 
CDPL_CHEM_API void extractReactionCenter (const MolecularGraph &molgraph, Fragment &rxn_center)
 Collects every atom and bond of the molecular graph molgraph that carries a reaction-center flag into the fragment rxn_center. More...
 
CDPL_CHEM_API double getStoichiometricNumber (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::STOICHIOMETRIC_NUMBER property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setStoichiometricNumber (MolecularGraph &molgraph, double num)
 Sets the value of the Chem::MolecularGraphProperty::STOICHIOMETRIC_NUMBER property of the molecular graph molgraph to num. More...
 
CDPL_CHEM_API void clearStoichiometricNumber (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::STOICHIOMETRIC_NUMBER property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasStoichiometricNumber (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::STOICHIOMETRIC_NUMBER property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API const std::string & getMDLUserInitials (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::MDL_USER_INITIALS property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setMDLUserInitials (MolecularGraph &molgraph, const std::string &initials)
 Sets the value of the Chem::MolecularGraphProperty::MDL_USER_INITIALS property of the molecular graph molgraph to initials. More...
 
CDPL_CHEM_API void clearMDLUserInitials (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::MDL_USER_INITIALS property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasMDLUserInitials (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::MDL_USER_INITIALS property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API const std::string & getMDLProgramName (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::MDL_PROGRAM_NAME property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setMDLProgramName (MolecularGraph &molgraph, const std::string &name)
 Sets the value of the Chem::MolecularGraphProperty::MDL_PROGRAM_NAME property of the molecular graph molgraph to name. More...
 
CDPL_CHEM_API void clearMDLProgramName (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::MDL_PROGRAM_NAME property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasMDLProgramName (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::MDL_PROGRAM_NAME property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API std::size_t getMDLRegistryNumber (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::MDL_REGISTRY_NUMBER property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setMDLRegistryNumber (MolecularGraph &molgraph, std::size_t reg_no)
 Sets the value of the Chem::MolecularGraphProperty::MDL_REGISTRY_NUMBER property of the molecular graph molgraph to reg_no. More...
 
CDPL_CHEM_API void clearMDLRegistryNumber (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::MDL_REGISTRY_NUMBER property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasMDLRegistryNumber (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::MDL_REGISTRY_NUMBER property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API unsigned int getMDLCTABVersion (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::MDL_CTAB_VERSION property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setMDLCTABVersion (MolecularGraph &molgraph, unsigned int version)
 Sets the value of the Chem::MolecularGraphProperty::MDL_CTAB_VERSION property of the molecular graph molgraph to version. More...
 
CDPL_CHEM_API void clearMDLCTABVersion (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::MDL_CTAB_VERSION property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasMDLCTABVersion (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::MDL_CTAB_VERSION property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API const StringDataBlock::SharedPointergetStructureData (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::STRUCTURE_DATA property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setStructureData (MolecularGraph &molgraph, const StringDataBlock::SharedPointer &data)
 Sets the value of the Chem::MolecularGraphProperty::STRUCTURE_DATA property of the molecular graph molgraph to data. More...
 
CDPL_CHEM_API void clearStructureData (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::STRUCTURE_DATA property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasStructureData (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::STRUCTURE_DATA property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API std::size_t getMDLDimensionality (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::MDL_DIMENSIONALITY property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setMDLDimensionality (MolecularGraph &molgraph, std::size_t dim)
 Sets the value of the Chem::MolecularGraphProperty::MDL_DIMENSIONALITY property of the molecular graph molgraph to dim. More...
 
CDPL_CHEM_API void clearMDLDimensionality (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::MDL_DIMENSIONALITY property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasMDLDimensionality (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::MDL_DIMENSIONALITY property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API long getMDLScalingFactor1 (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR1 property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setMDLScalingFactor1 (MolecularGraph &molgraph, long factor)
 Sets the value of the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR1 property of the molecular graph molgraph to factor. More...
 
CDPL_CHEM_API void clearMDLScalingFactor1 (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR1 property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasMDLScalingFactor1 (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR1 property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API double getMDLScalingFactor2 (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR2 property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setMDLScalingFactor2 (MolecularGraph &molgraph, double factor)
 Sets the value of the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR2 property of the molecular graph molgraph to factor. More...
 
CDPL_CHEM_API void clearMDLScalingFactor2 (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR2 property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasMDLScalingFactor2 (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR2 property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API double getMDLEnergy (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::MDL_ENERGY property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setMDLEnergy (MolecularGraph &molgraph, double energy)
 Sets the value of the Chem::MolecularGraphProperty::MDL_ENERGY property of the molecular graph molgraph to energy. More...
 
CDPL_CHEM_API void clearMDLEnergy (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::MDL_ENERGY property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasMDLEnergy (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::MDL_ENERGY property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API bool getMDLChiralFlag (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::MDL_CHIRAL_FLAG property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setMDLChiralFlag (MolecularGraph &molgraph, bool flag)
 Sets the value of the Chem::MolecularGraphProperty::MDL_CHIRAL_FLAG property of the molecular graph molgraph to flag. More...
 
CDPL_CHEM_API void clearMDLChiralFlag (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::MDL_CHIRAL_FLAG property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasMDLChiralFlag (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::MDL_CHIRAL_FLAG property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API unsigned int getMOL2MoleculeType (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::MOL2_MOLECULE_TYPE property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setMOL2MoleculeType (MolecularGraph &molgraph, unsigned int type)
 Sets the value of the Chem::MolecularGraphProperty::MOL2_MOLECULE_TYPE property of the molecular graph molgraph to type. More...
 
CDPL_CHEM_API void clearMOL2MoleculeType (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::MOL2_MOLECULE_TYPE property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasMOL2MoleculeType (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::MOL2_MOLECULE_TYPE property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API unsigned int getMOL2ChargeType (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::MOL2_CHARGE_TYPE property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setMOL2ChargeType (MolecularGraph &molgraph, unsigned int type)
 Sets the value of the Chem::MolecularGraphProperty::MOL2_CHARGE_TYPE property of the molecular graph molgraph to type. More...
 
CDPL_CHEM_API void clearMOL2ChargeType (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::MOL2_CHARGE_TYPE property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasMOL2ChargeType (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::MOL2_CHARGE_TYPE property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API void generateAdjacencyMatrix (const MolecularGraph &molgraph, Math::SparseULMatrix &mtx)
 Builds the adjacency matrix of the molecular graph molgraph (entry (i,j) is the bond count between atoms i and j). More...
 
CDPL_CHEM_API void generateIncidenceMatrix (const MolecularGraph &molgraph, Math::SparseULMatrix &mtx)
 Builds the atom/bond incidence matrix of the molecular graph molgraph (entry (i,j) is 1 if atom i is an endpoint of bond j). More...
 
CDPL_CHEM_API void generateBondMatrix (const MolecularGraph &molgraph, Math::SparseULMatrix &mtx)
 Builds the bond order matrix of the molecular graph molgraph (entry (i,j) is the order of the bond between atoms i and j). More...
 
CDPL_CHEM_API void generateBondElectronMatrix (const MolecularGraph &molgraph, Math::SparseULMatrix &mtx)
 Builds the bond-electron-count matrix of the molecular graph molgraph (entry (i,j) is the number of bonding electrons between atoms i and j). More...
 
CDPL_CHEM_API void generateBondAtomTypeMatrix (const MolecularGraph &molgraph, Math::SparseULMatrix &mtx)
 Builds a matrix combining bond order and atom type information of the endpoints of every bond in molgraph. More...
 
CDPL_CHEM_API const Math::ULMatrix::SharedPointer & getTopologicalDistanceMatrix (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::TOPOLOGICAL_DISTANCE_MATRIX property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setTopologicalDistanceMatrix (MolecularGraph &molgraph, const Math::ULMatrix::SharedPointer &mtx)
 Sets the value of the Chem::MolecularGraphProperty::TOPOLOGICAL_DISTANCE_MATRIX property of the molecular graph molgraph to mtx. More...
 
CDPL_CHEM_API void clearTopologicalDistanceMatrix (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::TOPOLOGICAL_DISTANCE_MATRIX property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasTopologicalDistanceMatrix (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::TOPOLOGICAL_DISTANCE_MATRIX property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API Math::ULMatrix::SharedPointer calcTopologicalDistanceMatrix (MolecularGraph &molgraph, bool overwrite)
 Computes and (optionally) stores the topological-distance matrix of the molecular graph molgraph. More...
 
CDPL_CHEM_API void calcTopologicalDistanceMatrix (const MolecularGraph &molgraph, Math::ULMatrix &mtx)
 Computes the topological-distance matrix of the molecular graph molgraph into the supplied mtx. More...
 
CDPL_CHEM_API Math::ULMatrix::SharedPointer extractTopologicalDistanceSubMatrix (const MolecularGraph &src_molgraph, MolecularGraph &tgt_molgraph, bool overwrite)
 Extracts the topological-distance sub-matrix of the molecular graph src_molgraph that covers the atoms of tgt_molgraph and (optionally) stores it on the latter. More...
 
CDPL_CHEM_API void extractTopologicalDistanceSubMatrix (const MolecularGraph &src_molgraph, const MolecularGraph &tgt_molgraph, Math::ULMatrix &mtx)
 Extracts the topological-distance sub-matrix of the molecular graph src_molgraph that covers the atoms of tgt_molgraph into the supplied mtx. More...
 
CDPL_CHEM_API const Math::DMatrix::SharedPointergetGeometricalDistanceMatrix (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::GEOMETRICAL_DISTANCE_MATRIX property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setGeometricalDistanceMatrix (MolecularGraph &molgraph, const Math::DMatrix::SharedPointer &mtx)
 Sets the value of the Chem::MolecularGraphProperty::GEOMETRICAL_DISTANCE_MATRIX property of the molecular graph molgraph to mtx. More...
 
CDPL_CHEM_API void clearGeometricalDistanceMatrix (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::GEOMETRICAL_DISTANCE_MATRIX property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasGeometricalDistanceMatrix (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::GEOMETRICAL_DISTANCE_MATRIX property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API Math::DMatrix::SharedPointer calcGeometricalDistanceMatrix (MolecularGraph &molgraph, bool overwrite)
 Computes and (optionally) stores the geometrical-distance matrix of the molecular graph molgraph from its 3D coordinates. More...
 
CDPL_CHEM_API const Fragment::SharedPointergetAromaticSubstructure (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::AROMATIC_SUBSTRUCTURE property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setAromaticSubstructure (MolecularGraph &molgraph, const Fragment::SharedPointer &substruct)
 Sets the value of the Chem::MolecularGraphProperty::AROMATIC_SUBSTRUCTURE property of the molecular graph molgraph to substruct. More...
 
CDPL_CHEM_API void clearAromaticSubstructure (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::AROMATIC_SUBSTRUCTURE property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasAromaticSubstructure (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::AROMATIC_SUBSTRUCTURE property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API Fragment::SharedPointer perceiveAromaticSubstructure (const MolecularGraph &molgraph)
 Perceives the aromatic substructure of the molecular graph molgraph. More...
 
CDPL_CHEM_API Fragment::SharedPointer perceiveAromaticSubstructure (MolecularGraph &molgraph, bool overwrite)
 Perceives and (optionally) stores the aromatic substructure of the molecular graph molgraph. More...
 
CDPL_CHEM_API const ElectronSystemList::SharedPointergetPiElectronSystems (const MolecularGraph &molgraph)
 Returns the value of the Chem::MolecularGraphProperty::PI_ELECTRON_SYSTEMS property of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setPiElectronSystems (MolecularGraph &molgraph, const ElectronSystemList::SharedPointer &pi_systems)
 Sets the value of the Chem::MolecularGraphProperty::PI_ELECTRON_SYSTEMS property of the molecular graph molgraph to pi_systems. More...
 
CDPL_CHEM_API void clearPiElectronSystems (MolecularGraph &molgraph)
 Clears the value of the Chem::MolecularGraphProperty::PI_ELECTRON_SYSTEMS property of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool hasPiElectronSystems (const MolecularGraph &molgraph)
 Tells whether the Chem::MolecularGraphProperty::PI_ELECTRON_SYSTEMS property of the molecular graph molgraph is set. More...
 
CDPL_CHEM_API ElectronSystemList::SharedPointer perceivePiElectronSystems (const MolecularGraph &molgraph)
 Perceives the pi-electron systems of the molecular graph molgraph. More...
 
CDPL_CHEM_API ElectronSystemList::SharedPointer perceivePiElectronSystems (MolecularGraph &molgraph, bool overwrite)
 Perceives and (optionally) stores the pi-electron systems of the molecular graph molgraph. More...
 
CDPL_CHEM_API bool generateSMILES (const MolecularGraph &molgraph, std::string &smiles, bool canonical=false, bool ord_h_deplete=true, unsigned int atom_flags=AtomPropertyFlag::DEFAULT, unsigned int bond_flags=BondPropertyFlag::DEFAULT)
 Generates a SMILES string for the molecular graph molgraph. More...
 
CDPL_CHEM_API int generateINCHI (const MolecularGraph &molgraph, std::string &inchi, const std::string &options=ControlParameterDefault::INCHI_OUTPUT_OPTIONS, std::size_t dim=0)
 Generates an InChI string for the molecular graph molgraph using the InChI C-API. More...
 
CDPL_CHEM_API int generateINCHIKey (const MolecularGraph &molgraph, std::string &inchi_key)
 Generates an InChIKey for the molecular graph molgraph using the InChI C-API. More...
 
CDPL_CHEM_API void canonicalize (MolecularGraph &molgraph, const AtomCompareFunction &func, bool atoms=true, bool atom_nbrs=true, bool bonds=true, bool bond_atoms=false)
 Reorders the atoms (and optionally their neighbors and bonds) of the molecular graph molgraph according to a user-supplied comparator. More...
 
CDPL_CHEM_API void canonicalize (MolecularGraph &molgraph, bool atoms=true, bool atom_nbrs=true, bool bonds=true, bool bond_atoms=false)
 Reorders the atoms (and optionally their neighbors and bonds) of the molecular graph molgraph according to the canonical-numbering attached to its atoms. More...
 
CDPL_CHEM_API void calc2DCoordinates (MolecularGraph &molgraph, bool overwrite)
 Computes 2D atom coordinates for the molecular graph molgraph and stores them as Chem::AtomProperty::COORDINATES_2D. More...
 
CDPL_CHEM_API bool align2DCoordinates (MolecularGraph &molgraph, const AtomContainer &atoms, const Math::Vector2DArray &ref_coords, bool fix_bond_stereo=true)
 Aligns molgraph's 2D coordinates so that the atoms of atoms come to lie at the reference coordinates ref_coords. More...
 
CDPL_CHEM_API bool align2DCoordinates (MolecularGraph &molgraph, const AtomMapping &ref_atom_mpg, bool fix_bond_stereo=true)
 Aligns molgraph's 2D coordinates onto a reference atom mapping. More...
 
CDPL_CHEM_API bool align2DCoordinates (MolecularGraph &molgraph, const MolecularGraph &ref_molgraph, bool use_mcss, bool fix_bond_stereo=true)
 Aligns molgraph's 2D coordinates onto those of ref_molgraph, using either a maximum-common-substructure search or substructure matching. More...
 
CDPL_CHEM_API bool align2DCoordinates (MolecularGraph &molgraph, const MolecularGraph &ref_molgraph, const MolecularGraph &substr_ptn, bool fix_bond_stereo=true)
 Aligns molgraph's 2D coordinates onto those of ref_molgraph, using substr_ptn as the explicit substructure pattern. More...
 
CDPL_CHEM_API void calcHydrogen3DCoordinates (MolecularGraph &molgraph, bool undef_only=true)
 Computes 3D coordinates for the hydrogen atoms of the molecular graph molgraph from the geometry of their non-hydrogen neighbors. More...
 
CDPL_CHEM_API void calcBond2DStereoFlags (MolecularGraph &molgraph, bool overwrite)
 Derives 2D wedge/hash bond stereo flags for the bonds of the molecular graph molgraph from the atoms' stereo descriptors and 2D layout. More...
 
CDPL_CHEM_API void calcCIPPriorities (MolecularGraph &molgraph, bool overwrite)
 Computes and stores CIP priorities for the atoms of the molecular graph molgraph. More...
 
CDPL_CHEM_API void perceiveSymmetryClasses (MolecularGraph &molgraph, bool overwrite, unsigned int atom_flags=AtomPropertyFlag::DEFAULT, unsigned int bond_flags=BondPropertyFlag::DEFAULT, bool inc_impl_h=true)
 Computes and stores topological-symmetry classes for the atoms of the molecular graph molgraph. More...
 
CDPL_CHEM_API void calcCanonicalNumbering (MolecularGraph &molgraph, bool overwrite, unsigned int atom_flags=AtomPropertyFlag::DEFAULT, unsigned int bond_flags=BondPropertyFlag::DEFAULT)
 Computes and stores canonical atom numbers for the atoms of the molecular graph molgraph. More...
 
CDPL_CHEM_API void calcMorganNumbering (MolecularGraph &molgraph, bool overwrite)
 Computes and stores Morgan numbers for the atoms of the molecular graph molgraph. More...
 
CDPL_CHEM_API void calcImplicitHydrogenCounts (MolecularGraph &molgraph, bool overwrite)
 Computes and stores implicit-hydrogen counts for the atoms of the molecular graph molgraph. More...
 
CDPL_CHEM_API void calcFormalCharges (MolecularGraph &molgraph, bool overwrite)
 Computes and stores formal charges for the atoms of the molecular graph molgraph from their valence environment. More...
 
CDPL_CHEM_API void perceiveHybridizationStates (MolecularGraph &molgraph, bool overwrite)
 Computes and stores hybridization states for the atoms of the molecular graph molgraph from their valence environment. More...
 
CDPL_CHEM_API void perceiveBondOrders (MolecularGraph &molgraph, bool overwrite)
 Perceives bond orders for the bonds of the molecular graph molgraph from atom geometry and ligand environment. More...
 
CDPL_CHEM_API void kekulizeBonds (MolecularGraph &molgraph)
 Assigns KekulĂ© bond orders to the aromatic bonds of the molecular graph molgraph. More...
 
CDPL_CHEM_API void perceiveAtomStereoCenters (MolecularGraph &molgraph, bool overwrite, bool check_asym=true, bool check_inv_n=true, bool check_quart_n=true, bool check_plan_n=true, bool check_amide_n=true, bool check_res_ctrs=true)
 Flags the atoms of the molecular graph molgraph that qualify as stereo centers under the supplied criteria. More...
 
CDPL_CHEM_API void perceiveBondStereoCenters (MolecularGraph &molgraph, bool overwrite, bool check_asym=true, bool check_term_n=true, bool check_order=true, std::size_t min_ring_size=8)
 Flags the bonds of the molecular graph molgraph that qualify as stereo centers under the supplied criteria. More...
 
CDPL_CHEM_API void calcMDLParities (MolecularGraph &molgraph, bool overwrite)
 Computes and stores MDL parities for the atoms of the molecular graph molgraph. More...
 
CDPL_CHEM_API void calcAtomStereoDescriptors (MolecularGraph &molgraph, bool overwrite, std::size_t dim=1, bool check_stc_flag=true)
 Computes and stores stereo descriptors for the atoms of the molecular graph molgraph from their geometric layout. More...
 
CDPL_CHEM_API void calcAtomStereoDescriptorsFromMDLParities (MolecularGraph &molgraph, bool overwrite)
 Derives atom stereo descriptors of the molecular graph molgraph from previously-assigned MDL parities. More...
 
CDPL_CHEM_API void calcBondStereoDescriptors (MolecularGraph &molgraph, bool overwrite, std::size_t dim=1, bool check_stc_flag=true)
 Computes and stores stereo descriptors for the bonds of the molecular graph molgraph from their geometric layout. More...
 
CDPL_CHEM_API void calcAtomCIPConfigurations (MolecularGraph &molgraph, bool overwrite)
 Computes and stores CIP configuration labels for the atoms of the molecular graph molgraph. More...
 
CDPL_CHEM_API void calcBondCIPConfigurations (MolecularGraph &molgraph, bool overwrite)
 Computes and stores CIP configuration labels for the bonds of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setAtomMatchConstraints (MolecularGraph &molgraph, const MatchConstraintList::SharedPointer &constr, bool overwrite)
 Sets the atom-level match constraint list constr on every atom of the molecular graph molgraph. More...
 
CDPL_CHEM_API void setBondMatchConstraints (MolecularGraph &molgraph, const MatchConstraintList::SharedPointer &constr, bool overwrite)
 Sets the bond-level match constraint list constr on every bond of the molecular graph molgraph. More...
 
CDPL_CHEM_API void generateMatchExpressions (MolecularGraph &molgraph, bool overwrite)
 Generates and stores match expressions for every atom, bond and the molecular graph molgraph itself. More...
 
CDPL_CHEM_API void generateMatchExpressionStrings (MolecularGraph &molgraph, bool overwrite)
 Generates and stores textual representations of the atom/bond match expressions of the molecular graph molgraph. More...
 
CDPL_CHEM_API void initSubstructureSearchQuery (MolecularGraph &molgraph, bool overwrite)
 Prepares the molecular graph molgraph for use as a substructure search query. More...
 
CDPL_CHEM_API void initSubstructureSearchTarget (MolecularGraph &molgraph, bool overwrite)
 Prepares the molecular graph molgraph for use as a substructure search target. More...
 
CDPL_CHEM_API void setAromaticityFlags (MolecularGraph &molgraph, bool overwrite)
 Perceives aromaticity and sets the corresponding atom/bond aromaticity flags on the molecular graph molgraph. More...
 
CDPL_CHEM_API void setRingFlags (MolecularGraph &molgraph, bool overwrite)
 Perceives ring membership and sets the corresponding atom/bond ring flags on the molecular graph molgraph. More...
 
CDPL_CHEM_API void setAtomTypesFromSymbols (MolecularGraph &molgraph, bool overwrite)
 Sets the atom types of the molecular graph molgraph from their element symbols. More...
 
CDPL_CHEM_API void setAtomSymbolsFromTypes (MolecularGraph &molgraph, bool overwrite)
 Sets the atom symbols of the molecular graph molgraph from their atom types. More...
 
CDPL_CHEM_API void perceiveSybylAtomTypes (MolecularGraph &molgraph, bool overwrite)
 Perceives Sybyl atom types for the atoms of the molecular graph molgraph. More...
 
CDPL_CHEM_API FragmentList::SharedPointer getAromaticRings (const MolecularGraph &molgraph)
 Returns the subset of the aromatic rings of the molecular graph molgraph. More...
 
CDPL_CHEM_API FragmentList::SharedPointer getAromaticSSSRSubset (const MolecularGraph &molgraph)
 Returns the subset of the SSSR of the molecular graph molgraph that contains only aromatic rings,. More...
 
CDPL_CHEM_API bool containsMolecularGraph (const MolecularGraph &molgraph, const MolecularGraph &sub_molgraph, bool atoms=true, bool bonds=true)
 Tells whether the molecular graph molgraph contains the atoms and/or bonds of sub_molgraph. More...
 
CDPL_CHEM_API void getContainedFragments (const MolecularGraph &molgraph, const FragmentList &frag_list, FragmentList &cont_frag_list, bool append=false, bool atoms=true, bool bonds=true)
 Collects the fragments in frag_list that are fully contained in the molecular graph molgraph into cont_frag_list. More...
 
CDPL_CHEM_API void getContainingFragments (const MolecularGraph &molgraph, const FragmentList &frag_list, FragmentList &cont_frag_list, bool append=false, bool atoms=true, bool bonds=true)
 Collects the fragments in frag_list that contain the molecular graph molgraph into cont_frag_list. More...
 
CDPL_CHEM_API void translateFragment (const MolecularGraph &src_molgraph, const Fragment &src_frag, const MolecularGraph &tgt_molgraph, Fragment &tgt_frag, bool append=false)
 Translates the atoms/bonds of src_frag to the corresponding atoms/bonds of tgt_molgraph and stores them in tgt_frag. More...
 
CDPL_CHEM_API void translateFragments (const MolecularGraph &src_molgraph, const FragmentList &src_frag_list, const MolecularGraph &tgt_molgraph, FragmentList &tgt_frag_list, bool append=false)
 Translates every fragment in src_frag_list to the corresponding fragments on tgt_molgraph. More...
 
CDPL_CHEM_API void splitIntoFragments (const MolecularGraph &molgraph, FragmentList &frag_list, const Util::BitSet &split_bond_mask, bool append=false)
 Splits the molecular graph molgraph into connected fragments by removing the bonds flagged in split_bond_mask. More...
 
CDPL_CHEM_API std::size_t getCompleteBondCount (const MolecularGraph &molgraph)
 Returns the number of bonds of the molecular graph molgraph whose connected atoms are likewise contained in molgraph. More...
 
CDPL_CHEM_API void calcBasicProperties (MolecularGraph &molgraph, bool overwrite)
 Computes the basic atom/bond/molecular graph properties (aromaticity, ring info, etc.) of the molecular graph molgraph. More...
 
CDPL_CHEM_API std::size_t editSubstructures (const MolecularGraph &molgraph, Molecule &result_mol, const std::string &search_ptns, const std::string &result_ptn, const std::string &exclude_ptns=std::string())
 Builds the molecule result_mol from the molecular graph molgraph by replacing all substructures matching the SMARTS patterns in search_ptns with result_ptn. More...
 
CDPL_CHEM_API bool makeHydrogenDeplete (Molecule &mol, bool corr_impl_h_count=true)
 Removes all explicit hydrogen atoms from the molecule mol. More...
 
CDPL_CHEM_API bool makeOrdinaryHydrogenDeplete (Molecule &mol, unsigned int flags, bool corr_impl_h_count=true)
 Removes all explicit ordinary hydrogen atoms from the molecule mol. More...
 
CDPL_CHEM_API bool makeHydrogenComplete (Molecule &mol, bool corr_impl_h_count=true)
 Converts all implicit hydrogens of the molecule mol to explicit hydrogen atoms. More...
 
CDPL_CHEM_API void connectAtoms (Molecule &mol, double dist_tol=0.3, std::size_t atom_idx_offs=0)
 Adds bonds between atoms of the molecule mol whose 3D distance falls within the covalent-radii sum plus dist_tol. More...
 
CDPL_CHEM_API void connectAtoms (Molecule &mol, const Atom3DCoordinatesFunction &coords_func, double dist_tol=0.3, std::size_t atom_idx_offs=0)
 Adds bonds between atoms of the molecule mol whose 3D distance (obtained via coords_func) falls within the covalent-radii sum plus dist_tol. More...
 
CDPL_CHEM_API void removeAtomsIf (Molecule &mol, const AtomPredicate &pred)
 Removes all atoms of the molecule mol for which the predicate pred returns true. More...
 
CDPL_CHEM_API void removeAtomsIfNot (Molecule &mol, const AtomPredicate &pred)
 Removes all atoms of the molecule mol for which the predicate pred returns false. More...
 
CDPL_CHEM_API std::size_t editSubstructures (Molecule &mol, const std::string &search_ptns, const std::string &result_ptn, const std::string &exclude_ptns=std::string())
 Edits the molecule mol by replacing all substructures matching the SMARTS search patterns in search_ptns with the SMILES replacement pattern result_ptn, optionally skipping matches that also match exclude_ptns. More...
 
CDPL_CHEM_API const std::string & getName (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::NAME property of the reaction rxn. More...
 
CDPL_CHEM_API void setName (Reaction &rxn, const std::string &name)
 Sets the value of the Chem::ReactionProperty::NAME property of the reaction rxn to name. More...
 
CDPL_CHEM_API void clearName (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::NAME property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasName (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::NAME property of the reaction rxn is set. More...
 
CDPL_CHEM_API std::time_t getTimestamp (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::TIMESTAMP property of the reaction rxn. More...
 
CDPL_CHEM_API void setTimestamp (Reaction &rxn, std::time_t time)
 Sets the value of the Chem::ReactionProperty::TIMESTAMP property of the reaction rxn to time. More...
 
CDPL_CHEM_API void clearTimestamp (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::TIMESTAMP property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasTimestamp (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::TIMESTAMP property of the reaction rxn is set. More...
 
CDPL_CHEM_API const std::string & getComment (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::COMMENT property of the reaction rxn. More...
 
CDPL_CHEM_API void setComment (Reaction &rxn, const std::string &comment)
 Sets the value of the Chem::ReactionProperty::COMMENT property of the reaction rxn to comment. More...
 
CDPL_CHEM_API void clearComment (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::COMMENT property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasComment (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::COMMENT property of the reaction rxn is set. More...
 
CDPL_CHEM_API const MatchExpression< Reaction >::SharedPointer & getMatchExpression (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::MATCH_EXPRESSION property of the reaction rxn. More...
 
CDPL_CHEM_API void setMatchExpression (Reaction &rxn, const MatchExpression< Reaction >::SharedPointer &expr)
 Sets the value of the Chem::ReactionProperty::MATCH_EXPRESSION property of the reaction rxn to expr. More...
 
CDPL_CHEM_API void clearMatchExpression (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::MATCH_EXPRESSION property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasMatchExpression (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::MATCH_EXPRESSION property of the reaction rxn is set. More...
 
CDPL_CHEM_API MatchExpression< Reaction >::SharedPointer generateMatchExpression (const Reaction &rxn)
 Builds a reaction-level match expression from the match constraints currently attached to the reaction rxn. More...
 
CDPL_CHEM_API MatchExpression< Reaction >::SharedPointer generateMatchExpression (Reaction &rxn, bool overwrite)
 Builds and (optionally) stores the reaction-level match expression of the reaction rxn. More...
 
CDPL_CHEM_API const MatchConstraintList::SharedPointergetMatchConstraints (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::MATCH_CONSTRAINTS property of the reaction rxn. More...
 
CDPL_CHEM_API void setMatchConstraints (Reaction &rxn, const MatchConstraintList::SharedPointer &constr)
 Sets the value of the Chem::ReactionProperty::MATCH_CONSTRAINTS property of the reaction rxn to constr. More...
 
CDPL_CHEM_API void clearMatchConstraints (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::MATCH_CONSTRAINTS property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasMatchConstraints (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::MATCH_CONSTRAINTS property of the reaction rxn is set. More...
 
CDPL_CHEM_API const FragmentList::SharedPointergetComponentGroups (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::COMPONENT_GROUPS property of the reaction rxn. More...
 
CDPL_CHEM_API void setComponentGroups (Reaction &rxn, const FragmentList::SharedPointer &comp_groups)
 Sets the value of the Chem::ReactionProperty::COMPONENT_GROUPS property of the reaction rxn to comp_groups. More...
 
CDPL_CHEM_API void clearComponentGroups (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::COMPONENT_GROUPS property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasComponentGroups (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::COMPONENT_GROUPS property of the reaction rxn is set. More...
 
CDPL_CHEM_API FragmentList::SharedPointer perceiveComponentGroups (const Reaction &rxn)
 Perceives the component groups of the reaction rxn. More...
 
CDPL_CHEM_API FragmentList::SharedPointer perceiveComponentGroups (Reaction &rxn, bool overwrite)
 Perceives and (optionally) stores the component groups of the reaction rxn. More...
 
CDPL_CHEM_API const AtomMapping::SharedPointergetAtomMapping (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::ATOM_MAPPING property of the reaction rxn. More...
 
CDPL_CHEM_API void setAtomMapping (Reaction &rxn, const AtomMapping::SharedPointer &mapping)
 Sets the value of the Chem::ReactionProperty::ATOM_MAPPING property of the reaction rxn to mapping. More...
 
CDPL_CHEM_API void clearAtomMapping (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::ATOM_MAPPING property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasAtomMapping (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::ATOM_MAPPING property of the reaction rxn is set. More...
 
CDPL_CHEM_API AtomMapping::SharedPointer perceiveAtomMapping (const Reaction &rxn)
 Derives the reactant-to-product atom mapping from the atom mapping IDs of the reaction rxn. More...
 
CDPL_CHEM_API AtomMapping::SharedPointer perceiveAtomMapping (Reaction &rxn, bool overwrite)
 Derives and (optionally) stores the reactant-to-product atom mapping of the reaction rxn. More...
 
CDPL_CHEM_API bool generateSMILES (const Reaction &rxn, std::string &smiles, bool canonical=false, bool ord_h_deplete=true, unsigned int atom_flags=AtomPropertyFlag::DEFAULT, unsigned int bond_flags=BondPropertyFlag::DEFAULT)
 Generates a reaction SMILES string for the reaction rxn. More...
 
CDPL_CHEM_API std::uint64_t calcHashCode (const Reaction &rxn, unsigned int role_mask=ReactionRole::ALL, unsigned int atom_flags=AtomPropertyFlag::DEFAULT, unsigned int bond_flags=BondPropertyFlag::DEFAULT, bool ord_h_deplete=true)
 Computes a 64-bit hash code for the reaction rxn taking into account the specified reaction roles and atom/bond properties. More...
 
CDPL_CHEM_API const std::string & getMDLUserInitials (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::MDL_USER_INITIALS property of the reaction rxn. More...
 
CDPL_CHEM_API void setMDLUserInitials (Reaction &rxn, const std::string &initials)
 Sets the value of the Chem::ReactionProperty::MDL_USER_INITIALS property of the reaction rxn to initials. More...
 
CDPL_CHEM_API void clearMDLUserInitials (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::MDL_USER_INITIALS property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasMDLUserInitials (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::MDL_USER_INITIALS property of the reaction rxn is set. More...
 
CDPL_CHEM_API const std::string & getMDLProgramName (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::MDL_PROGRAM_NAME property of the reaction rxn. More...
 
CDPL_CHEM_API void setMDLProgramName (Reaction &rxn, const std::string &name)
 Sets the value of the Chem::ReactionProperty::MDL_PROGRAM_NAME property of the reaction rxn to name. More...
 
CDPL_CHEM_API void clearMDLProgramName (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::MDL_PROGRAM_NAME property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasMDLProgramName (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::MDL_PROGRAM_NAME property of the reaction rxn is set. More...
 
CDPL_CHEM_API std::size_t getMDLRegistryNumber (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::MDL_REGISTRY_NUMBER property of the reaction rxn. More...
 
CDPL_CHEM_API void setMDLRegistryNumber (Reaction &rxn, std::size_t reg_no)
 Sets the value of the Chem::ReactionProperty::MDL_REGISTRY_NUMBER property of the reaction rxn to reg_no. More...
 
CDPL_CHEM_API void clearMDLRegistryNumber (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::MDL_REGISTRY_NUMBER property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasMDLRegistryNumber (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::MDL_REGISTRY_NUMBER property of the reaction rxn is set. More...
 
CDPL_CHEM_API const StringDataBlock::SharedPointergetReactionData (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::REACTION_DATA property of the reaction rxn. More...
 
CDPL_CHEM_API void setReactionData (Reaction &rxn, const StringDataBlock::SharedPointer &data)
 Sets the value of the Chem::ReactionProperty::REACTION_DATA property of the reaction rxn to data. More...
 
CDPL_CHEM_API void clearReactionData (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::REACTION_DATA property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasReactionData (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::REACTION_DATA property of the reaction rxn is set. More...
 
CDPL_CHEM_API const Molecule::SharedPointergetMDLMoleculeRecord (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::MDL_MOLECULE_RECORD property of the reaction rxn. More...
 
CDPL_CHEM_API void setMDLMoleculeRecord (Reaction &rxn, const Molecule::SharedPointer &mol_rec)
 Sets the value of the Chem::ReactionProperty::MDL_MOLECULE_RECORD property of the reaction rxn to mol_rec. More...
 
CDPL_CHEM_API void clearMDLMoleculeRecord (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::MDL_MOLECULE_RECORD property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasMDLMoleculeRecord (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::MDL_MOLECULE_RECORD property of the reaction rxn is set. More...
 
CDPL_CHEM_API const std::string & getMDLInternalRegistryNumber (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::MDL_INTERNAL_REGISTRY_NUMBER property of the reaction rxn. More...
 
CDPL_CHEM_API void setMDLInternalRegistryNumber (Reaction &rxn, const std::string &reg_no)
 Sets the value of the Chem::ReactionProperty::MDL_INTERNAL_REGISTRY_NUMBER property of the reaction rxn to reg_no. More...
 
CDPL_CHEM_API void clearMDLInternalRegistryNumber (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::MDL_INTERNAL_REGISTRY_NUMBER property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasMDLInternalRegistryNumber (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::MDL_INTERNAL_REGISTRY_NUMBER property of the reaction rxn is set. More...
 
CDPL_CHEM_API const std::string & getMDLExternalRegistryNumber (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::MDL_EXTERNAL_REGISTRY_NUMBER property of the reaction rxn. More...
 
CDPL_CHEM_API void setMDLExternalRegistryNumber (Reaction &rxn, const std::string &reg_no)
 Sets the value of the Chem::ReactionProperty::MDL_EXTERNAL_REGISTRY_NUMBER property of the reaction rxn to reg_no. More...
 
CDPL_CHEM_API void clearMDLExternalRegistryNumber (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::MDL_EXTERNAL_REGISTRY_NUMBER property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasMDLExternalRegistryNumber (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::MDL_EXTERNAL_REGISTRY_NUMBER property of the reaction rxn is set. More...
 
CDPL_CHEM_API unsigned int getMDLRXNFileVersion (const Reaction &rxn)
 Returns the value of the Chem::ReactionProperty::MDL_RXN_FILE_VERSION property of the reaction rxn. More...
 
CDPL_CHEM_API void setMDLRXNFileVersion (Reaction &rxn, unsigned int version)
 Sets the value of the Chem::ReactionProperty::MDL_RXN_FILE_VERSION property of the reaction rxn to version. More...
 
CDPL_CHEM_API void clearMDLRXNFileVersion (Reaction &rxn)
 Clears the value of the Chem::ReactionProperty::MDL_RXN_FILE_VERSION property of the reaction rxn. More...
 
CDPL_CHEM_API bool hasMDLRXNFileVersion (const Reaction &rxn)
 Tells whether the Chem::ReactionProperty::MDL_RXN_FILE_VERSION property of the reaction rxn is set. More...
 
CDPL_CHEM_API std::size_t getMaxComponentGroupID (const Reaction &rxn)
 Returns the largest component group ID found for any of the atoms of the components of the reaction rxn. More...
 
CDPL_CHEM_API std::size_t getMaxAtomMappingID (const Reaction &rxn)
 Returns the largest atom mapping ID found for any of the atoms of the components of the reaction rxn. More...
 
CDPL_CHEM_API void setAtomMatchConstraints (Reaction &rxn, const MatchConstraintList::SharedPointer &constr, bool overwrite)
 Sets the atom-level match constraint list constr on every atom of every component of the reaction rxn. More...
 
CDPL_CHEM_API void setBondMatchConstraints (Reaction &rxn, const MatchConstraintList::SharedPointer &constr, bool overwrite)
 Sets the bond-level match constraint list constr on every bond of every component of the reaction rxn. More...
 
CDPL_CHEM_API void setComponentMatchConstraints (Reaction &rxn, const MatchConstraintList::SharedPointer &constr, bool overwrite)
 Sets the molecular graph-level match constraint list constr on every component of the reaction rxn. More...
 
CDPL_CHEM_API void generateMatchExpressions (Reaction &rxn, bool overwrite)
 Generates and stores match expressions for the atoms, bonds, components, and the reaction rxn itself. More...
 
CDPL_CHEM_API void initSubstructureSearchQuery (Reaction &rxn, bool overwrite)
 Prepares the reaction rxn for use as a reaction substructure search query. More...
 
CDPL_CHEM_API void initSubstructureSearchTarget (Reaction &rxn, bool overwrite)
 Prepares the reaction rxn for use as a reaction substructure search target. More...
 
CDPL_CHEM_API void calcBasicProperties (Reaction &rxn, bool overwrite)
 Computes basic atom/bond/molecular graph properties (aromaticity, ring info, etc.) for every component of the reaction rxn. More...
 
CDPL_CHEM_API Molecule::SharedPointer parseSMARTS (const std::string &smarts, bool init_qry=true)
 Parses the SMARTS string smarts into a freshly allocated query Chem::Molecule. More...
 
CDPL_CHEM_API bool parseSMARTS (const std::string &smarts, Molecule &mol, bool init_qry=true)
 Parses the SMARTS string smarts into the supplied molecule mol. More...
 
CDPL_CHEM_API Molecule::SharedPointer parseSMILES (const std::string &smiles)
 Parses the SMILES string smiles into a freshly allocated Chem::Molecule. More...
 
CDPL_CHEM_API bool parseSMILES (const std::string &smiles, Molecule &mol)
 Parses the SMILES string smiles into the supplied molecule mol. More...
 
CDPL_CHEM_API void extendBoundingBox (Math::Vector3D &min, Math::Vector3D &max, const Math::Vector3D &coords, bool reset=false)
 Extends the axis-aligned bounding box defined by min and max so that it contains the point coords. More...
 
CDPL_CHEM_API bool insideBoundingBox (const Math::Vector3D &min, const Math::Vector3D &max, const Math::Vector3D &coords)
 Tells whether the point coords lies inside the axis-aligned bounding box defined by min and max. More...
 
CDPL_CHEM_API bool isAromatic (const Fragment &ring, const MolecularGraph &molgraph, const Util::BitSet &arom_bond_mask)
 Tells whether ring fulfills the Hückel (4n+2)π-electron criterion within molgraph. More...
 
CDPL_CHEM_API bool isNotAromatic (const Fragment &ring, const MolecularGraph &molgraph)
 Tells whether ring is guaranteed not to be aromatic (based on quick geometric/topological criteria). More...
 
CDPL_CHEM_API bool containsFragmentWithBond (const FragmentList &frag_list, const Bond &bond)
 Tells whether any fragment in frag_list contains the bond bond. More...
 
CDPL_CHEM_API bool containsFragmentWithMinSize (const FragmentList &frag_list, std::size_t min_size)
 Tells whether frag_list contains at least one fragment with at least min_size atoms. More...
 
CDPL_CHEM_API bool atomTypesMatch (unsigned int qry_type, unsigned int tgt_type)
 Tells whether the target atom type tgt_type matches the query atom type qry_type (taking generic atom type classes like Chem::AtomType::HET into account). More...
 
CDPL_CHEM_API unsigned int sybylToAtomType (unsigned int sybyl_type)
 Translates a Sybyl atom type identifier to the corresponding generic Chem::AtomType value. More...
 
CDPL_CHEM_API const std::string & getSybylAtomTypeString (unsigned int sybyl_type)
 Returns the canonical textual representation of the Sybyl atom type sybyl_type. More...
 
CDPL_CHEM_API const std::string & getSybylBondTypeString (unsigned int sybyl_type)
 Returns the canonical textual representation of the Sybyl bond type sybyl_type. More...
 

Detailed Description

Contains classes and functions related to chemistry.

Typedef Documentation

◆ Atom3DCoordinatesFunction

typedef std::function<const Math::Vector3D&(const Chem::Atom&)> CDPL::Chem::Atom3DCoordinatesFunction

Generic wrapper class used to store a user-defined Chem::Atom 3D-coordinates function.

◆ AtomCompareFunction

typedef std::function<bool(const Atom&, const Atom&)> CDPL::Chem::AtomCompareFunction

Generic wrapper class used to store a user-defined atom compare function.

◆ AtomPredicate

typedef std::function<bool(const Chem::Atom&)> CDPL::Chem::AtomPredicate

Generic wrapper class used to store a user-defined atom predicate.

◆ AtomPriorityFunction

typedef std::function<std::size_t(const Chem::Atom&)> CDPL::Chem::AtomPriorityFunction

Generic wrapper class used to store a user-defined atom priority function.

◆ BondCompareFunction

typedef std::function<bool(const Chem::Bond&, const Chem::Bond&)> CDPL::Chem::BondCompareFunction

Generic wrapper class used to store a user-defined bond compare function.

◆ BondPredicate

typedef std::function<bool(const Chem::Bond&)> CDPL::Chem::BondPredicate

Generic wrapper class used to store a user-defined bond predicate.

◆ CDFBZ2MolecularGraphOutputHandler

Handler for the output of bzip2-compressed molecular graph data in the native I/O format of the CDPL.

◆ CDFBZ2MolecularGraphWriter

Writer for molecular graph data in the bzip2-compressed native I/O format of the CDPL.

◆ CDFBZ2MoleculeInputHandler

Handler for the input of bzip2-compressed molecule data in the native I/O format of the CDPL.

◆ CDFBZ2MoleculeReader

Reader for molecule data in the bzip2-compressed native I/O format of the CDPL.

◆ CDFBZ2ReactionInputHandler

Handler for the input of bzip2-compressed reaction data in the native I/O format of the CDPL.

◆ CDFBZ2ReactionOutputHandler

Handler for the output of bzip2-compressed reaction data in the native I/O format of the CDPL.

◆ CDFBZ2ReactionReader

Reader for reaction data in the bzip2-compressed native I/O format of the CDPL.

◆ CDFBZ2ReactionWriter

Writer for reaction data in the bzip2-compressed native I/O format of the CDPL.

◆ CDFGZMolecularGraphOutputHandler

Handler for the output of gzip-compressed molecular graph data in the native I/O format of the CDPL.

◆ CDFGZMolecularGraphWriter

Writer for molecular graph data in the gzip-compressed native I/O format of the CDPL.

◆ CDFGZMoleculeInputHandler

Handler for the input of gzip-compressed molecule data in the native I/O format of the CDPL.

◆ CDFGZMoleculeReader

Reader for molecule data in the gzip-compressed native I/O format of the CDPL.

◆ CDFGZReactionInputHandler

Handler for the input of gzip-compressed reaction data in the native I/O format of the CDPL.

◆ CDFGZReactionOutputHandler

Handler for the output of gzip-compressed reaction data in the native I/O format of the CDPL.

◆ CDFGZReactionReader

Reader for reaction data in the gzip-compressed native I/O format of the CDPL.

◆ CDFGZReactionWriter

Writer for reaction data in the gzip-compressed native I/O format of the CDPL.

◆ CDFMolecularGraphOutputHandler

Handler for the output of molecular graph data in the native I/O format of the CDPL.

◆ CDFMoleculeInputHandler

Handler for the input of molecule data in the native I/O format of the CDPL.

◆ CDFReactionInputHandler

Handler for the input of reaction data in the native I/O format of the CDPL.

◆ CDFReactionOutputHandler

Handler for the output of reaction data in the native I/O format of the CDPL.

◆ CMLBZ2MolecularGraphOutputHandler

Handler for the output of bzip2-compressed molecular graph data in the Chemical Markup Language [CML] format.

Since
1.2

◆ CMLBZ2MolecularGraphWriter

Writer for molecular graph data in the bzip2-compressed Chemical Markup Language [CML] format.

Since
1.2

◆ CMLBZ2MoleculeInputHandler

Handler for the input of bzip2-compressed molecule data in the Chemical Markup Language [CML] format.

Since
1.2

◆ CMLBZ2MoleculeReader

Reader for molecule data in the bzip2-compressed Chemical Markup Language [CML] format.

Since
1.2

◆ CMLGZMolecularGraphOutputHandler

Handler for the output of gzip-compressed molecular graph data in the Chemical Markup Language [CML] format.

Since
1.2

◆ CMLGZMolecularGraphWriter

Writer for molecular graph data in the gzip-compressed Chemical Markup Language [CML] format.

Since
1.2

◆ CMLGZMoleculeInputHandler

Handler for the input of gzip-compressed molecule data in the Chemical Markup Language [CML] format.

Since
1.2

◆ CMLGZMoleculeReader

Reader for molecule data in the gzip-compressed Chemical Markup Language [CML] format.

Since
1.2

◆ CMLMolecularGraphOutputHandler

Handler for the output of molecular graph data in the Chemical Markup Language [CML] format.

Since
1.2

◆ CMLMoleculeInputHandler

Handler for the input of molecule data in the Chemical Markup Language [CML] format.

Since
1.2

◆ Entity3DCoordinatesFunction

typedef std::function<const Math::Vector3D&(const Chem::Entity&)> CDPL::Chem::Entity3DCoordinatesFunction

Generic wrapper class used to store a user-defined Chem::Entity3D coordinates function.

◆ INCHIMolecularGraphOutputHandler

Handler for the output of molecular graph data in the IUPAC International Chemical Identifier (InChI) [INCHI] format.

◆ INCHIMoleculeInputHandler

Handler for the input of molecule data in the IUPAC International Chemical Identifier (InChI) [INCHI] format.

◆ JMEMolecularGraphOutputHandler

Handler for the output of molecular graph data in the native I/O format of the JME Molecular Editor [JME] java applet.

◆ JMEMoleculeInputHandler

Handler for the input of molecule data in the native I/O format of the JME Molecular Editor [JME] java applet.

◆ JMEReactionInputHandler

Handler for the input of reaction data in the native I/O format of the JME Molecular Editor [JME] java applet.

◆ JMEReactionOutputHandler

Handler for the output of reaction data in the native I/O format of the JME Molecular Editor [JME] java applet.

◆ MOL2BZ2MolecularGraphOutputHandler

Handler for the output of bzip2-compressed molecular graph data in the Sybyl MOL2 format.

◆ MOL2BZ2MolecularGraphWriter

Writer for molecular graph data in the bzip2-compressed Sybyl MOL2 format.

◆ MOL2BZ2MoleculeInputHandler

Handler for the input of bzip2-compressed molecule data in the Sybyl MOL2 format.

◆ MOL2BZ2MoleculeReader

Reader for molecule data in the bzip2-compressed Sybyl MOL2 format.

◆ MOL2GZMolecularGraphOutputHandler

Handler for the output of gzip-compressed molecular graph data in the Sybyl MOL2 format.

◆ MOL2GZMolecularGraphWriter

Writer for molecular graph data in the gzip-compressed Sybyl MOL2 format.

◆ MOL2GZMoleculeInputHandler

Handler for the input of gzip-compressed molecule data in the Sybyl MOL2 format.

◆ MOL2GZMoleculeReader

Reader for molecule data in the gzip-compressed Sybyl MOL2 format.

◆ MOL2MolecularGraphOutputHandler

Handler for the output of molecular graph data in the Sybyl MOL2 format.

◆ MOL2MoleculeInputHandler

Handler for the input of molecule data in the Sybyl MOL2 format.

◆ MolecularGraphWriter

Writer for molecule data in any supported format.

◆ MoleculeReader

Reader for molecule data in any supported format.

◆ MOLMolecularGraphOutputHandler

Handler for the output of molecular graph data in the MDL Mol-File [CTFILE] format.

◆ MOLMoleculeInputHandler

Handler for the input of molecule data in the MDL Mol-File [CTFILE] format.

◆ RDFBZ2ReactionInputHandler

Handler for the input of bzip2-compressed reaction data in the MDL RD-File [CTFILE] format.

◆ RDFBZ2ReactionOutputHandler

Handler for the output of bzip2-compressed reaction data in the MDL RD-File [CTFILE] format.

◆ RDFBZ2ReactionReader

Reader for reaction data in the bzip2-compressed MDL RD-File [CTFILE] format.

◆ RDFBZ2ReactionWriter

Writer for reaction data in the bzip2-compressed MDL RD-File [CTFILE] format.

◆ RDFGZReactionInputHandler

Handler for the input of gzip-compressed reaction data in the MDL RD-File [CTFILE] format.

◆ RDFGZReactionOutputHandler

Handler for the output of gzip-compressed reaction data in the MDL RD-File [CTFILE] format.

◆ RDFGZReactionReader

Reader for reaction data in the gzip-compressed MDL RD-File [CTFILE] format.

◆ RDFGZReactionWriter

Writer for reaction data in the gzip-compressed MDL RD-File [CTFILE] format.

◆ RDFReactionInputHandler

Handler for the input of reaction data in the MDL RD-File [CTFILE] format.

◆ RDFReactionOutputHandler

Handler for the output of reaction data in the MDL RD-File [CTFILE] format.

◆ ReactionReader

Reader for reaction data in any supported format.

◆ ReactionWriter

Writer for reaction data in any supported format.

◆ RXNReactionInputHandler

Handler for the input of reaction data in the MDL Rxn-File [CTFILE] format.

◆ RXNReactionOutputHandler

Handler for the output of reaction data in the MDL Rxn-File [CTFILE] format.

◆ SDFBZ2MolecularGraphOutputHandler

Handler for the output of bzip2-compressed molecular graph data in the MDL SD-File [CTFILE] format.

◆ SDFBZ2MolecularGraphWriter

Writer for molecular graph data in the bzip2-compressed MDL SD-File [CTFILE] format.

◆ SDFBZ2MoleculeInputHandler

Handler for the input of bzip2-compressed molecule data in the MDL SD-File [CTFILE] format.

◆ SDFBZ2MoleculeReader

Reader for molecule data in the bzip2-compressed MDL SD-File [CTFILE] format.

◆ SDFGZMolecularGraphOutputHandler

Handler for the output of gzip-compressed molecular graph data in the MDL SD-File [CTFILE] format.

◆ SDFGZMolecularGraphWriter

Writer for molecular graph data in the gzip-compressed MDL SD-File [CTFILE] format.

◆ SDFGZMoleculeInputHandler

Handler for the input of gzip-compressed molecule data in the MDL SD-File [CTFILE] format.

◆ SDFGZMoleculeReader

Reader for molecule data in the gzip-compressed MDL SD-File [CTFILE] format.

◆ SDFMolecularGraphOutputHandler

Handler for the output of molecular graph data in the MDL SD-File [CTFILE] format.

◆ SDFMoleculeInputHandler

Handler for the input of molecule data in the MDL SD-File [CTFILE] format.

◆ SMARTSMolecularGraphOutputHandler

Handler for the output of molecular graph data in the Daylight SMARTS [SMARTS] format.

◆ SMARTSMoleculeInputHandler

Handler for the input of molecule data in the Daylight SMARTS [SMARTS] format.

◆ SMARTSReactionInputHandler

Handler for the input of reaction data in the Daylight SMARTS [SMARTS] format.

◆ SMARTSReactionOutputHandler

Handler for the output of reaction data in the Daylight SMARTS [SMARTS] format.

◆ SMILESBZ2MolecularGraphOutputHandler

Handler for the output of bzip2-compressed molecular graph data in the Daylight SMILES [SMILES] format.

◆ SMILESBZ2MolecularGraphWriter

Writer for molecular graph data in the bzip2-compressed Daylight SMILES [SMILES] format.

◆ SMILESBZ2MoleculeInputHandler

Handler for the input of bzip2-compressed molecule data in the Daylight SMILES [SMILES] format.

◆ SMILESBZ2MoleculeReader

Reader for molecule data in the bzip2-compressed Daylight SMILES [SMILES] format.

◆ SMILESBZ2ReactionInputHandler

Handler for the input of bzip2-compressed reaction data in the Daylight SMILES [SMILES] format.

◆ SMILESBZ2ReactionOutputHandler

Handler for the output of bzip2-compressed reaction data in the Daylight SMILES [SMILES] format.

◆ SMILESBZ2ReactionReader

Reader for reaction data in the bzip2-compressed Daylight SMILES [SMILES] format.

◆ SMILESBZ2ReactionWriter

Writer for reaction data in the bzip2-compressed Daylight SMILES [SMILES] format.

◆ SMILESGZMolecularGraphOutputHandler

Handler for the output of gzip-compressed molecular graph data in the Daylight SMILES [SMILES] format.

◆ SMILESGZMolecularGraphWriter

Writer for molecular graph data in the gzip-compressed Daylight SMILES [SMILES] format.

◆ SMILESGZMoleculeInputHandler

Handler for the input of gzip-compressed molecule data in Daylight SMILES [SMILES] format.

◆ SMILESGZMoleculeReader

Reader for molecule data in the gzip-compressed Daylight SMILES [SMILES] format.

◆ SMILESGZReactionInputHandler

Handler for the input of gzip-compressed reaction data in the Daylight SMILES [SMILES] format.

◆ SMILESGZReactionOutputHandler

Handler for the output of gzip-compressed reaction data in the Daylight SMILES [SMILES] format.

◆ SMILESGZReactionReader

Reader for reaction data in the gzip-compressed Daylight SMILES [SMILES] format.

◆ SMILESGZReactionWriter

Writer for reaction data in the gzip-compressed Daylight SMILES [SMILES] format.

◆ SMILESMolecularGraphOutputHandler

Handler for the output of molecular graph data in the Daylight SMILES [SMILES] format.

◆ SMILESMoleculeInputHandler

Handler for the input of molecule data in the Daylight SMILES [SMILES] format.

◆ SMILESReactionInputHandler

Handler for the input of reaction data in the Daylight SMILES [SMILES] format.

◆ SMILESReactionOutputHandler

Handler for the output of reaction data in the Daylight SMILES [SMILES] format.

◆ XYZBZ2MolecularGraphOutputHandler

Handler for the output of bzip2-compressed molecular graph data in the XYZ format.

Since
1.1

◆ XYZBZ2MolecularGraphWriter

Writer for molecular graph data in the bzip2-compressed XYZ format.

Since
1.1

◆ XYZBZ2MoleculeInputHandler

Handler for the input of bzip2-compressed molecule data in the XYZ format.

Since
1.1

◆ XYZBZ2MoleculeReader

Reader for molecule data in the bzip2-compressed XYZ format.

Since
1.1

◆ XYZGZMolecularGraphOutputHandler

Handler for the output of gzip-compressed molecular graph data in the XYZ format.

Since
1.1

◆ XYZGZMolecularGraphWriter

Writer for molecular graph data in the gzip-compressed XYZ format.

Since
1.1

◆ XYZGZMoleculeInputHandler

Handler for the input of gzip-compressed molecule data in the XYZ format.

Since
1.1

◆ XYZGZMoleculeReader

Reader for molecule data in the gzip-compressed XYZ format.

Since
1.1

◆ XYZMolecularGraphOutputHandler

Handler for the output of molecular graph data in the XYZ format.

Since
1.1

◆ XYZMoleculeInputHandler

Handler for the input of molecule data in the XYZ format.

Since
1.1

Function Documentation

◆ hasCoordinates()

CDPL_CHEM_API bool CDPL::Chem::hasCoordinates ( const AtomContainer cntnr,
std::size_t  dim 
)

Tells whether all atoms of cntnr carry coordinates of the given dimensionality.

Parameters
cntnrThe atom container.
dimThe coordinate dimensionality (2 or 3).
Returns
true if all atoms have the requested coordinates, and false otherwise.

◆ get2DCoordinates() [1/2]

CDPL_CHEM_API void CDPL::Chem::get2DCoordinates ( const AtomContainer cntnr,
Math::Vector2DArray coords,
bool  append = false 
)

Extracts the 2D coordinates of all atoms in cntnr into coords.

Parameters
cntnrThe atom container.
coordsThe output 2D-coordinate array.
appendIf true, the coordinates are appended to coords. Otherwise, coords is cleared first.

◆ set2DCoordinates() [1/2]

CDPL_CHEM_API void CDPL::Chem::set2DCoordinates ( AtomContainer cntnr,
const Math::Vector2DArray coords 
)

Writes the 2D coordinates in coords back to the corresponding atoms of cntnr.

Parameters
cntnrThe atom container.
coordsThe 2D coordinates to assign (must contain at least one entry per atom).

◆ transform2DCoordinates()

CDPL_CHEM_API void CDPL::Chem::transform2DCoordinates ( AtomContainer cntnr,
const Math::Matrix3D mtx 
)

Transforms the 2D coordinates of all atoms in cntnr by the affine 3×3 matrix mtx.

Parameters
cntnrThe atom container.
mtxThe 2D affine transformation matrix.

◆ get3DCoordinates() [1/3]

CDPL_CHEM_API void CDPL::Chem::get3DCoordinates ( const AtomContainer cntnr,
Math::Vector3DArray coords,
const Atom3DCoordinatesFunction coords_func,
bool  append = false 
)

Extracts the 3D coordinates of all atoms in cntnr into coords using the per-atom coordinate lookup function coords_func.

Parameters
cntnrThe atom container.
coordsThe output 3D-coordinate array.
coords_funcThe function returning the 3D coordinates of an atom.
appendIf true, the coordinates are appended to coords. Otherwise, coords is cleared first.

◆ clearConformations()

CDPL_CHEM_API void CDPL::Chem::clearConformations ( AtomContainer cntnr)

Removes all stored conformations from the atoms of cntnr.

Parameters
cntnrThe atom container.

◆ getNumConformations()

CDPL_CHEM_API std::size_t CDPL::Chem::getNumConformations ( const AtomContainer cntnr)

Returns the number of conformations stored on the atoms of cntnr.

Parameters
cntnrThe atom container.
Returns
The conformation count.

◆ applyConformation()

CDPL_CHEM_API void CDPL::Chem::applyConformation ( AtomContainer cntnr,
std::size_t  conf_idx 
)

Promotes the stored conformation at index conf_idx to the active per-atom 3D coordinates.

Parameters
cntnrThe atom container.
conf_idxThe zero-based conformation index.

◆ getConformation()

CDPL_CHEM_API void CDPL::Chem::getConformation ( const AtomContainer cntnr,
std::size_t  conf_idx,
Math::Vector3DArray coords,
bool  append = false 
)

Extracts the conformation at index conf_idx into coords.

Parameters
cntnrThe atom container.
conf_idxThe zero-based conformation index.
coordsThe output 3D-coordinate array.
appendIf true, the coordinates are appended to coords. Otherwise, coords is cleared first.

◆ setConformation() [1/2]

CDPL_CHEM_API void CDPL::Chem::setConformation ( AtomContainer cntnr,
std::size_t  conf_idx,
const Math::Vector3DArray coords 
)

Overwrites the conformation at index conf_idx with the supplied 3D coordinates.

Parameters
cntnrThe atom container.
conf_idxThe zero-based conformation index.
coordsThe 3D coordinates of the conformation.

◆ addConformation() [1/2]

CDPL_CHEM_API void CDPL::Chem::addConformation ( AtomContainer cntnr,
const Math::Vector3DArray coords 
)

Appends a new conformation built from the supplied 3D coordinates to the atoms of cntnr.

Parameters
cntnrThe atom container.
coordsThe 3D coordinates of the new conformation.

◆ transformConformation()

CDPL_CHEM_API void CDPL::Chem::transformConformation ( AtomContainer cntnr,
std::size_t  conf_idx,
const Math::Matrix4D mtx 
)

Transforms the conformation at index conf_idx by the homogeneous 4×4 matrix mtx.

Parameters
cntnrThe atom container.
conf_idxThe zero-based conformation index.
mtxThe homogeneous 4×4 transformation matrix.

◆ transformConformations()

CDPL_CHEM_API void CDPL::Chem::transformConformations ( AtomContainer cntnr,
const Math::Matrix4D mtx 
)

Transforms every stored conformation of the atoms in cntnr by the homogeneous 4×4 matrix mtx.

Parameters
cntnrThe atom container.
mtxThe homogeneous 4×4 transformation matrix.

◆ alignConformations() [1/4]

CDPL_CHEM_API bool CDPL::Chem::alignConformations ( AtomContainer cntnr,
const Util::BitSet ref_atoms,
const Math::Vector3DArray ref_coords 
)

Aligns each stored conformation of cntnr onto the supplied reference coordinates using the atoms flagged in ref_atoms as alignment anchors.

Parameters
cntnrThe atom container holding the conformations to be aligned.
ref_atomsBit mask selecting the atoms of cntnr used as alignment anchors.
ref_coordsReference 3D coordinates of the alignment-anchor atoms.
Returns
true if the alignment succeeded for every conformation, and false otherwise.
Since
1.1

◆ alignConformations() [2/4]

CDPL_CHEM_API bool CDPL::Chem::alignConformations ( AtomContainer cntnr,
const AtomContainer ref_atoms,
const Math::Vector3DArray ref_coords 
)

Aligns each stored conformation of cntnr onto the supplied reference coordinates using the atoms of ref_atoms as alignment anchors.

Parameters
cntnrThe atom container holding the conformations to be aligned.
ref_atomsThe atoms used as alignment anchors (must all be members of cntnr).
ref_coordsReference 3D coordinates of the alignment-anchor atoms.
Returns
true if the alignment succeeded for every conformation, and false otherwise.
Since
1.1

◆ alignConformations() [3/4]

CDPL_CHEM_API bool CDPL::Chem::alignConformations ( AtomContainer cntnr,
const Util::BitSet ref_atoms 
)

Aligns each stored conformation of cntnr to the first conformation using the atoms flagged in ref_atoms as alignment anchors.

Parameters
cntnrThe atom container holding the conformations to be aligned.
ref_atomsBit mask selecting the atoms of cntnr used as alignment anchors.
Returns
true if the alignment succeeded for every conformation, and false otherwise.
Since
1.1

◆ alignConformations() [4/4]

CDPL_CHEM_API bool CDPL::Chem::alignConformations ( AtomContainer cntnr,
const AtomContainer ref_atoms 
)

Aligns each stored conformation of cntnr to the first conformation using the atoms of ref_atoms as alignment anchors.

Parameters
cntnrThe atom container holding the conformations to be aligned.
ref_atomsThe atoms used as alignment anchors (must all be members of cntnr).
Returns
true if the alignment succeeded for every conformation, and false otherwise.
Since
1.1

◆ getMaxComponentGroupID() [1/2]

CDPL_CHEM_API std::size_t CDPL::Chem::getMaxComponentGroupID ( const AtomContainer cntnr)

Returns the largest component-group ID assigned to any atom of cntnr.

Parameters
cntnrThe atom container.
Returns
The largest component-group ID (zero if no atom carries a component-group ID).

◆ getMaxAtomMappingID() [1/2]

CDPL_CHEM_API std::size_t CDPL::Chem::getMaxAtomMappingID ( const AtomContainer cntnr)

Returns the largest atom mapping ID assigned to any atom of cntnr.

Parameters
cntnrThe atom container.
Returns
The largest atom mapping ID (zero if no atom carries an atom mapping ID).

◆ createAtomTypeMask()

CDPL_CHEM_API std::size_t CDPL::Chem::createAtomTypeMask ( const AtomContainer cntnr,
Util::BitSet mask,
unsigned int  type,
bool  reset = true,
bool  strict = true 
)

Sets bits in mask corresponding to atoms of cntnr whose atom type matches type.

Parameters
cntnrThe atom container.
maskThe output bit mask (bit i is set if atom i of cntnr has the requested type).
typeThe query atom type (Chem::AtomType value, possibly a generic class such as Chem::AtomType::HET).
resetIf true, mask is reset before processing. Otherwise, existing bits are preserved.
strictIf true, only exact type matches are accepted. If false, generic-class matches also set the bit.
Returns
The number of atoms whose bit was set.

◆ copyAtomsIf() [1/2]

CDPL_CHEM_API void CDPL::Chem::copyAtomsIf ( const AtomContainer cntnr,
Molecule mol,
const AtomPredicate pred,
bool  append = false 
)

Copies every atom of cntnr that satisfies pred into the molecule mol.

Parameters
cntnrThe source atom container.
molThe target molecule.
predThe predicate evaluated for each atom. Only atoms for which it returns true are copied.
appendIf true, atoms are appended to mol. Otherwise, mol is cleared first.

◆ copyAtomsIf() [2/2]

CDPL_CHEM_API void CDPL::Chem::copyAtomsIf ( const AtomContainer cntnr,
Fragment frag,
const AtomPredicate pred,
bool  append = false 
)

Copies every atom of cntnr that satisfies pred into the fragment frag.

Parameters
cntnrThe source atom container.
fragThe target fragment.
predThe predicate evaluated for each atom. Only atoms for which it returns true are copied.
appendIf true, atoms are appended to frag. Otherwise, frag is cleared first.

◆ copyAtomsIfNot() [1/2]

CDPL_CHEM_API void CDPL::Chem::copyAtomsIfNot ( const AtomContainer cntnr,
Molecule mol,
const AtomPredicate pred,
bool  append = false 
)

Copies every atom of cntnr that does not satisfy pred into the molecule mol.

Parameters
cntnrThe source atom container.
molThe target molecule.
predThe predicate evaluated for each atom. Only atoms for which it returns false are copied.
appendIf true, atoms are appended to mol. Otherwise, mol is cleared first.

◆ copyAtomsIfNot() [2/2]

CDPL_CHEM_API void CDPL::Chem::copyAtomsIfNot ( const AtomContainer cntnr,
Fragment frag,
const AtomPredicate pred,
bool  append = false 
)

Copies every atom of cntnr that does not satisfy pred into the fragment frag.

Parameters
cntnrThe source atom container.
fragThe target fragment.
predThe predicate evaluated for each atom. Only atoms for which it returns false are copied.
appendIf true, atoms are appended to frag. Otherwise, frag is cleared first.

◆ calcCenterOfMass()

CDPL_CHEM_API bool CDPL::Chem::calcCenterOfMass ( const AtomContainer cntnr,
const Atom3DCoordinatesFunction coords_func,
Math::Vector3D ctr 
)

Computes the mass-weighted center of mass of the atoms in cntnr.

Parameters
cntnrThe atom container.
coords_funcThe function returning the 3D coordinates of an atom.
ctrThe output center-of-mass coordinates.
Returns
true if the center of mass could be computed (at least one atom with non-zero mass), and false otherwise.

◆ calcCentroid() [1/2]

CDPL_CHEM_API bool CDPL::Chem::calcCentroid ( const AtomContainer cntnr,
const Atom3DCoordinatesFunction coords_func,
Math::Vector3D ctr 
)

Computes the unweighted centroid (arithmetic mean of atom coordinates) of cntnr.

Parameters
cntnrThe atom container.
coords_funcThe function returning the 3D coordinates of an atom.
ctrThe output centroid coordinates.
Returns
true if the centroid could be computed (cntnr is non-empty), and false otherwise.

◆ calcBoundingBox() [1/2]

CDPL_CHEM_API void CDPL::Chem::calcBoundingBox ( const AtomContainer cntnr,
Math::Vector3D min,
Math::Vector3D max,
const Atom3DCoordinatesFunction coords_func,
bool  reset = true 
)

Computes the axis-aligned bounding box enclosing the atoms of cntnr.

Parameters
cntnrThe atom container.
minThe output lower-left corner of the bounding box.
maxThe output upper-right corner of the bounding box.
coords_funcThe function returning the 3D coordinates of an atom.
resetIf true, the bounding box is reset to the first atom. Otherwise, min and max are extended in place.

◆ insideBoundingBox() [1/3]

CDPL_CHEM_API bool CDPL::Chem::insideBoundingBox ( const AtomContainer cntnr,
const Math::Vector3D min,
const Math::Vector3D max,
const Atom3DCoordinatesFunction coords_func 
)

Tells whether every atom of cntnr lies inside the axis-aligned bounding box defined by min and max.

Parameters
cntnrThe atom container.
minThe lower-left corner of the bounding box.
maxThe upper-right corner of the bounding box.
coords_funcThe function returning the 3D coordinates of an atom.
Returns
true if all atoms are inside the box, and false otherwise.

◆ intersectsBoundingBox() [1/2]

CDPL_CHEM_API bool CDPL::Chem::intersectsBoundingBox ( const AtomContainer cntnr,
const Math::Vector3D min,
const Math::Vector3D max,
const Atom3DCoordinatesFunction coords_func 
)

Tells whether at least one atom of cntnr lies inside the axis-aligned bounding box defined by min and max.

Parameters
cntnrThe atom container.
minThe lower-left corner of the bounding box.
maxThe upper-right corner of the bounding box.
coords_funcThe function returning the 3D coordinates of an atom.
Returns
true if at least one atom is inside the box, and false otherwise.

◆ getName() [1/3]

CDPL_CHEM_API const std::string& CDPL::Chem::getName ( const Atom atom)

Returns the value of the Chem::AtomProperty::NAME property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored atom name.

◆ setName() [1/3]

CDPL_CHEM_API void CDPL::Chem::setName ( Atom atom,
const std::string &  name 
)

Sets the value of the Chem::AtomProperty::NAME property of the atom atom to name.

Parameters
atomThe atom for which to set the property value.
nameThe new atom name.

◆ clearName() [1/3]

CDPL_CHEM_API void CDPL::Chem::clearName ( Atom atom)

Clears the value of the Chem::AtomProperty::NAME property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasName() [1/3]

CDPL_CHEM_API bool CDPL::Chem::hasName ( const Atom atom)

Tells whether the Chem::AtomProperty::NAME property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getSymbol()

CDPL_CHEM_API const std::string& CDPL::Chem::getSymbol ( const Atom atom)

Returns the value of the Chem::AtomProperty::SYMBOL property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored element symbol.

◆ setSymbol()

CDPL_CHEM_API void CDPL::Chem::setSymbol ( Atom atom,
const std::string &  symbol 
)

Sets the value of the Chem::AtomProperty::SYMBOL property of the atom atom to symbol.

Parameters
atomThe atom for which to set the property value.
symbolThe new element symbol.

◆ clearSymbol()

CDPL_CHEM_API void CDPL::Chem::clearSymbol ( Atom atom)

Clears the value of the Chem::AtomProperty::SYMBOL property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasSymbol()

CDPL_CHEM_API bool CDPL::Chem::hasSymbol ( const Atom atom)

Tells whether the Chem::AtomProperty::SYMBOL property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getSymbolForType()

CDPL_CHEM_API const std::string& CDPL::Chem::getSymbolForType ( const Atom atom)

Returns the element symbol that corresponds to the Chem::AtomProperty::TYPE property of the atom atom.

Parameters
atomThe atom to query.
Returns
The element symbol mapped from the atom's type (see namespace Chem::AtomType).

◆ getType()

CDPL_CHEM_API unsigned int CDPL::Chem::getType ( const Atom atom)

Returns the value of the Chem::AtomProperty::TYPE property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored atom type (see namespace Chem::AtomType).

◆ setType()

CDPL_CHEM_API void CDPL::Chem::setType ( Atom atom,
unsigned int  type 
)

Sets the value of the Chem::AtomProperty::TYPE property of the atom atom to type.

Parameters
atomThe atom for which to set the property value.
typeThe new atom type (see namespace Chem::AtomType).

◆ clearType()

CDPL_CHEM_API void CDPL::Chem::clearType ( Atom atom)

Clears the value of the Chem::AtomProperty::TYPE property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasType()

CDPL_CHEM_API bool CDPL::Chem::hasType ( const Atom atom)

Tells whether the Chem::AtomProperty::TYPE property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getTypeForSymbol()

CDPL_CHEM_API unsigned int CDPL::Chem::getTypeForSymbol ( const Atom atom)

Returns the atom type that corresponds to the Chem::AtomProperty::SYMBOL property of the atom atom.

Parameters
atomThe atom to query.
Returns
The atom type mapped from the element symbol.

◆ getGenericType()

CDPL_CHEM_API unsigned int CDPL::Chem::getGenericType ( const Atom atom)

Returns the generic atom type that the atom's Chem::AtomProperty::TYPE property value belongs to.

Parameters
atomThe atom to query.
Returns
The generic atom type.

◆ getFormalCharge()

CDPL_CHEM_API long CDPL::Chem::getFormalCharge ( const Atom atom)

Returns the value of the Chem::AtomProperty::FORMAL_CHARGE property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored formal charge.

◆ setFormalCharge()

CDPL_CHEM_API void CDPL::Chem::setFormalCharge ( Atom atom,
long  charge 
)

Sets the value of the Chem::AtomProperty::FORMAL_CHARGE property of the atom atom to charge.

Parameters
atomThe atom for which to set the property value.
chargeThe new formal charge.

◆ clearFormalCharge()

CDPL_CHEM_API void CDPL::Chem::clearFormalCharge ( Atom atom)

Clears the value of the Chem::AtomProperty::FORMAL_CHARGE property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasFormalCharge()

CDPL_CHEM_API bool CDPL::Chem::hasFormalCharge ( const Atom atom)

Tells whether the Chem::AtomProperty::FORMAL_CHARGE property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ calcFormalCharge()

CDPL_CHEM_API long CDPL::Chem::calcFormalCharge ( const Atom atom,
const MolecularGraph molgraph 
)

Computes the formal charge of the atom atom from its valence environment in the molecular graph molgraph.

Parameters
atomThe atom for which to calculate the charge.
molgraphThe molecular graph providing the structural context.
Returns
The computed formal charge.

◆ getIsotope()

CDPL_CHEM_API std::size_t CDPL::Chem::getIsotope ( const Atom atom)

Returns the value of the Chem::AtomProperty::ISOTOPE property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored mass number, or zero for the natural isotope mixture.

◆ setIsotope()

CDPL_CHEM_API void CDPL::Chem::setIsotope ( Atom atom,
std::size_t  isotope 
)

Sets the value of the Chem::AtomProperty::ISOTOPE property of the atom atom to isotope.

Parameters
atomThe atom for which to set the property value.
isotopeThe new mass number (zero for the natural isotope mixture).

◆ clearIsotope()

CDPL_CHEM_API void CDPL::Chem::clearIsotope ( Atom atom)

Clears the value of the Chem::AtomProperty::ISOTOPE property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasIsotope()

CDPL_CHEM_API bool CDPL::Chem::hasIsotope ( const Atom atom)

Tells whether the Chem::AtomProperty::ISOTOPE property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getRadicalType()

CDPL_CHEM_API unsigned int CDPL::Chem::getRadicalType ( const Atom atom)

Returns the value of the Chem::AtomProperty::RADICAL_TYPE property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored radical type (see namespace Chem::RadicalType).

◆ setRadicalType()

CDPL_CHEM_API void CDPL::Chem::setRadicalType ( Atom atom,
unsigned int  type 
)

Sets the value of the Chem::AtomProperty::RADICAL_TYPE property of the atom atom to type.

Parameters
atomThe atom for which to set the property value.
typeThe new radical type (see namespace Chem::RadicalType).

◆ clearRadicalType()

CDPL_CHEM_API void CDPL::Chem::clearRadicalType ( Atom atom)

Clears the value of the Chem::AtomProperty::RADICAL_TYPE property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasRadicalType()

CDPL_CHEM_API bool CDPL::Chem::hasRadicalType ( const Atom atom)

Tells whether the Chem::AtomProperty::RADICAL_TYPE property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getHybridizationState()

CDPL_CHEM_API unsigned int CDPL::Chem::getHybridizationState ( const Atom atom)

Returns the value of the Chem::AtomProperty::HYBRIDIZATION property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored hybridization state (see namespace Chem::HybridizationState).

◆ setHybridizationState()

CDPL_CHEM_API void CDPL::Chem::setHybridizationState ( Atom atom,
unsigned int  state 
)

Sets the value of the Chem::AtomProperty::HYBRIDIZATION property of the atom atom to state.

Parameters
atomThe atom for which to set the property value.
stateThe new hybridization state (see namespace Chem::HybridizationState).

◆ clearHybridizationState()

CDPL_CHEM_API void CDPL::Chem::clearHybridizationState ( Atom atom)

Clears the value of the Chem::AtomProperty::HYBRIDIZATION property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasHybridizationState()

CDPL_CHEM_API bool CDPL::Chem::hasHybridizationState ( const Atom atom)

Tells whether the Chem::AtomProperty::HYBRIDIZATION property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ perceiveHybridizationState()

CDPL_CHEM_API unsigned int CDPL::Chem::perceiveHybridizationState ( const Atom atom,
const MolecularGraph molgraph 
)

Derives the hybridization state of the atom atom from its valence environment in the molecular graph molgraph.

Parameters
atomThe atom for which to perceive the hybridzation state.
molgraphThe molecular graph providing the structural context.
Returns
The perceived hybridization state (see namespace Chem::HybridizationState).

◆ getRingFlag() [1/2]

CDPL_CHEM_API bool CDPL::Chem::getRingFlag ( const Atom atom)

Returns the value of the Chem::AtomProperty::RING_FLAG property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
true if the atom is flagged as part of any ring, and false otherwise.

◆ setRingFlag() [1/2]

CDPL_CHEM_API void CDPL::Chem::setRingFlag ( Atom atom,
bool  in_ring 
)

Sets the value of the Chem::AtomProperty::RING_FLAG property of the atom atom to in_ring.

Parameters
atomThe atom for which to set the property value.
in_ringtrue to flag the atom as part of a ring, and false to flag it as acyclic.

◆ clearRingFlag() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearRingFlag ( Atom atom)

Clears the value of the Chem::AtomProperty::RING_FLAG property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasRingFlag() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasRingFlag ( const Atom atom)

Tells whether the Chem::AtomProperty::RING_FLAG property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ isInFragmentOfSize() [1/2]

CDPL_CHEM_API bool CDPL::Chem::isInFragmentOfSize ( const Atom atom,
const FragmentList frag_list,
std::size_t  size 
)

Tells whether the atom atom is a member of any fragment in frag_list whose size matches size.

Parameters
atomThe atom to query.
frag_listThe list of fragments to search.
sizeThe required fragment size (in number of atoms).
Returns
true if at least one matching fragment contains atom, and false otherwise.

◆ getSizeOfSmallestContainingFragment() [1/2]

CDPL_CHEM_API std::size_t CDPL::Chem::getSizeOfSmallestContainingFragment ( const Atom atom,
const FragmentList frag_list 
)

Returns the size (in atoms) of the smallest fragment in frag_list that contains the atom atom.

Parameters
atomThe atom to query.
frag_listThe list of fragments to search.
Returns
The smallest containing fragment's size, or zero if no fragment contains atom.

◆ getSizeOfLargestContainingFragment() [1/2]

CDPL_CHEM_API std::size_t CDPL::Chem::getSizeOfLargestContainingFragment ( const Atom atom,
const FragmentList frag_list 
)

Returns the size (in atoms) of the largest fragment in frag_list that contains the atom atom.

Parameters
atomThe atom to query.
frag_listThe list of fragments to search.
Returns
The largest containing fragment's size, or zero if no fragment contains atom.

◆ getNumContainingFragments() [1/2]

CDPL_CHEM_API std::size_t CDPL::Chem::getNumContainingFragments ( const Atom atom,
const FragmentList frag_list 
)

Returns the number of fragments in frag_list that contain the atom atom.

Parameters
atomThe atom to query.
frag_listThe list of fragments to search.
Returns
The number of containing fragments.

◆ getContainingFragments() [1/3]

CDPL_CHEM_API void CDPL::Chem::getContainingFragments ( const Atom atom,
const FragmentList frag_list,
FragmentList cont_frag_list,
bool  append = false 
)

Collects the fragments in frag_list that contain the atom atom into cont_frag_list.

Parameters
atomThe atom to query.
frag_listThe list of fragments to search.
cont_frag_listThe output fragment list receiving the matches.
appendIf true, matches are appended to cont_frag_list. Otherwise, it is cleared first.

◆ getAromaticityFlag() [1/2]

CDPL_CHEM_API bool CDPL::Chem::getAromaticityFlag ( const Atom atom)

Returns the value of the Chem::AtomProperty::AROMATICITY_FLAG property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
true if the atom is flagged as aromatic, and false otherwise.

◆ setAromaticityFlag() [1/2]

CDPL_CHEM_API void CDPL::Chem::setAromaticityFlag ( Atom atom,
bool  aromatic 
)

Sets the value of the Chem::AtomProperty::AROMATICITY_FLAG property of the atom atom to aromatic.

Parameters
atomThe atom for which to set the property value.
aromatictrue to flag the atom as aromatic, and false to flag it as non-aromatic.

◆ clearAromaticityFlag() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearAromaticityFlag ( Atom atom)

Clears the value of the Chem::AtomProperty::AROMATICITY_FLAG property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasAromaticityFlag() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasAromaticityFlag ( const Atom atom)

Tells whether the Chem::AtomProperty::AROMATICITY_FLAG property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getUnpairedElectronCount()

CDPL_CHEM_API std::size_t CDPL::Chem::getUnpairedElectronCount ( const Atom atom)

Returns the value of the Chem::AtomProperty::UNPAIRED_ELECTRON_COUNT property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored unpaired electron count.

◆ setUnpairedElectronCount()

CDPL_CHEM_API void CDPL::Chem::setUnpairedElectronCount ( Atom atom,
std::size_t  count 
)

Sets the value of the Chem::AtomProperty::UNPAIRED_ELECTRON_COUNT property of the atom atom to count.

Parameters
atomThe atom for which to set the property value.
countThe new unpaired electron count.

◆ clearUnpairedElectronCount()

CDPL_CHEM_API void CDPL::Chem::clearUnpairedElectronCount ( Atom atom)

Clears the value of the Chem::AtomProperty::UNPAIRED_ELECTRON_COUNT property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasUnpairedElectronCount()

CDPL_CHEM_API bool CDPL::Chem::hasUnpairedElectronCount ( const Atom atom)

Tells whether the Chem::AtomProperty::UNPAIRED_ELECTRON_COUNT property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getImplicitHydrogenCount()

CDPL_CHEM_API std::size_t CDPL::Chem::getImplicitHydrogenCount ( const Atom atom)

Returns the value of the Chem::AtomProperty::IMPLICIT_HYDROGEN_COUNT property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored implicit-hydrogen count.

◆ setImplicitHydrogenCount()

CDPL_CHEM_API void CDPL::Chem::setImplicitHydrogenCount ( Atom atom,
std::size_t  count 
)

Sets the value of the Chem::AtomProperty::IMPLICIT_HYDROGEN_COUNT property of the atom atom to count.

Parameters
atomThe atom for which to set the property value.
countThe new implicit-hydrogen count.

◆ clearImplicitHydrogenCount()

CDPL_CHEM_API void CDPL::Chem::clearImplicitHydrogenCount ( Atom atom)

Clears the value of the Chem::AtomProperty::IMPLICIT_HYDROGEN_COUNT property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasImplicitHydrogenCount()

CDPL_CHEM_API bool CDPL::Chem::hasImplicitHydrogenCount ( const Atom atom)

Tells whether the Chem::AtomProperty::IMPLICIT_HYDROGEN_COUNT property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ calcImplicitHydrogenCount()

CDPL_CHEM_API std::size_t CDPL::Chem::calcImplicitHydrogenCount ( const Atom atom,
const MolecularGraph molgraph 
)

Computes the implicit hydrogen count of the atom atom from its valence environment in the molecular graph molgraph.

Parameters
atomThe atom for which to calculate the hydrogen count.
molgraphThe molecular graph providing the structural context.
Returns
The computed implicit-hydrogen count.

◆ get2DCoordinates() [2/2]

CDPL_CHEM_API const Math::Vector2D& CDPL::Chem::get2DCoordinates ( const Atom atom)

Returns the value of the Chem::AtomProperty::COORDINATES_2D property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored 2D coordinates.

◆ set2DCoordinates() [2/2]

CDPL_CHEM_API void CDPL::Chem::set2DCoordinates ( Atom atom,
const Math::Vector2D coords 
)

Sets the value of the Chem::AtomProperty::COORDINATES_2D property of the atom atom to coords.

Parameters
atomThe atom for which to set the property value.
coordsThe new 2D coordinates.

◆ clear2DCoordinates()

CDPL_CHEM_API void CDPL::Chem::clear2DCoordinates ( Atom atom)

Clears the value of the Chem::AtomProperty::COORDINATES_2D property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ has2DCoordinates()

CDPL_CHEM_API bool CDPL::Chem::has2DCoordinates ( const Atom atom)

Tells whether the Chem::AtomProperty::COORDINATES_2D property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getConformer3DCoordinates()

CDPL_CHEM_API const Math::Vector3D& CDPL::Chem::getConformer3DCoordinates ( const Atom atom,
std::size_t  conf_idx 
)

Returns the 3D coordinates of the atom atom for conformer conf_idx (from the Chem::AtomProperty::COORDINATES_3D_ARRAY property).

Parameters
atomThe atom for which to return the conformer 3D coordinates.
conf_idxThe zero-based conformer index.
Returns
The 3D coordinates of the specified conformer.

◆ get3DCoordinatesArray()

CDPL_CHEM_API const Math::Vector3DArray::SharedPointer& CDPL::Chem::get3DCoordinatesArray ( const Atom atom)

Returns the value of the Chem::AtomProperty::COORDINATES_3D_ARRAY property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored 3D conformer-coordinates array.

◆ set3DCoordinatesArray()

CDPL_CHEM_API void CDPL::Chem::set3DCoordinatesArray ( Atom atom,
const Math::Vector3DArray::SharedPointer &  coords_array 
)

Sets the value of the Chem::AtomProperty::COORDINATES_3D_ARRAY property of the atom atom to coords_array.

Parameters
atomThe atom for which to set the property value.
coords_arrayThe new 3D conformer-coordinates array.

◆ clear3DCoordinatesArray()

CDPL_CHEM_API void CDPL::Chem::clear3DCoordinatesArray ( Atom atom)

Clears the value of the Chem::AtomProperty::COORDINATES_3D_ARRAY property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ has3DCoordinatesArray()

CDPL_CHEM_API bool CDPL::Chem::has3DCoordinatesArray ( const Atom atom)

Tells whether the Chem::AtomProperty::COORDINATES_3D_ARRAY property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMorganNumber()

CDPL_CHEM_API std::size_t CDPL::Chem::getMorganNumber ( const Atom atom)

Returns the value of the Chem::AtomProperty::MORGAN_NUMBER property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored Morgan number.

◆ setMorganNumber()

CDPL_CHEM_API void CDPL::Chem::setMorganNumber ( Atom atom,
std::size_t  num 
)

Sets the value of the Chem::AtomProperty::MORGAN_NUMBER property of the atom atom to num.

Parameters
atomThe atom for which to set the property value.
numThe new Morgan number.

◆ clearMorganNumber()

CDPL_CHEM_API void CDPL::Chem::clearMorganNumber ( Atom atom)

Clears the value of the Chem::AtomProperty::MORGAN_NUMBER property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasMorganNumber()

CDPL_CHEM_API bool CDPL::Chem::hasMorganNumber ( const Atom atom)

Tells whether the Chem::AtomProperty::MORGAN_NUMBER property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getCanonicalNumber()

CDPL_CHEM_API std::size_t CDPL::Chem::getCanonicalNumber ( const Atom atom)

Returns the value of the Chem::AtomProperty::CANONICAL_NUMBER property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored canonical number.

◆ setCanonicalNumber()

CDPL_CHEM_API void CDPL::Chem::setCanonicalNumber ( Atom atom,
std::size_t  num 
)

Sets the value of the Chem::AtomProperty::CANONICAL_NUMBER property of the atom atom to num.

Parameters
atomThe atom for which to set the property value.
numThe new canonical number.

◆ clearCanonicalNumber()

CDPL_CHEM_API void CDPL::Chem::clearCanonicalNumber ( Atom atom)

Clears the value of the Chem::AtomProperty::CANONICAL_NUMBER property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasCanonicalNumber()

CDPL_CHEM_API bool CDPL::Chem::hasCanonicalNumber ( const Atom atom)

Tells whether the Chem::AtomProperty::CANONICAL_NUMBER property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getCIPPriority()

CDPL_CHEM_API std::size_t CDPL::Chem::getCIPPriority ( const Atom atom)

Returns the value of the Chem::AtomProperty::CIP_PRIORITY property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored CIP priority.

◆ setCIPPriority()

CDPL_CHEM_API void CDPL::Chem::setCIPPriority ( Atom atom,
std::size_t  priority 
)

Sets the value of the Chem::AtomProperty::CIP_PRIORITY property of the atom atom to priority.

Parameters
atomThe atom for which to set the property value.
priorityThe new CIP priority.

◆ clearCIPPriority()

CDPL_CHEM_API void CDPL::Chem::clearCIPPriority ( Atom atom)

Clears the value of the Chem::AtomProperty::CIP_PRIORITY property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasCIPPriority()

CDPL_CHEM_API bool CDPL::Chem::hasCIPPriority ( const Atom atom)

Tells whether the Chem::AtomProperty::CIP_PRIORITY property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getSymmetryClass()

CDPL_CHEM_API std::size_t CDPL::Chem::getSymmetryClass ( const Atom atom)

Returns the value of the Chem::AtomProperty::SYMMETRY_CLASS property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored topological-symmetry class ID.

◆ setSymmetryClass()

CDPL_CHEM_API void CDPL::Chem::setSymmetryClass ( Atom atom,
std::size_t  class_id 
)

Sets the value of the Chem::AtomProperty::SYMMETRY_CLASS property of the atom atom to class_id.

Parameters
atomThe atom for which to set the property value.
class_idThe new topological-symmetry class ID.

◆ clearSymmetryClass()

CDPL_CHEM_API void CDPL::Chem::clearSymmetryClass ( Atom atom)

Clears the value of the Chem::AtomProperty::SYMMETRY_CLASS property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasSymmetryClass()

CDPL_CHEM_API bool CDPL::Chem::hasSymmetryClass ( const Atom atom)

Tells whether the Chem::AtomProperty::SYMMETRY_CLASS property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getCIPConfiguration() [1/2]

CDPL_CHEM_API unsigned int CDPL::Chem::getCIPConfiguration ( const Atom atom)

Returns the value of the Chem::AtomProperty::CIP_CONFIGURATION property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored CIP configuration label (see namespace Chem::CIPDescriptor).

◆ setCIPConfiguration() [1/2]

CDPL_CHEM_API void CDPL::Chem::setCIPConfiguration ( Atom atom,
unsigned int  config 
)

Sets the value of the Chem::AtomProperty::CIP_CONFIGURATION property of the atom atom to config.

Parameters
atomThe atom for which to set the property value.
configThe new CIP configuration label (see namespace Chem::CIPDescriptor).

◆ clearCIPConfiguration() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearCIPConfiguration ( Atom atom)

Clears the value of the Chem::AtomProperty::CIP_CONFIGURATION property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasCIPConfiguration() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasCIPConfiguration ( const Atom atom)

Tells whether the Chem::AtomProperty::CIP_CONFIGURATION property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getStereoDescriptor() [1/2]

CDPL_CHEM_API const StereoDescriptor& CDPL::Chem::getStereoDescriptor ( const Atom atom)

Returns the value of the Chem::AtomProperty::STEREO_DESCRIPTOR property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored stereo descriptor.

◆ setStereoDescriptor() [1/2]

CDPL_CHEM_API void CDPL::Chem::setStereoDescriptor ( Atom atom,
const StereoDescriptor descr 
)

Sets the value of the Chem::AtomProperty::STEREO_DESCRIPTOR property of the atom atom to descr.

Parameters
atomThe atom for which to set the property value.
descrThe new stereo descriptor.

◆ clearStereoDescriptor() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearStereoDescriptor ( Atom atom)

Clears the value of the Chem::AtomProperty::STEREO_DESCRIPTOR property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasStereoDescriptor() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasStereoDescriptor ( const Atom atom)

Tells whether the Chem::AtomProperty::STEREO_DESCRIPTOR property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ calcStereoDescriptor() [1/2]

CDPL_CHEM_API StereoDescriptor CDPL::Chem::calcStereoDescriptor ( const Atom atom,
const MolecularGraph molgraph,
std::size_t  dim = 1 
)

Computes the stereo descriptor for the atom atom based on the geometry of the molecular graph molgraph.

Parameters
atomThe atom for which to calculate the stereo descriptor.
molgraphThe molecular graph providing the structural context.
dimThe dimensionality of the atomic coordinates to use (2 or 3).
Returns
The computed stereo descriptor.

◆ calcStereoDescriptorFromMDLParity()

CDPL_CHEM_API StereoDescriptor CDPL::Chem::calcStereoDescriptorFromMDLParity ( const Atom atom,
const MolecularGraph molgraph 
)

Derives the stereo descriptor of the atom atom from its MDL parity in the molecular graph molgraph.

Parameters
atomThe atom for which to calculate the stereo descriptor.
molgraphThe molecular graph providing the structural context.
Returns
The derived stereo descriptor.

◆ calcConfiguration() [1/2]

CDPL_CHEM_API unsigned int CDPL::Chem::calcConfiguration ( const Atom atom,
const MolecularGraph molgraph,
const StereoDescriptor descr,
const Math::Vector3DArray coords 
)

Derives the atom configuration label from the supplied descriptor and 3D coordinates.

Parameters
atomThe atom for which to calculate the configuration.
molgraphThe molecular graph providing the structural context.
descrThe stereo descriptor whose configuration is to be evaluated.
coordsThe 3D atomic coordinates used by the evaluation.
Returns
The derived configuration label (see namespace Chem::AtomConfiguration).

◆ getStereoCenterFlag() [1/2]

CDPL_CHEM_API bool CDPL::Chem::getStereoCenterFlag ( const Atom atom)

Returns the value of the Chem::AtomProperty::STEREO_CENTER_FLAG property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
true if the atom is flagged as a stereo center, and false otherwise.

◆ setStereoCenterFlag() [1/2]

CDPL_CHEM_API void CDPL::Chem::setStereoCenterFlag ( Atom atom,
bool  is_center 
)

Sets the value of the Chem::AtomProperty::STEREO_CENTER_FLAG property of the atom atom to is_center.

Parameters
atomThe atom for which to set the property value.
is_centertrue to flag the atom as a stereo center, and false otherwise.

◆ clearStereoCenterFlag() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearStereoCenterFlag ( Atom atom)

Clears the value of the Chem::AtomProperty::STEREO_CENTER_FLAG property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasStereoCenterFlag() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasStereoCenterFlag ( const Atom atom)

Tells whether the Chem::AtomProperty::STEREO_CENTER_FLAG property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ isStereoCenter() [1/2]

CDPL_CHEM_API bool CDPL::Chem::isStereoCenter ( const Atom atom,
const MolecularGraph molgraph,
bool  check_asym = true,
bool  check_inv_n = true,
bool  check_quart_n = true,
bool  check_plan_n = true,
bool  check_amide_n = true,
bool  check_res_ctrs = true 
)

Tells whether the atom atom qualifies as a stereo center in the context of the molecular graph molgraph.

Parameters
atomThe atom to evaluate.
molgraphThe molecular graph providing the structural context.
check_asymtrue to enforce non-equivalent ligand environments.
check_inv_ntrue to reject inversion-prone nitrogen centers (umbrella inversion).
check_quart_ntrue to accept positively charged quaternary nitrogen centers.
check_plan_ntrue to reject planar nitrogen centers.
check_amide_ntrue to reject amide-nitrogen centers.
check_res_ctrstrue to reject centers participating in resonance.
Returns
true if the atom qualifies as a stereo center under the given conditions, and false otherwise.

◆ getSybylType() [1/2]

CDPL_CHEM_API unsigned int CDPL::Chem::getSybylType ( const Atom atom)

Returns the value of the Chem::AtomProperty::SYBYL_TYPE property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored Sybyl MOL2 atom type (see namespace Chem::SybylAtomType).

◆ setSybylType() [1/2]

CDPL_CHEM_API void CDPL::Chem::setSybylType ( Atom atom,
unsigned int  type 
)

Sets the value of the Chem::AtomProperty::SYBYL_TYPE property of the atom atom to type.

Parameters
atomThe atom for which to set the property value.
typeThe new Sybyl MOL2 atom type (see namespace Chem::SybylAtomType).

◆ clearSybylType() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearSybylType ( Atom atom)

Clears the value of the Chem::AtomProperty::SYBYL_TYPE property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasSybylType() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasSybylType ( const Atom atom)

Tells whether the Chem::AtomProperty::SYBYL_TYPE property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ perceiveSybylType() [1/2]

CDPL_CHEM_API unsigned int CDPL::Chem::perceiveSybylType ( const Atom atom,
const MolecularGraph molgraph 
)

Derives the Sybyl MOL2 atom type of the atom atom from its valence environment in the molecular graph molgraph.

Parameters
atomThe atom for which to perceive the type.
molgraphThe molecular graph providing the structural context.
Returns
The perceived Sybyl MOL2 atom type (see namespace Chem::SybylAtomType).

◆ getMOL2Name()

CDPL_CHEM_API const std::string& CDPL::Chem::getMOL2Name ( const Atom atom)

Returns the value of the Chem::AtomProperty::MOL2_NAME property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored Sybyl MOL2 atom name.

◆ setMOL2Name()

CDPL_CHEM_API void CDPL::Chem::setMOL2Name ( Atom atom,
const std::string &  name 
)

Sets the value of the Chem::AtomProperty::MOL2_NAME property of the atom atom to name.

Parameters
atomThe atom for which to set the property value.
nameThe new Sybyl MOL2 atom name.

◆ clearMOL2Name()

CDPL_CHEM_API void CDPL::Chem::clearMOL2Name ( Atom atom)

Clears the value of the Chem::AtomProperty::MOL2_NAME property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasMOL2Name()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2Name ( const Atom atom)

Tells whether the Chem::AtomProperty::MOL2_NAME property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMOL2Charge()

CDPL_CHEM_API double CDPL::Chem::getMOL2Charge ( const Atom atom)

Returns the value of the Chem::AtomProperty::MOL2_CHARGE property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored Sybyl MOL2 partial charge.

◆ setMOL2Charge()

CDPL_CHEM_API void CDPL::Chem::setMOL2Charge ( Atom atom,
double  charge 
)

Sets the value of the Chem::AtomProperty::MOL2_CHARGE property of the atom atom to charge.

Parameters
atomThe atom for which to set the property value.
chargeThe new Sybyl MOL2 partial charge.

◆ clearMOL2Charge()

CDPL_CHEM_API void CDPL::Chem::clearMOL2Charge ( Atom atom)

Clears the value of the Chem::AtomProperty::MOL2_CHARGE property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasMOL2Charge()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2Charge ( const Atom atom)

Tells whether the Chem::AtomProperty::MOL2_CHARGE property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMOL2SubstructureID()

CDPL_CHEM_API std::size_t CDPL::Chem::getMOL2SubstructureID ( const Atom atom)

Returns the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_ID property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored Sybyl MOL2 substructure ID.

◆ setMOL2SubstructureID()

CDPL_CHEM_API void CDPL::Chem::setMOL2SubstructureID ( Atom atom,
std::size_t  id 
)

Sets the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_ID property of the atom atom to id.

Parameters
atomThe atom for which to set the property value.
idThe new Sybyl MOL2 substructure ID.

◆ clearMOL2SubstructureID()

CDPL_CHEM_API void CDPL::Chem::clearMOL2SubstructureID ( Atom atom)

Clears the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_ID property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasMOL2SubstructureID()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2SubstructureID ( const Atom atom)

Tells whether the Chem::AtomProperty::MOL2_SUBSTRUCTURE_ID property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMOL2SubstructureName()

CDPL_CHEM_API const std::string& CDPL::Chem::getMOL2SubstructureName ( const Atom atom)

Returns the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_NAME property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored Sybyl MOL2 substructure name.

◆ setMOL2SubstructureName()

CDPL_CHEM_API void CDPL::Chem::setMOL2SubstructureName ( Atom atom,
const std::string &  id 
)

Sets the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_NAME property of the atom atom to id.

Parameters
atomThe atom for which to set the property value.
idThe new Sybyl MOL2 substructure name.

◆ clearMOL2SubstructureName()

CDPL_CHEM_API void CDPL::Chem::clearMOL2SubstructureName ( Atom atom)

Clears the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_NAME property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasMOL2SubstructureName()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2SubstructureName ( const Atom atom)

Tells whether the Chem::AtomProperty::MOL2_SUBSTRUCTURE_NAME property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMOL2SubstructureSubtype()

CDPL_CHEM_API const std::string& CDPL::Chem::getMOL2SubstructureSubtype ( const Atom atom)

Returns the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_SUBTYPE property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored Sybyl MOL2 substructure subtype string.

◆ setMOL2SubstructureSubtype()

CDPL_CHEM_API void CDPL::Chem::setMOL2SubstructureSubtype ( Atom atom,
const std::string &  subtype 
)

Sets the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_SUBTYPE property of the atom atom to subtype.

Parameters
atomThe atom for which to set the property value.
subtypeThe new Sybyl MOL2 substructure subtype string.

◆ clearMOL2SubstructureSubtype()

CDPL_CHEM_API void CDPL::Chem::clearMOL2SubstructureSubtype ( Atom atom)

Clears the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_SUBTYPE property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasMOL2SubstructureSubtype()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2SubstructureSubtype ( const Atom atom)

Tells whether the Chem::AtomProperty::MOL2_SUBSTRUCTURE_SUBTYPE property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMOL2SubstructureChain()

CDPL_CHEM_API const std::string& CDPL::Chem::getMOL2SubstructureChain ( const Atom atom)

Returns the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_CHAIN property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored Sybyl MOL2 substructure chain identifier.

◆ setMOL2SubstructureChain()

CDPL_CHEM_API void CDPL::Chem::setMOL2SubstructureChain ( Atom atom,
const std::string &  chain 
)

Sets the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_CHAIN property of the atom atom to chain.

Parameters
atomThe atom for which to set the property value.
chainThe new Sybyl MOL2 substructure chain identifier.

◆ clearMOL2SubstructureChain()

CDPL_CHEM_API void CDPL::Chem::clearMOL2SubstructureChain ( Atom atom)

Clears the value of the Chem::AtomProperty::MOL2_SUBSTRUCTURE_CHAIN property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasMOL2SubstructureChain()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2SubstructureChain ( const Atom atom)

Tells whether the Chem::AtomProperty::MOL2_SUBSTRUCTURE_CHAIN property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLParity()

CDPL_CHEM_API unsigned int CDPL::Chem::getMDLParity ( const Atom atom)

Returns the value of the Chem::AtomProperty::MDL_PARITY property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored MDL stereo parity (see namespace Chem::MDLParity).

◆ setMDLParity()

CDPL_CHEM_API void CDPL::Chem::setMDLParity ( Atom atom,
unsigned int  parity 
)

Sets the value of the Chem::AtomProperty::MDL_PARITY property of the atom atom to parity.

Parameters
atomThe atom for which to set the property value.
parityThe new MDL stereo parity (see namespace Chem::MDLParity).

◆ clearMDLParity()

CDPL_CHEM_API void CDPL::Chem::clearMDLParity ( Atom atom)

Clears the value of the Chem::AtomProperty::MDL_PARITY property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasMDLParity()

CDPL_CHEM_API bool CDPL::Chem::hasMDLParity ( const Atom atom)

Tells whether the Chem::AtomProperty::MDL_PARITY property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ calcMDLParity()

CDPL_CHEM_API unsigned int CDPL::Chem::calcMDLParity ( const Atom atom,
const MolecularGraph molgraph 
)

Computes the MDL parity of the atom atom from its 2D layout and stereo flags in the molecular graph molgraph.

Parameters
atomThe atom for which to calculate the parity.
molgraphThe molecular graph providing the structural context.
Returns
The computed MDL parity (see namespace Chem::MDLParity).

◆ getMDLStereoCareFlag()

CDPL_CHEM_API bool CDPL::Chem::getMDLStereoCareFlag ( const Atom atom)

Returns the value of the Chem::AtomProperty::MDL_DB_STEREO_CARE_FLAG property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored MDL stereo-care flag.

◆ setMDLStereoCareFlag()

CDPL_CHEM_API void CDPL::Chem::setMDLStereoCareFlag ( Atom atom,
bool  flag 
)

Sets the value of the Chem::AtomProperty::MDL_DB_STEREO_CARE_FLAG property of the atom atom to flag.

Parameters
atomThe atom for which to set the property value.
flagThe new MDL stereo-care flag.

◆ clearMDLStereoCareFlag()

CDPL_CHEM_API void CDPL::Chem::clearMDLStereoCareFlag ( Atom atom)

Clears the value of the Chem::AtomProperty::MDL_DB_STEREO_CARE_FLAG property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasMDLStereoCareFlag()

CDPL_CHEM_API bool CDPL::Chem::hasMDLStereoCareFlag ( const Atom atom)

Tells whether the Chem::AtomProperty::MDL_DB_STEREO_CARE_FLAG property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getReactionCenterStatus() [1/2]

CDPL_CHEM_API unsigned int CDPL::Chem::getReactionCenterStatus ( const Atom atom)

Returns the value of the Chem::AtomProperty::REACTION_CENTER_STATUS property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored reaction-center status (see namespace Chem::ReactionCenterStatus).

◆ setReactionCenterStatus() [1/2]

CDPL_CHEM_API void CDPL::Chem::setReactionCenterStatus ( Atom atom,
unsigned int  status 
)

Sets the value of the Chem::AtomProperty::REACTION_CENTER_STATUS property of the atom atom to status.

Parameters
atomThe atom for which to set the property value.
statusThe new reaction-center status (see namespace Chem::ReactionCenterStatus).

◆ clearReactionCenterStatus() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearReactionCenterStatus ( Atom atom)

Clears the value of the Chem::AtomProperty::REACTION_CENTER_STATUS property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasReactionCenterStatus() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasReactionCenterStatus ( const Atom atom)

Tells whether the Chem::AtomProperty::REACTION_CENTER_STATUS property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getAtomMappingID()

CDPL_CHEM_API std::size_t CDPL::Chem::getAtomMappingID ( const Atom atom)

Returns the value of the Chem::AtomProperty::ATOM_MAPPING_ID property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored reactant-to-product atom mapping ID.

◆ setAtomMappingID()

CDPL_CHEM_API void CDPL::Chem::setAtomMappingID ( Atom atom,
std::size_t  id 
)

Sets the value of the Chem::AtomProperty::ATOM_MAPPING_ID property of the atom atom to id.

Parameters
atomThe atom for which to set the property value.
idThe new reactant-to-product atom mapping ID.

◆ clearAtomMappingID()

CDPL_CHEM_API void CDPL::Chem::clearAtomMappingID ( Atom atom)

Clears the value of the Chem::AtomProperty::ATOM_MAPPING_ID property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasAtomMappingID()

CDPL_CHEM_API bool CDPL::Chem::hasAtomMappingID ( const Atom atom)

Tells whether the Chem::AtomProperty::ATOM_MAPPING_ID property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getComponentGroupID()

CDPL_CHEM_API std::size_t CDPL::Chem::getComponentGroupID ( const Atom atom)

Returns the value of the Chem::AtomProperty::COMPONENT_GROUP_ID property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored component-group ID.

◆ setComponentGroupID()

CDPL_CHEM_API void CDPL::Chem::setComponentGroupID ( Atom atom,
std::size_t  id 
)

Sets the value of the Chem::AtomProperty::COMPONENT_GROUP_ID property of the atom atom to id.

Parameters
atomThe atom for which to set the property value.
idThe new component-group ID.

◆ clearComponentGroupID()

CDPL_CHEM_API void CDPL::Chem::clearComponentGroupID ( Atom atom)

Clears the value of the Chem::AtomProperty::COMPONENT_GROUP_ID property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasComponentGroupID()

CDPL_CHEM_API bool CDPL::Chem::hasComponentGroupID ( const Atom atom)

Tells whether the Chem::AtomProperty::COMPONENT_GROUP_ID property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMatchConstraints() [1/4]

CDPL_CHEM_API const MatchConstraintList::SharedPointer& CDPL::Chem::getMatchConstraints ( const Atom atom)

Returns the value of the Chem::AtomProperty::MATCH_CONSTRAINTS property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored match constraint list.

◆ setMatchConstraints() [1/4]

CDPL_CHEM_API void CDPL::Chem::setMatchConstraints ( Atom atom,
const MatchConstraintList::SharedPointer constr 
)

Sets the value of the Chem::AtomProperty::MATCH_CONSTRAINTS property of the atom atom to constr.

Parameters
atomThe atom for which to set the property value.
constrThe new match constraint list.

◆ clearMatchConstraints() [1/4]

CDPL_CHEM_API void CDPL::Chem::clearMatchConstraints ( Atom atom)

Clears the value of the Chem::AtomProperty::MATCH_CONSTRAINTS property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasMatchConstraints() [1/4]

CDPL_CHEM_API bool CDPL::Chem::hasMatchConstraints ( const Atom atom)

Tells whether the Chem::AtomProperty::MATCH_CONSTRAINTS property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMatchExpression() [1/4]

CDPL_CHEM_API const MatchExpression<Atom, MolecularGraph>::SharedPointer& CDPL::Chem::getMatchExpression ( const Atom atom)

Returns the value of the Chem::AtomProperty::MATCH_EXPRESSION property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored atom-level match expression.

◆ setMatchExpression() [1/4]

CDPL_CHEM_API void CDPL::Chem::setMatchExpression ( Atom atom,
const MatchExpression< Atom, MolecularGraph >::SharedPointer &  expr 
)

Sets the value of the Chem::AtomProperty::MATCH_EXPRESSION property of the atom atom to expr.

Parameters
atomThe atom for which to set the property value.
exprThe new atom-level match expression.

◆ clearMatchExpression() [1/4]

CDPL_CHEM_API void CDPL::Chem::clearMatchExpression ( Atom atom)

Clears the value of the Chem::AtomProperty::MATCH_EXPRESSION property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasMatchExpression() [1/4]

CDPL_CHEM_API bool CDPL::Chem::hasMatchExpression ( const Atom atom)

Tells whether the Chem::AtomProperty::MATCH_EXPRESSION property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ generateMatchExpression() [1/6]

CDPL_CHEM_API MatchExpression<Atom, MolecularGraph>::SharedPointer CDPL::Chem::generateMatchExpression ( const Atom atom,
const MolecularGraph molgraph 
)

Builds an atom-level match expression from the match constraint list attached to the atom atom.

Parameters
atomThe atom for which to generate the expression.
molgraphThe molecular graph providing the structural context.
Returns
The generated match expression.

◆ getMatchExpressionString() [1/2]

CDPL_CHEM_API const std::string& CDPL::Chem::getMatchExpressionString ( const Atom atom)

Returns the value of the Chem::AtomProperty::MATCH_EXPRESSION_STRING property of the atom atom.

Parameters
atomThe atom for which to return the property value.
Returns
The stored match expression string.

◆ setMatchExpressionString() [1/2]

CDPL_CHEM_API void CDPL::Chem::setMatchExpressionString ( Atom atom,
const std::string &  expr_str 
)

Sets the value of the Chem::AtomProperty::MATCH_EXPRESSION_STRING property of the atom atom to expr_str.

Parameters
atomThe atom for which to set the property value.
expr_strThe new match expression string.

◆ clearMatchExpressionString() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearMatchExpressionString ( Atom atom)

Clears the value of the Chem::AtomProperty::MATCH_EXPRESSION_STRING property of the atom atom.

Parameters
atomThe atom for which to clear the property value.

◆ hasMatchExpressionString() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasMatchExpressionString ( const Atom atom)

Tells whether the Chem::AtomProperty::MATCH_EXPRESSION_STRING property of the atom atom is set.

Parameters
atomThe atom for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ generateMatchExpressionString() [1/2]

CDPL_CHEM_API void CDPL::Chem::generateMatchExpressionString ( const Atom atom,
const MolecularGraph molgraph,
std::string &  expr_str 
)

Writes a textual representation of the atom-level match expression of the atom atom into expr_str.

Parameters
atomThe atom for which to generate the expression string.
molgraphThe molecular graph providing the structural context.
expr_strThe output string receiving the match expression text.

◆ markReachableAtoms()

CDPL_CHEM_API void CDPL::Chem::markReachableAtoms ( const Atom atom,
const MolecularGraph molgraph,
Util::BitSet atom_mask,
bool  reset = true 
)

Sets bits in atom_mask for every atom of the molecular graph molgraph that is reachable from the atom atom through the bonds of molgraph.

Parameters
atomThe seed atom.
molgraphThe molecular graph providing the bonding context.
atom_maskThe output bit mask.
resetIf true, atom_mask is cleared first. Otherwise, existing bits are preserved.

◆ getTopologicalDistance()

CDPL_CHEM_API std::size_t CDPL::Chem::getTopologicalDistance ( const Atom atom1,
const Atom atom2,
const MolecularGraph molgraph 
)

Returns the topological distance between two atoms of the molecular graph molgraph.

Parameters
atom1The first atom.
atom2The second atom.
molgraphThe molecular graph providing the bonding context.
Returns
The topological distance between atom1 and atom2.

◆ getEnvironment()

CDPL_CHEM_API std::size_t CDPL::Chem::getEnvironment ( const Atom atom,
const MolecularGraph molgraph,
std::size_t  max_dist,
Fragment env,
bool  append = false 
)

Collects every atom of the molecular graph molgraph that is within max_dist bonds of the atom atom into the fragment env.

Parameters
atomThe seed atom.
molgraphThe molecular graph providing the bonding context.
max_distThe maximum topological distance.
envThe output fragment receiving the environment atoms and the bonds between them.
appendIf true, atoms/bonds are appended to env. Otherwise, it is cleared first.
Returns
The number of atoms appended to env.

◆ getConnectedAtoms()

template<typename AtomType , typename OutputIterator >
std::size_t CDPL::Chem::getConnectedAtoms ( AtomType &  atom,
const MolecularGraph molgraph,
OutputIterator  it,
AtomType *  excl_atom = 0 
)

Writes every neighbor of the atom atom (with bonds belonging to the molecular graph molgraph) into it, skipping excl_atom.

Template Parameters
AtomTypeThe atom type (Atom or const Atom).
OutputIteratorThe output iterator type receiving pointers to the neighbor atoms.
Parameters
atomThe atom whose neighbors are to be enumerated.
molgraphThe molecular graph used to filter the atom/bond membership.
itThe output iterator receiving the neighbor pointers.
excl_atomIf non-null, a neighbor matching this pointer is skipped.
Returns
The number of neighbors written to it.

◆ getIncidentBonds()

template<typename AtomType , typename OutputIterator >
std::size_t CDPL::Chem::getIncidentBonds ( AtomType &  atom,
const MolecularGraph molgraph,
OutputIterator  it,
AtomType *  excl_atom = 0 
)

Writes every bond incident to the atom atom (with both endpoints belonging to the molecular graph molgraph) into it, skipping bonds to excl_atom.

Template Parameters
AtomTypeThe atom type (Atom or const Atom).
OutputIteratorThe output iterator type receiving pointers to the incident bonds.
Parameters
atomThe atom whose incident bonds are to be enumerated.
molgraphThe molecular graph used to filter the atom/bond membership.
itThe output iterator receiving the bond pointers.
excl_atomIf non-null, bonds whose neighbor matches this pointer are skipped.
Returns
The number of bonds written to it.

◆ getConnectedAtomsAndBonds()

template<typename AtomType , typename AtomOutputIterator , typename BondOutputIterator >
std::size_t CDPL::Chem::getConnectedAtomsAndBonds ( AtomType &  atom,
const MolecularGraph molgraph,
AtomOutputIterator  ao_it,
BondOutputIterator  bo_it,
AtomType *  excl_atom = 0 
)

Writes every neighbor of the atom atom and the corresponding incident bond (both filtered by the molecular graph molgraph) into the supplied output iterators.

Template Parameters
AtomTypeThe atom type (Atom or const Atom).
AtomOutputIteratorThe output iterator type receiving neighbor-atom pointers.
BondOutputIteratorThe output iterator type receiving incident-bond pointers.
Parameters
atomThe atom whose neighborhood is to be enumerated.
molgraphThe molecular graph used to filter the atom/bond membership.
ao_itThe output iterator receiving the neighbor-atom pointers.
bo_itThe output iterator receiving the corresponding incident-bond pointers.
excl_atomIf non-null, a neighbor matching this pointer (and its bond) is skipped.
Returns
The number of atom/bond pairs written to the iterators.

◆ getOrder()

CDPL_CHEM_API std::size_t CDPL::Chem::getOrder ( const Bond bond)

Returns the value of the Chem::BondProperty::ORDER property of the bond bond.

Parameters
bondThe bond for which to return the property value.
Returns
The stored bond order.

◆ setOrder()

CDPL_CHEM_API void CDPL::Chem::setOrder ( Bond bond,
std::size_t  order 
)

Sets the value of the Chem::BondProperty::ORDER property of the bond bond to order.

Parameters
bondThe bond for which to set the property value.
orderThe new bond order.

◆ clearOrder()

CDPL_CHEM_API void CDPL::Chem::clearOrder ( Bond bond)

Clears the value of the Chem::BondProperty::ORDER property of the bond bond.

Parameters
bondThe bond for which to clear the property value.

◆ hasOrder()

CDPL_CHEM_API bool CDPL::Chem::hasOrder ( const Bond bond)

Tells whether the Chem::BondProperty::ORDER property of the bond bond is set.

Parameters
bondThe bond for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getRingFlag() [2/2]

CDPL_CHEM_API bool CDPL::Chem::getRingFlag ( const Bond bond)

Returns the value of the Chem::BondProperty::RING_FLAG property of the bond bond.

Parameters
bondThe bond for which to return the property value.
Returns
true if the bond is flagged as part of any ring, and false otherwise.

◆ setRingFlag() [2/2]

CDPL_CHEM_API void CDPL::Chem::setRingFlag ( Bond bond,
bool  in_ring 
)

Sets the value of the Chem::BondProperty::RING_FLAG property of the bond bond to in_ring.

Parameters
bondThe bond for which to set the property value.
in_ringtrue to flag the bond as part of a ring, and false to flag it as acyclic.

◆ clearRingFlag() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearRingFlag ( Bond bond)

Clears the value of the Chem::BondProperty::RING_FLAG property of the bond bond.

Parameters
bondThe bond for which to clear the property value.

◆ hasRingFlag() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasRingFlag ( const Bond bond)

Tells whether the Chem::BondProperty::RING_FLAG property of the bond bond is set.

Parameters
bondThe bond for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ isInFragmentOfSize() [2/2]

CDPL_CHEM_API bool CDPL::Chem::isInFragmentOfSize ( const Bond bond,
const FragmentList frag_list,
std::size_t  size 
)

Tells whether the bond bond is a member of any fragment in frag_list whose size matches size.

Parameters
bondThe bond to query.
frag_listThe list of fragments to search.
sizeThe required fragment size (in number of atoms).
Returns
true if at least one matching fragment contains the bond bond, and false otherwise.

◆ getSizeOfSmallestContainingFragment() [2/2]

CDPL_CHEM_API std::size_t CDPL::Chem::getSizeOfSmallestContainingFragment ( const Bond bond,
const FragmentList frag_list 
)

Returns the size (in atoms) of the smallest fragment in frag_list that contains the bond bond.

Parameters
bondThe bond to query.
frag_listThe list of fragments to search.
Returns
The smallest containing fragment's size, or zero if no fragment contains the bond bond.

◆ getSizeOfLargestContainingFragment() [2/2]

CDPL_CHEM_API std::size_t CDPL::Chem::getSizeOfLargestContainingFragment ( const Bond bond,
const FragmentList frag_list 
)

Returns the size (in atoms) of the largest fragment in frag_list that contains the bond bond.

Parameters
bondThe bond to query.
frag_listThe list of fragments to search.
Returns
The largest containing fragment's size, or zero if no fragment contains the bond bond.

◆ getNumContainingFragments() [2/2]

CDPL_CHEM_API std::size_t CDPL::Chem::getNumContainingFragments ( const Bond bond,
const FragmentList frag_list 
)

Returns the number of fragments in frag_list that contain the bond bond.

Parameters
bondThe bond to query.
frag_listThe list of fragments to search.
Returns
The number of containing fragments.

◆ getContainingFragments() [2/3]

CDPL_CHEM_API void CDPL::Chem::getContainingFragments ( const Bond bond,
const FragmentList frag_list,
FragmentList cont_frag_list,
bool  append = false 
)

Collects the fragments in frag_list that contain the bond bond into cont_frag_list.

Parameters
bondThe bond to query.
frag_listThe list of fragments to search.
cont_frag_listThe output fragment list receiving the matches.
appendIf true, matches are appended to cont_frag_list. Otherwise, it is cleared first.

◆ getAromaticityFlag() [2/2]

CDPL_CHEM_API bool CDPL::Chem::getAromaticityFlag ( const Bond bond)

Returns the value of the Chem::BondProperty::AROMATICITY_FLAG property of the bond bond.

Parameters
bondThe bond for which to return the property value.
Returns
true if the bond is flagged as aromatic, and false otherwise.

◆ setAromaticityFlag() [2/2]

CDPL_CHEM_API void CDPL::Chem::setAromaticityFlag ( Bond bond,
bool  aromatic 
)

Sets the value of the Chem::BondProperty::AROMATICITY_FLAG property of the bond bond to aromatic.

Parameters
bondThe bond for which to set the property value.
aromatictrue to flag the bond as aromatic, and false to flag it as non-aromatic.

◆ clearAromaticityFlag() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearAromaticityFlag ( Bond bond)

Clears the value of the Chem::BondProperty::AROMATICITY_FLAG property of the bond bond.

Parameters
bondThe bond for which to clear the property value.

◆ hasAromaticityFlag() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasAromaticityFlag ( const Bond bond)

Tells whether the Chem::BondProperty::AROMATICITY_FLAG property of the bond bond is set.

Parameters
bondThe bond for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ get2DStereoFlag()

CDPL_CHEM_API unsigned int CDPL::Chem::get2DStereoFlag ( const Bond bond)

Returns the value of the Chem::BondProperty::STEREO_2D_FLAG property of the bond bond.

Parameters
bondThe bond for which to return the property value.
Returns
The stored 2D stereo flag (see namespace Chem::BondStereoFlag).

◆ set2DStereoFlag()

CDPL_CHEM_API void CDPL::Chem::set2DStereoFlag ( Bond bond,
unsigned int  flag 
)

Sets the value of the Chem::BondProperty::STEREO_2D_FLAG property of the bond bond to flag.

Parameters
bondThe bond for which to set the property value.
flagThe new 2D stereo flag value (see namespace Chem::BondStereoFlag).

◆ clear2DStereoFlag()

CDPL_CHEM_API void CDPL::Chem::clear2DStereoFlag ( Bond bond)

Clears the value of the Chem::BondProperty::STEREO_2D_FLAG property of the bond bond.

Parameters
bondThe bond for which to clear the property value.

◆ has2DStereoFlag()

CDPL_CHEM_API bool CDPL::Chem::has2DStereoFlag ( const Bond bond)

Tells whether the Chem::BondProperty::STEREO_2D_FLAG property of the bond bond is set.

Parameters
bondThe bond for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getCIPConfiguration() [2/2]

CDPL_CHEM_API unsigned int CDPL::Chem::getCIPConfiguration ( const Bond bond)

Returns the value of the Chem::BondProperty::CIP_CONFIGURATION property of the bond bond.

Parameters
bondThe bond for which to return the property value.
Returns
The stored CIP configuration label (see namespace Chem::CIPDescriptor).

◆ setCIPConfiguration() [2/2]

CDPL_CHEM_API void CDPL::Chem::setCIPConfiguration ( Bond bond,
unsigned int  config 
)

Sets the value of the Chem::BondProperty::CIP_CONFIGURATION property of the bond bond to config.

Parameters
bondThe bond for which to set the property value.
configThe new CIP configuration label (see namespace Chem::CIPDescriptor).

◆ clearCIPConfiguration() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearCIPConfiguration ( Bond bond)

Clears the value of the Chem::BondProperty::CIP_CONFIGURATION property of the bond bond.

Parameters
bondThe bond for which to clear the property value.

◆ hasCIPConfiguration() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasCIPConfiguration ( const Bond bond)

Tells whether the Chem::BondProperty::CIP_CONFIGURATION property of the bond bond is set.

Parameters
bondThe bond for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getStereoDescriptor() [2/2]

CDPL_CHEM_API const StereoDescriptor& CDPL::Chem::getStereoDescriptor ( const Bond bond)

Returns the value of the Chem::BondProperty::STEREO_DESCRIPTOR property of the bond bond.

Parameters
bondThe bond for which to return the property value.
Returns
The stored stereo descriptor.

◆ setStereoDescriptor() [2/2]

CDPL_CHEM_API void CDPL::Chem::setStereoDescriptor ( Bond bond,
const StereoDescriptor descr 
)

Sets the value of the Chem::BondProperty::STEREO_DESCRIPTOR property of the bond bond to descr.

Parameters
bondThe bond for which to set the property value.
descrThe new stereo descriptor.

◆ clearStereoDescriptor() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearStereoDescriptor ( Bond bond)

Clears the value of the Chem::BondProperty::STEREO_DESCRIPTOR property of the bond bond.

Parameters
bondThe bond for which to clear the property value.

◆ hasStereoDescriptor() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasStereoDescriptor ( const Bond bond)

Tells whether the Chem::BondProperty::STEREO_DESCRIPTOR property of the bond bond is set.

Parameters
bondThe bond for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ calcStereoDescriptor() [2/2]

CDPL_CHEM_API StereoDescriptor CDPL::Chem::calcStereoDescriptor ( const Bond bond,
const MolecularGraph molgraph,
std::size_t  dim = 1 
)

Computes the stereo descriptor for the bond bond based on the geometry of the molecular graph molgraph.

Parameters
bondThe bond to inspect.
molgraphThe molecular graph providing the structural context.
dimThe dimensionality of the atomic coordinates to use (2 or 3).
Returns
The computed stereo descriptor.

◆ calcConfiguration() [2/2]

CDPL_CHEM_API unsigned int CDPL::Chem::calcConfiguration ( const Bond bond,
const MolecularGraph molgraph,
const StereoDescriptor descr,
const Math::Vector3DArray coords 
)

Derives the bond configuration label from the supplied descriptor and 3D coordinates.

Parameters
bondThe bond to inspect.
molgraphThe molecular graph providing the structural context.
descrThe stereo descriptor whose configuration is to be evaluated.
coordsThe 3D atomic coordinates used by the evaluation.
Returns
The derived configuration label (see namespace Chem::BondConfiguration).

◆ getStereoCenterFlag() [2/2]

CDPL_CHEM_API bool CDPL::Chem::getStereoCenterFlag ( const Bond bond)

Returns the value of the Chem::BondProperty::STEREO_CENTER_FLAG property of the bond bond.

Parameters
bondThe bond for which to return the property value.
Returns
true if the bond is flagged as a stereo center, and false otherwise.

◆ setStereoCenterFlag() [2/2]

CDPL_CHEM_API void CDPL::Chem::setStereoCenterFlag ( Bond bond,
bool  is_center 
)

Sets the value of the Chem::BondProperty::STEREO_CENTER_FLAG property of the bond bond to is_center.

Parameters
bondThe bond for which to set the property value.
is_centertrue to flag the bond as a stereo center, and false otherwise.

◆ clearStereoCenterFlag() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearStereoCenterFlag ( Bond bond)

Clears the value of the Chem::BondProperty::STEREO_CENTER_FLAG property of the bond bond.

Parameters
bondThe bond for which to clear the property value.

◆ hasStereoCenterFlag() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasStereoCenterFlag ( const Bond bond)

Tells whether the Chem::BondProperty::STEREO_CENTER_FLAG property of the bond bond is set.

Parameters
bondThe bond for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ isStereoCenter() [2/2]

CDPL_CHEM_API bool CDPL::Chem::isStereoCenter ( const Bond bond,
const MolecularGraph molgraph,
bool  check_asym = true,
bool  check_term_n = true,
bool  check_order = true,
std::size_t  min_ring_size = 8 
)

Tells whether the bond bond qualifies as a stereo center in the context of the molecular graph molgraph.

Parameters
bondThe bond to inspect.
molgraphThe molecular graph providing the structural context.
check_asymtrue to enforce non-equivalent ligand environments.
check_term_ntrue to reject bonds to terminal nitrogen atoms.
check_ordertrue to require that the bond order matches a stereogenic pattern.
min_ring_sizeIf the bond bond is a ring bond, the containing ring must have at least this size to qualify.
Returns
true if the bond qualifies as a stereo center under the given conditions, and false otherwise.

◆ getDirection()

CDPL_CHEM_API unsigned int CDPL::Chem::getDirection ( const Bond bond)

Returns the value of the Chem::BondProperty::DIRECTION property of the bond bond.

Parameters
bondThe bond for which to return the property value.
Returns
The stored SMILES/SMARTS bond direction descriptor (see namespace Chem::BondDirection).

◆ setDirection()

CDPL_CHEM_API void CDPL::Chem::setDirection ( Bond bond,
unsigned int  dir 
)

Sets the value of the Chem::BondProperty::DIRECTION property of the bond bond to dir.

Parameters
bondThe bond for which to set the property value.
dirThe new bond direction descriptor (see namespace Chem::BondDirection).

◆ clearDirection()

CDPL_CHEM_API void CDPL::Chem::clearDirection ( Bond bond)

Clears the value of the Chem::BondProperty::DIRECTION property of the bond bond.

Parameters
bondThe bond for which to clear the property value.

◆ hasDirection()

CDPL_CHEM_API bool CDPL::Chem::hasDirection ( const Bond bond)

Tells whether the Chem::BondProperty::DIRECTION property of the bond bond is set.

Parameters
bondThe bond for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getReactionCenterStatus() [2/2]

CDPL_CHEM_API unsigned int CDPL::Chem::getReactionCenterStatus ( const Bond bond)

Returns the value of the Chem::BondProperty::REACTION_CENTER_STATUS property of the bond bond.

Parameters
bondThe bond for which to return the property value.
Returns
The stored reaction-center status (see namespace Chem::ReactionCenterStatus).

◆ setReactionCenterStatus() [2/2]

CDPL_CHEM_API void CDPL::Chem::setReactionCenterStatus ( Bond bond,
unsigned int  status 
)

Sets the value of the Chem::BondProperty::REACTION_CENTER_STATUS property of the bond bond to status.

Parameters
bondThe bond for which to set the property value.
statusThe new reaction-center status (see namespace Chem::ReactionCenterStatus).

◆ clearReactionCenterStatus() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearReactionCenterStatus ( Bond bond)

Clears the value of the Chem::BondProperty::REACTION_CENTER_STATUS property of the bond bond.

Parameters
bondThe bond for which to clear the property value.

◆ hasReactionCenterStatus() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasReactionCenterStatus ( const Bond bond)

Tells whether the Chem::BondProperty::REACTION_CENTER_STATUS property of the bond bond is set.

Parameters
bondThe bond for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMatchConstraints() [2/4]

CDPL_CHEM_API const MatchConstraintList::SharedPointer& CDPL::Chem::getMatchConstraints ( const Bond bond)

Returns the value of the Chem::BondProperty::MATCH_CONSTRAINTS property of the bond bond.

Parameters
bondThe bond for which to return the property value.
Returns
The stored match constraint list.

◆ setMatchConstraints() [2/4]

CDPL_CHEM_API void CDPL::Chem::setMatchConstraints ( Bond bond,
const MatchConstraintList::SharedPointer constr 
)

Sets the value of the Chem::BondProperty::MATCH_CONSTRAINTS property of the bond bond to constr.

Parameters
bondThe bond for which to set the property value.
constrThe new match constraint list.

◆ clearMatchConstraints() [2/4]

CDPL_CHEM_API void CDPL::Chem::clearMatchConstraints ( Bond bond)

Clears the value of the Chem::BondProperty::MATCH_CONSTRAINTS property of the bond bond.

Parameters
bondThe bond for which to clear the property value.

◆ hasMatchConstraints() [2/4]

CDPL_CHEM_API bool CDPL::Chem::hasMatchConstraints ( const Bond bond)

Tells whether the Chem::BondProperty::MATCH_CONSTRAINTS property of the bond bond is set.

Parameters
bondThe bond for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMatchExpression() [2/4]

CDPL_CHEM_API const MatchExpression<Bond, MolecularGraph>::SharedPointer& CDPL::Chem::getMatchExpression ( const Bond bond)

Returns the value of the Chem::BondProperty::MATCH_EXPRESSION property of the bond bond.

Parameters
bondThe bond for which to return the property value.
Returns
The stored bond-level match expression.

◆ setMatchExpression() [2/4]

CDPL_CHEM_API void CDPL::Chem::setMatchExpression ( Bond bond,
const MatchExpression< Bond, MolecularGraph >::SharedPointer &  expr 
)

Sets the value of the Chem::BondProperty::MATCH_EXPRESSION property of the bond bond to expr.

Parameters
bondThe bond for which to set the property value.
exprThe new bond-level match expression.

◆ clearMatchExpression() [2/4]

CDPL_CHEM_API void CDPL::Chem::clearMatchExpression ( Bond bond)

Clears the value of the Chem::BondProperty::MATCH_EXPRESSION property of the bond bond.

Parameters
bondThe bond for which to clear the property value.

◆ hasMatchExpression() [2/4]

CDPL_CHEM_API bool CDPL::Chem::hasMatchExpression ( const Bond bond)

Tells whether the Chem::BondProperty::MATCH_EXPRESSION property of the bond bond is set.

Parameters
bondThe bond for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ generateMatchExpression() [2/6]

CDPL_CHEM_API MatchExpression<Bond, MolecularGraph>::SharedPointer CDPL::Chem::generateMatchExpression ( const Bond bond,
const MolecularGraph molgraph 
)

Builds a bond-level match expression from the match constraint list attached to the bond bond.

Parameters
bondThe bond to inspect.
molgraphThe molecular graph providing the structural context.
Returns
The generated match expression.

◆ getMatchExpressionString() [2/2]

CDPL_CHEM_API const std::string& CDPL::Chem::getMatchExpressionString ( const Bond bond)

Returns the value of the Chem::BondProperty::MATCH_EXPRESSION_STRING property of the bond bond.

Parameters
bondThe bond for which to return the property value.
Returns
The stored match expression string.

◆ setMatchExpressionString() [2/2]

CDPL_CHEM_API void CDPL::Chem::setMatchExpressionString ( Bond bond,
const std::string &  expr_str 
)

Sets the value of the Chem::BondProperty::MATCH_EXPRESSION_STRING property of the bond bond to expr_str.

Parameters
bondThe bond for which to set the property value.
expr_strThe new match expression string.

◆ clearMatchExpressionString() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearMatchExpressionString ( Bond bond)

Clears the value of the Chem::BondProperty::MATCH_EXPRESSION_STRING property of the bond bond.

Parameters
bondThe bond for which to clear the property value.

◆ hasMatchExpressionString() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasMatchExpressionString ( const Bond bond)

Tells whether the Chem::BondProperty::MATCH_EXPRESSION_STRING property of the bond bond is set.

Parameters
bondThe bond for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ generateMatchExpressionString() [2/2]

CDPL_CHEM_API void CDPL::Chem::generateMatchExpressionString ( const Bond bond,
const MolecularGraph molgraph,
std::string &  str 
)

Writes a textual representation of the bond-level match expression of the bond bond into str.

Parameters
bondThe bond to inspect.
molgraphThe molecular graph providing the structural context.
strThe output string receiving the match expression text.

◆ getSybylType() [2/2]

CDPL_CHEM_API unsigned int CDPL::Chem::getSybylType ( const Bond bond)

Returns the value of the Chem::BondProperty::SYBYL_TYPE property of the bond bond.

Parameters
bondThe bond for which to return the property value.
Returns
The stored Sybyl MOL2 bond type (see namespace Chem::SybylBondType).

◆ setSybylType() [2/2]

CDPL_CHEM_API void CDPL::Chem::setSybylType ( Bond bond,
unsigned int  type 
)

Sets the value of the Chem::BondProperty::SYBYL_TYPE property of the bond bond to type.

Parameters
bondThe bond for which to set the property value.
typeThe new Sybyl MOL2 bond type (see namespace Chem::SybylBondType).

◆ clearSybylType() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearSybylType ( Bond bond)

Clears the value of the Chem::BondProperty::SYBYL_TYPE property of the bond bond.

Parameters
bondThe bond for which to clear the property value.

◆ hasSybylType() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasSybylType ( const Bond bond)

Tells whether the Chem::BondProperty::SYBYL_TYPE property of the bond bond is set.

Parameters
bondThe bond for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ perceiveSybylType() [2/2]

CDPL_CHEM_API unsigned int CDPL::Chem::perceiveSybylType ( const Bond bond,
const MolecularGraph molgraph 
)

Derives the Sybyl MOL2 bond type of the bond bond from its bond order, aromaticity and ligand environment in the molecular graph molgraph.

Parameters
bondThe bond to inspect.
molgraphThe molecular graph providing the structural context.
Returns
The perceived Sybyl MOL2 bond type (see namespace Chem::SybylBondType).

◆ getOrdinaryHydrogenDepleteParameter()

CDPL_CHEM_API bool CDPL::Chem::getOrdinaryHydrogenDepleteParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::ORDINARY_HYDROGEN_DEPLETE parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setOrdinaryHydrogenDepleteParameter()

CDPL_CHEM_API void CDPL::Chem::setOrdinaryHydrogenDepleteParameter ( Base::ControlParameterContainer cntnr,
bool  deplete 
)

Sets the value of the Chem::ControlParameter::ORDINARY_HYDROGEN_DEPLETE parameter of cntnr to deplete.

Parameters
cntnrThe control-parameter container.
depleteThe new parameter value.

◆ hasOrdinaryHydrogenDepleteParameter()

CDPL_CHEM_API bool CDPL::Chem::hasOrdinaryHydrogenDepleteParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::ORDINARY_HYDROGEN_DEPLETE parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearOrdinaryHydrogenDepleteParameter()

CDPL_CHEM_API void CDPL::Chem::clearOrdinaryHydrogenDepleteParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::ORDINARY_HYDROGEN_DEPLETE parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getCoordinatesDimensionParameter()

CDPL_CHEM_API std::size_t CDPL::Chem::getCoordinatesDimensionParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::COORDINATES_DIMENSION parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored coordinates dimensionality.

◆ setCoordinatesDimensionParameter()

CDPL_CHEM_API void CDPL::Chem::setCoordinatesDimensionParameter ( Base::ControlParameterContainer cntnr,
std::size_t  dim 
)

Sets the value of the Chem::ControlParameter::COORDINATES_DIMENSION parameter of cntnr to dim.

Parameters
cntnrThe control-parameter container.
dimThe new coordinates dimensionality.

◆ hasCoordinatesDimensionParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCoordinatesDimensionParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::COORDINATES_DIMENSION parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearCoordinatesDimensionParameter()

CDPL_CHEM_API void CDPL::Chem::clearCoordinatesDimensionParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::COORDINATES_DIMENSION parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getStrictErrorCheckingParameter()

CDPL_CHEM_API bool CDPL::Chem::getStrictErrorCheckingParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::STRICT_ERROR_CHECKING parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setStrictErrorCheckingParameter()

CDPL_CHEM_API void CDPL::Chem::setStrictErrorCheckingParameter ( Base::ControlParameterContainer cntnr,
bool  strict 
)

Sets the value of the Chem::ControlParameter::STRICT_ERROR_CHECKING parameter of cntnr to strict.

Parameters
cntnrThe control-parameter container.
strictThe new parameter value.

◆ hasStrictErrorCheckingParameter()

CDPL_CHEM_API bool CDPL::Chem::hasStrictErrorCheckingParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::STRICT_ERROR_CHECKING parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearStrictErrorCheckingParameter()

CDPL_CHEM_API void CDPL::Chem::clearStrictErrorCheckingParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::STRICT_ERROR_CHECKING parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getRecordSeparatorParameter()

CDPL_CHEM_API const std::string& CDPL::Chem::getRecordSeparatorParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::RECORD_SEPARATOR parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored record separator string.

◆ setRecordSeparatorParameter()

CDPL_CHEM_API void CDPL::Chem::setRecordSeparatorParameter ( Base::ControlParameterContainer cntnr,
const std::string &  sep 
)

Sets the value of the Chem::ControlParameter::RECORD_SEPARATOR parameter of cntnr to sep.

Parameters
cntnrThe control-parameter container.
sepThe new record separator string.

◆ hasRecordSeparatorParameter()

CDPL_CHEM_API bool CDPL::Chem::hasRecordSeparatorParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::RECORD_SEPARATOR parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearRecordSeparatorParameter()

CDPL_CHEM_API void CDPL::Chem::clearRecordSeparatorParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::RECORD_SEPARATOR parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getBondMemberSwapStereoFixParameter()

CDPL_CHEM_API bool CDPL::Chem::getBondMemberSwapStereoFixParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::BOND_MEMBER_SWAP_STEREO_FIX parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setBondMemberSwapStereoFixParameter()

CDPL_CHEM_API void CDPL::Chem::setBondMemberSwapStereoFixParameter ( Base::ControlParameterContainer cntnr,
bool  fix 
)

Sets the value of the Chem::ControlParameter::BOND_MEMBER_SWAP_STEREO_FIX parameter of cntnr to fix.

Parameters
cntnrThe control-parameter container.
fixThe new parameter value.

◆ hasBondMemberSwapStereoFixParameter()

CDPL_CHEM_API bool CDPL::Chem::hasBondMemberSwapStereoFixParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::BOND_MEMBER_SWAP_STEREO_FIX parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearBondMemberSwapStereoFixParameter()

CDPL_CHEM_API void CDPL::Chem::clearBondMemberSwapStereoFixParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::BOND_MEMBER_SWAP_STEREO_FIX parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getCheckLineLengthParameter()

CDPL_CHEM_API bool CDPL::Chem::getCheckLineLengthParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CHECK_LINE_LENGTH parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setCheckLineLengthParameter()

CDPL_CHEM_API void CDPL::Chem::setCheckLineLengthParameter ( Base::ControlParameterContainer cntnr,
bool  check 
)

Sets the value of the Chem::ControlParameter::CHECK_LINE_LENGTH parameter of cntnr to check.

Parameters
cntnrThe control-parameter container.
checkThe new parameter value.

◆ hasCheckLineLengthParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCheckLineLengthParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CHECK_LINE_LENGTH parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearCheckLineLengthParameter()

CDPL_CHEM_API void CDPL::Chem::clearCheckLineLengthParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CHECK_LINE_LENGTH parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMDLCTABVersionParameter()

CDPL_CHEM_API unsigned int CDPL::Chem::getMDLCTABVersionParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MDL_CTAB_VERSION parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored CTAB version (see namespace Chem::MDLDataFormatVersion).

◆ setMDLCTABVersionParameter()

CDPL_CHEM_API void CDPL::Chem::setMDLCTABVersionParameter ( Base::ControlParameterContainer cntnr,
unsigned int  version 
)

Sets the value of the Chem::ControlParameter::MDL_CTAB_VERSION parameter of cntnr to version.

Parameters
cntnrThe control-parameter container.
versionThe new CTAB version (see namespace Chem::MDLDataFormatVersion).

◆ hasMDLCTABVersionParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMDLCTABVersionParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MDL_CTAB_VERSION parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMDLCTABVersionParameter()

CDPL_CHEM_API void CDPL::Chem::clearMDLCTABVersionParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MDL_CTAB_VERSION parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMDLIgnoreParityParameter()

CDPL_CHEM_API bool CDPL::Chem::getMDLIgnoreParityParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MDL_IGNORE_PARITY parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMDLIgnoreParityParameter()

CDPL_CHEM_API void CDPL::Chem::setMDLIgnoreParityParameter ( Base::ControlParameterContainer cntnr,
bool  ignore 
)

Sets the value of the Chem::ControlParameter::MDL_IGNORE_PARITY parameter of cntnr to ignore.

Parameters
cntnrThe control-parameter container.
ignoreThe new parameter value.

◆ hasMDLIgnoreParityParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMDLIgnoreParityParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MDL_IGNORE_PARITY parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMDLIgnoreParityParameter()

CDPL_CHEM_API void CDPL::Chem::clearMDLIgnoreParityParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MDL_IGNORE_PARITY parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMDLUpdateTimestampParameter()

CDPL_CHEM_API bool CDPL::Chem::getMDLUpdateTimestampParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MDL_UPDATE_TIMESTAMP parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMDLUpdateTimestampParameter()

CDPL_CHEM_API void CDPL::Chem::setMDLUpdateTimestampParameter ( Base::ControlParameterContainer cntnr,
bool  update 
)

Sets the value of the Chem::ControlParameter::MDL_UPDATE_TIMESTAMP parameter of cntnr to update.

Parameters
cntnrThe control-parameter container.
updateThe new parameter value.

◆ hasMDLUpdateTimestampParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMDLUpdateTimestampParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MDL_UPDATE_TIMESTAMP parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMDLUpdateTimestampParameter()

CDPL_CHEM_API void CDPL::Chem::clearMDLUpdateTimestampParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MDL_UPDATE_TIMESTAMP parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMDLTrimStringsParameter()

CDPL_CHEM_API bool CDPL::Chem::getMDLTrimStringsParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MDL_TRIM_STRINGS parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMDLTrimStringsParameter()

CDPL_CHEM_API void CDPL::Chem::setMDLTrimStringsParameter ( Base::ControlParameterContainer cntnr,
bool  trim 
)

Sets the value of the Chem::ControlParameter::MDL_TRIM_STRINGS parameter of cntnr to trim.

Parameters
cntnrThe control-parameter container.
trimThe new parameter value.

◆ hasMDLTrimStringsParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMDLTrimStringsParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MDL_TRIM_STRINGS parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMDLTrimStringsParameter()

CDPL_CHEM_API void CDPL::Chem::clearMDLTrimStringsParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MDL_TRIM_STRINGS parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMDLTrimLinesParameter()

CDPL_CHEM_API bool CDPL::Chem::getMDLTrimLinesParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MDL_TRIM_LINES parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMDLTrimLinesParameter()

CDPL_CHEM_API void CDPL::Chem::setMDLTrimLinesParameter ( Base::ControlParameterContainer cntnr,
bool  trim 
)

Sets the value of the Chem::ControlParameter::MDL_TRIM_LINES parameter of cntnr to trim.

Parameters
cntnrThe control-parameter container.
trimThe new parameter value.

◆ hasMDLTrimLinesParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMDLTrimLinesParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MDL_TRIM_LINES parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMDLTrimLinesParameter()

CDPL_CHEM_API void CDPL::Chem::clearMDLTrimLinesParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MDL_TRIM_LINES parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMDLTruncateStringsParameter()

CDPL_CHEM_API bool CDPL::Chem::getMDLTruncateStringsParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MDL_TRUNCATE_STRINGS parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMDLTruncateStringsParameter()

CDPL_CHEM_API void CDPL::Chem::setMDLTruncateStringsParameter ( Base::ControlParameterContainer cntnr,
bool  trunc 
)

Sets the value of the Chem::ControlParameter::MDL_TRUNCATE_STRINGS parameter of cntnr to trunc.

Parameters
cntnrThe control-parameter container.
truncThe new parameter value.

◆ hasMDLTruncateStringsParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMDLTruncateStringsParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MDL_TRUNCATE_STRINGS parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMDLTruncateStringsParameter()

CDPL_CHEM_API void CDPL::Chem::clearMDLTruncateStringsParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MDL_TRUNCATE_STRINGS parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMDLTruncateLinesParameter()

CDPL_CHEM_API bool CDPL::Chem::getMDLTruncateLinesParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MDL_TRUNCATE_LINES parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMDLTruncateLinesParameter()

CDPL_CHEM_API void CDPL::Chem::setMDLTruncateLinesParameter ( Base::ControlParameterContainer cntnr,
bool  trunc 
)

Sets the value of the Chem::ControlParameter::MDL_TRUNCATE_LINES parameter of cntnr to trunc.

Parameters
cntnrThe control-parameter container.
truncThe new parameter value.

◆ hasMDLTruncateLinesParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMDLTruncateLinesParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MDL_TRUNCATE_LINES parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMDLTruncateLinesParameter()

CDPL_CHEM_API void CDPL::Chem::clearMDLTruncateLinesParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MDL_TRUNCATE_LINES parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMDLRXNFileVersionParameter()

CDPL_CHEM_API unsigned int CDPL::Chem::getMDLRXNFileVersionParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MDL_RXN_FILE_VERSION parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored MDL Rxn-File version (see namespace Chem::MDLDataFormatVersion).

◆ setMDLRXNFileVersionParameter()

CDPL_CHEM_API void CDPL::Chem::setMDLRXNFileVersionParameter ( Base::ControlParameterContainer cntnr,
unsigned int  version 
)

Sets the value of the Chem::ControlParameter::MDL_RXN_FILE_VERSION parameter of cntnr to version.

Parameters
cntnrThe control-parameter container.
versionThe new MDL Rxn-File version (see namespace Chem::MDLDataFormatVersion).

◆ hasMDLRXNFileVersionParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMDLRXNFileVersionParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MDL_RXN_FILE_VERSION parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMDLRXNFileVersionParameter()

CDPL_CHEM_API void CDPL::Chem::clearMDLRXNFileVersionParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MDL_RXN_FILE_VERSION parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMDLOutputConfEnergyToEnergyFieldParameter()

CDPL_CHEM_API bool CDPL::Chem::getMDLOutputConfEnergyToEnergyFieldParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_TO_ENERGY_FIELD parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMDLOutputConfEnergyToEnergyFieldParameter()

CDPL_CHEM_API void CDPL::Chem::setMDLOutputConfEnergyToEnergyFieldParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_TO_ENERGY_FIELD parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.

◆ hasMDLOutputConfEnergyToEnergyFieldParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMDLOutputConfEnergyToEnergyFieldParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_TO_ENERGY_FIELD parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMDLOutputConfEnergyToEnergyFieldParameter()

CDPL_CHEM_API void CDPL::Chem::clearMDLOutputConfEnergyToEnergyFieldParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_TO_ENERGY_FIELD parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMDLOutputConfEnergyAsSDEntryParameter()

CDPL_CHEM_API bool CDPL::Chem::getMDLOutputConfEnergyAsSDEntryParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_AS_SD_ENTRY parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMDLOutputConfEnergyAsSDEntryParameter()

CDPL_CHEM_API void CDPL::Chem::setMDLOutputConfEnergyAsSDEntryParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_AS_SD_ENTRY parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.

◆ hasMDLOutputConfEnergyAsSDEntryParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMDLOutputConfEnergyAsSDEntryParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_AS_SD_ENTRY parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMDLOutputConfEnergyAsSDEntryParameter()

CDPL_CHEM_API void CDPL::Chem::clearMDLOutputConfEnergyAsSDEntryParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MDL_OUTPUT_CONF_ENERGY_AS_SD_ENTRY parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMDLEnableAromaticBondTypesParameter()

CDPL_CHEM_API bool CDPL::Chem::getMDLEnableAromaticBondTypesParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MDL_ENABLE_AROMATIC_BOND_TYPES parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.3

◆ setMDLEnableAromaticBondTypesParameter()

CDPL_CHEM_API void CDPL::Chem::setMDLEnableAromaticBondTypesParameter ( Base::ControlParameterContainer cntnr,
bool  enable 
)

Sets the value of the Chem::ControlParameter::MDL_ENABLE_AROMATIC_BOND_TYPES parameter of cntnr to enable.

Parameters
cntnrThe control-parameter container.
enableThe new parameter value.
Since
1.3

◆ hasMDLEnableAromaticBondTypesParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMDLEnableAromaticBondTypesParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MDL_ENABLE_AROMATIC_BOND_TYPES parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.3

◆ clearMDLEnableAromaticBondTypesParameter()

CDPL_CHEM_API void CDPL::Chem::clearMDLEnableAromaticBondTypesParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MDL_ENABLE_AROMATIC_BOND_TYPES parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.3

◆ getMDLConfEnergySDTagParameter()

CDPL_CHEM_API const std::string& CDPL::Chem::getMDLConfEnergySDTagParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MDL_CONF_ENERGY_SD_TAG parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored MDL SD-File structure data record header string.

◆ setMDLConfEnergySDTagParameter()

CDPL_CHEM_API void CDPL::Chem::setMDLConfEnergySDTagParameter ( Base::ControlParameterContainer cntnr,
const std::string &  tag 
)

Sets the value of the Chem::ControlParameter::MDL_CONF_ENERGY_SD_TAG parameter of cntnr to tag.

Parameters
cntnrThe control-parameter container.
tagThe new MDL SD-File structure data record header string.

◆ hasMDLConfEnergySDTagParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMDLConfEnergySDTagParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MDL_CONF_ENERGY_SD_TAG parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMDLConfEnergySDTagParameter()

CDPL_CHEM_API void CDPL::Chem::clearMDLConfEnergySDTagParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MDL_CONF_ENERGY_SD_TAG parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getJMESeparateComponentsParameter()

CDPL_CHEM_API bool CDPL::Chem::getJMESeparateComponentsParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::JME_SEPARATE_COMPONENTS parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setJMESeparateComponentsParameter()

CDPL_CHEM_API void CDPL::Chem::setJMESeparateComponentsParameter ( Base::ControlParameterContainer cntnr,
bool  separate 
)

Sets the value of the Chem::ControlParameter::JME_SEPARATE_COMPONENTS parameter of cntnr to separate.

Parameters
cntnrThe control-parameter container.
separateThe new parameter value.

◆ hasJMESeparateComponentsParameter()

CDPL_CHEM_API bool CDPL::Chem::hasJMESeparateComponentsParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::JME_SEPARATE_COMPONENTS parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearJMESeparateComponentsParameter()

CDPL_CHEM_API void CDPL::Chem::clearJMESeparateComponentsParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::JME_SEPARATE_COMPONENTS parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getSMILESRecordFormatParameter()

CDPL_CHEM_API const std::string& CDPL::Chem::getSMILESRecordFormatParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_RECORD_FORMAT parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored record-format string.

◆ setSMILESRecordFormatParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESRecordFormatParameter ( Base::ControlParameterContainer cntnr,
const std::string &  format 
)

Sets the value of the Chem::ControlParameter::SMILES_RECORD_FORMAT parameter of cntnr to format.

Parameters
cntnrThe control-parameter container.
formatThe new record-format string.

◆ hasSMILESRecordFormatParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESRecordFormatParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_RECORD_FORMAT parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearSMILESRecordFormatParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESRecordFormatParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_RECORD_FORMAT parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getSMILESOutputCanonicalFormParameter()

CDPL_CHEM_API bool CDPL::Chem::getSMILESOutputCanonicalFormParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_CANONICAL_FORM parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setSMILESOutputCanonicalFormParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESOutputCanonicalFormParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_CANONICAL_FORM parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasSMILESOutputCanonicalFormParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESOutputCanonicalFormParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_OUTPUT_CANONICAL_FORM parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearSMILESOutputCanonicalFormParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESOutputCanonicalFormParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_OUTPUT_CANONICAL_FORM parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getSMILESOutputKekuleFormParameter()

CDPL_CHEM_API bool CDPL::Chem::getSMILESOutputKekuleFormParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_KEKULE_FORM parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setSMILESOutputKekuleFormParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESOutputKekuleFormParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_KEKULE_FORM parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasSMILESOutputKekuleFormParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESOutputKekuleFormParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_OUTPUT_KEKULE_FORM parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearSMILESOutputKekuleFormParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESOutputKekuleFormParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_OUTPUT_KEKULE_FORM parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getSMILESOutputAtomStereoParameter()

CDPL_CHEM_API bool CDPL::Chem::getSMILESOutputAtomStereoParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_ATOM_STEREO parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setSMILESOutputAtomStereoParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESOutputAtomStereoParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_ATOM_STEREO parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasSMILESOutputAtomStereoParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESOutputAtomStereoParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_OUTPUT_ATOM_STEREO parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearSMILESOutputAtomStereoParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESOutputAtomStereoParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_OUTPUT_ATOM_STEREO parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getSMILESOutputBondStereoParameter()

CDPL_CHEM_API bool CDPL::Chem::getSMILESOutputBondStereoParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_BOND_STEREO parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setSMILESOutputBondStereoParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESOutputBondStereoParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_BOND_STEREO parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasSMILESOutputBondStereoParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESOutputBondStereoParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_OUTPUT_BOND_STEREO parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearSMILESOutputBondStereoParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESOutputBondStereoParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_OUTPUT_BOND_STEREO parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getSMILESOutputRingBondStereoParameter()

CDPL_CHEM_API bool CDPL::Chem::getSMILESOutputRingBondStereoParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_RING_BOND_STEREO parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setSMILESOutputRingBondStereoParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESOutputRingBondStereoParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_RING_BOND_STEREO parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasSMILESOutputRingBondStereoParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESOutputRingBondStereoParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_OUTPUT_RING_BOND_STEREO parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearSMILESOutputRingBondStereoParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESOutputRingBondStereoParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_OUTPUT_RING_BOND_STEREO parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getSMILESMinStereoBondRingSizeParameter()

CDPL_CHEM_API std::size_t CDPL::Chem::getSMILESMinStereoBondRingSizeParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_MIN_STEREO_BOND_RING_SIZE parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored minimum ring size.

◆ setSMILESMinStereoBondRingSizeParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESMinStereoBondRingSizeParameter ( Base::ControlParameterContainer cntnr,
std::size_t  min_size 
)

Sets the value of the Chem::ControlParameter::SMILES_MIN_STEREO_BOND_RING_SIZE parameter of cntnr to min_size.

Parameters
cntnrThe control-parameter container.
min_sizeThe new minimum ring size.

◆ hasSMILESMinStereoBondRingSizeParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESMinStereoBondRingSizeParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_MIN_STEREO_BOND_RING_SIZE parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearSMILESMinStereoBondRingSizeParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESMinStereoBondRingSizeParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_MIN_STEREO_BOND_RING_SIZE parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getSMILESOutputIsotopeParameter()

CDPL_CHEM_API bool CDPL::Chem::getSMILESOutputIsotopeParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_ISOTOPE parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setSMILESOutputIsotopeParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESOutputIsotopeParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_ISOTOPE parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasSMILESOutputIsotopeParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESOutputIsotopeParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_OUTPUT_ISOTOPE parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearSMILESOutputIsotopeParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESOutputIsotopeParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_OUTPUT_ISOTOPE parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getSMILESOutputHydrogenCountParameter()

CDPL_CHEM_API bool CDPL::Chem::getSMILESOutputHydrogenCountParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_HYDROGEN_COUNT parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.3

◆ setSMILESOutputHydrogenCountParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESOutputHydrogenCountParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_HYDROGEN_COUNT parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.3

◆ hasSMILESOutputHydrogenCountParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESOutputHydrogenCountParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_OUTPUT_HYDROGEN_COUNT parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.3

◆ clearSMILESOutputHydrogenCountParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESOutputHydrogenCountParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_OUTPUT_HYDROGEN_COUNT parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.3

◆ getSMILESMolOutputAtomMappingIDParameter()

CDPL_CHEM_API bool CDPL::Chem::getSMILESMolOutputAtomMappingIDParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_MOL_OUTPUT_ATOM_MAPPING_ID parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setSMILESMolOutputAtomMappingIDParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESMolOutputAtomMappingIDParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::SMILES_MOL_OUTPUT_ATOM_MAPPING_ID parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasSMILESMolOutputAtomMappingIDParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESMolOutputAtomMappingIDParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_MOL_OUTPUT_ATOM_MAPPING_ID parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearSMILESMolOutputAtomMappingIDParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESMolOutputAtomMappingIDParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_MOL_OUTPUT_ATOM_MAPPING_ID parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getSMILESRxnOutputAtomMappingIDParameter()

CDPL_CHEM_API bool CDPL::Chem::getSMILESRxnOutputAtomMappingIDParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_RXN_OUTPUT_ATOM_MAPPING_ID parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setSMILESRxnOutputAtomMappingIDParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESRxnOutputAtomMappingIDParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::SMILES_RXN_OUTPUT_ATOM_MAPPING_ID parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasSMILESRxnOutputAtomMappingIDParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESRxnOutputAtomMappingIDParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_RXN_OUTPUT_ATOM_MAPPING_ID parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearSMILESRxnOutputAtomMappingIDParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESRxnOutputAtomMappingIDParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_RXN_OUTPUT_ATOM_MAPPING_ID parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getSMILESOutputSingleBondsParameter()

CDPL_CHEM_API bool CDPL::Chem::getSMILESOutputSingleBondsParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_SINGLE_BONDS parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setSMILESOutputSingleBondsParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESOutputSingleBondsParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_SINGLE_BONDS parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasSMILESOutputSingleBondsParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESOutputSingleBondsParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_OUTPUT_SINGLE_BONDS parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearSMILESOutputSingleBondsParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESOutputSingleBondsParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_OUTPUT_SINGLE_BONDS parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getSMILESOutputAromaticBondsParameter()

CDPL_CHEM_API bool CDPL::Chem::getSMILESOutputAromaticBondsParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_OUTPUT_AROMATIC_BONDS parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setSMILESOutputAromaticBondsParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESOutputAromaticBondsParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::SMILES_OUTPUT_AROMATIC_BONDS parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasSMILESOutputAromaticBondsParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESOutputAromaticBondsParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_OUTPUT_AROMATIC_BONDS parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearSMILESOutputAromaticBondsParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESOutputAromaticBondsParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_OUTPUT_AROMATIC_BONDS parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getSMILESNoOrganicSubsetParameter()

CDPL_CHEM_API bool CDPL::Chem::getSMILESNoOrganicSubsetParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::SMILES_NO_ORGANIC_SUBSET parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setSMILESNoOrganicSubsetParameter()

CDPL_CHEM_API void CDPL::Chem::setSMILESNoOrganicSubsetParameter ( Base::ControlParameterContainer cntnr,
bool  no_subset 
)

Sets the value of the Chem::ControlParameter::SMILES_NO_ORGANIC_SUBSET parameter of cntnr to no_subset.

Parameters
cntnrThe control-parameter container.
no_subsetThe new parameter value.

◆ hasSMILESNoOrganicSubsetParameter()

CDPL_CHEM_API bool CDPL::Chem::hasSMILESNoOrganicSubsetParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::SMILES_NO_ORGANIC_SUBSET parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearSMILESNoOrganicSubsetParameter()

CDPL_CHEM_API void CDPL::Chem::clearSMILESNoOrganicSubsetParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::SMILES_NO_ORGANIC_SUBSET parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getINCHIInputOptionsParameter()

CDPL_CHEM_API const std::string& CDPL::Chem::getINCHIInputOptionsParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::INCHI_INPUT_OPTIONS parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored InChI input-options string.

◆ setINCHIInputOptionsParameter()

CDPL_CHEM_API void CDPL::Chem::setINCHIInputOptionsParameter ( Base::ControlParameterContainer cntnr,
const std::string &  opts 
)

Sets the value of the Chem::ControlParameter::INCHI_INPUT_OPTIONS parameter of cntnr to opts.

Parameters
cntnrThe control-parameter container.
optsThe new InChI input-options string.

◆ hasINCHIInputOptionsParameter()

CDPL_CHEM_API bool CDPL::Chem::hasINCHIInputOptionsParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::INCHI_INPUT_OPTIONS parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearINCHIInputOptionsParameter()

CDPL_CHEM_API void CDPL::Chem::clearINCHIInputOptionsParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::INCHI_INPUT_OPTIONS parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getINCHIOutputOptionsParameter()

CDPL_CHEM_API const std::string& CDPL::Chem::getINCHIOutputOptionsParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::INCHI_OUTPUT_OPTIONS parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored InChI output-options string.

◆ setINCHIOutputOptionsParameter()

CDPL_CHEM_API void CDPL::Chem::setINCHIOutputOptionsParameter ( Base::ControlParameterContainer cntnr,
const std::string &  opts 
)

Sets the value of the Chem::ControlParameter::INCHI_OUTPUT_OPTIONS parameter of cntnr to opts.

Parameters
cntnrThe control-parameter container.
optsThe new InChI output-options string.

◆ hasINCHIOutputOptionsParameter()

CDPL_CHEM_API bool CDPL::Chem::hasINCHIOutputOptionsParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::INCHI_OUTPUT_OPTIONS parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearINCHIOutputOptionsParameter()

CDPL_CHEM_API void CDPL::Chem::clearINCHIOutputOptionsParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::INCHI_OUTPUT_OPTIONS parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMultiConfImportParameter()

CDPL_CHEM_API bool CDPL::Chem::getMultiConfImportParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MULTI_CONF_IMPORT parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMultiConfImportParameter()

CDPL_CHEM_API void CDPL::Chem::setMultiConfImportParameter ( Base::ControlParameterContainer cntnr,
bool  multi_conf 
)

Sets the value of the Chem::ControlParameter::MULTI_CONF_IMPORT parameter of cntnr to multi_conf.

Parameters
cntnrThe control-parameter container.
multi_confThe new parameter value.

◆ hasMultiConfImportParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMultiConfImportParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MULTI_CONF_IMPORT parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMultiConfImportParameter()

CDPL_CHEM_API void CDPL::Chem::clearMultiConfImportParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MULTI_CONF_IMPORT parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMultiConfExportParameter()

CDPL_CHEM_API bool CDPL::Chem::getMultiConfExportParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MULTI_CONF_EXPORT parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMultiConfExportParameter()

CDPL_CHEM_API void CDPL::Chem::setMultiConfExportParameter ( Base::ControlParameterContainer cntnr,
bool  multi_conf 
)

Sets the value of the Chem::ControlParameter::MULTI_CONF_EXPORT parameter of cntnr to multi_conf.

Parameters
cntnrThe control-parameter container.
multi_confThe new parameter value.

◆ hasMultiConfExportParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMultiConfExportParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MULTI_CONF_EXPORT parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMultiConfExportParameter()

CDPL_CHEM_API void CDPL::Chem::clearMultiConfExportParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MULTI_CONF_EXPORT parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getOutputConfEnergyAsCommentParameter()

CDPL_CHEM_API bool CDPL::Chem::getOutputConfEnergyAsCommentParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::OUTPUT_CONF_ENERGY_AS_COMMENT parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setOutputConfEnergyAsCommentParameter()

CDPL_CHEM_API void CDPL::Chem::setOutputConfEnergyAsCommentParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::OUTPUT_CONF_ENERGY_AS_COMMENT parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.

◆ hasOutputConfEnergyAsCommentParameter()

CDPL_CHEM_API bool CDPL::Chem::hasOutputConfEnergyAsCommentParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::OUTPUT_CONF_ENERGY_AS_COMMENT parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearOutputConfEnergyAsCommentParameter()

CDPL_CHEM_API void CDPL::Chem::clearOutputConfEnergyAsCommentParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::OUTPUT_CONF_ENERGY_AS_COMMENT parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getConfIndexNameSuffixPatternParameter()

CDPL_CHEM_API const std::string& CDPL::Chem::getConfIndexNameSuffixPatternParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CONF_INDEX_NAME_SUFFIX_PATTERN parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored suffix pattern string.

◆ setConfIndexNameSuffixPatternParameter()

CDPL_CHEM_API void CDPL::Chem::setConfIndexNameSuffixPatternParameter ( Base::ControlParameterContainer cntnr,
const std::string &  pattern 
)

Sets the value of the Chem::ControlParameter::CONF_INDEX_NAME_SUFFIX_PATTERN parameter of cntnr to pattern.

Parameters
cntnrThe control-parameter container.
patternThe new suffix pattern string.

◆ hasConfIndexNameSuffixPatternParameter()

CDPL_CHEM_API bool CDPL::Chem::hasConfIndexNameSuffixPatternParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CONF_INDEX_NAME_SUFFIX_PATTERN parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearConfIndexNameSuffixPatternParameter()

CDPL_CHEM_API void CDPL::Chem::clearConfIndexNameSuffixPatternParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CONF_INDEX_NAME_SUFFIX_PATTERN parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMultiConfInputProcessorParameter()

CDPL_CHEM_API const MultiConfMoleculeInputProcessor::SharedPointer& CDPL::Chem::getMultiConfInputProcessorParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MULTI_CONF_INPUT_PROCESSOR parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored Chem::MultiConfMoleculeInputProcessor implementation pointer.

◆ setMultiConfInputProcessorParameter()

CDPL_CHEM_API void CDPL::Chem::setMultiConfInputProcessorParameter ( Base::ControlParameterContainer cntnr,
const MultiConfMoleculeInputProcessor::SharedPointer proc 
)

Sets the value of the Chem::ControlParameter::MULTI_CONF_INPUT_PROCESSOR parameter of cntnr to proc.

Parameters
cntnrThe control-parameter container.
procThe new Chem::MultiConfMoleculeInputProcessor implementation pointer.

◆ hasMultiConfInputProcessorParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMultiConfInputProcessorParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MULTI_CONF_INPUT_PROCESSOR parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMultiConfInputProcessorParameter()

CDPL_CHEM_API void CDPL::Chem::clearMultiConfInputProcessorParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MULTI_CONF_INPUT_PROCESSOR parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getCDFOutputSinglePrecisionFloatsParameter()

CDPL_CHEM_API bool CDPL::Chem::getCDFOutputSinglePrecisionFloatsParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setCDFOutputSinglePrecisionFloatsParameter()

CDPL_CHEM_API void CDPL::Chem::setCDFOutputSinglePrecisionFloatsParameter ( Base::ControlParameterContainer cntnr,
bool  single_prec 
)

Sets the value of the Chem::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter of cntnr to single_prec.

Parameters
cntnrThe control-parameter container.
single_precThe new parameter value.
Since
1.2

◆ hasCDFOutputSinglePrecisionFloatsParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCDFOutputSinglePrecisionFloatsParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearCDFOutputSinglePrecisionFloatsParameter()

CDPL_CHEM_API void CDPL::Chem::clearCDFOutputSinglePrecisionFloatsParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getMOL2EnableExtendedAtomTypesParameter()

CDPL_CHEM_API bool CDPL::Chem::getMOL2EnableExtendedAtomTypesParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MOL2_ENABLE_EXTENDED_ATOM_TYPES parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMOL2EnableExtendedAtomTypesParameter()

CDPL_CHEM_API void CDPL::Chem::setMOL2EnableExtendedAtomTypesParameter ( Base::ControlParameterContainer cntnr,
bool  enable 
)

Sets the value of the Chem::ControlParameter::MOL2_ENABLE_EXTENDED_ATOM_TYPES parameter of cntnr to enable.

Parameters
cntnrThe control-parameter container.
enableThe new parameter value.

◆ hasMOL2EnableExtendedAtomTypesParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2EnableExtendedAtomTypesParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MOL2_ENABLE_EXTENDED_ATOM_TYPES parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMOL2EnableExtendedAtomTypesParameter()

CDPL_CHEM_API void CDPL::Chem::clearMOL2EnableExtendedAtomTypesParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MOL2_ENABLE_EXTENDED_ATOM_TYPES parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMOL2EnableAromaticBondTypesParameter()

CDPL_CHEM_API bool CDPL::Chem::getMOL2EnableAromaticBondTypesParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MOL2_ENABLE_AROMATIC_BOND_TYPES parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMOL2EnableAromaticBondTypesParameter()

CDPL_CHEM_API void CDPL::Chem::setMOL2EnableAromaticBondTypesParameter ( Base::ControlParameterContainer cntnr,
bool  enable 
)

Sets the value of the Chem::ControlParameter::MOL2_ENABLE_AROMATIC_BOND_TYPES parameter of cntnr to enable.

Parameters
cntnrThe control-parameter container.
enableThe new parameter value.

◆ hasMOL2EnableAromaticBondTypesParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2EnableAromaticBondTypesParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MOL2_ENABLE_AROMATIC_BOND_TYPES parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMOL2EnableAromaticBondTypesParameter()

CDPL_CHEM_API void CDPL::Chem::clearMOL2EnableAromaticBondTypesParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MOL2_ENABLE_AROMATIC_BOND_TYPES parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMOL2ReadPartialAsFormalChargesParameter()

CDPL_CHEM_API bool CDPL::Chem::getMOL2ReadPartialAsFormalChargesParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MOL2_READ_PARTIAL_AS_FORMAL_CHARGES parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2.3

◆ setMOL2ReadPartialAsFormalChargesParameter()

CDPL_CHEM_API void CDPL::Chem::setMOL2ReadPartialAsFormalChargesParameter ( Base::ControlParameterContainer cntnr,
bool  read 
)

Sets the value of the Chem::ControlParameter::MOL2_READ_PARTIAL_AS_FORMAL_CHARGES parameter of cntnr to read.

Parameters
cntnrThe control-parameter container.
readThe new parameter value.
Since
1.2.3

◆ hasMOL2ReadPartialAsFormalChargesParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2ReadPartialAsFormalChargesParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MOL2_READ_PARTIAL_AS_FORMAL_CHARGES parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2.3

◆ clearMOL2ReadPartialAsFormalChargesParameter()

CDPL_CHEM_API void CDPL::Chem::clearMOL2ReadPartialAsFormalChargesParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MOL2_READ_PARTIAL_AS_FORMAL_CHARGES parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2.3

◆ getMOL2CalcFormalChargesParameter()

CDPL_CHEM_API bool CDPL::Chem::getMOL2CalcFormalChargesParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MOL2_CALC_FORMAL_CHARGES parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMOL2CalcFormalChargesParameter()

CDPL_CHEM_API void CDPL::Chem::setMOL2CalcFormalChargesParameter ( Base::ControlParameterContainer cntnr,
bool  calc 
)

Sets the value of the Chem::ControlParameter::MOL2_CALC_FORMAL_CHARGES parameter of cntnr to calc.

Parameters
cntnrThe control-parameter container.
calcThe new parameter value.

◆ hasMOL2CalcFormalChargesParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2CalcFormalChargesParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MOL2_CALC_FORMAL_CHARGES parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMOL2CalcFormalChargesParameter()

CDPL_CHEM_API void CDPL::Chem::clearMOL2CalcFormalChargesParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MOL2_CALC_FORMAL_CHARGES parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMOL2ChargeTypeParameter()

CDPL_CHEM_API unsigned int CDPL::Chem::getMOL2ChargeTypeParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MOL2_CHARGE_TYPE parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored Sybyl MOL2 charge type (see namespace Chem::MOL2ChargeType).

◆ setMOL2ChargeTypeParameter()

CDPL_CHEM_API void CDPL::Chem::setMOL2ChargeTypeParameter ( Base::ControlParameterContainer cntnr,
unsigned int  type 
)

Sets the value of the Chem::ControlParameter::MOL2_CHARGE_TYPE parameter of cntnr to type.

Parameters
cntnrThe control-parameter container.
typeThe new Sybyl MOL2 charge type (see namespace Chem::MOL2ChargeType).

◆ hasMOL2ChargeTypeParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2ChargeTypeParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MOL2_CHARGE_TYPE parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMOL2ChargeTypeParameter()

CDPL_CHEM_API void CDPL::Chem::clearMOL2ChargeTypeParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MOL2_CHARGE_TYPE parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMOL2MoleculeTypeParameter()

CDPL_CHEM_API unsigned int CDPL::Chem::getMOL2MoleculeTypeParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MOL2_MOLECULE_TYPE parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored Sybyl MOL2 molecule type (see namespace Chem::MOL2MoleculeType).

◆ setMOL2MoleculeTypeParameter()

CDPL_CHEM_API void CDPL::Chem::setMOL2MoleculeTypeParameter ( Base::ControlParameterContainer cntnr,
unsigned int  type 
)

Sets the value of the Chem::ControlParameter::MOL2_MOLECULE_TYPE parameter of cntnr to type.

Parameters
cntnrThe control-parameter container.
typeThe new Sybyl MOL2 molecule type (see namespace Chem::MOL2MoleculeType).

◆ hasMOL2MoleculeTypeParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2MoleculeTypeParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MOL2_MOLECULE_TYPE parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMOL2MoleculeTypeParameter()

CDPL_CHEM_API void CDPL::Chem::clearMOL2MoleculeTypeParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MOL2_MOLECULE_TYPE parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMOL2OutputSubstructuresParameter()

CDPL_CHEM_API bool CDPL::Chem::getMOL2OutputSubstructuresParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MOL2_OUTPUT_SUBSTRUCTURES parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.

◆ setMOL2OutputSubstructuresParameter()

CDPL_CHEM_API void CDPL::Chem::setMOL2OutputSubstructuresParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::MOL2_OUTPUT_SUBSTRUCTURES parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.

◆ hasMOL2OutputSubstructuresParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2OutputSubstructuresParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MOL2_OUTPUT_SUBSTRUCTURES parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.

◆ clearMOL2OutputSubstructuresParameter()

CDPL_CHEM_API void CDPL::Chem::clearMOL2OutputSubstructuresParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MOL2_OUTPUT_SUBSTRUCTURES parameter from cntnr.

Parameters
cntnrThe control-parameter container.

◆ getMOL2OutputFormalChargesParameter()

CDPL_CHEM_API bool CDPL::Chem::getMOL2OutputFormalChargesParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::MOL2_OUTPUT_FORMAL_CHARGES parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2.3

◆ setMOL2OutputFormalChargesParameter()

CDPL_CHEM_API void CDPL::Chem::setMOL2OutputFormalChargesParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::MOL2_OUTPUT_FORMAL_CHARGES parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2.3

◆ hasMOL2OutputFormalChargesParameter()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2OutputFormalChargesParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::MOL2_OUTPUT_FORMAL_CHARGES parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2.3

◆ clearMOL2OutputFormalChargesParameter()

CDPL_CHEM_API void CDPL::Chem::clearMOL2OutputFormalChargesParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::MOL2_OUTPUT_FORMAL_CHARGES parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2.3

◆ getXYZCommentIsNameParameter()

CDPL_CHEM_API bool CDPL::Chem::getXYZCommentIsNameParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::XYZ_COMMENT_IS_NAME parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.1

◆ setXYZCommentIsNameParameter()

CDPL_CHEM_API void CDPL::Chem::setXYZCommentIsNameParameter ( Base::ControlParameterContainer cntnr,
bool  is_name 
)

Sets the value of the Chem::ControlParameter::XYZ_COMMENT_IS_NAME parameter of cntnr to is_name.

Parameters
cntnrThe control-parameter container.
is_nameThe new parameter value.
Since
1.1

◆ hasXYZCommentIsNameParameter()

CDPL_CHEM_API bool CDPL::Chem::hasXYZCommentIsNameParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::XYZ_COMMENT_IS_NAME parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.1

◆ clearXYZCommentIsNameParameter()

CDPL_CHEM_API void CDPL::Chem::clearXYZCommentIsNameParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::XYZ_COMMENT_IS_NAME parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.1

◆ getXYZPerceiveConnectivityParameter()

CDPL_CHEM_API bool CDPL::Chem::getXYZPerceiveConnectivityParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::XYZ_PERCEIVE_CONNECTIVITY parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.1

◆ setXYZPerceiveConnectivityParameter()

CDPL_CHEM_API void CDPL::Chem::setXYZPerceiveConnectivityParameter ( Base::ControlParameterContainer cntnr,
bool  perceive 
)

Sets the value of the Chem::ControlParameter::XYZ_PERCEIVE_CONNECTIVITY parameter of cntnr to perceive.

Parameters
cntnrThe control-parameter container.
perceiveThe new parameter value.
Since
1.1

◆ hasXYZPerceiveConnectivityParameter()

CDPL_CHEM_API bool CDPL::Chem::hasXYZPerceiveConnectivityParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::XYZ_PERCEIVE_CONNECTIVITY parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.1

◆ clearXYZPerceiveConnectivityParameter()

CDPL_CHEM_API void CDPL::Chem::clearXYZPerceiveConnectivityParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::XYZ_PERCEIVE_CONNECTIVITY parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.1

◆ getXYZPerceiveBondOrdersParameter()

CDPL_CHEM_API bool CDPL::Chem::getXYZPerceiveBondOrdersParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::XYZ_PERCEIVE_BOND_ORDERS parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.1

◆ setXYZPerceiveBondOrdersParameter()

CDPL_CHEM_API void CDPL::Chem::setXYZPerceiveBondOrdersParameter ( Base::ControlParameterContainer cntnr,
bool  perceive 
)

Sets the value of the Chem::ControlParameter::XYZ_PERCEIVE_BOND_ORDERS parameter of cntnr to perceive.

Parameters
cntnrThe control-parameter container.
perceiveThe new parameter value.
Since
1.1

◆ hasXYZPerceiveBondOrdersParameter()

CDPL_CHEM_API bool CDPL::Chem::hasXYZPerceiveBondOrdersParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::XYZ_PERCEIVE_BOND_ORDERS parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.1

◆ clearXYZPerceiveBondOrdersParameter()

CDPL_CHEM_API void CDPL::Chem::clearXYZPerceiveBondOrdersParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::XYZ_PERCEIVE_BOND_ORDERS parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.1

◆ getXYZCalcFormalChargesParameter()

CDPL_CHEM_API bool CDPL::Chem::getXYZCalcFormalChargesParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::XYZ_CALC_FORMAL_CHARGES parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.1

◆ setXYZCalcFormalChargesParameter()

CDPL_CHEM_API void CDPL::Chem::setXYZCalcFormalChargesParameter ( Base::ControlParameterContainer cntnr,
bool  calc 
)

Sets the value of the Chem::ControlParameter::XYZ_CALC_FORMAL_CHARGES parameter of cntnr to calc.

Parameters
cntnrThe control-parameter container.
calcThe new parameter value.
Since
1.1

◆ hasXYZCalcFormalChargesParameter()

CDPL_CHEM_API bool CDPL::Chem::hasXYZCalcFormalChargesParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::XYZ_CALC_FORMAL_CHARGES parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.1

◆ clearXYZCalcFormalChargesParameter()

CDPL_CHEM_API void CDPL::Chem::clearXYZCalcFormalChargesParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::XYZ_CALC_FORMAL_CHARGES parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.1

◆ getCMLOutputXMLDeclarationParameter()

CDPL_CHEM_API bool CDPL::Chem::getCMLOutputXMLDeclarationParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CML_OUTPUT_XML_DECLARATION parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setCMLOutputXMLDeclarationParameter()

CDPL_CHEM_API void CDPL::Chem::setCMLOutputXMLDeclarationParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::CML_OUTPUT_XML_DECLARATION parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasCMLOutputXMLDeclarationParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCMLOutputXMLDeclarationParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CML_OUTPUT_XML_DECLARATION parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearCMLOutputXMLDeclarationParameter()

CDPL_CHEM_API void CDPL::Chem::clearCMLOutputXMLDeclarationParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CML_OUTPUT_XML_DECLARATION parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getCMLOutputElementNamespaceParameter()

CDPL_CHEM_API const std::string& CDPL::Chem::getCMLOutputElementNamespaceParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CML_OUTPUT_ELEMENT_NAMESPACE parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The stored XML-namespace string.
Since
1.2

◆ setCMLOutputElementNamespaceParameter()

CDPL_CHEM_API void CDPL::Chem::setCMLOutputElementNamespaceParameter ( Base::ControlParameterContainer cntnr,
const std::string &  ns 
)

Sets the value of the Chem::ControlParameter::CML_OUTPUT_ELEMENT_NAMESPACE parameter of cntnr to ns.

Parameters
cntnrThe control-parameter container.
nsThe new XML-namespace string.
Since
1.2

◆ hasCMLOutputElementNamespaceParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCMLOutputElementNamespaceParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CML_OUTPUT_ELEMENT_NAMESPACE parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearCMLOutputElementNamespaceParameter()

CDPL_CHEM_API void CDPL::Chem::clearCMLOutputElementNamespaceParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CML_OUTPUT_ELEMENT_NAMESPACE parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getCMLOutputAtomParityParameter()

CDPL_CHEM_API bool CDPL::Chem::getCMLOutputAtomParityParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CML_OUTPUT_ATOM_PARITY parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setCMLOutputAtomParityParameter()

CDPL_CHEM_API void CDPL::Chem::setCMLOutputAtomParityParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::CML_OUTPUT_ATOM_PARITY parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasCMLOutputAtomParityParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCMLOutputAtomParityParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CML_OUTPUT_ATOM_PARITY parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearCMLOutputAtomParityParameter()

CDPL_CHEM_API void CDPL::Chem::clearCMLOutputAtomParityParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CML_OUTPUT_ATOM_PARITY parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getCMLOutputSingleBondStereoParameter()

CDPL_CHEM_API bool CDPL::Chem::getCMLOutputSingleBondStereoParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CML_OUTPUT_SINGLE_BOND_STEREO parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setCMLOutputSingleBondStereoParameter()

CDPL_CHEM_API void CDPL::Chem::setCMLOutputSingleBondStereoParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::CML_OUTPUT_SINGLE_BOND_STEREO parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasCMLOutputSingleBondStereoParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCMLOutputSingleBondStereoParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CML_OUTPUT_SINGLE_BOND_STEREO parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearCMLOutputSingleBondStereoParameter()

CDPL_CHEM_API void CDPL::Chem::clearCMLOutputSingleBondStereoParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CML_OUTPUT_SINGLE_BOND_STEREO parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getCMLOutputDoubleBondStereoParameter()

CDPL_CHEM_API bool CDPL::Chem::getCMLOutputDoubleBondStereoParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CML_OUTPUT_DOUBLE_BOND_STEREO parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setCMLOutputDoubleBondStereoParameter()

CDPL_CHEM_API void CDPL::Chem::setCMLOutputDoubleBondStereoParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::CML_OUTPUT_DOUBLE_BOND_STEREO parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasCMLOutputDoubleBondStereoParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCMLOutputDoubleBondStereoParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CML_OUTPUT_DOUBLE_BOND_STEREO parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearCMLOutputDoubleBondStereoParameter()

CDPL_CHEM_API void CDPL::Chem::clearCMLOutputDoubleBondStereoParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CML_OUTPUT_DOUBLE_BOND_STEREO parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getCMLEnableAromaticBondTypesParameter()

CDPL_CHEM_API bool CDPL::Chem::getCMLEnableAromaticBondTypesParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CML_ENABLE_AROMATIC_BOND_TYPES parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.3

◆ setCMLEnableAromaticBondTypesParameter()

CDPL_CHEM_API void CDPL::Chem::setCMLEnableAromaticBondTypesParameter ( Base::ControlParameterContainer cntnr,
bool  enable 
)

Sets the value of the Chem::ControlParameter::CML_ENABLE_AROMATIC_BOND_TYPES parameter of cntnr to enable.

Parameters
cntnrThe control-parameter container.
enableThe new parameter value.
Since
1.3

◆ hasCMLEnableAromaticBondTypesParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCMLEnableAromaticBondTypesParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CML_ENABLE_AROMATIC_BOND_TYPES parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.3

◆ clearCMLEnableAromaticBondTypesParameter()

CDPL_CHEM_API void CDPL::Chem::clearCMLEnableAromaticBondTypesParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CML_ENABLE_AROMATIC_BOND_TYPES parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.3

◆ getCMLOutputMoleculeNameParameter()

CDPL_CHEM_API bool CDPL::Chem::getCMLOutputMoleculeNameParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CML_OUTPUT_MOLECULE_NAME parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setCMLOutputMoleculeNameParameter()

CDPL_CHEM_API void CDPL::Chem::setCMLOutputMoleculeNameParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::CML_OUTPUT_MOLECULE_NAME parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasCMLOutputMoleculeNameParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCMLOutputMoleculeNameParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CML_OUTPUT_MOLECULE_NAME parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearCMLOutputMoleculeNameParameter()

CDPL_CHEM_API void CDPL::Chem::clearCMLOutputMoleculeNameParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CML_OUTPUT_MOLECULE_NAME parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getCMLOutputStructureDataParameter()

CDPL_CHEM_API bool CDPL::Chem::getCMLOutputStructureDataParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CML_OUTPUT_STRUCTURE_DATA parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setCMLOutputStructureDataParameter()

CDPL_CHEM_API void CDPL::Chem::setCMLOutputStructureDataParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::CML_OUTPUT_STRUCTURE_DATA parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasCMLOutputStructureDataParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCMLOutputStructureDataParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CML_OUTPUT_STRUCTURE_DATA parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearCMLOutputStructureDataParameter()

CDPL_CHEM_API void CDPL::Chem::clearCMLOutputStructureDataParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CML_OUTPUT_STRUCTURE_DATA parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getCMLOutputIsotopeParameter()

CDPL_CHEM_API bool CDPL::Chem::getCMLOutputIsotopeParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CML_OUTPUT_ISOTOPE parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setCMLOutputIsotopeParameter()

CDPL_CHEM_API void CDPL::Chem::setCMLOutputIsotopeParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::CML_OUTPUT_ISOTOPE parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasCMLOutputIsotopeParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCMLOutputIsotopeParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CML_OUTPUT_ISOTOPE parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearCMLOutputIsotopeParameter()

CDPL_CHEM_API void CDPL::Chem::clearCMLOutputIsotopeParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CML_OUTPUT_ISOTOPE parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getCMLOutputSpinMultiplicityParameter()

CDPL_CHEM_API bool CDPL::Chem::getCMLOutputSpinMultiplicityParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CML_OUTPUT_SPIN_MULTIPLICITY parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setCMLOutputSpinMultiplicityParameter()

CDPL_CHEM_API void CDPL::Chem::setCMLOutputSpinMultiplicityParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::CML_OUTPUT_SPIN_MULTIPLICITY parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasCMLOutputSpinMultiplicityParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCMLOutputSpinMultiplicityParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CML_OUTPUT_SPIN_MULTIPLICITY parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearCMLOutputSpinMultiplicityParameter()

CDPL_CHEM_API void CDPL::Chem::clearCMLOutputSpinMultiplicityParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CML_OUTPUT_SPIN_MULTIPLICITY parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getCMLOutputCompactAtomDataParameter()

CDPL_CHEM_API bool CDPL::Chem::getCMLOutputCompactAtomDataParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CML_OUTPUT_COMPACT_ATOM_DATA parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setCMLOutputCompactAtomDataParameter()

CDPL_CHEM_API void CDPL::Chem::setCMLOutputCompactAtomDataParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::CML_OUTPUT_COMPACT_ATOM_DATA parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasCMLOutputCompactAtomDataParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCMLOutputCompactAtomDataParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CML_OUTPUT_COMPACT_ATOM_DATA parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearCMLOutputCompactAtomDataParameter()

CDPL_CHEM_API void CDPL::Chem::clearCMLOutputCompactAtomDataParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CML_OUTPUT_COMPACT_ATOM_DATA parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ getCMLOutputCompactBondDataParameter()

CDPL_CHEM_API bool CDPL::Chem::getCMLOutputCompactBondDataParameter ( const Base::ControlParameterContainer cntnr)

Returns the value of the Chem::ControlParameter::CML_OUTPUT_COMPACT_BOND_DATA parameter stored in cntnr.

Parameters
cntnrThe control-parameter container.
Returns
The value of the parameter.
Since
1.2

◆ setCMLOutputCompactBondDataParameter()

CDPL_CHEM_API void CDPL::Chem::setCMLOutputCompactBondDataParameter ( Base::ControlParameterContainer cntnr,
bool  output 
)

Sets the value of the Chem::ControlParameter::CML_OUTPUT_COMPACT_BOND_DATA parameter of cntnr to output.

Parameters
cntnrThe control-parameter container.
outputThe new parameter value.
Since
1.2

◆ hasCMLOutputCompactBondDataParameter()

CDPL_CHEM_API bool CDPL::Chem::hasCMLOutputCompactBondDataParameter ( const Base::ControlParameterContainer cntnr)

Tells whether the Chem::ControlParameter::CML_OUTPUT_COMPACT_BOND_DATA parameter of cntnr is set.

Parameters
cntnrThe control-parameter container.
Returns
true if the parameter is set, and false otherwise.
Since
1.2

◆ clearCMLOutputCompactBondDataParameter()

CDPL_CHEM_API void CDPL::Chem::clearCMLOutputCompactBondDataParameter ( Base::ControlParameterContainer cntnr)

Removes the Chem::ControlParameter::CML_OUTPUT_COMPACT_BOND_DATA parameter from cntnr.

Parameters
cntnrThe control-parameter container.
Since
1.2

◆ calcGeometricalDistanceMatrix() [1/2]

CDPL_CHEM_API void CDPL::Chem::calcGeometricalDistanceMatrix ( const Entity3DContainer cntnr,
Math::DMatrix mtx 
)

Calculates the inter-entity geometric distance matrix for the entities of cntnr.

Parameters
cntnrThe entity 3D container providing the source coordinates.
mtxThe output matrix receiving the calculated pairwise distances.

◆ get3DCoordinates() [2/3]

CDPL_CHEM_API void CDPL::Chem::get3DCoordinates ( const Entity3DContainer cntnr,
Math::Vector3DArray coords,
bool  append = false 
)

Stores the 3D coordinates of the entities of cntnr in coords.

Parameters
cntnrThe entity 3D container providing the source coordinates.
coordsThe output coordinates array.
appendIf true, the entity coordinates are appended to coords. If false, coords is cleared first.

◆ set3DCoordinates() [1/2]

CDPL_CHEM_API void CDPL::Chem::set3DCoordinates ( Entity3DContainer cntnr,
const Math::Vector3DArray coords 
)

Sets the 3D coordinates of the entities of cntnr from coords.

Parameters
cntnrThe entity 3D container whose coordinates are to be updated.
coordsThe input coordinates array (must contain at least one position per entity in cntnr).

◆ transform3DCoordinates()

CDPL_CHEM_API void CDPL::Chem::transform3DCoordinates ( Entity3DContainer cntnr,
const Math::Matrix4D mtx 
)

Transforms the 3D coordinates of the entities of cntnr by the affine matrix mtx.

Parameters
cntnrThe entity 3D container whose coordinates are to be transformed.
mtxThe 4×4 affine transformation matrix.

◆ align3DCoordinates()

CDPL_CHEM_API bool CDPL::Chem::align3DCoordinates ( Entity3DContainer cntnr,
const Entity3DContainer ref_entities,
const Math::Vector3DArray ref_coords 
)

Transforms the 3D coordinates of the entities of cntnr by the affine matrix that is calculated for the rigid-body alignment of the 3D coordinates of the entities of ref_entities with the given reference coordinates ref_coords.

Parameters
cntnrThe entity 3D container whose coordinates are to be transformed.
ref_entitiesThe reference entity 3D container.
ref_coordsThe reference coordinates corresponding to the entities of ref_entities.
Returns
true if the alignment succeeded, and false otherwise.
Since
1.1

◆ calcCentroid() [2/2]

CDPL_CHEM_API bool CDPL::Chem::calcCentroid ( const Entity3DContainer cntnr,
Math::Vector3D ctr 
)

Calculates the geometric centroid of the 3D coordinates of the entities of cntnr.

Parameters
cntnrThe entity 3D container.
ctrThe output centroid vector.
Returns
true if the centroid could be calculated (i.e. cntnr is non-empty), and false otherwise.

◆ calcBoundingBox() [2/2]

CDPL_CHEM_API void CDPL::Chem::calcBoundingBox ( const Entity3DContainer cntnr,
Math::Vector3D min,
Math::Vector3D max,
bool  reset = true 
)

Calculates the axis-aligned bounding box of the 3D coordinates of the entities of cntnr.

Parameters
cntnrThe entity 3D container.
minThe output vector receiving the per-axis minimum coordinates.
maxThe output vector receiving the per-axis maximum coordinates.
resetIf true, min and max are reset before the calculation. If false, the given bounding box is extended.

◆ insideBoundingBox() [2/3]

CDPL_CHEM_API bool CDPL::Chem::insideBoundingBox ( const Entity3DContainer cntnr,
const Math::Vector3D min,
const Math::Vector3D max 
)

Tells whether all 3D coordinates of the entities of cntnr lie within the axis-aligned bounding box defined by min and max.

Parameters
cntnrThe entity 3D container.
minThe per-axis minimum coordinates of the box.
maxThe per-axis maximum coordinates of the box.
Returns
true if every entity coordinate is inside the bounding box, and false otherwise.

◆ intersectsBoundingBox() [2/2]

CDPL_CHEM_API bool CDPL::Chem::intersectsBoundingBox ( const Entity3DContainer cntnr,
const Math::Vector3D min,
const Math::Vector3D max 
)

Tells whether at least one entity of cntnr lies within the axis-aligned bounding box defined by min and max.

Parameters
cntnrThe entity 3D container.
minThe per-axis minimum coordinates of the box.
maxThe per-axis maximum coordinates of the box.
Returns
true if any entity coordinate is inside the bounding box, and false otherwise.

◆ get3DCoordinates() [3/3]

CDPL_CHEM_API const Math::Vector3D& CDPL::Chem::get3DCoordinates ( const Entity3D entity)

Returns the value of the Chem::Entity3DProperty::COORDINATES_3D property of the 3D entity entity.

Parameters
entityThe 3D entity for which to return the property value.
Returns
The stored 3D coordinates.
Exceptions
Base::ItemNotFoundif the property has not been set.

◆ set3DCoordinates() [2/2]

CDPL_CHEM_API void CDPL::Chem::set3DCoordinates ( Entity3D entity,
const Math::Vector3D coords 
)

Sets the value of the Chem::Entity3DProperty::COORDINATES_3D property of the 3D entity entity to coords.

Parameters
entityThe 3D entity for which to set the property value.
coordsThe new 3D coordinates.

◆ clear3DCoordinates()

CDPL_CHEM_API void CDPL::Chem::clear3DCoordinates ( Entity3D entity)

Clears the value of the Chem::Entity3DProperty::COORDINATES_3D property of the 3D entity entity.

Parameters
entityThe 3D entity for which to clear the property value.

◆ has3DCoordinates()

CDPL_CHEM_API bool CDPL::Chem::has3DCoordinates ( const Entity3D entity)

Tells whether the Chem::Entity3DProperty::COORDINATES_3D property of the 3D entity entity is set.

Parameters
entityThe 3D entity for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ makeHydrogenDeplete() [1/2]

CDPL_CHEM_API bool CDPL::Chem::makeHydrogenDeplete ( Fragment frag)

Removes all explicit hydrogen atoms from the fragment frag.

Parameters
fragThe fragment for which to remove all explicit hydrogen atoms.
Returns
false if frag was not altered, true otherwise.

◆ makeOrdinaryHydrogenDeplete() [1/2]

CDPL_CHEM_API bool CDPL::Chem::makeOrdinaryHydrogenDeplete ( Fragment frag,
unsigned int  flags 
)

Removes all explicit ordinary hydrogen atoms from the fragment frag.

Parameters
fragThe fragment for which to remove all explicit ordinary hydrogen atoms.
flagsSpecifies the set of atom properties to check (see namespace Chem::AtomPropertyFlag).
Returns
false if frag was not altered, true otherwise.
See also
MolProp::isOrdinaryHydrogen

◆ removeAtomsIf() [1/2]

CDPL_CHEM_API void CDPL::Chem::removeAtomsIf ( Fragment frag,
const AtomPredicate pred 
)

Removes all atoms of the fragment frag for which the predicate pred returns true.

Parameters
fragThe fragment to filter in place.
predThe atom predicate to evaluate.

◆ removeAtomsIfNot() [1/2]

CDPL_CHEM_API void CDPL::Chem::removeAtomsIfNot ( Fragment frag,
const AtomPredicate pred 
)

Removes all atoms of the fragment frag for which the predicate pred returns false.

Parameters
fragThe fragment to filter in place.
predThe atom predicate to evaluate.

◆ getName() [2/3]

CDPL_CHEM_API const std::string& CDPL::Chem::getName ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::NAME property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored name.

◆ setName() [2/3]

CDPL_CHEM_API void CDPL::Chem::setName ( MolecularGraph molgraph,
const std::string &  name 
)

Sets the value of the Chem::MolecularGraphProperty::NAME property of the molecular graph molgraph to name.

Parameters
molgraphThe molecular graph for which to set the property value.
nameThe new name.

◆ clearName() [2/3]

CDPL_CHEM_API void CDPL::Chem::clearName ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::NAME property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasName() [2/3]

CDPL_CHEM_API bool CDPL::Chem::hasName ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::NAME property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getTimestamp() [1/2]

CDPL_CHEM_API std::time_t CDPL::Chem::getTimestamp ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::TIMESTAMP property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored timestamp.

◆ setTimestamp() [1/2]

CDPL_CHEM_API void CDPL::Chem::setTimestamp ( MolecularGraph molgraph,
std::time_t  time 
)

Sets the value of the Chem::MolecularGraphProperty::TIMESTAMP property of the molecular graph molgraph to time.

Parameters
molgraphThe molecular graph for which to set the property value.
timeThe new timestamp value.

◆ clearTimestamp() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearTimestamp ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::TIMESTAMP property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasTimestamp() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasTimestamp ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::TIMESTAMP property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getComment() [1/2]

CDPL_CHEM_API const std::string& CDPL::Chem::getComment ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::COMMENT property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored comment.

◆ setComment() [1/2]

CDPL_CHEM_API void CDPL::Chem::setComment ( MolecularGraph molgraph,
const std::string &  comment 
)

Sets the value of the Chem::MolecularGraphProperty::COMMENT property of the molecular graph molgraph to comment.

Parameters
molgraphThe molecular graph for which to set the property value.
commentThe new comment string.

◆ clearComment() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearComment ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::COMMENT property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasComment() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasComment ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::COMMENT property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMatchConstraints() [3/4]

CDPL_CHEM_API const MatchConstraintList::SharedPointer& CDPL::Chem::getMatchConstraints ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::MATCH_CONSTRAINTS property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored top-level match constraint list.

◆ setMatchConstraints() [3/4]

CDPL_CHEM_API void CDPL::Chem::setMatchConstraints ( MolecularGraph molgraph,
const MatchConstraintList::SharedPointer constr 
)

Sets the value of the Chem::MolecularGraphProperty::MATCH_CONSTRAINTS property of the molecular graph molgraph to constr.

Parameters
molgraphThe molecular graph for which to set the property value.
constrThe new top-level match constraint list.

◆ clearMatchConstraints() [3/4]

CDPL_CHEM_API void CDPL::Chem::clearMatchConstraints ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::MATCH_CONSTRAINTS property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasMatchConstraints() [3/4]

CDPL_CHEM_API bool CDPL::Chem::hasMatchConstraints ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::MATCH_CONSTRAINTS property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMatchExpression() [3/4]

CDPL_CHEM_API const MatchExpression<MolecularGraph>::SharedPointer& CDPL::Chem::getMatchExpression ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::MATCH_EXPRESSION property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored top-level match expression.

◆ setMatchExpression() [3/4]

CDPL_CHEM_API void CDPL::Chem::setMatchExpression ( MolecularGraph molgraph,
const MatchExpression< MolecularGraph >::SharedPointer &  expr 
)

Sets the value of the Chem::MolecularGraphProperty::MATCH_EXPRESSION property of the molecular graph molgraph to expr.

Parameters
molgraphThe molecular graph for which to set the property value.
exprThe new top-level match expression.

◆ clearMatchExpression() [3/4]

CDPL_CHEM_API void CDPL::Chem::clearMatchExpression ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::MATCH_EXPRESSION property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasMatchExpression() [3/4]

CDPL_CHEM_API bool CDPL::Chem::hasMatchExpression ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::MATCH_EXPRESSION property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ generateMatchExpression() [3/6]

CDPL_CHEM_API MatchExpression<MolecularGraph>::SharedPointer CDPL::Chem::generateMatchExpression ( const MolecularGraph molgraph)

Builds a top-level match expression from the match constraints currently attached to the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect.
Returns
The generated match expression.

◆ generateMatchExpression() [4/6]

CDPL_CHEM_API MatchExpression<MolecularGraph>::SharedPointer CDPL::Chem::generateMatchExpression ( MolecularGraph molgraph,
bool  overwrite 
)

Builds and (optionally) stores the top-level match expression of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect/modify.
overwriteIf true, replaces any existing match expression. Otherwise, the existing one (if any) is returned unchanged.
Returns
The generated (or pre-existing) match expression.

◆ getRings()

CDPL_CHEM_API const FragmentList::SharedPointer& CDPL::Chem::getRings ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::RINGS property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored full ring set.

◆ setRings()

CDPL_CHEM_API void CDPL::Chem::setRings ( MolecularGraph molgraph,
const FragmentList::SharedPointer rings 
)

Sets the value of the Chem::MolecularGraphProperty::RINGS property of the molecular graph molgraph to rings.

Parameters
molgraphThe molecular graph for which to set the property value.
ringsThe new full ring set.

◆ clearRings()

CDPL_CHEM_API void CDPL::Chem::clearRings ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::RINGS property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasRings()

CDPL_CHEM_API bool CDPL::Chem::hasRings ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::RINGS property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ perceiveRings() [1/2]

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::perceiveRings ( const MolecularGraph molgraph)

Perceives the full set of rings of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect.
Returns
The perceived ring set.

◆ perceiveRings() [2/2]

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::perceiveRings ( MolecularGraph molgraph,
bool  overwrite 
)

Perceives and (optionally) stores the full set of rings of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect/modify.
overwriteIf true, replaces any existing ring set. Otherwise, the existing one (if any) is returned unchanged.
Returns
The perceived (or pre-existing) ring set.

◆ getSSSR()

CDPL_CHEM_API const FragmentList::SharedPointer& CDPL::Chem::getSSSR ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::SSSR property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored Smallest Set of Smallest Rings.

◆ setSSSR()

CDPL_CHEM_API void CDPL::Chem::setSSSR ( MolecularGraph molgraph,
const FragmentList::SharedPointer sssr 
)

Sets the value of the Chem::MolecularGraphProperty::SSSR property of the molecular graph molgraph to sssr.

Parameters
molgraphThe molecular graph for which to set the property value.
sssrThe new Smallest Set of Smallest Rings.

◆ clearSSSR()

CDPL_CHEM_API void CDPL::Chem::clearSSSR ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::SSSR property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasSSSR()

CDPL_CHEM_API bool CDPL::Chem::hasSSSR ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::SSSR property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ perceiveSSSR() [1/2]

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::perceiveSSSR ( const MolecularGraph molgraph)

Perceives the Smallest Set of Smallest Rings of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect.
Returns
A shared pointer to the perceived SSSR.

◆ perceiveSSSR() [2/2]

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::perceiveSSSR ( MolecularGraph molgraph,
bool  overwrite 
)

Perceives and (optionally) stores the Smallest Set of Smallest Rings of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect/modify.
overwriteIf true, replaces any existing SSSR. Otherwise, the existing one (if any) is returned unchanged.
Returns
The perceived (or pre-existing) SSSR.

◆ extractSSSRSubset() [1/2]

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::extractSSSRSubset ( const MolecularGraph src_molgraph,
const MolecularGraph tgt_molgraph 
)

Extracts the subset of the SSSR of the molecular graph src_molgraph whose rings consist of atoms and bonds of tgt_molgraph.

Parameters
src_molgraphThe source molecular graph whose SSSR is to be projected.
tgt_molgraphThe target molecular graph providing the membership filter.
Returns
The extracted SSSR subset.

◆ extractSSSRSubset() [2/2]

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::extractSSSRSubset ( const MolecularGraph src_molgraph,
MolecularGraph tgt_molgraph,
bool  overwrite 
)

Extracts the SSSR subset of the molecular graph src_molgraph that fits within tgt_molgraph and (optionally) stores it on the latter.

Parameters
src_molgraphThe source molecular graph whose SSSR is to be projected.
tgt_molgraphThe target molecular graph that receives the projected SSSR.
overwriteIf true, replaces any existing SSSR on tgt_molgraph.
Returns
The extracted (or pre-existing) SSSR subset.

◆ getCyclicSubstructure()

CDPL_CHEM_API const Fragment::SharedPointer& CDPL::Chem::getCyclicSubstructure ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::CYCLIC_SUBSTRUCTURE property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored cyclic substructure.

◆ setCyclicSubstructure()

CDPL_CHEM_API void CDPL::Chem::setCyclicSubstructure ( MolecularGraph molgraph,
const Fragment::SharedPointer substruct 
)

Sets the value of the Chem::MolecularGraphProperty::CYCLIC_SUBSTRUCTURE property of the molecular graph molgraph to substruct.

Parameters
molgraphThe molecular graph for which to set the property value.
substructThe new cyclic substructure.

◆ clearCyclicSubstructure()

CDPL_CHEM_API void CDPL::Chem::clearCyclicSubstructure ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::CYCLIC_SUBSTRUCTURE property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasCyclicSubstructure()

CDPL_CHEM_API bool CDPL::Chem::hasCyclicSubstructure ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::CYCLIC_SUBSTRUCTURE property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ perceiveCyclicSubstructure() [1/2]

CDPL_CHEM_API Fragment::SharedPointer CDPL::Chem::perceiveCyclicSubstructure ( const MolecularGraph molgraph)

Perceives the cyclic substructure (union of all rings) of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect.
Returns
The perceived cyclic substructure.

◆ perceiveCyclicSubstructure() [2/2]

CDPL_CHEM_API Fragment::SharedPointer CDPL::Chem::perceiveCyclicSubstructure ( MolecularGraph molgraph,
bool  overwrite 
)

Perceives and (optionally) stores the cyclic substructure of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect/modify.
overwriteIf true, replaces any existing cyclic substructure. Otherwise, the existing one (if any) is returned unchanged.
Returns
The perceived (or pre-existing) cyclic substructure.

◆ getComponents()

CDPL_CHEM_API const FragmentList::SharedPointer& CDPL::Chem::getComponents ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::COMPONENTS property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored connected-component list.

◆ setComponents()

CDPL_CHEM_API void CDPL::Chem::setComponents ( MolecularGraph molgraph,
const FragmentList::SharedPointer comps 
)

Sets the value of the Chem::MolecularGraphProperty::COMPONENTS property of the molecular graph molgraph to comps.

Parameters
molgraphThe molecular graph for which to set the property value.
compsThe new connected-component list.

◆ clearComponents()

CDPL_CHEM_API void CDPL::Chem::clearComponents ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::COMPONENTS property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasComponents()

CDPL_CHEM_API bool CDPL::Chem::hasComponents ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::COMPONENTS property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ perceiveComponents() [1/2]

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::perceiveComponents ( const MolecularGraph molgraph)

Perceives the connected components of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect.
Returns
The perceived connected-component list.

◆ perceiveComponents() [2/2]

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::perceiveComponents ( MolecularGraph molgraph,
bool  overwrite 
)

Perceives and (optionally) stores the connected components of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect/modify.
overwriteIf true, replaces any existing component list. Otherwise, the existing one (if any) is returned unchanged.
Returns
The perceived (or pre-existing) component list.

◆ getComponentGroups() [1/2]

CDPL_CHEM_API const FragmentList::SharedPointer& CDPL::Chem::getComponentGroups ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::COMPONENT_GROUPS property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored component-group fragment list.

◆ setComponentGroups() [1/2]

CDPL_CHEM_API void CDPL::Chem::setComponentGroups ( MolecularGraph molgraph,
const FragmentList::SharedPointer comp_groups 
)

Sets the value of the Chem::MolecularGraphProperty::COMPONENT_GROUPS property of the molecular graph molgraph to comp_groups.

Parameters
molgraphThe molecular graph for which to set the property value.
comp_groupsThe new component-group fragment list.

◆ clearComponentGroups() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearComponentGroups ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::COMPONENT_GROUPS property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasComponentGroups() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasComponentGroups ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::COMPONENT_GROUPS property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ perceiveComponentGroups() [1/4]

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::perceiveComponentGroups ( const MolecularGraph molgraph)

Perceives the component groups of the molecular graph molgraph (from atom-level Chem::AtomProperty::COMPONENT_GROUP_ID values).

Parameters
molgraphThe molecular graph to inspect.
Returns
The perceived component group fragment list.

◆ perceiveComponentGroups() [2/4]

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::perceiveComponentGroups ( MolecularGraph molgraph,
bool  overwrite 
)

Perceives and (optionally) stores the component groups of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect/modify.
overwriteIf true, replaces any existing component group list. Otherwise, the existing one (if any) is returned unchanged.
Returns
The perceived (or pre-existing) component group fragment list.

◆ getConformationIndex()

CDPL_CHEM_API std::size_t CDPL::Chem::getConformationIndex ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::CONFORMATION_INDEX property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored zero-based conformation index.

◆ setConformationIndex()

CDPL_CHEM_API void CDPL::Chem::setConformationIndex ( MolecularGraph molgraph,
std::size_t  index 
)

Sets the value of the Chem::MolecularGraphProperty::CONFORMATION_INDEX property of the molecular graph molgraph to index.

Parameters
molgraphThe molecular graph for which to set the property value.
indexThe new zero-based conformation index.

◆ clearConformationIndex()

CDPL_CHEM_API void CDPL::Chem::clearConformationIndex ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::CONFORMATION_INDEX property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasConformationIndex()

CDPL_CHEM_API bool CDPL::Chem::hasConformationIndex ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::CONFORMATION_INDEX property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getConformerEnergies()

CDPL_CHEM_API const Util::DArray::SharedPointer& CDPL::Chem::getConformerEnergies ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::CONFORMER_ENERGIES property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored per-conformer energy array.

◆ setConformerEnergies()

CDPL_CHEM_API void CDPL::Chem::setConformerEnergies ( MolecularGraph molgraph,
const Util::DArray::SharedPointer &  energies 
)

Sets the value of the Chem::MolecularGraphProperty::CONFORMER_ENERGIES property of the molecular graph molgraph to energies.

Parameters
molgraphThe molecular graph for which to set the property value.
energiesThe new per-conformer energy array.

◆ clearConformerEnergies()

CDPL_CHEM_API void CDPL::Chem::clearConformerEnergies ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::CONFORMER_ENERGIES property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasConformerEnergies()

CDPL_CHEM_API bool CDPL::Chem::hasConformerEnergies ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::CONFORMER_ENERGIES property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ setConformation() [2/2]

CDPL_CHEM_API void CDPL::Chem::setConformation ( MolecularGraph molgraph,
std::size_t  conf_idx,
const Math::Vector3DArray coords,
double  energy 
)

Overwrites the conformation at index conf_idx with the supplied coordinates and energy.

Parameters
molgraphThe molecular graph to modify.
conf_idxThe zero-based conformation index.
coordsThe 3D coordinates of the conformation.
energyThe energy associated with the conformation.

◆ addConformation() [2/2]

CDPL_CHEM_API void CDPL::Chem::addConformation ( MolecularGraph molgraph,
const Math::Vector3DArray coords,
double  energy 
)

Appends a new conformation built from the supplied coordinates and energy.

Parameters
molgraphThe molecular graph to modify.
coordsThe 3D coordinates of the new conformation.
energyThe energy associated with the new conformation.

◆ getConformationEnergy()

CDPL_CHEM_API double CDPL::Chem::getConformationEnergy ( const MolecularGraph molgraph,
std::size_t  conf_idx 
)

Returns the energy of the conformation at index conf_idx.

Parameters
molgraphThe molecular graph to query.
conf_idxThe zero-based conformation index.
Returns
The energy of the requested conformation.

◆ getHashCode()

CDPL_CHEM_API std::uint64_t CDPL::Chem::getHashCode ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::HASH_CODE property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored 64-bit hash code.

◆ setHashCode()

CDPL_CHEM_API void CDPL::Chem::setHashCode ( MolecularGraph molgraph,
std::uint64_t  hash_code 
)

Sets the value of the Chem::MolecularGraphProperty::HASH_CODE property of the molecular graph molgraph to hash_code.

Parameters
molgraphThe molecular graph for which to set the property value.
hash_codeThe new 64-bit hash code.

◆ clearHashCode()

CDPL_CHEM_API void CDPL::Chem::clearHashCode ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::HASH_CODE property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasHashCode()

CDPL_CHEM_API bool CDPL::Chem::hasHashCode ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::HASH_CODE property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ calcHashCode() [1/2]

CDPL_CHEM_API std::uint64_t CDPL::Chem::calcHashCode ( const MolecularGraph molgraph,
unsigned int  atom_flags = AtomPropertyFlag::DEFAULT,
unsigned int  bond_flags = BondPropertyFlag::DEFAULT,
bool  ord_h_deplete = true 
)

Computes a 64-bit hash code for the molecular graph molgraph taking into account the specified atom and bond properties.

Parameters
molgraphThe molecular graph to hash.
atom_flagsA bitmask of Chem::AtomPropertyFlag flags controlling which atomic properties enter the hash.
bond_flagsA bitmask of Chem::BondPropertyFlag flags controlling which bond properties enter the hash.
ord_h_depletetrue to suppress ordinary hydrogens before hashing.
Returns
The computed hash code.

◆ extractReactionCenter()

CDPL_CHEM_API void CDPL::Chem::extractReactionCenter ( const MolecularGraph molgraph,
Fragment rxn_center 
)

Collects every atom and bond of the molecular graph molgraph that carries a reaction-center flag into the fragment rxn_center.

Parameters
molgraphThe molecular graph to inspect.
rxn_centerThe output fragment receiving the reaction-center atoms and bonds.

◆ getStoichiometricNumber()

CDPL_CHEM_API double CDPL::Chem::getStoichiometricNumber ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::STOICHIOMETRIC_NUMBER property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored stoichiometric number.

◆ setStoichiometricNumber()

CDPL_CHEM_API void CDPL::Chem::setStoichiometricNumber ( MolecularGraph molgraph,
double  num 
)

Sets the value of the Chem::MolecularGraphProperty::STOICHIOMETRIC_NUMBER property of the molecular graph molgraph to num.

Parameters
molgraphThe molecular graph for which to set the property value.
numThe new stoichiometric number.

◆ clearStoichiometricNumber()

CDPL_CHEM_API void CDPL::Chem::clearStoichiometricNumber ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::STOICHIOMETRIC_NUMBER property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasStoichiometricNumber()

CDPL_CHEM_API bool CDPL::Chem::hasStoichiometricNumber ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::STOICHIOMETRIC_NUMBER property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLUserInitials() [1/2]

CDPL_CHEM_API const std::string& CDPL::Chem::getMDLUserInitials ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::MDL_USER_INITIALS property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored MDL user initials.

◆ setMDLUserInitials() [1/2]

CDPL_CHEM_API void CDPL::Chem::setMDLUserInitials ( MolecularGraph molgraph,
const std::string &  initials 
)

Sets the value of the Chem::MolecularGraphProperty::MDL_USER_INITIALS property of the molecular graph molgraph to initials.

Parameters
molgraphThe molecular graph for which to set the property value.
initialsThe new MDL user initials.

◆ clearMDLUserInitials() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearMDLUserInitials ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::MDL_USER_INITIALS property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasMDLUserInitials() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasMDLUserInitials ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::MDL_USER_INITIALS property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLProgramName() [1/2]

CDPL_CHEM_API const std::string& CDPL::Chem::getMDLProgramName ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::MDL_PROGRAM_NAME property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored MDL program name.

◆ setMDLProgramName() [1/2]

CDPL_CHEM_API void CDPL::Chem::setMDLProgramName ( MolecularGraph molgraph,
const std::string &  name 
)

Sets the value of the Chem::MolecularGraphProperty::MDL_PROGRAM_NAME property of the molecular graph molgraph to name.

Parameters
molgraphThe molecular graph for which to set the property value.
nameThe new MDL program name.

◆ clearMDLProgramName() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearMDLProgramName ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::MDL_PROGRAM_NAME property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasMDLProgramName() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasMDLProgramName ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::MDL_PROGRAM_NAME property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLRegistryNumber() [1/2]

CDPL_CHEM_API std::size_t CDPL::Chem::getMDLRegistryNumber ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::MDL_REGISTRY_NUMBER property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored MDL registry number.

◆ setMDLRegistryNumber() [1/2]

CDPL_CHEM_API void CDPL::Chem::setMDLRegistryNumber ( MolecularGraph molgraph,
std::size_t  reg_no 
)

Sets the value of the Chem::MolecularGraphProperty::MDL_REGISTRY_NUMBER property of the molecular graph molgraph to reg_no.

Parameters
molgraphThe molecular graph for which to set the property value.
reg_noThe new MDL registry number.

◆ clearMDLRegistryNumber() [1/2]

CDPL_CHEM_API void CDPL::Chem::clearMDLRegistryNumber ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::MDL_REGISTRY_NUMBER property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasMDLRegistryNumber() [1/2]

CDPL_CHEM_API bool CDPL::Chem::hasMDLRegistryNumber ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::MDL_REGISTRY_NUMBER property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLCTABVersion()

CDPL_CHEM_API unsigned int CDPL::Chem::getMDLCTABVersion ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::MDL_CTAB_VERSION property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored CTAB version (see namespace Chem::MDLDataFormatVersion).

◆ setMDLCTABVersion()

CDPL_CHEM_API void CDPL::Chem::setMDLCTABVersion ( MolecularGraph molgraph,
unsigned int  version 
)

Sets the value of the Chem::MolecularGraphProperty::MDL_CTAB_VERSION property of the molecular graph molgraph to version.

Parameters
molgraphThe molecular graph for which to set the property value.
versionThe new CTAB version (see namespace Chem::MDLDataFormatVersion).

◆ clearMDLCTABVersion()

CDPL_CHEM_API void CDPL::Chem::clearMDLCTABVersion ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::MDL_CTAB_VERSION property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasMDLCTABVersion()

CDPL_CHEM_API bool CDPL::Chem::hasMDLCTABVersion ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::MDL_CTAB_VERSION property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getStructureData()

CDPL_CHEM_API const StringDataBlock::SharedPointer& CDPL::Chem::getStructureData ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::STRUCTURE_DATA property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored structure data block.

◆ setStructureData()

CDPL_CHEM_API void CDPL::Chem::setStructureData ( MolecularGraph molgraph,
const StringDataBlock::SharedPointer data 
)

Sets the value of the Chem::MolecularGraphProperty::STRUCTURE_DATA property of the molecular graph molgraph to data.

Parameters
molgraphThe molecular graph for which to set the property value.
dataThe new structure data block.

◆ clearStructureData()

CDPL_CHEM_API void CDPL::Chem::clearStructureData ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::STRUCTURE_DATA property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasStructureData()

CDPL_CHEM_API bool CDPL::Chem::hasStructureData ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::STRUCTURE_DATA property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLDimensionality()

CDPL_CHEM_API std::size_t CDPL::Chem::getMDLDimensionality ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::MDL_DIMENSIONALITY property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored MDL coordinate dimensionality.

◆ setMDLDimensionality()

CDPL_CHEM_API void CDPL::Chem::setMDLDimensionality ( MolecularGraph molgraph,
std::size_t  dim 
)

Sets the value of the Chem::MolecularGraphProperty::MDL_DIMENSIONALITY property of the molecular graph molgraph to dim.

Parameters
molgraphThe molecular graph for which to set the property value.
dimThe new MDL coordinate dimensionality.

◆ clearMDLDimensionality()

CDPL_CHEM_API void CDPL::Chem::clearMDLDimensionality ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::MDL_DIMENSIONALITY property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasMDLDimensionality()

CDPL_CHEM_API bool CDPL::Chem::hasMDLDimensionality ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::MDL_DIMENSIONALITY property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLScalingFactor1()

CDPL_CHEM_API long CDPL::Chem::getMDLScalingFactor1 ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR1 property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored MDL scaling factor 1.

◆ setMDLScalingFactor1()

CDPL_CHEM_API void CDPL::Chem::setMDLScalingFactor1 ( MolecularGraph molgraph,
long  factor 
)

Sets the value of the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR1 property of the molecular graph molgraph to factor.

Parameters
molgraphThe molecular graph for which to set the property value.
factorThe new MDL scaling factor 1.

◆ clearMDLScalingFactor1()

CDPL_CHEM_API void CDPL::Chem::clearMDLScalingFactor1 ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR1 property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasMDLScalingFactor1()

CDPL_CHEM_API bool CDPL::Chem::hasMDLScalingFactor1 ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR1 property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLScalingFactor2()

CDPL_CHEM_API double CDPL::Chem::getMDLScalingFactor2 ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR2 property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored MDL scaling factor 2.

◆ setMDLScalingFactor2()

CDPL_CHEM_API void CDPL::Chem::setMDLScalingFactor2 ( MolecularGraph molgraph,
double  factor 
)

Sets the value of the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR2 property of the molecular graph molgraph to factor.

Parameters
molgraphThe molecular graph for which to set the property value.
factorThe new MDL scaling factor 2.

◆ clearMDLScalingFactor2()

CDPL_CHEM_API void CDPL::Chem::clearMDLScalingFactor2 ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR2 property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasMDLScalingFactor2()

CDPL_CHEM_API bool CDPL::Chem::hasMDLScalingFactor2 ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::MDL_SCALING_FACTOR2 property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLEnergy()

CDPL_CHEM_API double CDPL::Chem::getMDLEnergy ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::MDL_ENERGY property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored MDL energy.

◆ setMDLEnergy()

CDPL_CHEM_API void CDPL::Chem::setMDLEnergy ( MolecularGraph molgraph,
double  energy 
)

Sets the value of the Chem::MolecularGraphProperty::MDL_ENERGY property of the molecular graph molgraph to energy.

Parameters
molgraphThe molecular graph for which to set the property value.
energyThe new MDL energy.

◆ clearMDLEnergy()

CDPL_CHEM_API void CDPL::Chem::clearMDLEnergy ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::MDL_ENERGY property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasMDLEnergy()

CDPL_CHEM_API bool CDPL::Chem::hasMDLEnergy ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::MDL_ENERGY property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLChiralFlag()

CDPL_CHEM_API bool CDPL::Chem::getMDLChiralFlag ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::MDL_CHIRAL_FLAG property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored MDL chiral flag.

◆ setMDLChiralFlag()

CDPL_CHEM_API void CDPL::Chem::setMDLChiralFlag ( MolecularGraph molgraph,
bool  flag 
)

Sets the value of the Chem::MolecularGraphProperty::MDL_CHIRAL_FLAG property of the molecular graph molgraph to flag.

Parameters
molgraphThe molecular graph for which to set the property value.
flagThe new MDL chiral flag.

◆ clearMDLChiralFlag()

CDPL_CHEM_API void CDPL::Chem::clearMDLChiralFlag ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::MDL_CHIRAL_FLAG property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasMDLChiralFlag()

CDPL_CHEM_API bool CDPL::Chem::hasMDLChiralFlag ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::MDL_CHIRAL_FLAG property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMOL2MoleculeType()

CDPL_CHEM_API unsigned int CDPL::Chem::getMOL2MoleculeType ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::MOL2_MOLECULE_TYPE property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored Sybyl MOL2 molecule type (see namespace Chem::MOL2MoleculeType).

◆ setMOL2MoleculeType()

CDPL_CHEM_API void CDPL::Chem::setMOL2MoleculeType ( MolecularGraph molgraph,
unsigned int  type 
)

Sets the value of the Chem::MolecularGraphProperty::MOL2_MOLECULE_TYPE property of the molecular graph molgraph to type.

Parameters
molgraphThe molecular graph for which to set the property value.
typeThe new Sybyl MOL2 molecule type (see namespace Chem::MOL2MoleculeType).

◆ clearMOL2MoleculeType()

CDPL_CHEM_API void CDPL::Chem::clearMOL2MoleculeType ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::MOL2_MOLECULE_TYPE property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasMOL2MoleculeType()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2MoleculeType ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::MOL2_MOLECULE_TYPE property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMOL2ChargeType()

CDPL_CHEM_API unsigned int CDPL::Chem::getMOL2ChargeType ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::MOL2_CHARGE_TYPE property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored Sybyl MOL2 charge type (see namespace Chem::MOL2ChargeType).

◆ setMOL2ChargeType()

CDPL_CHEM_API void CDPL::Chem::setMOL2ChargeType ( MolecularGraph molgraph,
unsigned int  type 
)

Sets the value of the Chem::MolecularGraphProperty::MOL2_CHARGE_TYPE property of the molecular graph molgraph to type.

Parameters
molgraphThe molecular graph for which to set the property value.
typeThe new Sybyl MOL2 charge type (see namespace Chem::MOL2ChargeType).

◆ clearMOL2ChargeType()

CDPL_CHEM_API void CDPL::Chem::clearMOL2ChargeType ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::MOL2_CHARGE_TYPE property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasMOL2ChargeType()

CDPL_CHEM_API bool CDPL::Chem::hasMOL2ChargeType ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::MOL2_CHARGE_TYPE property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ generateAdjacencyMatrix()

CDPL_CHEM_API void CDPL::Chem::generateAdjacencyMatrix ( const MolecularGraph molgraph,
Math::SparseULMatrix mtx 
)

Builds the adjacency matrix of the molecular graph molgraph (entry (i,j) is the bond count between atoms i and j).

Parameters
molgraphThe molecular graph to inspect.
mtxThe output sparse matrix receiving the adjacency entries.

◆ generateIncidenceMatrix()

CDPL_CHEM_API void CDPL::Chem::generateIncidenceMatrix ( const MolecularGraph molgraph,
Math::SparseULMatrix mtx 
)

Builds the atom/bond incidence matrix of the molecular graph molgraph (entry (i,j) is 1 if atom i is an endpoint of bond j).

Parameters
molgraphThe molecular graph to inspect.
mtxThe output sparse matrix receiving the incidence entries.

◆ generateBondMatrix()

CDPL_CHEM_API void CDPL::Chem::generateBondMatrix ( const MolecularGraph molgraph,
Math::SparseULMatrix mtx 
)

Builds the bond order matrix of the molecular graph molgraph (entry (i,j) is the order of the bond between atoms i and j).

Parameters
molgraphThe molecular graph to inspect.
mtxThe output sparse matrix receiving the bond order entries.

◆ generateBondElectronMatrix()

CDPL_CHEM_API void CDPL::Chem::generateBondElectronMatrix ( const MolecularGraph molgraph,
Math::SparseULMatrix mtx 
)

Builds the bond-electron-count matrix of the molecular graph molgraph (entry (i,j) is the number of bonding electrons between atoms i and j).

Parameters
molgraphThe molecular graph to inspect.
mtxThe output sparse matrix receiving the bond-electron counts.

◆ generateBondAtomTypeMatrix()

CDPL_CHEM_API void CDPL::Chem::generateBondAtomTypeMatrix ( const MolecularGraph molgraph,
Math::SparseULMatrix mtx 
)

Builds a matrix combining bond order and atom type information of the endpoints of every bond in molgraph.

Parameters
molgraphThe molecular graph to inspect.
mtxThe output sparse matrix receiving the combined entries.

◆ getTopologicalDistanceMatrix()

CDPL_CHEM_API const Math::ULMatrix::SharedPointer& CDPL::Chem::getTopologicalDistanceMatrix ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::TOPOLOGICAL_DISTANCE_MATRIX property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored topological-distance matrix.

◆ setTopologicalDistanceMatrix()

CDPL_CHEM_API void CDPL::Chem::setTopologicalDistanceMatrix ( MolecularGraph molgraph,
const Math::ULMatrix::SharedPointer &  mtx 
)

Sets the value of the Chem::MolecularGraphProperty::TOPOLOGICAL_DISTANCE_MATRIX property of the molecular graph molgraph to mtx.

Parameters
molgraphThe molecular graph for which to set the property value.
mtxThe new topological-distance matrix.

◆ clearTopologicalDistanceMatrix()

CDPL_CHEM_API void CDPL::Chem::clearTopologicalDistanceMatrix ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::TOPOLOGICAL_DISTANCE_MATRIX property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasTopologicalDistanceMatrix()

CDPL_CHEM_API bool CDPL::Chem::hasTopologicalDistanceMatrix ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::TOPOLOGICAL_DISTANCE_MATRIX property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ calcTopologicalDistanceMatrix() [1/2]

CDPL_CHEM_API Math::ULMatrix::SharedPointer CDPL::Chem::calcTopologicalDistanceMatrix ( MolecularGraph molgraph,
bool  overwrite 
)

Computes and (optionally) stores the topological-distance matrix of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect/modify.
overwriteIf true, replaces any existing topological-distance matrix.
Returns
The computed (or pre-existing) matrix.

◆ calcTopologicalDistanceMatrix() [2/2]

CDPL_CHEM_API void CDPL::Chem::calcTopologicalDistanceMatrix ( const MolecularGraph molgraph,
Math::ULMatrix mtx 
)

Computes the topological-distance matrix of the molecular graph molgraph into the supplied mtx.

Parameters
molgraphThe molecular graph to inspect.
mtxThe output dense matrix receiving the topological distances.

◆ extractTopologicalDistanceSubMatrix() [1/2]

CDPL_CHEM_API Math::ULMatrix::SharedPointer CDPL::Chem::extractTopologicalDistanceSubMatrix ( const MolecularGraph src_molgraph,
MolecularGraph tgt_molgraph,
bool  overwrite 
)

Extracts the topological-distance sub-matrix of the molecular graph src_molgraph that covers the atoms of tgt_molgraph and (optionally) stores it on the latter.

Parameters
src_molgraphThe source molecular graph providing the full matrix.
tgt_molgraphThe target molecular graph providing the atom subset and (optionally) receiving the sub-matrix.
overwriteIf true, replaces any existing matrix on tgt_molgraph.
Returns
The extracted (or pre-existing) sub-matrix.

◆ extractTopologicalDistanceSubMatrix() [2/2]

CDPL_CHEM_API void CDPL::Chem::extractTopologicalDistanceSubMatrix ( const MolecularGraph src_molgraph,
const MolecularGraph tgt_molgraph,
Math::ULMatrix mtx 
)

Extracts the topological-distance sub-matrix of the molecular graph src_molgraph that covers the atoms of tgt_molgraph into the supplied mtx.

Parameters
src_molgraphThe source molecular graph providing the full matrix.
tgt_molgraphThe target molecular graph providing the atom subset.
mtxThe output dense matrix receiving the sub-matrix entries.

◆ getGeometricalDistanceMatrix()

CDPL_CHEM_API const Math::DMatrix::SharedPointer& CDPL::Chem::getGeometricalDistanceMatrix ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::GEOMETRICAL_DISTANCE_MATRIX property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored geometrical-distance matrix.

◆ setGeometricalDistanceMatrix()

CDPL_CHEM_API void CDPL::Chem::setGeometricalDistanceMatrix ( MolecularGraph molgraph,
const Math::DMatrix::SharedPointer mtx 
)

Sets the value of the Chem::MolecularGraphProperty::GEOMETRICAL_DISTANCE_MATRIX property of the molecular graph molgraph to mtx.

Parameters
molgraphThe molecular graph for which to set the property value.
mtxThe new geometrical-distance matrix.

◆ clearGeometricalDistanceMatrix()

CDPL_CHEM_API void CDPL::Chem::clearGeometricalDistanceMatrix ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::GEOMETRICAL_DISTANCE_MATRIX property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasGeometricalDistanceMatrix()

CDPL_CHEM_API bool CDPL::Chem::hasGeometricalDistanceMatrix ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::GEOMETRICAL_DISTANCE_MATRIX property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ calcGeometricalDistanceMatrix() [2/2]

CDPL_CHEM_API Math::DMatrix::SharedPointer CDPL::Chem::calcGeometricalDistanceMatrix ( MolecularGraph molgraph,
bool  overwrite 
)

Computes and (optionally) stores the geometrical-distance matrix of the molecular graph molgraph from its 3D coordinates.

Parameters
molgraphThe molecular graph to inspect/modify.
overwriteIf true, replaces any existing geometrical-distance matrix.
Returns
The computed (or pre-existing) matrix.

◆ getAromaticSubstructure()

CDPL_CHEM_API const Fragment::SharedPointer& CDPL::Chem::getAromaticSubstructure ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::AROMATIC_SUBSTRUCTURE property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored aromatic substructure.

◆ setAromaticSubstructure()

CDPL_CHEM_API void CDPL::Chem::setAromaticSubstructure ( MolecularGraph molgraph,
const Fragment::SharedPointer substruct 
)

Sets the value of the Chem::MolecularGraphProperty::AROMATIC_SUBSTRUCTURE property of the molecular graph molgraph to substruct.

Parameters
molgraphThe molecular graph for which to set the property value.
substructThe new aromatic substructure.

◆ clearAromaticSubstructure()

CDPL_CHEM_API void CDPL::Chem::clearAromaticSubstructure ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::AROMATIC_SUBSTRUCTURE property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasAromaticSubstructure()

CDPL_CHEM_API bool CDPL::Chem::hasAromaticSubstructure ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::AROMATIC_SUBSTRUCTURE property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ perceiveAromaticSubstructure() [1/2]

CDPL_CHEM_API Fragment::SharedPointer CDPL::Chem::perceiveAromaticSubstructure ( const MolecularGraph molgraph)

Perceives the aromatic substructure of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect.
Returns
The perceived aromatic substructure.

◆ perceiveAromaticSubstructure() [2/2]

CDPL_CHEM_API Fragment::SharedPointer CDPL::Chem::perceiveAromaticSubstructure ( MolecularGraph molgraph,
bool  overwrite 
)

Perceives and (optionally) stores the aromatic substructure of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect/modify.
overwriteIf true, replaces any existing aromatic substructure.
Returns
The perceived (or pre-existing) aromatic substructure.

◆ getPiElectronSystems()

CDPL_CHEM_API const ElectronSystemList::SharedPointer& CDPL::Chem::getPiElectronSystems ( const MolecularGraph molgraph)

Returns the value of the Chem::MolecularGraphProperty::PI_ELECTRON_SYSTEMS property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to return the property value.
Returns
The stored pi-electron-system list.

◆ setPiElectronSystems()

CDPL_CHEM_API void CDPL::Chem::setPiElectronSystems ( MolecularGraph molgraph,
const ElectronSystemList::SharedPointer pi_systems 
)

Sets the value of the Chem::MolecularGraphProperty::PI_ELECTRON_SYSTEMS property of the molecular graph molgraph to pi_systems.

Parameters
molgraphThe molecular graph for which to set the property value.
pi_systemsThe new pi-electron-system list.

◆ clearPiElectronSystems()

CDPL_CHEM_API void CDPL::Chem::clearPiElectronSystems ( MolecularGraph molgraph)

Clears the value of the Chem::MolecularGraphProperty::PI_ELECTRON_SYSTEMS property of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to clear the property value.

◆ hasPiElectronSystems()

CDPL_CHEM_API bool CDPL::Chem::hasPiElectronSystems ( const MolecularGraph molgraph)

Tells whether the Chem::MolecularGraphProperty::PI_ELECTRON_SYSTEMS property of the molecular graph molgraph is set.

Parameters
molgraphThe molecular graph for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ perceivePiElectronSystems() [1/2]

CDPL_CHEM_API ElectronSystemList::SharedPointer CDPL::Chem::perceivePiElectronSystems ( const MolecularGraph molgraph)

Perceives the pi-electron systems of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect.
Returns
The perceived pi-electron-system list.

◆ perceivePiElectronSystems() [2/2]

CDPL_CHEM_API ElectronSystemList::SharedPointer CDPL::Chem::perceivePiElectronSystems ( MolecularGraph molgraph,
bool  overwrite 
)

Perceives and (optionally) stores the pi-electron systems of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect/modify.
overwriteIf true, replaces any existing pi-electron-system list.
Returns
The perceived (or pre-existing) pi-electron-system list.

◆ generateSMILES() [1/2]

CDPL_CHEM_API bool CDPL::Chem::generateSMILES ( const MolecularGraph molgraph,
std::string &  smiles,
bool  canonical = false,
bool  ord_h_deplete = true,
unsigned int  atom_flags = AtomPropertyFlag::DEFAULT,
unsigned int  bond_flags = BondPropertyFlag::DEFAULT 
)

Generates a SMILES string for the molecular graph molgraph.

Parameters
molgraphThe molecular graph to encode.
smilesThe string receiving the generated SMILES.
canonicaltrue to emit a canonical SMILES.
ord_h_depletetrue to suppress the output of ordinary hydrogens.
atom_flagsA bitmask of Chem::AtomPropertyFlag flags controlling which atomic properties to encode.
bond_flagsA bitmask of Chem::BondPropertyFlag flags controlling which bond properties to encode.
Returns
true on success, and false if an unrecoverable error was encountered.

◆ generateINCHI()

CDPL_CHEM_API int CDPL::Chem::generateINCHI ( const MolecularGraph molgraph,
std::string &  inchi,
const std::string &  options = ControlParameterDefault::INCHI_OUTPUT_OPTIONS,
std::size_t  dim = 0 
)

Generates an InChI string for the molecular graph molgraph using the InChI C-API.

Parameters
molgraphThe molecular graph to encode.
inchiThe string receiving the generated InChI.
optionsThe InChI C-API option string (see Chem::ControlParameter::INCHI_OUTPUT_OPTIONS).
dimThe dimensionality of the atomic coordinates to forward to the InChI library.
Returns
The InChI return code (see namespace Chem::INCHIReturnCode).

◆ generateINCHIKey()

CDPL_CHEM_API int CDPL::Chem::generateINCHIKey ( const MolecularGraph molgraph,
std::string &  inchi_key 
)

Generates an InChIKey for the molecular graph molgraph using the InChI C-API.

Parameters
molgraphThe molecular graph to encode.
inchi_keyThe string receiving the generated InChIKey.
Returns
The InChI return code (see namespace Chem::INCHIReturnCode).

◆ canonicalize() [1/2]

CDPL_CHEM_API void CDPL::Chem::canonicalize ( MolecularGraph molgraph,
const AtomCompareFunction func,
bool  atoms = true,
bool  atom_nbrs = true,
bool  bonds = true,
bool  bond_atoms = false 
)

Reorders the atoms (and optionally their neighbors and bonds) of the molecular graph molgraph according to a user-supplied comparator.

Parameters
molgraphThe molecular graph to canonicalize.
funcThe atom comparator that defines the canonical ordering.
atomstrue to sort atoms.
atom_nbrstrue to sort each atom's neighbor list.
bondstrue to sort bonds.
bond_atomstrue to reorder the start/end atoms of each bond according to the comparator.

◆ canonicalize() [2/2]

CDPL_CHEM_API void CDPL::Chem::canonicalize ( MolecularGraph molgraph,
bool  atoms = true,
bool  atom_nbrs = true,
bool  bonds = true,
bool  bond_atoms = false 
)

Reorders the atoms (and optionally their neighbors and bonds) of the molecular graph molgraph according to the canonical-numbering attached to its atoms.

Parameters
molgraphThe molecular graph to canonicalize.
atomstrue to sort atoms.
atom_nbrstrue to sort each atom's neighbor list.
bondstrue to sort bonds.
bond_atomstrue to reorder the start/end atoms of each bond.

◆ calc2DCoordinates()

CDPL_CHEM_API void CDPL::Chem::calc2DCoordinates ( MolecularGraph molgraph,
bool  overwrite 
)

Computes 2D atom coordinates for the molecular graph molgraph and stores them as Chem::AtomProperty::COORDINATES_2D.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing 2D coordinates. Otherwise, leaves atoms that already carry coordinates unchanged.

◆ align2DCoordinates() [1/4]

CDPL_CHEM_API bool CDPL::Chem::align2DCoordinates ( MolecularGraph molgraph,
const AtomContainer atoms,
const Math::Vector2DArray ref_coords,
bool  fix_bond_stereo = true 
)

Aligns molgraph's 2D coordinates so that the atoms of atoms come to lie at the reference coordinates ref_coords.

Parameters
molgraphThe molecular graph to align.
atomsThe atoms used as alignment anchors.
ref_coordsReference 2D coordinates of the alignment-anchor atoms.
fix_bond_stereoIf true, postprocess bond stereo flags so that they remain consistent with the aligned coordinates.
Returns
true if the alignment succeeded, and false otherwise.
Since
1.3

◆ align2DCoordinates() [2/4]

CDPL_CHEM_API bool CDPL::Chem::align2DCoordinates ( MolecularGraph molgraph,
const AtomMapping ref_atom_mpg,
bool  fix_bond_stereo = true 
)

Aligns molgraph's 2D coordinates onto a reference atom mapping.

Parameters
molgraphThe molecular graph to align.
ref_atom_mpgThe atom mapping providing the target atom→atom correspondence.
fix_bond_stereoIf true, postprocess bond stereo flags so that they remain consistent with the aligned coordinates.
Returns
true if the alignment succeeded, and false otherwise.
Since
1.3

◆ align2DCoordinates() [3/4]

CDPL_CHEM_API bool CDPL::Chem::align2DCoordinates ( MolecularGraph molgraph,
const MolecularGraph ref_molgraph,
bool  use_mcss,
bool  fix_bond_stereo = true 
)

Aligns molgraph's 2D coordinates onto those of ref_molgraph, using either a maximum-common-substructure search or substructure matching.

Parameters
molgraphThe molecular graph to align.
ref_molgraphThe reference molecular graph providing the target coordinates.
use_mcssIf true, the atom correspondence is found by maximum-common-substructure search. Otherwise, by substructure matching.
fix_bond_stereoIf true, postprocess bond stereo flags so that they remain consistent with the aligned coordinates.
Returns
true if the alignment succeeded, and false otherwise.
Since
1.3

◆ align2DCoordinates() [4/4]

CDPL_CHEM_API bool CDPL::Chem::align2DCoordinates ( MolecularGraph molgraph,
const MolecularGraph ref_molgraph,
const MolecularGraph substr_ptn,
bool  fix_bond_stereo = true 
)

Aligns molgraph's 2D coordinates onto those of ref_molgraph, using substr_ptn as the explicit substructure pattern.

Parameters
molgraphThe molecular graph to align.
ref_molgraphThe reference molecular graph providing the target coordinates.
substr_ptnThe substructure pattern that defines the atom correspondence.
fix_bond_stereoIf true, postprocess bond stereo flags so that they remain consistent with the aligned coordinates.
Returns
true if the alignment succeeded, and false otherwise.
Since
1.3

◆ calcHydrogen3DCoordinates()

CDPL_CHEM_API void CDPL::Chem::calcHydrogen3DCoordinates ( MolecularGraph molgraph,
bool  undef_only = true 
)

Computes 3D coordinates for the hydrogen atoms of the molecular graph molgraph from the geometry of their non-hydrogen neighbors.

Parameters
molgraphThe molecular graph to modify.
undef_onlyIf true, only hydrogens without prior 3D coordinates are placed. If false, all hydrogen coordinates are recomputed.

◆ calcBond2DStereoFlags()

CDPL_CHEM_API void CDPL::Chem::calcBond2DStereoFlags ( MolecularGraph molgraph,
bool  overwrite 
)

Derives 2D wedge/hash bond stereo flags for the bonds of the molecular graph molgraph from the atoms' stereo descriptors and 2D layout.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing 2D stereo flags.

◆ calcCIPPriorities()

CDPL_CHEM_API void CDPL::Chem::calcCIPPriorities ( MolecularGraph molgraph,
bool  overwrite 
)

Computes and stores CIP priorities for the atoms of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing CIP-priority values.

◆ perceiveSymmetryClasses()

CDPL_CHEM_API void CDPL::Chem::perceiveSymmetryClasses ( MolecularGraph molgraph,
bool  overwrite,
unsigned int  atom_flags = AtomPropertyFlag::DEFAULT,
unsigned int  bond_flags = BondPropertyFlag::DEFAULT,
bool  inc_impl_h = true 
)

Computes and stores topological-symmetry classes for the atoms of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing symmetry-class IDs.
atom_flagsA bitmask of Chem::AtomPropertyFlag flags controlling which atomic properties enter the perception.
bond_flagsA bitmask of Chem::BondPropertyFlag flags controlling which bond properties enter the perception.
inc_impl_hIf true, implicit hydrogens are treated as if they were explicit. Otherwise, they are ignored.

◆ calcCanonicalNumbering()

CDPL_CHEM_API void CDPL::Chem::calcCanonicalNumbering ( MolecularGraph molgraph,
bool  overwrite,
unsigned int  atom_flags = AtomPropertyFlag::DEFAULT,
unsigned int  bond_flags = BondPropertyFlag::DEFAULT 
)

Computes and stores canonical atom numbers for the atoms of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing canonical numbers.
atom_flagsA bitmask of Chem::AtomPropertyFlag flags controlling which atomic properties enter the numbering.
bond_flagsA bitmask of Chem::BondPropertyFlag flags controlling which bond properties enter the numbering.

◆ calcMorganNumbering()

CDPL_CHEM_API void CDPL::Chem::calcMorganNumbering ( MolecularGraph molgraph,
bool  overwrite 
)

Computes and stores Morgan numbers for the atoms of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing Morgan numbers.

◆ calcImplicitHydrogenCounts()

CDPL_CHEM_API void CDPL::Chem::calcImplicitHydrogenCounts ( MolecularGraph molgraph,
bool  overwrite 
)

Computes and stores implicit-hydrogen counts for the atoms of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing implicit-hydrogen counts.

◆ calcFormalCharges()

CDPL_CHEM_API void CDPL::Chem::calcFormalCharges ( MolecularGraph molgraph,
bool  overwrite 
)

Computes and stores formal charges for the atoms of the molecular graph molgraph from their valence environment.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing formal charges.

◆ perceiveHybridizationStates()

CDPL_CHEM_API void CDPL::Chem::perceiveHybridizationStates ( MolecularGraph molgraph,
bool  overwrite 
)

Computes and stores hybridization states for the atoms of the molecular graph molgraph from their valence environment.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing hybridization states.

◆ perceiveBondOrders()

CDPL_CHEM_API void CDPL::Chem::perceiveBondOrders ( MolecularGraph molgraph,
bool  overwrite 
)

Perceives bond orders for the bonds of the molecular graph molgraph from atom geometry and ligand environment.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing bond orders.

◆ kekulizeBonds()

CDPL_CHEM_API void CDPL::Chem::kekulizeBonds ( MolecularGraph molgraph)

Assigns Kekulé bond orders to the aromatic bonds of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.

◆ perceiveAtomStereoCenters()

CDPL_CHEM_API void CDPL::Chem::perceiveAtomStereoCenters ( MolecularGraph molgraph,
bool  overwrite,
bool  check_asym = true,
bool  check_inv_n = true,
bool  check_quart_n = true,
bool  check_plan_n = true,
bool  check_amide_n = true,
bool  check_res_ctrs = true 
)

Flags the atoms of the molecular graph molgraph that qualify as stereo centers under the supplied criteria.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing stereo-center flags.
check_asymtrue to enforce non-equivalent ligand environments.
check_inv_ntrue to reject inversion-prone nitrogen centers.
check_quart_ntrue to accept positively charged quaternary nitrogen centers.
check_plan_ntrue to reject planar nitrogen centers.
check_amide_ntrue to reject amide-nitrogen centers.
check_res_ctrstrue to reject centers participating in resonance.

◆ perceiveBondStereoCenters()

CDPL_CHEM_API void CDPL::Chem::perceiveBondStereoCenters ( MolecularGraph molgraph,
bool  overwrite,
bool  check_asym = true,
bool  check_term_n = true,
bool  check_order = true,
std::size_t  min_ring_size = 8 
)

Flags the bonds of the molecular graph molgraph that qualify as stereo centers under the supplied criteria.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing stereo-center flags.
check_asymtrue to enforce non-equivalent ligand environments.
check_term_ntrue to reject bonds to terminal nitrogen atoms.
check_ordertrue to require that the bond order matches a stereogenic pattern.
min_ring_sizeThe minimum ring size required for ring bonds to qualify.

◆ calcMDLParities()

CDPL_CHEM_API void CDPL::Chem::calcMDLParities ( MolecularGraph molgraph,
bool  overwrite 
)

Computes and stores MDL parities for the atoms of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing MDL parities.

◆ calcAtomStereoDescriptors()

CDPL_CHEM_API void CDPL::Chem::calcAtomStereoDescriptors ( MolecularGraph molgraph,
bool  overwrite,
std::size_t  dim = 1,
bool  check_stc_flag = true 
)

Computes and stores stereo descriptors for the atoms of the molecular graph molgraph from their geometric layout.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing stereo descriptors.
dimThe dimensionality of the atomic coordinates to use (2 or 3).
check_stc_flagIf true, descriptors are only computed for atoms whose Chem::AtomProperty::STEREO_CENTER_FLAG is set.

◆ calcAtomStereoDescriptorsFromMDLParities()

CDPL_CHEM_API void CDPL::Chem::calcAtomStereoDescriptorsFromMDLParities ( MolecularGraph molgraph,
bool  overwrite 
)

Derives atom stereo descriptors of the molecular graph molgraph from previously-assigned MDL parities.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing stereo descriptors.

◆ calcBondStereoDescriptors()

CDPL_CHEM_API void CDPL::Chem::calcBondStereoDescriptors ( MolecularGraph molgraph,
bool  overwrite,
std::size_t  dim = 1,
bool  check_stc_flag = true 
)

Computes and stores stereo descriptors for the bonds of the molecular graph molgraph from their geometric layout.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing stereo descriptors.
dimThe dimensionality of the atomic coordinates to use (2 or 3).
check_stc_flagIf true, descriptors are only computed for bonds whose Chem::BondProperty::STEREO_CENTER_FLAG is set.

◆ calcAtomCIPConfigurations()

CDPL_CHEM_API void CDPL::Chem::calcAtomCIPConfigurations ( MolecularGraph molgraph,
bool  overwrite 
)

Computes and stores CIP configuration labels for the atoms of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing CIP configuration labels.

◆ calcBondCIPConfigurations()

CDPL_CHEM_API void CDPL::Chem::calcBondCIPConfigurations ( MolecularGraph molgraph,
bool  overwrite 
)

Computes and stores CIP configuration labels for the bonds of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing CIP configuration labels.

◆ setAtomMatchConstraints() [1/2]

CDPL_CHEM_API void CDPL::Chem::setAtomMatchConstraints ( MolecularGraph molgraph,
const MatchConstraintList::SharedPointer constr,
bool  overwrite 
)

Sets the atom-level match constraint list constr on every atom of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
constrThe match constraint list to assign.
overwriteIf true, replaces any existing per-atom constraints. If false, leaves atoms that already carry a list unchanged.

◆ setBondMatchConstraints() [1/2]

CDPL_CHEM_API void CDPL::Chem::setBondMatchConstraints ( MolecularGraph molgraph,
const MatchConstraintList::SharedPointer constr,
bool  overwrite 
)

Sets the bond-level match constraint list constr on every bond of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
constrThe match constraint list to assign.
overwriteIf true, replaces any existing per-bond constraints. If false, leaves bonds that already carry a list unchanged.

◆ generateMatchExpressions() [1/2]

CDPL_CHEM_API void CDPL::Chem::generateMatchExpressions ( MolecularGraph molgraph,
bool  overwrite 
)

Generates and stores match expressions for every atom, bond and the molecular graph molgraph itself.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing match expressions. If false, leaves atoms/bonds that already carry a match expression unchanged.

◆ generateMatchExpressionStrings()

CDPL_CHEM_API void CDPL::Chem::generateMatchExpressionStrings ( MolecularGraph molgraph,
bool  overwrite 
)

Generates and stores textual representations of the atom/bond match expressions of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing match expression strings. If false, leaves atoms/bonds that already carry a match expression string unchanged.

◆ initSubstructureSearchQuery() [1/2]

CDPL_CHEM_API void CDPL::Chem::initSubstructureSearchQuery ( MolecularGraph molgraph,
bool  overwrite 
)

Prepares the molecular graph molgraph for use as a substructure search query.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, recomputes and stores any required property values. If false, leaves already available property values unchanged.

◆ initSubstructureSearchTarget() [1/2]

CDPL_CHEM_API void CDPL::Chem::initSubstructureSearchTarget ( MolecularGraph molgraph,
bool  overwrite 
)

Prepares the molecular graph molgraph for use as a substructure search target.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, recomputes and stores any required property values. If false, leaves already available property values unchanged.

◆ setAromaticityFlags()

CDPL_CHEM_API void CDPL::Chem::setAromaticityFlags ( MolecularGraph molgraph,
bool  overwrite 
)

Perceives aromaticity and sets the corresponding atom/bond aromaticity flags on the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing aromaticity flags.

◆ setRingFlags()

CDPL_CHEM_API void CDPL::Chem::setRingFlags ( MolecularGraph molgraph,
bool  overwrite 
)

Perceives ring membership and sets the corresponding atom/bond ring flags on the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing ring flags.

◆ setAtomTypesFromSymbols()

CDPL_CHEM_API void CDPL::Chem::setAtomTypesFromSymbols ( MolecularGraph molgraph,
bool  overwrite 
)

Sets the atom types of the molecular graph molgraph from their element symbols.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing atom types.

◆ setAtomSymbolsFromTypes()

CDPL_CHEM_API void CDPL::Chem::setAtomSymbolsFromTypes ( MolecularGraph molgraph,
bool  overwrite 
)

Sets the atom symbols of the molecular graph molgraph from their atom types.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing atom symbols.

◆ perceiveSybylAtomTypes()

CDPL_CHEM_API void CDPL::Chem::perceiveSybylAtomTypes ( MolecularGraph molgraph,
bool  overwrite 
)

Perceives Sybyl atom types for the atoms of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, replaces any existing Sybyl atom types.

◆ getAromaticRings()

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::getAromaticRings ( const MolecularGraph molgraph)

Returns the subset of the aromatic rings of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to inspect.
Returns
The aromatic rings.

◆ getAromaticSSSRSubset()

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::getAromaticSSSRSubset ( const MolecularGraph molgraph)

Returns the subset of the SSSR of the molecular graph molgraph that contains only aromatic rings,.

Parameters
molgraphThe molecular graph to inspect.
Returns
The aromatic-SSSR subset.

◆ containsMolecularGraph()

CDPL_CHEM_API bool CDPL::Chem::containsMolecularGraph ( const MolecularGraph molgraph,
const MolecularGraph sub_molgraph,
bool  atoms = true,
bool  bonds = true 
)

Tells whether the molecular graph molgraph contains the atoms and/or bonds of sub_molgraph.

Parameters
molgraphThe host molecular graph.
sub_molgraphThe candidate sub-graph.
atomsIf true, every atom of sub_molgraph must be a member of the molecular graph molgraph.
bondsIf true, every bond of sub_molgraph must be a member of the molecular graph molgraph.
Returns
true if the requested containment relations all hold, and false otherwise.

◆ getContainedFragments()

CDPL_CHEM_API void CDPL::Chem::getContainedFragments ( const MolecularGraph molgraph,
const FragmentList frag_list,
FragmentList cont_frag_list,
bool  append = false,
bool  atoms = true,
bool  bonds = true 
)

Collects the fragments in frag_list that are fully contained in the molecular graph molgraph into cont_frag_list.

Parameters
molgraphThe host molecular graph.
frag_listThe candidate fragment list.
cont_frag_listThe output fragment list receiving the matches.
appendIf true, matches are appended to cont_frag_list. Otherwise, it is cleared first.
atomsIf true, atom membership is required for a match.
bondsIf true, bond membership is required for a match.

◆ getContainingFragments() [3/3]

CDPL_CHEM_API void CDPL::Chem::getContainingFragments ( const MolecularGraph molgraph,
const FragmentList frag_list,
FragmentList cont_frag_list,
bool  append = false,
bool  atoms = true,
bool  bonds = true 
)

Collects the fragments in frag_list that contain the molecular graph molgraph into cont_frag_list.

Parameters
molgraphThe query molecular graph.
frag_listThe candidate fragment list.
cont_frag_listThe output fragment list receiving the matches.
appendIf true, matches are appended to cont_frag_list. Otherwise, it is cleared first.
atomsIf true, atom membership is required for a match.
bondsIf true, bond membership is required for a match.

◆ translateFragment()

CDPL_CHEM_API void CDPL::Chem::translateFragment ( const MolecularGraph src_molgraph,
const Fragment src_frag,
const MolecularGraph tgt_molgraph,
Fragment tgt_frag,
bool  append = false 
)

Translates the atoms/bonds of src_frag to the corresponding atoms/bonds of tgt_molgraph and stores them in tgt_frag.

Parameters
src_molgraphThe source molecular graph providing the original atoms/bonds.
src_fragThe fragment defining the atom/bond subset to translate (a fragment of the molecular graph src_molgraph).
tgt_molgraphThe target molecular graph providing the translated atoms/bonds.
tgt_fragThe output fragment receiving the translated atoms/bonds.
appendIf true, atoms/bonds are appended to tgt_frag. Otherwise, it is cleared first.

◆ translateFragments()

CDPL_CHEM_API void CDPL::Chem::translateFragments ( const MolecularGraph src_molgraph,
const FragmentList src_frag_list,
const MolecularGraph tgt_molgraph,
FragmentList tgt_frag_list,
bool  append = false 
)

Translates every fragment in src_frag_list to the corresponding fragments on tgt_molgraph.

Parameters
src_molgraphThe source molecular graph providing the original atoms/bonds.
src_frag_listThe fragments to translate (fragments of the molecular graph src_molgraph).
tgt_molgraphThe target molecular graph providing the translated atoms/bonds.
tgt_frag_listThe output fragment list receiving the translated fragments.
appendIf true, fragments are appended to tgt_frag_list. Otherwise, it is cleared first.

◆ splitIntoFragments()

CDPL_CHEM_API void CDPL::Chem::splitIntoFragments ( const MolecularGraph molgraph,
FragmentList frag_list,
const Util::BitSet split_bond_mask,
bool  append = false 
)

Splits the molecular graph molgraph into connected fragments by removing the bonds flagged in split_bond_mask.

Parameters
molgraphThe molecular graph to split.
frag_listThe output fragment list receiving the resulting fragments.
split_bond_maskBit mask selecting the bonds to be virtually removed before fragmentation (bit i corresponds to the bond at index i in molgraph).
appendIf true, fragments are appended to frag_list. Otherwise, it is cleared first.

◆ getCompleteBondCount()

CDPL_CHEM_API std::size_t CDPL::Chem::getCompleteBondCount ( const MolecularGraph molgraph)

Returns the number of bonds of the molecular graph molgraph whose connected atoms are likewise contained in molgraph.

Parameters
molgraphThe molecular graph to inspect.
Returns
The count of non-dangling bonds.

◆ calcBasicProperties() [1/2]

CDPL_CHEM_API void CDPL::Chem::calcBasicProperties ( MolecularGraph molgraph,
bool  overwrite 
)

Computes the basic atom/bond/molecular graph properties (aromaticity, ring info, etc.) of the molecular graph molgraph.

Parameters
molgraphThe molecular graph to modify.
overwriteIf true, recomputes and stores basic property values. If false, leaves already available property values unchanged.
Since
1.1

◆ editSubstructures() [1/2]

CDPL_CHEM_API std::size_t CDPL::Chem::editSubstructures ( const MolecularGraph molgraph,
Molecule result_mol,
const std::string &  search_ptns,
const std::string &  result_ptn,
const std::string &  exclude_ptns = std::string() 
)

Builds the molecule result_mol from the molecular graph molgraph by replacing all substructures matching the SMARTS patterns in search_ptns with result_ptn.

Parameters
molgraphThe source molecular graph.
result_molThe molecule receiving the edited result.
search_ptnsA whitespace-separated list of SMARTS patterns matching the substructures to replace.
result_ptnThe SMARTS replacement pattern.
exclude_ptnsA whitespace-separated list of SMARTS patterns matching substructures that shall be retained even if they also match search_ptns.
Returns
The number of applied substructure replacements.
Since
1.3

◆ makeHydrogenDeplete() [2/2]

CDPL_CHEM_API bool CDPL::Chem::makeHydrogenDeplete ( Molecule mol,
bool  corr_impl_h_count = true 
)

Removes all explicit hydrogen atoms from the molecule mol.

Parameters
molThe molecule for which to remove all explicit hydrogen atoms.
corr_impl_h_counttrue if the implicit hydrogen count property of the affected remaining atoms shall be corrected, false if the property shall be left unchanged.
Returns
false if mol was not altered, true otherwise.

◆ makeOrdinaryHydrogenDeplete() [2/2]

CDPL_CHEM_API bool CDPL::Chem::makeOrdinaryHydrogenDeplete ( Molecule mol,
unsigned int  flags,
bool  corr_impl_h_count = true 
)

Removes all explicit ordinary hydrogen atoms from the molecule mol.

Parameters
molThe molecule for which to remove all explicit ordinary hydrogen atoms.
flagsSpecifies the set of atom properties to check (see namespace Chem::AtomPropertyFlag).
corr_impl_h_counttrue if the implicit hydrogen count property of the affected remaining atoms shall be corrected, false if the property shall be left unchanged.
Returns
false if mol was not altered, true otherwise.
See also
MolProp::isOrdinaryHydrogen

◆ makeHydrogenComplete()

CDPL_CHEM_API bool CDPL::Chem::makeHydrogenComplete ( Molecule mol,
bool  corr_impl_h_count = true 
)

Converts all implicit hydrogens of the molecule mol to explicit hydrogen atoms.

Parameters
molThe molecule that has to be made hydrogen complete.
corr_impl_h_counttrue if the implicit hydrogen count property of the hydrogen completed shall be set to zero, false if the property shall be left unchanged.
Returns
false if mol was not altered, true otherwise.

◆ connectAtoms() [1/2]

CDPL_CHEM_API void CDPL::Chem::connectAtoms ( Molecule mol,
double  dist_tol = 0.3,
std::size_t  atom_idx_offs = 0 
)

Adds bonds between atoms of the molecule mol whose 3D distance falls within the covalent-radii sum plus dist_tol.

Parameters
molThe molecule whose atoms shall be connected.
dist_tolThe tolerance added to the sum of the two atoms' covalent radii.
atom_idx_offsBonds are only added when at least one of the two atom indices is greater than or equal to atom_idx_offs.
Note
The minimum atom pair distance is 0.5 Å.

◆ connectAtoms() [2/2]

CDPL_CHEM_API void CDPL::Chem::connectAtoms ( Molecule mol,
const Atom3DCoordinatesFunction coords_func,
double  dist_tol = 0.3,
std::size_t  atom_idx_offs = 0 
)

Adds bonds between atoms of the molecule mol whose 3D distance (obtained via coords_func) falls within the covalent-radii sum plus dist_tol.

Parameters
molThe molecule whose atoms are to be connected.
coords_funcThe function used to retrieve the 3D coordinates of an atom.
dist_tolThe tolerance added to the sum of the two atoms' covalent radii.
atom_idx_offsBonds are only added when at least one of the two atom indices is greater than or equal to atom_idx_offs.
Note
The minimum atom pair distance is 0.5 Å.

◆ removeAtomsIf() [2/2]

CDPL_CHEM_API void CDPL::Chem::removeAtomsIf ( Molecule mol,
const AtomPredicate pred 
)

Removes all atoms of the molecule mol for which the predicate pred returns true.

Parameters
molThe molecule to filter in place.
predThe atom predicate to evaluate.

◆ removeAtomsIfNot() [2/2]

CDPL_CHEM_API void CDPL::Chem::removeAtomsIfNot ( Molecule mol,
const AtomPredicate pred 
)

Removes all atoms of the molecule mol for which the predicate pred returns false.

Parameters
molThe molecule to filter in place.
predThe atom predicate to evaluate.

◆ editSubstructures() [2/2]

CDPL_CHEM_API std::size_t CDPL::Chem::editSubstructures ( Molecule mol,
const std::string &  search_ptns,
const std::string &  result_ptn,
const std::string &  exclude_ptns = std::string() 
)

Edits the molecule mol by replacing all substructures matching the SMARTS search patterns in search_ptns with the SMILES replacement pattern result_ptn, optionally skipping matches that also match exclude_ptns.

A molecule editing operation is specified via a string of one or more SMARTS patterns (search_ptns) describing the substructures to edit, optional substructure exclude patterns (exclude_ptns) and a SMILES string (result_ptn) encoding the specific atom and bond modifications to perform. If multiple search and/or exclude patterns are specified then they need to be separated by a whitespace character.

In the substructure search pattern(s), any atoms to be edited and/or atoms connected by bonds to be modified must be labeled by a unique non-zero integer number (by means of a colon followed the integer number at the end of the SMARTS atom specification). These numeric ids are used to establish an unambiguous mapping between the atoms/bonds of the search pattern and the SMILES string encoding the editing instructions. As mentioned above, the atom/bond editing operations are all specified by means of a simple SMILES string. For the purpose of substructure editing, the SMILES format has been extended by additional atom type and bond order symbols that allow to mark atom/bonds for deletion or act as a 'do not change' marker for atom type or bond order.

Editing result SMILES strings have to be composed according to the following rules:

  • Atoms of the molecule matching labeled search pattern atoms are referenced by their numeric id (likewise specified by means of a colon followed by the integer number at the end of the SMILES atom specification)
  • A bond between two labeled atoms in the result SMILES string will be mapped to the bond of the molecule that matched the corresponding bond of the search pattern
  • If such a bond of the molecule does not exist it will be created with the specified bond order
  • A molecule bond connecting two atoms that match labeled search pattern atoms which is not occurring in the result SMILES string will be left unchanged
  • A molecule atom matching a labeled search pattern atom which is not occurring in the result SMILES string will be left unchanged
  • A labeled atom in the result SMILES string with a numeric id that does not occur in the search pattern will be created with specified properties (symbol, form. charge, isotope, chirality, ...)
  • Any unlabeled atoms in the result SMILES string will be created with the specified properties (symbol, form. charge, isotope, chirality, ...)
  • Bonds to/between unlabeled result SMILES string atoms will be created with the specified bond order
  • For a mapped molecule atom only those properties (symbol, form. charge, isotope, chirality, ...) that were specified for the corresponding result SMILES string atom will be modified
  • The special result SMILES string atom type symbol x (only valid in brackets) results in the removal of the mapped molecule atom including any incident bonds
  • The special result SMILES string atom type symbol ~ (only valid in brackets) indicates that the type of the mapped molecule atom shall be left unchanged
  • The special result SMILES string bond order symbol x results in the removal of the mapped molecule bond
  • The special result SMILES string bond order symbol ~ indicates that the order of the mapped molecule bond shall be left unchanged
Parameters
molThe molecule to edit in place.
search_ptnsA whitespace-separated list of SMARTS patterns matching the substructures to replace.
result_ptnThe SMARTS replacement pattern.
exclude_ptnsA whitespace-separated list of SMARTS patterns matching substructures that shall be retained even if they match search_ptns.
Returns
The number of replaced substructures.
Since
1.3

◆ getName() [3/3]

CDPL_CHEM_API const std::string& CDPL::Chem::getName ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::NAME property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored reaction name.

◆ setName() [3/3]

CDPL_CHEM_API void CDPL::Chem::setName ( Reaction rxn,
const std::string &  name 
)

Sets the value of the Chem::ReactionProperty::NAME property of the reaction rxn to name.

Parameters
rxnThe reaction for which to set the property value.
nameThe new reaction name.

◆ clearName() [3/3]

CDPL_CHEM_API void CDPL::Chem::clearName ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::NAME property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasName() [3/3]

CDPL_CHEM_API bool CDPL::Chem::hasName ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::NAME property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getTimestamp() [2/2]

CDPL_CHEM_API std::time_t CDPL::Chem::getTimestamp ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::TIMESTAMP property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored timestamp.

◆ setTimestamp() [2/2]

CDPL_CHEM_API void CDPL::Chem::setTimestamp ( Reaction rxn,
std::time_t  time 
)

Sets the value of the Chem::ReactionProperty::TIMESTAMP property of the reaction rxn to time.

Parameters
rxnThe reaction for which to set the property value.
timeThe new timestamp value.

◆ clearTimestamp() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearTimestamp ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::TIMESTAMP property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasTimestamp() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasTimestamp ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::TIMESTAMP property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getComment() [2/2]

CDPL_CHEM_API const std::string& CDPL::Chem::getComment ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::COMMENT property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored comment.

◆ setComment() [2/2]

CDPL_CHEM_API void CDPL::Chem::setComment ( Reaction rxn,
const std::string &  comment 
)

Sets the value of the Chem::ReactionProperty::COMMENT property of the reaction rxn to comment.

Parameters
rxnThe reaction for which to set the property value.
commentThe new comment string.

◆ clearComment() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearComment ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::COMMENT property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasComment() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasComment ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::COMMENT property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMatchExpression() [4/4]

CDPL_CHEM_API const MatchExpression<Reaction>::SharedPointer& CDPL::Chem::getMatchExpression ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::MATCH_EXPRESSION property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored top-level reaction match expression.

◆ setMatchExpression() [4/4]

CDPL_CHEM_API void CDPL::Chem::setMatchExpression ( Reaction rxn,
const MatchExpression< Reaction >::SharedPointer &  expr 
)

Sets the value of the Chem::ReactionProperty::MATCH_EXPRESSION property of the reaction rxn to expr.

Parameters
rxnThe reaction for which to set the property value.
exprThe new match expression to store.

◆ clearMatchExpression() [4/4]

CDPL_CHEM_API void CDPL::Chem::clearMatchExpression ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::MATCH_EXPRESSION property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasMatchExpression() [4/4]

CDPL_CHEM_API bool CDPL::Chem::hasMatchExpression ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::MATCH_EXPRESSION property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ generateMatchExpression() [5/6]

CDPL_CHEM_API MatchExpression<Reaction>::SharedPointer CDPL::Chem::generateMatchExpression ( const Reaction rxn)

Builds a reaction-level match expression from the match constraints currently attached to the reaction rxn.

Parameters
rxnThe reaction to inspect.
Returns
The generated match expression.

◆ generateMatchExpression() [6/6]

CDPL_CHEM_API MatchExpression<Reaction>::SharedPointer CDPL::Chem::generateMatchExpression ( Reaction rxn,
bool  overwrite 
)

Builds and (optionally) stores the reaction-level match expression of the reaction rxn.

Parameters
rxnThe reaction to inspect/modify.
overwriteIf true, the generated expression replaces any existing match expression. Otherwise, the existing one (if any) is returned unchanged.
Returns
The generated (or pre-existing) match expression.

◆ getMatchConstraints() [4/4]

CDPL_CHEM_API const MatchConstraintList::SharedPointer& CDPL::Chem::getMatchConstraints ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::MATCH_CONSTRAINTS property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored top-level match constraint list.

◆ setMatchConstraints() [4/4]

CDPL_CHEM_API void CDPL::Chem::setMatchConstraints ( Reaction rxn,
const MatchConstraintList::SharedPointer constr 
)

Sets the value of the Chem::ReactionProperty::MATCH_CONSTRAINTS property of the reaction rxn to constr.

Parameters
rxnThe reaction for which to set the property value.
constrThe new match constraint list to store.

◆ clearMatchConstraints() [4/4]

CDPL_CHEM_API void CDPL::Chem::clearMatchConstraints ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::MATCH_CONSTRAINTS property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasMatchConstraints() [4/4]

CDPL_CHEM_API bool CDPL::Chem::hasMatchConstraints ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::MATCH_CONSTRAINTS property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getComponentGroups() [2/2]

CDPL_CHEM_API const FragmentList::SharedPointer& CDPL::Chem::getComponentGroups ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::COMPONENT_GROUPS property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored component-group fragment list.

◆ setComponentGroups() [2/2]

CDPL_CHEM_API void CDPL::Chem::setComponentGroups ( Reaction rxn,
const FragmentList::SharedPointer comp_groups 
)

Sets the value of the Chem::ReactionProperty::COMPONENT_GROUPS property of the reaction rxn to comp_groups.

Parameters
rxnThe reaction for which to set the property value.
comp_groupsThe new component-group fragment list.

◆ clearComponentGroups() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearComponentGroups ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::COMPONENT_GROUPS property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasComponentGroups() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasComponentGroups ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::COMPONENT_GROUPS property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ perceiveComponentGroups() [3/4]

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::perceiveComponentGroups ( const Reaction rxn)

Perceives the component groups of the reaction rxn.

Parameters
rxnThe reaction to inspect.
Returns
The perceived component group fragment list.

◆ perceiveComponentGroups() [4/4]

CDPL_CHEM_API FragmentList::SharedPointer CDPL::Chem::perceiveComponentGroups ( Reaction rxn,
bool  overwrite 
)

Perceives and (optionally) stores the component groups of the reaction rxn.

Parameters
rxnThe reaction to inspect/modify.
overwriteIf true, replaces any existing component group list. Otherwise, the existing one (if any) is returned unchanged.
Returns
The perceived (or pre-existing) component group fragment list.

◆ getAtomMapping()

CDPL_CHEM_API const AtomMapping::SharedPointer& CDPL::Chem::getAtomMapping ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::ATOM_MAPPING property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored reactant-to-product atom mapping.

◆ setAtomMapping()

CDPL_CHEM_API void CDPL::Chem::setAtomMapping ( Reaction rxn,
const AtomMapping::SharedPointer mapping 
)

Sets the value of the Chem::ReactionProperty::ATOM_MAPPING property of the reaction rxn to mapping.

Parameters
rxnThe reaction for which to set the property value.
mappingThe new reactant-to-product atom mapping.

◆ clearAtomMapping()

CDPL_CHEM_API void CDPL::Chem::clearAtomMapping ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::ATOM_MAPPING property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasAtomMapping()

CDPL_CHEM_API bool CDPL::Chem::hasAtomMapping ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::ATOM_MAPPING property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ perceiveAtomMapping() [1/2]

CDPL_CHEM_API AtomMapping::SharedPointer CDPL::Chem::perceiveAtomMapping ( const Reaction rxn)

Derives the reactant-to-product atom mapping from the atom mapping IDs of the reaction rxn.

Parameters
rxnThe reaction to inspect.
Returns
The perceived atom mapping.

◆ perceiveAtomMapping() [2/2]

CDPL_CHEM_API AtomMapping::SharedPointer CDPL::Chem::perceiveAtomMapping ( Reaction rxn,
bool  overwrite 
)

Derives and (optionally) stores the reactant-to-product atom mapping of the reaction rxn.

Parameters
rxnThe reaction to inspect/modify.
overwriteIf true, the perceived mapping replaces any existing atom mapping. If false, the existing one (if any) is returned unchanged.
Returns
The perceived (or pre-existing) atom mapping.

◆ generateSMILES() [2/2]

CDPL_CHEM_API bool CDPL::Chem::generateSMILES ( const Reaction rxn,
std::string &  smiles,
bool  canonical = false,
bool  ord_h_deplete = true,
unsigned int  atom_flags = AtomPropertyFlag::DEFAULT,
unsigned int  bond_flags = BondPropertyFlag::DEFAULT 
)

Generates a reaction SMILES string for the reaction rxn.

Parameters
rxnThe reaction to encode.
smilesThe string to receiving the generated reaction SMILES.
canonicaltrue to emit a canonical reaction SMILES.
ord_h_depletetrue to suppress the output ordinary hydrogens.
atom_flagsA bitmask of Chem::AtomPropertyFlag flags controlling which atomic properties to encode.
bond_flagsA bitmask of Chem::BondPropertyFlag flags controlling which bond properties to encode.
Returns
true on success, and false if an unrecoverable error was encountered.

◆ calcHashCode() [2/2]

CDPL_CHEM_API std::uint64_t CDPL::Chem::calcHashCode ( const Reaction rxn,
unsigned int  role_mask = ReactionRole::ALL,
unsigned int  atom_flags = AtomPropertyFlag::DEFAULT,
unsigned int  bond_flags = BondPropertyFlag::DEFAULT,
bool  ord_h_deplete = true 
)

Computes a 64-bit hash code for the reaction rxn taking into account the specified reaction roles and atom/bond properties.

Parameters
rxnThe reaction to hash.
role_maskA bitmask of Chem::ReactionRole flags selecting the considered component sets.
atom_flagsA bitmask of Chem::AtomPropertyFlag flags controlling which atomic properties enter the hash.
bond_flagsA bitmask of Chem::BondPropertyFlag flags controlling which bond properties enter the hash.
ord_h_depletetrue to suppress ordinary hydrogens before hashing.
Returns
The computed hash code.

◆ getMDLUserInitials() [2/2]

CDPL_CHEM_API const std::string& CDPL::Chem::getMDLUserInitials ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::MDL_USER_INITIALS property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored MDL user initials.

◆ setMDLUserInitials() [2/2]

CDPL_CHEM_API void CDPL::Chem::setMDLUserInitials ( Reaction rxn,
const std::string &  initials 
)

Sets the value of the Chem::ReactionProperty::MDL_USER_INITIALS property of the reaction rxn to initials.

Parameters
rxnThe reaction for which to set the property value.
initialsThe new MDL user initials.

◆ clearMDLUserInitials() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearMDLUserInitials ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::MDL_USER_INITIALS property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasMDLUserInitials() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasMDLUserInitials ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::MDL_USER_INITIALS property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLProgramName() [2/2]

CDPL_CHEM_API const std::string& CDPL::Chem::getMDLProgramName ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::MDL_PROGRAM_NAME property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored MDL program name.

◆ setMDLProgramName() [2/2]

CDPL_CHEM_API void CDPL::Chem::setMDLProgramName ( Reaction rxn,
const std::string &  name 
)

Sets the value of the Chem::ReactionProperty::MDL_PROGRAM_NAME property of the reaction rxn to name.

Parameters
rxnThe reaction for which to set the property value.
nameThe new MDL program name.

◆ clearMDLProgramName() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearMDLProgramName ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::MDL_PROGRAM_NAME property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasMDLProgramName() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasMDLProgramName ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::MDL_PROGRAM_NAME property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLRegistryNumber() [2/2]

CDPL_CHEM_API std::size_t CDPL::Chem::getMDLRegistryNumber ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::MDL_REGISTRY_NUMBER property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored MDL registry number.

◆ setMDLRegistryNumber() [2/2]

CDPL_CHEM_API void CDPL::Chem::setMDLRegistryNumber ( Reaction rxn,
std::size_t  reg_no 
)

Sets the value of the Chem::ReactionProperty::MDL_REGISTRY_NUMBER property of the reaction rxn to reg_no.

Parameters
rxnThe reaction for which to set the property value.
reg_noThe new MDL registry number.

◆ clearMDLRegistryNumber() [2/2]

CDPL_CHEM_API void CDPL::Chem::clearMDLRegistryNumber ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::MDL_REGISTRY_NUMBER property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasMDLRegistryNumber() [2/2]

CDPL_CHEM_API bool CDPL::Chem::hasMDLRegistryNumber ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::MDL_REGISTRY_NUMBER property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getReactionData()

CDPL_CHEM_API const StringDataBlock::SharedPointer& CDPL::Chem::getReactionData ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::REACTION_DATA property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored reaction data block.

◆ setReactionData()

CDPL_CHEM_API void CDPL::Chem::setReactionData ( Reaction rxn,
const StringDataBlock::SharedPointer data 
)

Sets the value of the Chem::ReactionProperty::REACTION_DATA property of the reaction rxn to data.

Parameters
rxnThe reaction for which to set the property value.
dataThe new reaction data block.

◆ clearReactionData()

CDPL_CHEM_API void CDPL::Chem::clearReactionData ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::REACTION_DATA property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasReactionData()

CDPL_CHEM_API bool CDPL::Chem::hasReactionData ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::REACTION_DATA property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLMoleculeRecord()

CDPL_CHEM_API const Molecule::SharedPointer& CDPL::Chem::getMDLMoleculeRecord ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::MDL_MOLECULE_RECORD property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored MDL RD-File molecule record.

◆ setMDLMoleculeRecord()

CDPL_CHEM_API void CDPL::Chem::setMDLMoleculeRecord ( Reaction rxn,
const Molecule::SharedPointer mol_rec 
)

Sets the value of the Chem::ReactionProperty::MDL_MOLECULE_RECORD property of the reaction rxn to mol_rec.

Parameters
rxnThe reaction for which to set the property value.
mol_recThe new MDL RD-File molecule record.

◆ clearMDLMoleculeRecord()

CDPL_CHEM_API void CDPL::Chem::clearMDLMoleculeRecord ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::MDL_MOLECULE_RECORD property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasMDLMoleculeRecord()

CDPL_CHEM_API bool CDPL::Chem::hasMDLMoleculeRecord ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::MDL_MOLECULE_RECORD property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLInternalRegistryNumber()

CDPL_CHEM_API const std::string& CDPL::Chem::getMDLInternalRegistryNumber ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::MDL_INTERNAL_REGISTRY_NUMBER property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored MDL internal registry number.

◆ setMDLInternalRegistryNumber()

CDPL_CHEM_API void CDPL::Chem::setMDLInternalRegistryNumber ( Reaction rxn,
const std::string &  reg_no 
)

Sets the value of the Chem::ReactionProperty::MDL_INTERNAL_REGISTRY_NUMBER property of the reaction rxn to reg_no.

Parameters
rxnThe reaction for which to set the property value.
reg_noThe new MDL internal registry number.

◆ clearMDLInternalRegistryNumber()

CDPL_CHEM_API void CDPL::Chem::clearMDLInternalRegistryNumber ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::MDL_INTERNAL_REGISTRY_NUMBER property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasMDLInternalRegistryNumber()

CDPL_CHEM_API bool CDPL::Chem::hasMDLInternalRegistryNumber ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::MDL_INTERNAL_REGISTRY_NUMBER property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLExternalRegistryNumber()

CDPL_CHEM_API const std::string& CDPL::Chem::getMDLExternalRegistryNumber ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::MDL_EXTERNAL_REGISTRY_NUMBER property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored MDL external registry number.

◆ setMDLExternalRegistryNumber()

CDPL_CHEM_API void CDPL::Chem::setMDLExternalRegistryNumber ( Reaction rxn,
const std::string &  reg_no 
)

Sets the value of the Chem::ReactionProperty::MDL_EXTERNAL_REGISTRY_NUMBER property of the reaction rxn to reg_no.

Parameters
rxnThe reaction for which to set the property value.
reg_noThe new MDL external registry number.

◆ clearMDLExternalRegistryNumber()

CDPL_CHEM_API void CDPL::Chem::clearMDLExternalRegistryNumber ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::MDL_EXTERNAL_REGISTRY_NUMBER property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasMDLExternalRegistryNumber()

CDPL_CHEM_API bool CDPL::Chem::hasMDLExternalRegistryNumber ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::MDL_EXTERNAL_REGISTRY_NUMBER property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMDLRXNFileVersion()

CDPL_CHEM_API unsigned int CDPL::Chem::getMDLRXNFileVersion ( const Reaction rxn)

Returns the value of the Chem::ReactionProperty::MDL_RXN_FILE_VERSION property of the reaction rxn.

Parameters
rxnThe reaction for which to return the property value.
Returns
The stored MDL Rxn-File version (see Chem::MDLDataFormatVersion).

◆ setMDLRXNFileVersion()

CDPL_CHEM_API void CDPL::Chem::setMDLRXNFileVersion ( Reaction rxn,
unsigned int  version 
)

Sets the value of the Chem::ReactionProperty::MDL_RXN_FILE_VERSION property of the reaction rxn to version.

Parameters
rxnThe reaction for which to set the property value.
versionThe new MDL Rxn-File version (see Chem::MDLDataFormatVersion).

◆ clearMDLRXNFileVersion()

CDPL_CHEM_API void CDPL::Chem::clearMDLRXNFileVersion ( Reaction rxn)

Clears the value of the Chem::ReactionProperty::MDL_RXN_FILE_VERSION property of the reaction rxn.

Parameters
rxnThe reaction for which to clear the property value.

◆ hasMDLRXNFileVersion()

CDPL_CHEM_API bool CDPL::Chem::hasMDLRXNFileVersion ( const Reaction rxn)

Tells whether the Chem::ReactionProperty::MDL_RXN_FILE_VERSION property of the reaction rxn is set.

Parameters
rxnThe reaction for which to query the property value.
Returns
true if the property is set, and false otherwise.

◆ getMaxComponentGroupID() [2/2]

CDPL_CHEM_API std::size_t CDPL::Chem::getMaxComponentGroupID ( const Reaction rxn)

Returns the largest component group ID found for any of the atoms of the components of the reaction rxn.

Parameters
rxnThe reaction to scan.
Returns
The largest component group ID, or zero if no IDs are assigned.

◆ getMaxAtomMappingID() [2/2]

CDPL_CHEM_API std::size_t CDPL::Chem::getMaxAtomMappingID ( const Reaction rxn)

Returns the largest atom mapping ID found for any of the atoms of the components of the reaction rxn.

Parameters
rxnThe reaction to scan.
Returns
The largest atom mapping ID, or zero if no IDs are assigned.

◆ setAtomMatchConstraints() [2/2]

CDPL_CHEM_API void CDPL::Chem::setAtomMatchConstraints ( Reaction rxn,
const MatchConstraintList::SharedPointer constr,
bool  overwrite 
)

Sets the atom-level match constraint list constr on every atom of every component of the reaction rxn.

Parameters
rxnThe reaction to modify.
constrThe match constraint list to assign.
overwriteIf true, replaces any existing per-atom constraints. If false, leaves atoms that already carry a list unchanged.

◆ setBondMatchConstraints() [2/2]

CDPL_CHEM_API void CDPL::Chem::setBondMatchConstraints ( Reaction rxn,
const MatchConstraintList::SharedPointer constr,
bool  overwrite 
)

Sets the bond-level match constraint list constr on every bond of every component of the reaction rxn.

Parameters
rxnThe reaction to modify.
constrThe match constraint list to assign.
overwriteIf true, replaces any existing per-bond constraints. If false, leaves bonds that already carry a list unchanged.

◆ setComponentMatchConstraints()

CDPL_CHEM_API void CDPL::Chem::setComponentMatchConstraints ( Reaction rxn,
const MatchConstraintList::SharedPointer constr,
bool  overwrite 
)

Sets the molecular graph-level match constraint list constr on every component of the reaction rxn.

Parameters
rxnThe reaction to modify.
constrThe match constraint list to assign.
overwriteIf true, replaces any existing per-component constraints. If false, leaves components that already carry a list unchanged.

◆ generateMatchExpressions() [2/2]

CDPL_CHEM_API void CDPL::Chem::generateMatchExpressions ( Reaction rxn,
bool  overwrite 
)

Generates and stores match expressions for the atoms, bonds, components, and the reaction rxn itself.

Parameters
rxnThe reaction to modify.
overwriteIf true, replaces any existing match expressions. If false, leaves objects that already carry a match expression unchanged.

◆ initSubstructureSearchQuery() [2/2]

CDPL_CHEM_API void CDPL::Chem::initSubstructureSearchQuery ( Reaction rxn,
bool  overwrite 
)

Prepares the reaction rxn for use as a reaction substructure search query.

Parameters
rxnThe reaction to modify.
overwriteIf true, recomputes and stores any required property values. If false, leaves already available property values unchanged.

◆ initSubstructureSearchTarget() [2/2]

CDPL_CHEM_API void CDPL::Chem::initSubstructureSearchTarget ( Reaction rxn,
bool  overwrite 
)

Prepares the reaction rxn for use as a reaction substructure search target.

Parameters
rxnThe reaction to modify.
overwriteIf true, recomputes and stores any required property values. If false, leaves already available property values unchanged.

◆ calcBasicProperties() [2/2]

CDPL_CHEM_API void CDPL::Chem::calcBasicProperties ( Reaction rxn,
bool  overwrite 
)

Computes basic atom/bond/molecular graph properties (aromaticity, ring info, etc.) for every component of the reaction rxn.

Parameters
rxnThe reaction to modify.
overwriteIf true, recomputes and stores basic property values. If false, leaves already available property values unchanged.
Since
1.1

◆ parseSMARTS() [1/2]

CDPL_CHEM_API Molecule::SharedPointer CDPL::Chem::parseSMARTS ( const std::string &  smarts,
bool  init_qry = true 
)

Parses the SMARTS string smarts into a freshly allocated query Chem::Molecule.

Parameters
smartsThe SMARTS string to parse.
init_qryIf true, query-specific perception (e.g. ring-membership, aromaticity) is run on the parsed molecule.
Returns
A smart pointer to the parsed molecule, or an empty smart pointer if parsing failed.

◆ parseSMARTS() [2/2]

CDPL_CHEM_API bool CDPL::Chem::parseSMARTS ( const std::string &  smarts,
Molecule mol,
bool  init_qry = true 
)

Parses the SMARTS string smarts into the supplied molecule mol.

Parameters
smartsThe SMARTS string to parse.
molThe molecule to populate (cleared before parsing).
init_qryIf true, query-specific perception is run on the parsed molecule.
Returns
true if parsing succeeded, and false otherwise.

◆ parseSMILES() [1/2]

CDPL_CHEM_API Molecule::SharedPointer CDPL::Chem::parseSMILES ( const std::string &  smiles)

Parses the SMILES string smiles into a freshly allocated Chem::Molecule.

Parameters
smilesThe SMILES string to parse.
Returns
A smart pointer to the parsed molecule, or an empty smart pointer if parsing failed.

◆ parseSMILES() [2/2]

CDPL_CHEM_API bool CDPL::Chem::parseSMILES ( const std::string &  smiles,
Molecule mol 
)

Parses the SMILES string smiles into the supplied molecule mol.

Parameters
smilesThe SMILES string to parse.
molThe molecule to populate (cleared before parsing).
Returns
true if parsing succeeded, and false otherwise.

◆ extendBoundingBox()

CDPL_CHEM_API void CDPL::Chem::extendBoundingBox ( Math::Vector3D min,
Math::Vector3D max,
const Math::Vector3D coords,
bool  reset = false 
)

Extends the axis-aligned bounding box defined by min and max so that it contains the point coords.

Parameters
minThe lower-left corner of the bounding box (updated in place).
maxThe upper-right corner of the bounding box (updated in place).
coordsThe 3D point to include.
resetIf true, the bounding box is first reset to coords (degenerate point box) before extension.

◆ insideBoundingBox() [3/3]

CDPL_CHEM_API bool CDPL::Chem::insideBoundingBox ( const Math::Vector3D min,
const Math::Vector3D max,
const Math::Vector3D coords 
)

Tells whether the point coords lies inside the axis-aligned bounding box defined by min and max.

Parameters
minThe lower-left corner of the bounding box.
maxThe upper-right corner of the bounding box.
coordsThe 3D point to test.
Returns
true if the point is inside (componentwise <= max and >= min), and false otherwise.

◆ isAromatic()

CDPL_CHEM_API bool CDPL::Chem::isAromatic ( const Fragment ring,
const MolecularGraph molgraph,
const Util::BitSet arom_bond_mask 
)

Tells whether ring fulfills the Hückel (4n+2)π-electron criterion within molgraph.

Parameters
ringThe candidate aromatic ring.
molgraphThe parent molecular graph.
arom_bond_maskA bond bit mask flagging bonds already known to be aromatic.
Returns
true if ring satisfies the Hückel rule, and false otherwise.

◆ isNotAromatic()

CDPL_CHEM_API bool CDPL::Chem::isNotAromatic ( const Fragment ring,
const MolecularGraph molgraph 
)

Tells whether ring is guaranteed not to be aromatic (based on quick geometric/topological criteria).

Parameters
ringThe ring to test.
molgraphThe parent molecular graph.
Returns
true if ring cannot be aromatic, and false if a more thorough test is required.

◆ containsFragmentWithBond()

CDPL_CHEM_API bool CDPL::Chem::containsFragmentWithBond ( const FragmentList frag_list,
const Bond bond 
)

Tells whether any fragment in frag_list contains the bond bond.

Parameters
frag_listThe list of fragments to search.
bondThe queried bond.
Returns
true if at least one fragment contains bond, and false otherwise.

◆ containsFragmentWithMinSize()

CDPL_CHEM_API bool CDPL::Chem::containsFragmentWithMinSize ( const FragmentList frag_list,
std::size_t  min_size 
)

Tells whether frag_list contains at least one fragment with at least min_size atoms.

Parameters
frag_listThe list of fragments to search.
min_sizeThe minimum required atom count.
Returns
true if such a fragment exists, and false otherwise.

◆ atomTypesMatch()

CDPL_CHEM_API bool CDPL::Chem::atomTypesMatch ( unsigned int  qry_type,
unsigned int  tgt_type 
)

Tells whether the target atom type tgt_type matches the query atom type qry_type (taking generic atom type classes like Chem::AtomType::HET into account).

Parameters
qry_typeThe query atom type (Chem::AtomType value).
tgt_typeThe target atom type (Chem::AtomType value).
Returns
true if the target matches the query, and false otherwise.

◆ sybylToAtomType()

CDPL_CHEM_API unsigned int CDPL::Chem::sybylToAtomType ( unsigned int  sybyl_type)

Translates a Sybyl atom type identifier to the corresponding generic Chem::AtomType value.

Parameters
sybyl_typeThe Sybyl atom type identifier (Chem::SybylAtomType value).
Returns
The corresponding Chem::AtomType value.

◆ getSybylAtomTypeString()

CDPL_CHEM_API const std::string& CDPL::Chem::getSybylAtomTypeString ( unsigned int  sybyl_type)

Returns the canonical textual representation of the Sybyl atom type sybyl_type.

Parameters
sybyl_typeThe Sybyl atom type identifier (Chem::SybylAtomType value).
Returns
A const reference to the type-name string (empty for unknown types).

◆ getSybylBondTypeString()

CDPL_CHEM_API const std::string& CDPL::Chem::getSybylBondTypeString ( unsigned int  sybyl_type)

Returns the canonical textual representation of the Sybyl bond type sybyl_type.

Parameters
sybyl_typeThe Sybyl bond-type identifier (Chem::SybylBondType value).
Returns
A const reference to the type-name string (empty for unknown types).