rdkit-headers 2022.3.3__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- rdkit_headers/__init__.py +13 -0
- rdkit_headers/include/rdkit/CIPLabeler/CIPLabeler.h +59 -0
- rdkit_headers/include/rdkit/CIPLabeler/TooManyNodesException.h +28 -0
- rdkit_headers/include/rdkit/Catalogs/Catalog.h +461 -0
- rdkit_headers/include/rdkit/Catalogs/CatalogEntry.h +48 -0
- rdkit_headers/include/rdkit/Catalogs/CatalogParams.h +42 -0
- rdkit_headers/include/rdkit/ChemicalFeatures/ChemicalFeature.h +38 -0
- rdkit_headers/include/rdkit/ChemicalFeatures/FreeChemicalFeature.h +97 -0
- rdkit_headers/include/rdkit/DataManip/MetricMatrixCalc/MetricFuncs.h +54 -0
- rdkit_headers/include/rdkit/DataManip/MetricMatrixCalc/MetricMatrixCalc.h +106 -0
- rdkit_headers/include/rdkit/DataStructs/BitOps.h +337 -0
- rdkit_headers/include/rdkit/DataStructs/BitVect.h +68 -0
- rdkit_headers/include/rdkit/DataStructs/BitVectUtils.h +35 -0
- rdkit_headers/include/rdkit/DataStructs/BitVects.h +25 -0
- rdkit_headers/include/rdkit/DataStructs/DatastructsException.h +31 -0
- rdkit_headers/include/rdkit/DataStructs/DatastructsStreamOps.h +72 -0
- rdkit_headers/include/rdkit/DataStructs/DiscreteDistMat.h +30 -0
- rdkit_headers/include/rdkit/DataStructs/DiscreteValueVect.h +146 -0
- rdkit_headers/include/rdkit/DataStructs/ExplicitBitVect.h +96 -0
- rdkit_headers/include/rdkit/DataStructs/FPBReader.h +281 -0
- rdkit_headers/include/rdkit/DataStructs/MultiFPBReader.h +213 -0
- rdkit_headers/include/rdkit/DataStructs/SparseBitVect.h +101 -0
- rdkit_headers/include/rdkit/DataStructs/SparseIntVect.h +571 -0
- rdkit_headers/include/rdkit/DataStructs/base64.h +41 -0
- rdkit_headers/include/rdkit/DistGeom/BoundsMatrix.h +121 -0
- rdkit_headers/include/rdkit/DistGeom/ChiralSet.h +58 -0
- rdkit_headers/include/rdkit/DistGeom/ChiralViolationContrib.h +96 -0
- rdkit_headers/include/rdkit/DistGeom/DistGeomUtils.h +195 -0
- rdkit_headers/include/rdkit/DistGeom/DistViolationContrib.h +54 -0
- rdkit_headers/include/rdkit/DistGeom/FourthDimContrib.h +65 -0
- rdkit_headers/include/rdkit/DistGeom/TriangleSmooth.h +36 -0
- rdkit_headers/include/rdkit/Features/Feature.h +96 -0
- rdkit_headers/include/rdkit/ForceField/Contrib.h +40 -0
- rdkit_headers/include/rdkit/ForceField/ForceField.h +253 -0
- rdkit_headers/include/rdkit/ForceField/MMFF/AngleBend.h +78 -0
- rdkit_headers/include/rdkit/ForceField/MMFF/AngleConstraint.h +64 -0
- rdkit_headers/include/rdkit/ForceField/MMFF/BondStretch.h +67 -0
- rdkit_headers/include/rdkit/ForceField/MMFF/Contribs.h +26 -0
- rdkit_headers/include/rdkit/ForceField/MMFF/DistanceConstraint.h +61 -0
- rdkit_headers/include/rdkit/ForceField/MMFF/Nonbonded.h +105 -0
- rdkit_headers/include/rdkit/ForceField/MMFF/OopBend.h +65 -0
- rdkit_headers/include/rdkit/ForceField/MMFF/Params.h +1134 -0
- rdkit_headers/include/rdkit/ForceField/MMFF/PositionConstraint.h +55 -0
- rdkit_headers/include/rdkit/ForceField/MMFF/StretchBend.h +70 -0
- rdkit_headers/include/rdkit/ForceField/MMFF/TorsionAngle.h +79 -0
- rdkit_headers/include/rdkit/ForceField/MMFF/TorsionConstraint.h +70 -0
- rdkit_headers/include/rdkit/ForceField/UFF/AngleBend.h +92 -0
- rdkit_headers/include/rdkit/ForceField/UFF/AngleConstraint.h +64 -0
- rdkit_headers/include/rdkit/ForceField/UFF/BondStretch.h +83 -0
- rdkit_headers/include/rdkit/ForceField/UFF/Contribs.h +23 -0
- rdkit_headers/include/rdkit/ForceField/UFF/DistanceConstraint.h +62 -0
- rdkit_headers/include/rdkit/ForceField/UFF/Inversion.h +81 -0
- rdkit_headers/include/rdkit/ForceField/UFF/Nonbonded.h +87 -0
- rdkit_headers/include/rdkit/ForceField/UFF/Params.h +153 -0
- rdkit_headers/include/rdkit/ForceField/UFF/PositionConstraint.h +55 -0
- rdkit_headers/include/rdkit/ForceField/UFF/TorsionAngle.h +115 -0
- rdkit_headers/include/rdkit/ForceField/UFF/TorsionConstraint.h +70 -0
- rdkit_headers/include/rdkit/Geometry/Grid3D.h +55 -0
- rdkit_headers/include/rdkit/Geometry/GridUtils.h +64 -0
- rdkit_headers/include/rdkit/Geometry/Transform.h +19 -0
- rdkit_headers/include/rdkit/Geometry/Transform2D.h +85 -0
- rdkit_headers/include/rdkit/Geometry/Transform3D.h +101 -0
- rdkit_headers/include/rdkit/Geometry/UniformGrid3D.h +217 -0
- rdkit_headers/include/rdkit/Geometry/Utils.h +97 -0
- rdkit_headers/include/rdkit/Geometry/point.h +585 -0
- rdkit_headers/include/rdkit/GraphMol/Abbreviations/Abbreviations.h +132 -0
- rdkit_headers/include/rdkit/GraphMol/Atom.h +449 -0
- rdkit_headers/include/rdkit/GraphMol/AtomIterators.h +212 -0
- rdkit_headers/include/rdkit/GraphMol/Bond.h +393 -0
- rdkit_headers/include/rdkit/GraphMol/BondIterators.h +75 -0
- rdkit_headers/include/rdkit/GraphMol/Canon.h +130 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/Enumerate/CartesianProduct.h +147 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/Enumerate/Enumerate.h +187 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/Enumerate/EnumerateBase.h +200 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/Enumerate/EnumerateTypes.h +59 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/Enumerate/EnumerationPickler.h +60 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/Enumerate/EnumerationStrategyBase.h +227 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/Enumerate/RandomSample.h +163 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/Enumerate/RandomSampleAllBBs.h +184 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/PreprocessRxn.h +64 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/Reaction.h +491 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/ReactionFingerprints.h +147 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/ReactionParser.h +274 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/ReactionPickler.h +119 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/ReactionRunner.h +116 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/ReactionUtils.h +74 -0
- rdkit_headers/include/rdkit/GraphMol/ChemReactions/SanitizeRxn.h +169 -0
- rdkit_headers/include/rdkit/GraphMol/ChemTransforms/ChemTransforms.h +270 -0
- rdkit_headers/include/rdkit/GraphMol/ChemTransforms/MolFragmenter.h +120 -0
- rdkit_headers/include/rdkit/GraphMol/Chirality.h +137 -0
- rdkit_headers/include/rdkit/GraphMol/Conformer.h +183 -0
- rdkit_headers/include/rdkit/GraphMol/CoordGen.h +195 -0
- rdkit_headers/include/rdkit/GraphMol/Depictor/DepictUtils.h +366 -0
- rdkit_headers/include/rdkit/GraphMol/Depictor/EmbeddedFrag.h +544 -0
- rdkit_headers/include/rdkit/GraphMol/Depictor/RDDepictor.h +284 -0
- rdkit_headers/include/rdkit/GraphMol/Deprotect/Deprotect.h +105 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/AUTOCORR2D.h +49 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/AUTOCORR3D.h +51 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/AtomFeat.h +39 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/BCUT.h +66 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/ConnectivityDescriptors.h +211 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/CoulombMat.h +42 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/Crippen.h +137 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/Data3Ddescriptors.h +55 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/EEM.h +59 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/GETAWAY.h +51 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/Lipinski.h +169 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/MORSE.h +50 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/MQN.h +47 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/MolData3Ddescriptors.h +62 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/MolDescriptors.h +86 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/MolDescriptors3D.h +25 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/MolSurf.h +120 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/PBF.h +60 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/PMI.h +128 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/Property.h +123 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/RDF.h +52 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/RegisterDescriptor.h +84 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/USRDescriptor.h +137 -0
- rdkit_headers/include/rdkit/GraphMol/Descriptors/WHIM.h +51 -0
- rdkit_headers/include/rdkit/GraphMol/DistGeomHelpers/BoundsMatrixBuilder.h +77 -0
- rdkit_headers/include/rdkit/GraphMol/DistGeomHelpers/Embedder.h +437 -0
- rdkit_headers/include/rdkit/GraphMol/FMCS/FMCS.h +194 -0
- rdkit_headers/include/rdkit/GraphMol/FMCS/Graph.h +43 -0
- rdkit_headers/include/rdkit/GraphMol/FileParsers/FileParserUtils.h +231 -0
- rdkit_headers/include/rdkit/GraphMol/FileParsers/FileParsers.h +399 -0
- rdkit_headers/include/rdkit/GraphMol/FileParsers/GeneralFileReader.h +170 -0
- rdkit_headers/include/rdkit/GraphMol/FileParsers/MolFileStereochem.h +60 -0
- rdkit_headers/include/rdkit/GraphMol/FileParsers/MolSupplier.h +444 -0
- rdkit_headers/include/rdkit/GraphMol/FileParsers/MolWriters.h +338 -0
- rdkit_headers/include/rdkit/GraphMol/FileParsers/MultithreadedMolSupplier.h +102 -0
- rdkit_headers/include/rdkit/GraphMol/FileParsers/MultithreadedSDMolSupplier.h +65 -0
- rdkit_headers/include/rdkit/GraphMol/FileParsers/MultithreadedSmilesMolSupplier.h +66 -0
- rdkit_headers/include/rdkit/GraphMol/FileParsers/PNGParser.h +203 -0
- rdkit_headers/include/rdkit/GraphMol/FileParsers/SequenceParsers.h +117 -0
- rdkit_headers/include/rdkit/GraphMol/FileParsers/SequenceWriters.h +47 -0
- rdkit_headers/include/rdkit/GraphMol/FilterCatalog/FilterCatalog.h +260 -0
- rdkit_headers/include/rdkit/GraphMol/FilterCatalog/FilterCatalogEntry.h +276 -0
- rdkit_headers/include/rdkit/GraphMol/FilterCatalog/FilterMatcherBase.h +152 -0
- rdkit_headers/include/rdkit/GraphMol/FilterCatalog/FilterMatchers.h +576 -0
- rdkit_headers/include/rdkit/GraphMol/FilterCatalog/FunctionalGroupHierarchy.h +52 -0
- rdkit_headers/include/rdkit/GraphMol/Fingerprints/AtomPairGenerator.h +188 -0
- rdkit_headers/include/rdkit/GraphMol/Fingerprints/AtomPairs.h +268 -0
- rdkit_headers/include/rdkit/GraphMol/Fingerprints/FingerprintGenerator.h +372 -0
- rdkit_headers/include/rdkit/GraphMol/Fingerprints/FingerprintUtil.h +160 -0
- rdkit_headers/include/rdkit/GraphMol/Fingerprints/Fingerprints.h +167 -0
- rdkit_headers/include/rdkit/GraphMol/Fingerprints/MACCS.h +32 -0
- rdkit_headers/include/rdkit/GraphMol/Fingerprints/MHFP.h +285 -0
- rdkit_headers/include/rdkit/GraphMol/Fingerprints/MorganFingerprints.h +210 -0
- rdkit_headers/include/rdkit/GraphMol/Fingerprints/MorganGenerator.h +251 -0
- rdkit_headers/include/rdkit/GraphMol/Fingerprints/RDKitFPGenerator.h +162 -0
- rdkit_headers/include/rdkit/GraphMol/Fingerprints/TopologicalTorsionGenerator.h +127 -0
- rdkit_headers/include/rdkit/GraphMol/ForceFieldHelpers/CrystalFF/TorsionAngleM6.h +72 -0
- rdkit_headers/include/rdkit/GraphMol/ForceFieldHelpers/CrystalFF/TorsionPreferences.h +41 -0
- rdkit_headers/include/rdkit/GraphMol/ForceFieldHelpers/FFConvenience.h +130 -0
- rdkit_headers/include/rdkit/GraphMol/ForceFieldHelpers/MMFF/AtomTyper.h +236 -0
- rdkit_headers/include/rdkit/GraphMol/ForceFieldHelpers/MMFF/Builder.h +141 -0
- rdkit_headers/include/rdkit/GraphMol/ForceFieldHelpers/MMFF/MMFF.h +105 -0
- rdkit_headers/include/rdkit/GraphMol/ForceFieldHelpers/UFF/AtomTyper.h +57 -0
- rdkit_headers/include/rdkit/GraphMol/ForceFieldHelpers/UFF/Builder.h +129 -0
- rdkit_headers/include/rdkit/GraphMol/ForceFieldHelpers/UFF/UFF.h +82 -0
- rdkit_headers/include/rdkit/GraphMol/FragCatalog/FragCatGenerator.h +33 -0
- rdkit_headers/include/rdkit/GraphMol/FragCatalog/FragCatParams.h +94 -0
- rdkit_headers/include/rdkit/GraphMol/FragCatalog/FragCatalogEntry.h +136 -0
- rdkit_headers/include/rdkit/GraphMol/FragCatalog/FragCatalogUtils.h +62 -0
- rdkit_headers/include/rdkit/GraphMol/FragCatalog/FragFPGenerator.h +38 -0
- rdkit_headers/include/rdkit/GraphMol/GenericGroups/GenericGroups.h +301 -0
- rdkit_headers/include/rdkit/GraphMol/GraphMol.h +22 -0
- rdkit_headers/include/rdkit/GraphMol/MMPA/MMPA.h +81 -0
- rdkit_headers/include/rdkit/GraphMol/MolAlign/AlignMolecules.h +183 -0
- rdkit_headers/include/rdkit/GraphMol/MolAlign/O3AAlignMolecules.h +354 -0
- rdkit_headers/include/rdkit/GraphMol/MolBundle.h +121 -0
- rdkit_headers/include/rdkit/GraphMol/MolCatalog/MolCatalog.h +20 -0
- rdkit_headers/include/rdkit/GraphMol/MolCatalog/MolCatalogEntry.h +109 -0
- rdkit_headers/include/rdkit/GraphMol/MolCatalog/MolCatalogParams.h +40 -0
- rdkit_headers/include/rdkit/GraphMol/MolChemicalFeatures/FeatureParser.h +58 -0
- rdkit_headers/include/rdkit/GraphMol/MolChemicalFeatures/MolChemicalFeature.h +98 -0
- rdkit_headers/include/rdkit/GraphMol/MolChemicalFeatures/MolChemicalFeatureDef.h +68 -0
- rdkit_headers/include/rdkit/GraphMol/MolChemicalFeatures/MolChemicalFeatureFactory.h +78 -0
- rdkit_headers/include/rdkit/GraphMol/MolDraw2D/MolDraw2D.h +539 -0
- rdkit_headers/include/rdkit/GraphMol/MolDraw2D/MolDraw2DHelpers.h +284 -0
- rdkit_headers/include/rdkit/GraphMol/MolDraw2D/MolDraw2DJS.h +62 -0
- rdkit_headers/include/rdkit/GraphMol/MolDraw2D/MolDraw2DSVG.h +88 -0
- rdkit_headers/include/rdkit/GraphMol/MolDraw2D/MolDraw2DUtils.h +179 -0
- rdkit_headers/include/rdkit/GraphMol/MolDraw2D/MolDraw2Dwx.h +107 -0
- rdkit_headers/include/rdkit/GraphMol/MolEnumerator/LinkNode.h +159 -0
- rdkit_headers/include/rdkit/GraphMol/MolEnumerator/MolEnumerator.h +276 -0
- rdkit_headers/include/rdkit/GraphMol/MolHash/MolHash.h +12 -0
- rdkit_headers/include/rdkit/GraphMol/MolHash/nmmolhash.h +60 -0
- rdkit_headers/include/rdkit/GraphMol/MolInterchange/MolInterchange.h +93 -0
- rdkit_headers/include/rdkit/GraphMol/MolInterchange/details.h +49 -0
- rdkit_headers/include/rdkit/GraphMol/MolOps.h +1016 -0
- rdkit_headers/include/rdkit/GraphMol/MolPickler.h +314 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/AcidBaseCatalog/AcidBaseCatalogEntry.h +56 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/AcidBaseCatalog/AcidBaseCatalogParams.h +65 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/AcidBaseCatalog/AcidBaseCatalogUtils.h +37 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/Charge.h +145 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/Fragment.h +105 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/FragmentCatalog/FragmentCatalogEntry.h +60 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/FragmentCatalog/FragmentCatalogParams.h +63 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/FragmentCatalog/FragmentCatalogUtils.h +35 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/Metal.h +73 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/MolStandardize.h +178 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/Normalize.h +104 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/Tautomer.h +428 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/TautomerCatalog/TautomerCatalogEntry.h +59 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/TautomerCatalog/TautomerCatalogParams.h +69 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/TautomerCatalog/TautomerCatalogUtils.h +81 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/TransformCatalog/TransformCatalogEntry.h +57 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/TransformCatalog/TransformCatalogParams.h +66 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/TransformCatalog/TransformCatalogUtils.h +37 -0
- rdkit_headers/include/rdkit/GraphMol/MolStandardize/Validate.h +199 -0
- rdkit_headers/include/rdkit/GraphMol/MolTransforms/MolTransforms.h +222 -0
- rdkit_headers/include/rdkit/GraphMol/MonomerInfo.h +138 -0
- rdkit_headers/include/rdkit/GraphMol/PartialCharges/GasteigerCharges.h +27 -0
- rdkit_headers/include/rdkit/GraphMol/PartialCharges/GasteigerParams.h +86 -0
- rdkit_headers/include/rdkit/GraphMol/PeriodicTable.h +325 -0
- rdkit_headers/include/rdkit/GraphMol/QueryAtom.h +161 -0
- rdkit_headers/include/rdkit/GraphMol/QueryBond.h +146 -0
- rdkit_headers/include/rdkit/GraphMol/QueryOps.h +1110 -0
- rdkit_headers/include/rdkit/GraphMol/RDKitBase.h +35 -0
- rdkit_headers/include/rdkit/GraphMol/RDKitQueries.h +25 -0
- rdkit_headers/include/rdkit/GraphMol/RGroupDecomposition/RGroupDecomp.h +225 -0
- rdkit_headers/include/rdkit/GraphMol/ROMol.h +844 -0
- rdkit_headers/include/rdkit/GraphMol/RWMol.h +222 -0
- rdkit_headers/include/rdkit/GraphMol/ReducedGraphs/ReducedGraphs.h +85 -0
- rdkit_headers/include/rdkit/GraphMol/Resonance.h +236 -0
- rdkit_headers/include/rdkit/GraphMol/RingInfo.h +274 -0
- rdkit_headers/include/rdkit/GraphMol/Rings.h +90 -0
- rdkit_headers/include/rdkit/GraphMol/SLNParse/SLNAttribs.h +93 -0
- rdkit_headers/include/rdkit/GraphMol/SLNParse/SLNParse.h +70 -0
- rdkit_headers/include/rdkit/GraphMol/SLNParse/SLNParseOps.h +328 -0
- rdkit_headers/include/rdkit/GraphMol/SanitException.h +120 -0
- rdkit_headers/include/rdkit/GraphMol/ScaffoldNetwork/ScaffoldNetwork.h +195 -0
- rdkit_headers/include/rdkit/GraphMol/ShapeHelpers/ShapeEncoder.h +73 -0
- rdkit_headers/include/rdkit/GraphMol/ShapeHelpers/ShapeUtils.h +279 -0
- rdkit_headers/include/rdkit/GraphMol/SmilesParse/SmartsWrite.h +46 -0
- rdkit_headers/include/rdkit/GraphMol/SmilesParse/SmilesParse.h +160 -0
- rdkit_headers/include/rdkit/GraphMol/SmilesParse/SmilesParseOps.h +53 -0
- rdkit_headers/include/rdkit/GraphMol/SmilesParse/SmilesWrite.h +288 -0
- rdkit_headers/include/rdkit/GraphMol/SmilesParse/primes.h +18 -0
- rdkit_headers/include/rdkit/GraphMol/StereoGroup.h +74 -0
- rdkit_headers/include/rdkit/GraphMol/Subgraphs/SubgraphUtils.h +57 -0
- rdkit_headers/include/rdkit/GraphMol/Subgraphs/Subgraphs.h +154 -0
- rdkit_headers/include/rdkit/GraphMol/SubstanceGroup.h +297 -0
- rdkit_headers/include/rdkit/GraphMol/Substruct/SubstructMatch.h +232 -0
- rdkit_headers/include/rdkit/GraphMol/Substruct/SubstructUtils.h +44 -0
- rdkit_headers/include/rdkit/GraphMol/SubstructLibrary/PatternFactory.h +40 -0
- rdkit_headers/include/rdkit/GraphMol/SubstructLibrary/SubstructLibrary.h +951 -0
- rdkit_headers/include/rdkit/GraphMol/SubstructLibrary/SubstructLibrarySerialization.h +231 -0
- rdkit_headers/include/rdkit/GraphMol/TautomerQuery/TautomerQuery.h +104 -0
- rdkit_headers/include/rdkit/GraphMol/Trajectory/Snapshot.h +69 -0
- rdkit_headers/include/rdkit/GraphMol/Trajectory/Trajectory.h +105 -0
- rdkit_headers/include/rdkit/GraphMol/atomic_data.h +76 -0
- rdkit_headers/include/rdkit/GraphMol/details.h +15 -0
- rdkit_headers/include/rdkit/GraphMol/new_canon.h +772 -0
- rdkit_headers/include/rdkit/Numerics/Alignment/AlignPoints.h +49 -0
- rdkit_headers/include/rdkit/Numerics/Conrec.h +203 -0
- rdkit_headers/include/rdkit/Numerics/EigenSolvers/PowerEigenSolver.h +68 -0
- rdkit_headers/include/rdkit/Numerics/Matrix.h +347 -0
- rdkit_headers/include/rdkit/Numerics/Optimizer/BFGSOpt.h +397 -0
- rdkit_headers/include/rdkit/Numerics/SquareMatrix.h +89 -0
- rdkit_headers/include/rdkit/Numerics/SymmMatrix.h +361 -0
- rdkit_headers/include/rdkit/Numerics/Vector.h +327 -0
- rdkit_headers/include/rdkit/Query/AndQuery.h +57 -0
- rdkit_headers/include/rdkit/Query/EqualityQuery.h +88 -0
- rdkit_headers/include/rdkit/Query/GreaterEqualQuery.h +74 -0
- rdkit_headers/include/rdkit/Query/GreaterQuery.h +74 -0
- rdkit_headers/include/rdkit/Query/LessEqualQuery.h +75 -0
- rdkit_headers/include/rdkit/Query/LessQuery.h +74 -0
- rdkit_headers/include/rdkit/Query/NullQueryAlgebra.h +86 -0
- rdkit_headers/include/rdkit/Query/OrQuery.h +58 -0
- rdkit_headers/include/rdkit/Query/Query.h +210 -0
- rdkit_headers/include/rdkit/Query/QueryObjects.h +38 -0
- rdkit_headers/include/rdkit/Query/RangeQuery.h +116 -0
- rdkit_headers/include/rdkit/Query/SetQuery.h +87 -0
- rdkit_headers/include/rdkit/Query/XOrQuery.h +63 -0
- rdkit_headers/include/rdkit/RDGeneral/BadFileException.h +39 -0
- rdkit_headers/include/rdkit/RDGeneral/BoostEndInclude.h +69 -0
- rdkit_headers/include/rdkit/RDGeneral/BoostStartInclude.h +95 -0
- rdkit_headers/include/rdkit/RDGeneral/ConcurrentQueue.h +132 -0
- rdkit_headers/include/rdkit/RDGeneral/Dict.h +350 -0
- rdkit_headers/include/rdkit/RDGeneral/Exceptions.h +73 -0
- rdkit_headers/include/rdkit/RDGeneral/FileParseException.h +36 -0
- rdkit_headers/include/rdkit/RDGeneral/Invariant.h +198 -0
- rdkit_headers/include/rdkit/RDGeneral/LocaleSwitcher.h +54 -0
- rdkit_headers/include/rdkit/RDGeneral/RDAny.h +217 -0
- rdkit_headers/include/rdkit/RDGeneral/RDConfig.h +49 -0
- rdkit_headers/include/rdkit/RDGeneral/RDExportMacros.h +40 -0
- rdkit_headers/include/rdkit/RDGeneral/RDLog.h +142 -0
- rdkit_headers/include/rdkit/RDGeneral/RDProps.h +172 -0
- rdkit_headers/include/rdkit/RDGeneral/RDThreads.h +44 -0
- rdkit_headers/include/rdkit/RDGeneral/RDValue-doublemagic.h +478 -0
- rdkit_headers/include/rdkit/RDGeneral/RDValue-taggedunion.h +518 -0
- rdkit_headers/include/rdkit/RDGeneral/RDValue.h +285 -0
- rdkit_headers/include/rdkit/RDGeneral/Ranking.h +87 -0
- rdkit_headers/include/rdkit/RDGeneral/StreamOps.h +637 -0
- rdkit_headers/include/rdkit/RDGeneral/export.h +559 -0
- rdkit_headers/include/rdkit/RDGeneral/hanoiSort.h +167 -0
- rdkit_headers/include/rdkit/RDGeneral/hash/detail/float_functions.hpp +156 -0
- rdkit_headers/include/rdkit/RDGeneral/hash/detail/hash_float.hpp +179 -0
- rdkit_headers/include/rdkit/RDGeneral/hash/extensions.hpp +152 -0
- rdkit_headers/include/rdkit/RDGeneral/hash/hash.hpp +463 -0
- rdkit_headers/include/rdkit/RDGeneral/hash/hash_fwd.hpp +51 -0
- rdkit_headers/include/rdkit/RDGeneral/test.h +274 -0
- rdkit_headers/include/rdkit/RDGeneral/types.h +401 -0
- rdkit_headers/include/rdkit/RDGeneral/utils.h +106 -0
- rdkit_headers/include/rdkit/RDGeneral/versions.h +27 -0
- rdkit_headers/include/rdkit/RDStreams/streams.h +19 -0
- rdkit_headers/include/rdkit/RingDecomposerLib.h +751 -0
- rdkit_headers/include/rdkit/SimDivPickers/DistPicker.h +92 -0
- rdkit_headers/include/rdkit/SimDivPickers/HierarchicalClusterPicker.h +107 -0
- rdkit_headers/include/rdkit/SimDivPickers/LeaderPicker.h +470 -0
- rdkit_headers/include/rdkit/SimDivPickers/MaxMinPicker.h +303 -0
- rdkit_headers-2022.3.3.dist-info/METADATA +24 -0
- rdkit_headers-2022.3.3.dist-info/RECORD +320 -0
- rdkit_headers-2022.3.3.dist-info/WHEEL +4 -0
- rdkit_headers-2022.3.3.dist-info/entry_points.txt +4 -0
- rdkit_headers-2022.3.3.dist-info/licenses/LICENSE +29 -0
- rdkit_headers-2022.3.3.dist-info/licenses/NOTICE +5 -0
|
@@ -0,0 +1,751 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* This file is part of the RingDecomposerLib, licensed
|
|
3
|
+
* under BSD New license (see LICENSE in the root directory).
|
|
4
|
+
* Copyright (c) 2016
|
|
5
|
+
* University of Hamburg, ZBH - Center for Bioinformatics
|
|
6
|
+
* Niek Andresen, Florian Flachsenberg, Matthias Rarey
|
|
7
|
+
*
|
|
8
|
+
* Please cite:
|
|
9
|
+
*
|
|
10
|
+
* Kolodzik, A.; Urbaczek, S.; Rarey, M.
|
|
11
|
+
* Unique Ring Families: A Chemically Meaningful Description
|
|
12
|
+
* of Molecular Ring Topologies.
|
|
13
|
+
* J. Chem. Inf. Model., 2012, 52 (8), pp 2013-2021
|
|
14
|
+
*
|
|
15
|
+
* Flachsenberg, F.; Andresen, N.; Rarey, M.
|
|
16
|
+
* RingDecomposerLib: An Open-Source Implementation of
|
|
17
|
+
* Unique Ring Families and Other Cycle Bases.
|
|
18
|
+
* J. Chem. Inf. Model., 2017, 57 (2), pp 122-126
|
|
19
|
+
*/
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* @file RingDecomposerLib.h
|
|
23
|
+
* @brief This file contains the API of the RingDecomposerLib
|
|
24
|
+
* library.
|
|
25
|
+
*/
|
|
26
|
+
|
|
27
|
+
#ifndef RING_DECOMPOSER_LIB_H
|
|
28
|
+
#define RING_DECOMPOSER_LIB_H
|
|
29
|
+
|
|
30
|
+
#if (defined( _WIN32 ) && defined( _MSC_VER ) )
|
|
31
|
+
/* Win32 & MS VC ++ */
|
|
32
|
+
#define RDL_API __declspec(dllexport)
|
|
33
|
+
#elif __GNUC__ >= 4 || defined(__clang__)
|
|
34
|
+
#define RDL_API __attribute__((visibility("default")))
|
|
35
|
+
#else
|
|
36
|
+
#define RDL_API
|
|
37
|
+
#endif
|
|
38
|
+
|
|
39
|
+
#ifdef __cplusplus
|
|
40
|
+
extern "C" {
|
|
41
|
+
#endif
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* @brief Structure representing a calculation result.
|
|
45
|
+
*
|
|
46
|
+
* This is the central structure, that is used to store
|
|
47
|
+
* the calculation results. Almost all functions
|
|
48
|
+
* in this header work on it.
|
|
49
|
+
*/
|
|
50
|
+
typedef struct RDL_data RDL_data;
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* @brief Datastructure representing a graph for calculations.
|
|
54
|
+
*
|
|
55
|
+
* Build graph data structure that is used for the calculation.
|
|
56
|
+
* The graph is stored as an adjacency list.
|
|
57
|
+
* The vertices are numbered from 0 to |V|-1. Call the following functions:
|
|
58
|
+
*
|
|
59
|
+
* \ref RDL_initNewGraph(unsigned V) to initialize a new graph with V vertices
|
|
60
|
+
* (returns \ref RDL_graph *)
|
|
61
|
+
*
|
|
62
|
+
* \ref RDL_addUEdge(RDL_graph *, RDL_node from, RDL_node to) to add a new (undirected) edge
|
|
63
|
+
* from the vertex with index "from" to the vertex with index "to".
|
|
64
|
+
*
|
|
65
|
+
* Then \ref RDL_calculate can be called on it.
|
|
66
|
+
*
|
|
67
|
+
*/
|
|
68
|
+
typedef struct RDL_graph RDL_graph;
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* @brief A node is represented by its index in the graph (0 to |V|-1).
|
|
72
|
+
*/
|
|
73
|
+
typedef unsigned RDL_node;
|
|
74
|
+
|
|
75
|
+
/** @brief An edge is represented by an array of size two
|
|
76
|
+
* containing the adjacent nodes.
|
|
77
|
+
*/
|
|
78
|
+
typedef RDL_node RDL_edge[2];
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* @brief error levels for custom logging functions
|
|
82
|
+
*/
|
|
83
|
+
typedef enum RDL_ERROR_LEVEL {
|
|
84
|
+
RDL_DEBUG,
|
|
85
|
+
RDL_WARNING,
|
|
86
|
+
RDL_ERROR,
|
|
87
|
+
RDL_INITIALIZE_OUTPUT
|
|
88
|
+
} RDL_ERROR_LEVEL;
|
|
89
|
+
|
|
90
|
+
/*
|
|
91
|
+
* @brief output function for writing errors/warnings
|
|
92
|
+
*
|
|
93
|
+
* @param level `RDL_ERROR_LEVEL` specifying the level of the message
|
|
94
|
+
* @param m message associated with the event
|
|
95
|
+
*/
|
|
96
|
+
typedef void (*RDL_outputFunction) (RDL_ERROR_LEVEL level, const char* m, ...);
|
|
97
|
+
|
|
98
|
+
/** @brief the output function for warnings and errors */
|
|
99
|
+
RDL_API extern RDL_outputFunction RDL_outputFunc;
|
|
100
|
+
|
|
101
|
+
/**
|
|
102
|
+
* @brief Set the output function for warning and error messages.
|
|
103
|
+
* @param func: callback function for errors and warnings
|
|
104
|
+
* @warning This function sets a `static` variable. When using multiple
|
|
105
|
+
* threads, only one thread should set the output function and the
|
|
106
|
+
* output function should be thread-safe.
|
|
107
|
+
*
|
|
108
|
+
* Default is no output at all (\ref RDL_writeNothing).
|
|
109
|
+
* Call `RDL_setOutputFunction(RDL_writeToStderr)` to enable output
|
|
110
|
+
* of warning and error messages to `stderr`.
|
|
111
|
+
*/
|
|
112
|
+
RDL_API
|
|
113
|
+
void RDL_setOutputFunction(RDL_outputFunction func);
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* @brief An output function for writing everything to stderr
|
|
117
|
+
*/
|
|
118
|
+
RDL_API
|
|
119
|
+
void RDL_writeToStderr(RDL_ERROR_LEVEL level, const char* fmt, ...);
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* @brief No output function
|
|
123
|
+
*/
|
|
124
|
+
RDL_API
|
|
125
|
+
void RDL_writeNothing(RDL_ERROR_LEVEL level, const char* fmt, ...);
|
|
126
|
+
|
|
127
|
+
/** @brief Invalid result indicator */
|
|
128
|
+
RDL_API extern const unsigned RDL_INVALID_RESULT;
|
|
129
|
+
/** @brief Duplicate edge indicator */
|
|
130
|
+
RDL_API extern const unsigned RDL_DUPLICATE_EDGE;
|
|
131
|
+
/** @brief No ringsystem indicator */
|
|
132
|
+
RDL_API extern const unsigned RDL_NO_RINGSYSTEM;
|
|
133
|
+
/** @brief Invalid number of RCs */
|
|
134
|
+
RDL_API extern const double RDL_INVALID_RC_COUNT;
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* @brief Initializes a new \ref RDL_graph
|
|
138
|
+
* @param nof_nodes the number of nodes in the graph
|
|
139
|
+
* @return pointer to the new \ref RDL_graph structure.
|
|
140
|
+
*/
|
|
141
|
+
RDL_API
|
|
142
|
+
RDL_graph *RDL_initNewGraph(unsigned nof_nodes);
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* @brief Delete \ref RDL_graph.
|
|
146
|
+
* @param graph pointer to \ref RDL_graph to delete
|
|
147
|
+
* @note You don't have to delete the graph after successful calculation!
|
|
148
|
+
*/
|
|
149
|
+
RDL_API
|
|
150
|
+
void RDL_deleteGraph(RDL_graph *graph);
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* @brief Adds an undirected edge to the graph.
|
|
154
|
+
* @param graph pointer to the \ref RDL_graph that the edge will to be added to
|
|
155
|
+
* @param node1, node2 pair of \ref RDL_node which the edge is going to connect
|
|
156
|
+
* @returns internal index of edge if successful,
|
|
157
|
+
* \ref RDL_INVALID_RESULT on failures (invalid index, loop),
|
|
158
|
+
* \ref RDL_DUPLICATE_EDGE if the edge was already present
|
|
159
|
+
*/
|
|
160
|
+
RDL_API
|
|
161
|
+
unsigned RDL_addUEdge(RDL_graph *graph, RDL_node node1, RDL_node node2);
|
|
162
|
+
|
|
163
|
+
/**
|
|
164
|
+
* @brief Calculates the \ref RDL_data structure of the given graph and returns it.
|
|
165
|
+
* @param input_graph The graph for calculation.
|
|
166
|
+
* @return pointer to the \ref RDL_data containing the calculation result, `NULL` on failure
|
|
167
|
+
* @note The \ref RDL_graph has to be an undirected graph.
|
|
168
|
+
* @note Takes ownership of the \ref RDL_graph, if calculation is successful!
|
|
169
|
+
*/
|
|
170
|
+
RDL_API
|
|
171
|
+
RDL_data *RDL_calculate(RDL_graph *input_graph);
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* @brief Deletes \ref RDL_data from memory, including the \ref RDL_graph.
|
|
175
|
+
* @param data pointer to the \ref RDL_data that is going to be deleted
|
|
176
|
+
* @note also deletes the associated \ref RDL_graph
|
|
177
|
+
*/
|
|
178
|
+
RDL_API
|
|
179
|
+
void RDL_deleteData(RDL_data *data);
|
|
180
|
+
|
|
181
|
+
/**
|
|
182
|
+
* @brief Returns the number of URFs.
|
|
183
|
+
* @param data Pointer to the \ref RDL_data of which the number of URF is requested
|
|
184
|
+
* @return The number of URFs, \ref RDL_INVALID_RESULT on failure
|
|
185
|
+
*/
|
|
186
|
+
RDL_API
|
|
187
|
+
unsigned RDL_getNofURF(const RDL_data *data);
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* @brief Returns the number of RCFs.
|
|
191
|
+
* @param data Pointer to the \ref RDL_data of which the number of RCF is requested
|
|
192
|
+
* @return The number of RCFs, \ref RDL_INVALID_RESULT on failure
|
|
193
|
+
*/
|
|
194
|
+
RDL_API
|
|
195
|
+
unsigned RDL_getNofRCF(const RDL_data *data);
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* @brief Returns the weight of each cycle in the URF identified by its index.
|
|
199
|
+
* @param data pointer to the \ref RDL_data holding the URFs
|
|
200
|
+
* @param index the index of the URF
|
|
201
|
+
* @return the weight of the URF, \ref RDL_INVALID_RESULT on failure (if `index` is out of range)
|
|
202
|
+
*/
|
|
203
|
+
RDL_API
|
|
204
|
+
unsigned RDL_getWeightForURF(const RDL_data *data, unsigned index);
|
|
205
|
+
|
|
206
|
+
/**
|
|
207
|
+
* @brief Returns the weight of each cycle in the RCF identified by its index.
|
|
208
|
+
* @param data pointer to the \ref RDL_data holding the URFs
|
|
209
|
+
* @param index the index of the RCF
|
|
210
|
+
* @return the weight of the RCF, \ref RDL_INVALID_RESULT on failure (if `index` is out of range)
|
|
211
|
+
*/
|
|
212
|
+
RDL_API
|
|
213
|
+
unsigned RDL_getWeightForRCF(const RDL_data *data, unsigned index);
|
|
214
|
+
|
|
215
|
+
/**
|
|
216
|
+
* @brief Gives the nodes of an URF identified with its index in an array of \ref RDL_node.
|
|
217
|
+
* @return the number of nodes in the URF, \ref RDL_INVALID_RESULT on failure
|
|
218
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
219
|
+
* @param index the index of the URF
|
|
220
|
+
* @param RDL_node_array_ptr pointer that points to the result array (declare
|
|
221
|
+
* \ref RDL_node * and give address as parameter)
|
|
222
|
+
* @note result has to be deallocated using `free(*RDL_node_array_ptr)`.
|
|
223
|
+
*/
|
|
224
|
+
RDL_API
|
|
225
|
+
unsigned RDL_getNodesForURF(const RDL_data *data, unsigned index,
|
|
226
|
+
RDL_node **RDL_node_array_ptr);
|
|
227
|
+
|
|
228
|
+
/**
|
|
229
|
+
* @brief Gives the edges of an URF identified with its index.
|
|
230
|
+
* @return the number of edges in this URF, \ref RDL_INVALID_RESULT on failure
|
|
231
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
232
|
+
* @param index the index of the URF
|
|
233
|
+
* @param RDL_edge_array_ptr pointer that points to the result array (declare
|
|
234
|
+
* \ref RDL_edge * and give address as parameter)
|
|
235
|
+
* @note Result has to be deallocated using `free(*RDL_edge_array_ptr)`
|
|
236
|
+
* Gives an array of edges where an edge is represented by two \ref RDL_node that it
|
|
237
|
+
* connects.
|
|
238
|
+
*/
|
|
239
|
+
RDL_API
|
|
240
|
+
unsigned RDL_getEdgesForURF(const RDL_data *data, unsigned index,
|
|
241
|
+
RDL_edge **RDL_edge_array_ptr);
|
|
242
|
+
|
|
243
|
+
/**
|
|
244
|
+
* @brief Gives the nodes of an RCF identified with its index in an array of \ref RDL_node.
|
|
245
|
+
* @return the number of nodes in the RCF, \ref RDL_INVALID_RESULT on failure
|
|
246
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
247
|
+
* @param index the index of the RCF
|
|
248
|
+
* @param RDL_node_array_ptr pointer that points to the result array (declare
|
|
249
|
+
* \ref RDL_node * and give address as parameter)
|
|
250
|
+
* @note result has to be deallocated using `free(*RDL_node_array_ptr)`.
|
|
251
|
+
*/
|
|
252
|
+
RDL_API
|
|
253
|
+
unsigned RDL_getNodesForRCF(const RDL_data *data, unsigned index,
|
|
254
|
+
RDL_node **RDL_node_array_ptr);
|
|
255
|
+
|
|
256
|
+
/**
|
|
257
|
+
* @brief Gives the edges of an RCF identified with its index.
|
|
258
|
+
* @return the number of edges in this RCF, \ref RDL_INVALID_RESULT on failure
|
|
259
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
260
|
+
* @param index the index of the RCF
|
|
261
|
+
* @param RDL_edge_array_ptr pointer that points to the result array (declare
|
|
262
|
+
* \ref RDL_edge * and give address as parameter)
|
|
263
|
+
* @note Result has to be deallocated using `free(*RDL_edge_array_ptr)`
|
|
264
|
+
* Gives an array of edges where an edge is represented by two \ref RDL_node that it
|
|
265
|
+
* connects.
|
|
266
|
+
*/
|
|
267
|
+
RDL_API
|
|
268
|
+
unsigned RDL_getEdgesForRCF(const RDL_data *data, unsigned index,
|
|
269
|
+
RDL_edge **RDL_edge_array_ptr);
|
|
270
|
+
|
|
271
|
+
/**
|
|
272
|
+
* @brief Returns the number of URFs that contain the given node.
|
|
273
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
274
|
+
* @param node the \ref RDL_node to look for in the URFs
|
|
275
|
+
* @return number of URFs containing the node, \ref RDL_INVALID_RESULT on failure
|
|
276
|
+
* @note This functions internally enumerates all nodes for each URF.
|
|
277
|
+
* For repeated checks with different \ref RDL_node it is recommended to
|
|
278
|
+
* enumerate them with \ref RDL_getNodesForURF and check against this array.
|
|
279
|
+
*/
|
|
280
|
+
RDL_API
|
|
281
|
+
unsigned RDL_getNofURFContainingNode(const RDL_data *data, RDL_node node);
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* @brief Returns the number of URFs that contain the \ref RDL_edge defined
|
|
285
|
+
* by the two given nodes
|
|
286
|
+
* @param data Pointer to the \ref RDL_data storing the calculation results.
|
|
287
|
+
* @param node1, node2 pair of \ref RDL_node connected by the edge
|
|
288
|
+
* @return number of URFs containing the edge, \ref RDL_INVALID_RESULT on failure
|
|
289
|
+
* @note This functions internally enumerates all edges for each URF.
|
|
290
|
+
* For repeated checks with different \ref RDL_node it is recommended to
|
|
291
|
+
* enumerate them with \ref RDL_getEdgesForURF and check against this array.
|
|
292
|
+
*/
|
|
293
|
+
RDL_API
|
|
294
|
+
unsigned RDL_getNofURFContainingEdge(const RDL_data *data, RDL_node node1,
|
|
295
|
+
RDL_node node2);
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* @brief Returns the number of RCFs that contain the given node.
|
|
299
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
300
|
+
* @param node the \ref RDL_node to look for in the RCFs
|
|
301
|
+
* @return number of RCFs containing the node, \ref RDL_INVALID_RESULT on failure
|
|
302
|
+
* @note This functions internally enumerates all nodes for each RCF.
|
|
303
|
+
* For repeated checks with different \ref RDL_node it is recommended to
|
|
304
|
+
* enumerate them with \ref RDL_getNodesForRCF and check against this array.
|
|
305
|
+
*/
|
|
306
|
+
RDL_API
|
|
307
|
+
unsigned RDL_getNofRCFContainingNode(const RDL_data *data, RDL_node node);
|
|
308
|
+
|
|
309
|
+
/**
|
|
310
|
+
* @brief Returns the number of RCFs that contain the \ref RDL_edge defined
|
|
311
|
+
* by the two given nodes
|
|
312
|
+
* @param data Pointer to the \ref RDL_data storing the calculation results.
|
|
313
|
+
* @param node1, node2 pair of \ref RDL_node connected by the edge
|
|
314
|
+
* @return number of RCFs containing the edge, \ref RDL_INVALID_RESULT on failure
|
|
315
|
+
* @note This functions internally enumerates all edges for each RCF.
|
|
316
|
+
* For repeated checks with different \ref RDL_node it is recommended to
|
|
317
|
+
* enumerate them with \ref RDL_getEdgesForRCF and check against this array.
|
|
318
|
+
*/
|
|
319
|
+
RDL_API
|
|
320
|
+
unsigned RDL_getNofRCFContainingEdge(const RDL_data *data, RDL_node node1,
|
|
321
|
+
RDL_node node2);
|
|
322
|
+
|
|
323
|
+
/**
|
|
324
|
+
* @brief Gives all URFs containing the node.
|
|
325
|
+
* @return the number of URFs containing the node, \ref RDL_INVALID_RESULT on failure
|
|
326
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
327
|
+
* @param node the \ref RDL_node
|
|
328
|
+
* @param RDL_ids_ptr pointer that points to the result array of integers
|
|
329
|
+
* containing all indices of URFs containing the node. (declare `unsigned *` and give
|
|
330
|
+
* address as parameter)
|
|
331
|
+
* @note The array RDL_ids_ptr has to be to be deallocated with
|
|
332
|
+
* `free(*RDL_ids_ptr)`
|
|
333
|
+
* @note This functions internally enumerates all nodes for each URF.
|
|
334
|
+
* For repeated queries with different \ref RDL_node it is recommended to
|
|
335
|
+
* enumerate them with \ref RDL_getNodesForURF once and use this array.
|
|
336
|
+
*/
|
|
337
|
+
RDL_API
|
|
338
|
+
unsigned RDL_getURFsContainingNode(const RDL_data *data, RDL_node node,
|
|
339
|
+
unsigned **RDL_ids_ptr);
|
|
340
|
+
|
|
341
|
+
/**
|
|
342
|
+
* @brief Gives all URFs containing the edge.
|
|
343
|
+
* @return the number of URFs containing the edge, \ref RDL_INVALID_RESULT on failure
|
|
344
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
345
|
+
* @param node1 the first \ref RDL_node of the edge
|
|
346
|
+
* @param node2 the the second \ref RDL_node of the edge
|
|
347
|
+
* @param RDL_ids_ptr pointer that points to the result array of integers
|
|
348
|
+
* containing all indices of URFs containing the edge. (declare `unsigned *` and give
|
|
349
|
+
* address as parameter)
|
|
350
|
+
* @note The array RDL_ids_ptr has to be to be deallocated with
|
|
351
|
+
* `free(*RDL_ids_ptr)`
|
|
352
|
+
* @note This functions internally enumerates all edges for each URF.
|
|
353
|
+
* For repeated queries with different \ref RDL_node it is recommended to
|
|
354
|
+
* enumerate them with \ref RDL_getEdgesForURF once and use this array.
|
|
355
|
+
*/
|
|
356
|
+
RDL_API
|
|
357
|
+
unsigned RDL_getURFsContainingEdge(const RDL_data *data, RDL_node node1,
|
|
358
|
+
RDL_node node2, unsigned **RDL_ids_ptr);
|
|
359
|
+
|
|
360
|
+
/**
|
|
361
|
+
* @brief Gives all RCFs containing the node.
|
|
362
|
+
* @return the number of RCFs containing the node, \ref RDL_INVALID_RESULT on failure
|
|
363
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
364
|
+
* @param node the \ref RDL_node
|
|
365
|
+
* @param RDL_ids_ptr pointer that points to the result array of integers
|
|
366
|
+
* containing all indices of URFs containing the node. (declare `unsigned *` and give
|
|
367
|
+
* address as parameter)
|
|
368
|
+
* @note The array RDL_ids_ptr has to be to be deallocated with
|
|
369
|
+
* `free(*RDL_ids_ptr)`
|
|
370
|
+
* @note This functions internally enumerates all nodes for each RCF.
|
|
371
|
+
* For repeated queries with different \ref RDL_node it is recommended to
|
|
372
|
+
* enumerate them with \ref RDL_getNodesForRCF once and use this array.
|
|
373
|
+
*/
|
|
374
|
+
RDL_API
|
|
375
|
+
unsigned RDL_getRCFsContainingNode(const RDL_data *data, RDL_node node,
|
|
376
|
+
unsigned **RDL_ids_ptr);
|
|
377
|
+
|
|
378
|
+
/**
|
|
379
|
+
* @brief Gives all RCFs containing the edge.
|
|
380
|
+
* @return the number of RCFs containing the edge, \ref RDL_INVALID_RESULT on failure
|
|
381
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
382
|
+
* @param node1 the first \ref RDL_node of the edge
|
|
383
|
+
* @param node2 the the second \ref RDL_node of the edge
|
|
384
|
+
* @param RDL_ids_ptr pointer that points to the result array of integers
|
|
385
|
+
* containing all indices of RCFs containing the edge. (declare `unsigned *` and give
|
|
386
|
+
* address as parameter)
|
|
387
|
+
* @note The array RDL_ids_ptr has to be to be deallocated with
|
|
388
|
+
* `free(*RDL_ids_ptr)`
|
|
389
|
+
* @note This functions internally enumerates all edges for each RCF.
|
|
390
|
+
* For repeated queries with different \ref RDL_node it is recommended to
|
|
391
|
+
* enumerate them with \ref RDL_getEdgesForRCF once and use this array.
|
|
392
|
+
*/
|
|
393
|
+
RDL_API
|
|
394
|
+
unsigned RDL_getRCFsContainingEdge(const RDL_data *data, RDL_node node1,
|
|
395
|
+
RDL_node node2, unsigned **RDL_ids_ptr);
|
|
396
|
+
|
|
397
|
+
/**
|
|
398
|
+
* This structure holds a cycle (or ring) in the graph.
|
|
399
|
+
* It is essentially an array of edges which are represented by pairs of nodes.
|
|
400
|
+
*/
|
|
401
|
+
typedef struct RDL_cycle {
|
|
402
|
+
/** array of \ref RDL_edge in the cycle */
|
|
403
|
+
RDL_edge *edges;
|
|
404
|
+
/** weight of the cycle (length of the array) */
|
|
405
|
+
unsigned weight;
|
|
406
|
+
/** URF of the cycle */
|
|
407
|
+
unsigned urf;
|
|
408
|
+
/** RCF of the cycle */
|
|
409
|
+
unsigned rcf;
|
|
410
|
+
} RDL_cycle;
|
|
411
|
+
|
|
412
|
+
/**
|
|
413
|
+
* @brief Free memory of \ref RDL_cycle
|
|
414
|
+
* @param cycle The \ref RDL_cycle to delete.
|
|
415
|
+
*/
|
|
416
|
+
RDL_API
|
|
417
|
+
void RDL_deleteCycle(RDL_cycle *cycle);
|
|
418
|
+
|
|
419
|
+
/**
|
|
420
|
+
* @brief Iterator for relevant cycles.
|
|
421
|
+
*
|
|
422
|
+
* Always check if the iterator is at end BEFORE incrementing
|
|
423
|
+
* or accessing it.
|
|
424
|
+
*
|
|
425
|
+
* Example usage:
|
|
426
|
+
*
|
|
427
|
+
* RDL_cycle *cycle;
|
|
428
|
+
* RDL_cycleIterator *it = RDL_getRCyclesIterator(data);
|
|
429
|
+
* while(!RDL_cycleIteratorAtEnd(it)) {
|
|
430
|
+
* cycle = RDL_cycleIteratorGetCycle(it);
|
|
431
|
+
* <do something with the cycle>
|
|
432
|
+
* RDL_deleteCycle(cycle);
|
|
433
|
+
* RDL_cycleIteratorNext(it);
|
|
434
|
+
* }
|
|
435
|
+
* RDL_deleteCycleIterator(it);
|
|
436
|
+
*/
|
|
437
|
+
typedef struct RDL_cycleIterator RDL_cycleIterator;
|
|
438
|
+
|
|
439
|
+
/**
|
|
440
|
+
* @brief Advance the cycle iterator by one.
|
|
441
|
+
* @param it \ref RDL_cycleIterator
|
|
442
|
+
* @returns returns the iterator `it` itself, if successful; `NULL` on error
|
|
443
|
+
* @note DO NOT call without checking \ref RDL_cycleIteratorAtEnd
|
|
444
|
+
*/
|
|
445
|
+
RDL_API
|
|
446
|
+
RDL_cycleIterator* RDL_cycleIteratorNext(RDL_cycleIterator* it);
|
|
447
|
+
|
|
448
|
+
/**
|
|
449
|
+
* @brief Get the cycle as \ref RDL_cycle
|
|
450
|
+
* @param it \ref RDL_cycleIterator
|
|
451
|
+
* @returns \ref RDL_cycle holding the cycle, `NULL` on error
|
|
452
|
+
* @note The \ref RDL_cycle is constructed and returned as a pointer.
|
|
453
|
+
* You have to delete it using \ref RDL_deleteCycle.
|
|
454
|
+
* @note DO NOT call without checking \ref RDL_cycleIteratorAtEnd
|
|
455
|
+
*/
|
|
456
|
+
RDL_API
|
|
457
|
+
RDL_cycle* RDL_cycleIteratorGetCycle(RDL_cycleIterator* it);
|
|
458
|
+
|
|
459
|
+
/**
|
|
460
|
+
* @brief Check if iterator is at end (invalid)
|
|
461
|
+
* @param it \ref RDL_cycleIterator
|
|
462
|
+
* @returns 0 if not at end, a non-zero value otherwise
|
|
463
|
+
*/
|
|
464
|
+
RDL_API
|
|
465
|
+
int RDL_cycleIteratorAtEnd(RDL_cycleIterator* it);
|
|
466
|
+
/**
|
|
467
|
+
* @brief Free memory of the cycle iterator
|
|
468
|
+
* @param it \ref RDL_cycleIterator
|
|
469
|
+
*/
|
|
470
|
+
RDL_API
|
|
471
|
+
void RDL_deleteCycleIterator(RDL_cycleIterator* it);
|
|
472
|
+
|
|
473
|
+
/**
|
|
474
|
+
* @brief Gives all relevant cycles of the URF with the given index.
|
|
475
|
+
* @return the number of cycles found, \ref RDL_INVALID_RESULT on failure
|
|
476
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
477
|
+
* @param index the index of the URF
|
|
478
|
+
* @param RDL_cycle_array_ptr pointer that points to the result array of cycles
|
|
479
|
+
* (declare \ref RDL_cycle ** and give address as parameter)
|
|
480
|
+
* @note RDL_cycle_array_ptr has to be deallocated using
|
|
481
|
+
* \ref RDL_deleteCycles(RDL_cycle **cycles, unsigned number)
|
|
482
|
+
* @note Consider using \ref RDL_getRCyclesForURFIterator instead
|
|
483
|
+
*/
|
|
484
|
+
RDL_API
|
|
485
|
+
unsigned RDL_getRCyclesForURF(const RDL_data *data, unsigned index,
|
|
486
|
+
RDL_cycle ***RDL_cycle_array_ptr);
|
|
487
|
+
|
|
488
|
+
/**
|
|
489
|
+
* @brief Get iterator for all relevant cycles of the URF with the given index.
|
|
490
|
+
* @return \ref RDL_cycleIterator, NULL on failure
|
|
491
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
492
|
+
* @param index the index of the URF
|
|
493
|
+
* @note See \ref RDL_cycleIterator for an example.
|
|
494
|
+
*/
|
|
495
|
+
RDL_API
|
|
496
|
+
RDL_cycleIterator* RDL_getRCyclesForURFIterator(const RDL_data *data, unsigned index);
|
|
497
|
+
|
|
498
|
+
/**
|
|
499
|
+
* @brief Gives all relevant cycles of the RCF with the given index.
|
|
500
|
+
* @return the number of cycles found, \ref RDL_INVALID_RESULT on failure
|
|
501
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
502
|
+
* @param index the index of the RCF
|
|
503
|
+
* @param RDL_cycle_array_ptr pointer that points to the result array of cycles
|
|
504
|
+
* (declare \ref RDL_cycle ** and give address as parameter)
|
|
505
|
+
* @note RDL_cycle_array_ptr has to be deallocated using
|
|
506
|
+
* \ref RDL_deleteCycles(RDL_cycle **cycles, unsigned number)
|
|
507
|
+
* @note Consider using \ref RDL_getRCyclesForRCFIterator instead
|
|
508
|
+
*/
|
|
509
|
+
RDL_API
|
|
510
|
+
unsigned RDL_getRCyclesForRCF(const RDL_data *data, unsigned index,
|
|
511
|
+
RDL_cycle ***RDL_cycle_array_ptr);
|
|
512
|
+
|
|
513
|
+
/**
|
|
514
|
+
* @brief Get iterator for all relevant cycles of the RCF with the given index.
|
|
515
|
+
* @return \ref RDL_cycleIterator, NULL on failure
|
|
516
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
517
|
+
* @param index the index of the RCF
|
|
518
|
+
* @note See \ref RDL_cycleIterator for an example.
|
|
519
|
+
*/
|
|
520
|
+
RDL_API
|
|
521
|
+
RDL_cycleIterator* RDL_getRCyclesForRCFIterator(const RDL_data *data, unsigned index);
|
|
522
|
+
|
|
523
|
+
/**
|
|
524
|
+
* @brief Gives a list of all relevant cycles
|
|
525
|
+
* @return the number of cycles, \ref RDL_INVALID_RESULT on error
|
|
526
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
527
|
+
* @param RDL_cycle_array_ptr pointer to the result array
|
|
528
|
+
* (declare \ref RDL_cycle ** and give address as parameter)
|
|
529
|
+
* The result is an array of cycles.
|
|
530
|
+
* @note Result has to be deallocated using
|
|
531
|
+
* \ref RDL_deleteCycles(RDL_cycle **cycles, unsigned number)
|
|
532
|
+
* @note Consider using \ref RDL_getRCyclesIterator instead
|
|
533
|
+
*/
|
|
534
|
+
RDL_API
|
|
535
|
+
unsigned RDL_getRCycles(const RDL_data *data, RDL_cycle ***RDL_cycle_array_ptr);
|
|
536
|
+
|
|
537
|
+
/**
|
|
538
|
+
* @brief Get iterator for all relevant cycles.
|
|
539
|
+
* @return \ref RDL_cycleIterator, NULL on failure
|
|
540
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
541
|
+
* @note See \ref RDL_cycleIterator for an example.
|
|
542
|
+
*/
|
|
543
|
+
RDL_API
|
|
544
|
+
RDL_cycleIterator* RDL_getRCyclesIterator(const RDL_data *data);
|
|
545
|
+
|
|
546
|
+
/**
|
|
547
|
+
* @brief Gives the number of relevant cycles in this URF
|
|
548
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
549
|
+
* @param index the index of the URF
|
|
550
|
+
* @returns the number of relevant cycles in the URF or
|
|
551
|
+
* \ref RDL_INVALID_RC_COUNT if the number is too large to calculate or on failure
|
|
552
|
+
*/
|
|
553
|
+
RDL_API
|
|
554
|
+
double RDL_getNofRCForURF(const RDL_data *data, unsigned index);
|
|
555
|
+
|
|
556
|
+
/**
|
|
557
|
+
* @brief Gives the number of relevant cycles in this RCF.
|
|
558
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
559
|
+
* @param index id of the RCF
|
|
560
|
+
* @returns the number of relevant cycles in the RCF or
|
|
561
|
+
* \ref RDL_INVALID_RC_COUNT if the number is too large to calculate or on failure
|
|
562
|
+
*/
|
|
563
|
+
RDL_API
|
|
564
|
+
double RDL_getNofRCForRCF(const RDL_data *data, unsigned index);
|
|
565
|
+
|
|
566
|
+
/**
|
|
567
|
+
* @brief Gives the number of relevant cycles
|
|
568
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
569
|
+
* @returns the number of relevant cycles
|
|
570
|
+
* \ref RDL_INVALID_RC_COUNT if the number is too large to calculate or on failure
|
|
571
|
+
*/
|
|
572
|
+
RDL_API
|
|
573
|
+
double RDL_getNofRC(const RDL_data *data);
|
|
574
|
+
|
|
575
|
+
/**
|
|
576
|
+
* @brief Gives a set of cycles that forms a Minimal Cycle Basis of the graph.
|
|
577
|
+
* @return the number of cycles returned (`|E|-|V|+1` for connected graphs),
|
|
578
|
+
* RDL_INVALID_RESULT on error
|
|
579
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
580
|
+
* @param RDL_cycle_array_ptr pointer that points to the result array
|
|
581
|
+
* (declare \ref RDL_cycle ** and give address as parameter)
|
|
582
|
+
* @note Result has to be deallocated using
|
|
583
|
+
* \ref RDL_deleteCycles(RDL_cycle **cycles, unsigned number)
|
|
584
|
+
* The result is an array of cycles.
|
|
585
|
+
*/
|
|
586
|
+
RDL_API
|
|
587
|
+
unsigned RDL_getSSSR(const RDL_data *data, RDL_cycle ***RDL_cycle_array_ptr);
|
|
588
|
+
|
|
589
|
+
/**
|
|
590
|
+
* @brief Gives a list of relevant cycle prototypes (one for each RCF).
|
|
591
|
+
* @return the number of prototypes, \ref RDL_INVALID_RESULT on error
|
|
592
|
+
* @param data pointer to the \ref RDL_data holding the calculation results
|
|
593
|
+
* @param RDL_cycle_array_ptr pointer to the result array
|
|
594
|
+
* (declare \ref RDL_cycle ** and give address as parameter)
|
|
595
|
+
* The result is an array of cycles.
|
|
596
|
+
* @note Result has to be deallocated using
|
|
597
|
+
* \ref RDL_deleteCycles(RDL_cycle **cycles, unsigned number)
|
|
598
|
+
*/
|
|
599
|
+
RDL_API
|
|
600
|
+
unsigned RDL_getRCPrototypes(const RDL_data *data,
|
|
601
|
+
RDL_cycle ***RDL_cycle_array_ptr);
|
|
602
|
+
|
|
603
|
+
/**
|
|
604
|
+
* @brief Deallocates the structure given by \ref RDL_getRCycles(), \ref RDL_getSSSR(),
|
|
605
|
+
* \ref RDL_getRCPrototypes() and \ref RDL_getRCyclesForURF(), if called on its result and
|
|
606
|
+
* return value (the number of cycles)
|
|
607
|
+
* @param cycles The array of cycles.
|
|
608
|
+
* @param number The number of cycles in the array
|
|
609
|
+
*/
|
|
610
|
+
RDL_API
|
|
611
|
+
void RDL_deleteCycles(RDL_cycle **cycles, unsigned number);
|
|
612
|
+
|
|
613
|
+
/**
|
|
614
|
+
* @brief Translates the results of \ref RDL_getRCycles(), \ref RDL_getSSSR(),
|
|
615
|
+
* \ref RDL_getRCPrototypes() and \ref RDL_getRCyclesForURF() (arrays of \ref RDL_cycle) into an
|
|
616
|
+
* array of cycles represented by arrays of `{0,1}^|E|` (bitsets).
|
|
617
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
618
|
+
* @param old_array The resulting structure of the functions named above
|
|
619
|
+
* @param number The return value of the functions named above
|
|
620
|
+
* (the number of cycles given)
|
|
621
|
+
* @param RDL_cycle_array_ptr pointer to the result array
|
|
622
|
+
* (declare char ** and give address as parameter)
|
|
623
|
+
* @return The number of cycles given (same as the parameter 'number'), \ref RDL_INVALID_RESULT on failure
|
|
624
|
+
* @note The initial structure still exists afterwards and still has to be
|
|
625
|
+
* deleted.
|
|
626
|
+
*
|
|
627
|
+
* The resulting array has a 1 at
|
|
628
|
+
* position i if edge i is part of the cycle or 0 otherwise. An edge is identified
|
|
629
|
+
* by the position at which it was added to the graph starting at 0
|
|
630
|
+
* (the return value of \ref RDL_addUEdge()).
|
|
631
|
+
*/
|
|
632
|
+
RDL_API
|
|
633
|
+
unsigned RDL_translateCycArray(const RDL_data *data,
|
|
634
|
+
RDL_cycle **old_array,
|
|
635
|
+
unsigned number,
|
|
636
|
+
char ***RDL_cycle_array_ptr);
|
|
637
|
+
|
|
638
|
+
/**
|
|
639
|
+
* @brief Deallocates the structure given by \ref RDL_translateCycArray(), if called on
|
|
640
|
+
* its result and return value (the number of cycles).
|
|
641
|
+
* @param cycles The translated array of cycles.
|
|
642
|
+
* @param number The number of cycles in the array.
|
|
643
|
+
*/
|
|
644
|
+
RDL_API
|
|
645
|
+
void RDL_deleteEdgeIdxArray(char **cycles, unsigned number);
|
|
646
|
+
|
|
647
|
+
/**
|
|
648
|
+
* @brief Gives the edges of the graph.
|
|
649
|
+
* @return the number of edges in the graph, \ref RDL_INVALID_RESULT on error
|
|
650
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
651
|
+
* @param RDL_edge_array_ptr pointer that points to the result array
|
|
652
|
+
* (declare \ref RDL_edge * and give address as parameter)
|
|
653
|
+
* @note Result has to be deallocated using `free(*RDL_edge_array_ptr)`
|
|
654
|
+
*/
|
|
655
|
+
RDL_API
|
|
656
|
+
unsigned RDL_getEdgeArray(const RDL_data *data, RDL_edge **RDL_edge_array_ptr);
|
|
657
|
+
|
|
658
|
+
/**
|
|
659
|
+
* @brief Get the number of edges in the graph.
|
|
660
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
661
|
+
* @returns number of edges in the graph, \ref RDL_INVALID_RESULT on error
|
|
662
|
+
*/
|
|
663
|
+
RDL_API
|
|
664
|
+
unsigned RDL_getNofEdges(const RDL_data *data);
|
|
665
|
+
|
|
666
|
+
/**
|
|
667
|
+
* @brief Get the id of the edge.
|
|
668
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
669
|
+
* @param from \ref RDL_node starting at this edge
|
|
670
|
+
* @param to \ref RDL_node starting at this edge
|
|
671
|
+
* @return edge id, \ref RDL_INVALID_RESULT, if not present
|
|
672
|
+
* @note As the graph is stored as an adjacency list, this function
|
|
673
|
+
* has linear runtime in the node degree.
|
|
674
|
+
*/
|
|
675
|
+
RDL_API
|
|
676
|
+
unsigned RDL_getEdgeId(const RDL_data *data, unsigned from, unsigned to);
|
|
677
|
+
|
|
678
|
+
/**
|
|
679
|
+
* @brief Get the number of ring systems in the graph.
|
|
680
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
681
|
+
* @returns number of ring systems in the graph, \ref RDL_INVALID_RESULT on error
|
|
682
|
+
*/
|
|
683
|
+
RDL_API
|
|
684
|
+
unsigned RDL_getNofRingsystems(const RDL_data* data);
|
|
685
|
+
|
|
686
|
+
/**
|
|
687
|
+
* @brief Get the number of nodes in the ring system.
|
|
688
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
689
|
+
* @param idx index of the ring system
|
|
690
|
+
* @returns number of nodes in the ring system, \ref RDL_INVALID_RESULT on error
|
|
691
|
+
* @note A ring system is a 2-connected component of the graph.
|
|
692
|
+
*/
|
|
693
|
+
RDL_API
|
|
694
|
+
unsigned RDL_getNofNodesForRingsystem(const RDL_data *data, unsigned idx);
|
|
695
|
+
|
|
696
|
+
/**
|
|
697
|
+
* @brief Get the number of edges in the ring system.
|
|
698
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
699
|
+
* @param idx index of the ring system
|
|
700
|
+
* @returns number of edges in the ring system, \ref RDL_INVALID_RESULT on error
|
|
701
|
+
* @note A ring system is a 2-connected component of the graph.
|
|
702
|
+
*/
|
|
703
|
+
RDL_API
|
|
704
|
+
unsigned RDL_getNofEdgesForRingsystem(const RDL_data *data, unsigned idx);
|
|
705
|
+
|
|
706
|
+
/**
|
|
707
|
+
* @brief Get the edges in the ring system.
|
|
708
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
709
|
+
* @param idx index of the ring system
|
|
710
|
+
* @param edges pointer that points to the result array
|
|
711
|
+
* (declare \ref RDL_edge * and give address as parameter)
|
|
712
|
+
* @note Result has to be deallocated using `free(*edges)`
|
|
713
|
+
* @returns number of edges in the ring system, \ref RDL_INVALID_RESULT on error
|
|
714
|
+
* @note A ring system is a 2-connected component of the graph.
|
|
715
|
+
*/
|
|
716
|
+
RDL_API
|
|
717
|
+
unsigned RDL_getEdgesForRingsystem(
|
|
718
|
+
const RDL_data *data, unsigned idx, RDL_edge** edges);
|
|
719
|
+
|
|
720
|
+
/**
|
|
721
|
+
* @brief Get the nodes in the ring system.
|
|
722
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
723
|
+
* @param idx index of the ring system
|
|
724
|
+
* @param nodes pointer that points to the result array
|
|
725
|
+
* (declare \ref RDL_edge * and give address as parameter)
|
|
726
|
+
* @note Result has to be deallocated using `free(*nodes)`
|
|
727
|
+
* @returns number of nodes in the ring system, \ref RDL_INVALID_RESULT on error
|
|
728
|
+
* @note A ring system is a 2-connected component of the graph.
|
|
729
|
+
*/
|
|
730
|
+
RDL_API
|
|
731
|
+
unsigned RDL_getNodesForRingsystem(
|
|
732
|
+
const RDL_data *data, unsigned idx, RDL_node** nodes);
|
|
733
|
+
|
|
734
|
+
/**
|
|
735
|
+
* @brief Get the ring system id for given edge.
|
|
736
|
+
* @param data pointer to the \ref RDL_data holding the calculation results.
|
|
737
|
+
* @param from \ref RDL_node starting at this edge
|
|
738
|
+
* @param to \ref RDL_node starting at this edge
|
|
739
|
+
* @returns number of edges in the ring system, \ref RDL_INVALID_RESULT on error
|
|
740
|
+
* \ref RDL_NO_RINGSYSTEM if edge is not part of a ring system
|
|
741
|
+
* @note A ring system is a 2-connected component of the graph.
|
|
742
|
+
*/
|
|
743
|
+
RDL_API
|
|
744
|
+
unsigned RDL_getRingsystemForEdge(
|
|
745
|
+
const RDL_data* data, unsigned from, unsigned to);
|
|
746
|
+
|
|
747
|
+
#ifdef __cplusplus
|
|
748
|
+
} /* extern "C" */
|
|
749
|
+
#endif
|
|
750
|
+
|
|
751
|
+
#endif
|