Files
rdkit/Code/PgSQL/rdkit/rdkit.h
2015-09-21 16:31:36 +02:00

318 lines
13 KiB
C

// $Id$
//
// Copyright (c) 2010-2015, Novartis Institutes for BioMedical Research Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following
// disclaimer in the documentation and/or other materials provided
// with the distribution.
// * Neither the name of Novartis Institutes for BioMedical Research Inc.
// nor the names of its contributors may be used to endorse or promote
// products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
#ifndef _RDKIT_H_
#define _RDKIT_H_
#ifdef __cplusplus
extern "C" {
#endif
#include "postgres.h"
typedef bytea Mol;
#define DatumGetMolP(x) ((Mol*)PG_DETOAST_DATUM(x))
#define DatumGetMolPCopy(x) ((Mol*)PG_DETOAST_DATUM_COPY(x))
#define MolPGetDatum(x) (PointerGetDatum(x))
#define PG_GETARG_MOL_P(x) DatumGetMolP(PG_GETARG_DATUM(x))
#define PG_GETARG_MOL_P_COPY(x) DatumGetMolPCopy(PG_GETARG_DATUM(x))
#define PG_RETURN_MOL_P(x) PG_RETURN_DATUM(MolPGetDatum(x))
typedef bytea BitmapFingerPrint;
#define DatumGetBitmapFingerPrintP(x) ((BitmapFingerPrint*)PG_DETOAST_DATUM(x))
#define DatumGetBitmapFingerPrintPCopy(x) ((BitmapFingerPrint*)PG_DETOAST_DATUM_COPY(x))
#define BitmapFingerPrintPGetDatum(x) (PointerGetDatum(x))
#define PG_GETARG_BITMAPFINGERPRINT_P(x) DatumGetBitmapFingerPrintP(PG_GETARG_DATUM(x))
#define PG_GETARG_BITMAPFINGERPRINT_P_COPY(x) DatumGetBitmapFingerPrintPCopy(PG_GETARG_DATUM(x))
#define PG_RETURN_BITMAPFINGERPRINT_P(x) PG_RETURN_DATUM(BitmapFingerPrintPGetDatum(x))
typedef bytea SparseFingerPrint;
#define DatumGetSparseFingerPrintP(x) ((SparseFingerPrint*)PG_DETOAST_DATUM(x))
#define DatumGetSparseFingerPrintPCopy(x) ((SparseFingerPrint*)PG_DETOAST_DATUM_COPY(x))
#define SparseFingerPrintPGetDatum(x) (PointerGetDatum(x))
#define PG_GETARG_SPARSEFINGERPRINT_P(x) DatumGetSparseFingerPrintP(PG_GETARG_DATUM(x))
#define PG_GETARG_SPARSEFINGERPRINT_P_COPY(x) DatumGetSparseFingerPrintPCopy(PG_GETARG_DATUM(x))
#define PG_RETURN_SPARSEFINGERPRINT_P(x) PG_RETURN_DATUM(SparseFingerPrintPGetDatum(x))
typedef bytea ChemReactionBA;
#define DatumGetChemReactionP(x) ((ChemReactionBA*)PG_DETOAST_DATUM(x))
#define DatumGetChemReactionPCopy(x) ((ChemReactionBA*)PG_DETOAST_DATUM_COPY(x))
#define ChemReactionPGetDatum(x) (PointerGetDatum(x))
#define PG_GETARG_CHEMREACTION_P(x) DatumGetChemReactionP(PG_GETARG_DATUM(x))
#define PG_GETARG_CHEMREACTION_P_COPY(x) DatumGetChemReactionPCopy(PG_GETARG_DATUM(x))
#define PG_RETURN_CHEMREACTION_P(x) PG_RETURN_DATUM(ChemReactionPGetDatum(x))
/*
* GUC
*/
extern double getTanimotoLimit(void);
extern double getDiceLimit(void);
extern bool getDoChiralSSS(void);
extern int getSubstructFpSize(void);
extern int getMorganFpSize(void);
extern int getFeatMorganFpSize(void);
extern int getLayeredFpSize(void);
extern int getRDKitFpSize(void);
extern int getHashedTorsionFpSize(void);
extern int getHashedAtomPairFpSize(void);
extern int getAvalonFpSize(void);
extern int getReactionSubstructFpSize(void);
extern int getReactionSubstructFpType(void);
extern int getReactionDifferenceFpSize(void);
extern int getReactionDifferenceFpType(void);
extern bool getIgnoreReactionAgents(void);
extern double getReactionStructuralFPAgentBitRatio(void);
extern bool getMoveUnmappedReactantsToAgents(void);
extern double getThresholdUnmappedReactantAtoms(void);
extern bool getInitReaction(void);
extern int getReactionDifferenceFPWeightNonagents(void);
extern int getReactionDifferenceFPWeightAgents(void);
/*
* From/to C/C++
*/
/* RDKit::ROMol */
typedef void * CROMol;
void freeCROMol(CROMol data);
CROMol constructROMol(Mol* data);
Mol * deconstructROMol(CROMol data);
CROMol parseMolBlob(char *data,int len);
char *makeMolBlob(CROMol data, int *len);
CROMol parseMolText(char *data,bool asSmarts,bool warnOnFail,bool asQuery);
CROMol parseMolCTAB(char *data,bool keepConformer,bool warnOnFail,bool asQuery);
char *makeMolText(CROMol data, int *len,bool asSmarts);
char *makeCtabText(CROMol data, int *len, bool createDepictionIfMissing);
bool isValidSmiles(char *data);
bool isValidSmarts(char *data);
bool isValidCTAB(char *data);
bool isValidMolBlob(char *data,int len);
int molcmp(CROMol i, CROMol a);
int MolSubstruct(CROMol i, CROMol a);
int MolSubstructCount(CROMol i, CROMol a,bool uniquify);
bytea *makeMolSign(CROMol data);
double MolAMW(CROMol i);
double MolLogP(CROMol i);
int MolHBA(CROMol i);
int MolHBD(CROMol i);
int MolNumAtoms(CROMol i);
int MolNumHeavyAtoms(CROMol i);
int MolNumRotatableBonds(CROMol i);
int MolNumHeteroatoms(CROMol i);
int MolNumRings(CROMol i);
int MolNumAromaticRings(CROMol i);
int MolNumAliphaticRings(CROMol i);
int MolNumSaturatedRings(CROMol i);
int MolNumAromaticHeterocycles(CROMol i);
int MolNumAliphaticHeterocycles(CROMol i);
int MolNumSaturatedHeterocycles(CROMol i);
int MolNumAromaticCarbocycles(CROMol i);
int MolNumAliphaticCarbocycles(CROMol i);
int MolNumSaturatedCarbocycles(CROMol i);
int MolNumHeterocycles(CROMol i);
double MolFractionCSP3(CROMol i);
double MolTPSA(CROMol i);
double MolChi0v(CROMol i);
double MolChi1v(CROMol i);
double MolChi2v(CROMol i);
double MolChi3v(CROMol i);
double MolChi4v(CROMol i);
double MolChi0n(CROMol i);
double MolChi1n(CROMol i);
double MolChi2n(CROMol i);
double MolChi3n(CROMol i);
double MolChi4n(CROMol i);
double MolKappa1(CROMol i);
double MolKappa2(CROMol i);
double MolKappa3(CROMol i);
int MolNumSpiroAtoms(CROMol i);
int MolNumBridgeheadAtoms(CROMol i);
char *makeMolFormulaText(CROMol data, int *len, bool separateIsotopes, bool abbreviateHIsotopes);
const char *MolInchi(CROMol i);
const char *MolInchiKey(CROMol i);
CROMol MolMurckoScaffold(CROMol i);
/* ExplicitBitVect */
typedef void * MolBitmapFingerPrint;
void freeMolBitmapFingerPrint(MolBitmapFingerPrint data);
MolBitmapFingerPrint constructMolBitmapFingerPrint(BitmapFingerPrint *data);
BitmapFingerPrint * deconstructMolBitmapFingerPrint(MolBitmapFingerPrint data);
bytea * makeSignatureBitmapFingerPrint(MolBitmapFingerPrint data);
int MolBitmapFingerPrintSize(MolBitmapFingerPrint a);
double calcBitmapTanimotoSml(MolBitmapFingerPrint a, MolBitmapFingerPrint b);
double calcBitmapDiceSml(MolBitmapFingerPrint a, MolBitmapFingerPrint b);
double calcBitmapTverskySml(MolBitmapFingerPrint a, MolBitmapFingerPrint b,float ca, float cb);
/* SparseIntVect<boost::int32_t> */
typedef void * MolSparseFingerPrint;
void freeMolSparseFingerPrint(MolSparseFingerPrint data);
MolSparseFingerPrint constructMolSparseFingerPrint(SparseFingerPrint *data);
SparseFingerPrint * deconstructMolSparseFingerPrint(MolSparseFingerPrint data);
bytea * makeSignatureSparseFingerPrint(MolSparseFingerPrint data, int numBits);
bytea * makeLowSparseFingerPrint(MolSparseFingerPrint data, int numInts);
double calcSparseTanimotoSml(MolSparseFingerPrint a, MolSparseFingerPrint b);
double calcSparseDiceSml(MolSparseFingerPrint a, MolSparseFingerPrint b);
double calcSparseStringDiceSml(const char *a, unsigned int sza, const char *b, unsigned int szb);
bool calcSparseStringAllValsGT(const char *a, unsigned int sza, int tgt);
bool calcSparseStringAllValsLT(const char *a, unsigned int sza, int tgt);
MolSparseFingerPrint addSFP(MolSparseFingerPrint a, MolSparseFingerPrint b);
MolSparseFingerPrint subtractSFP(MolSparseFingerPrint a, MolSparseFingerPrint b);
void countOverlapValues(bytea * sign, MolSparseFingerPrint data, int numBits,
int * sum, int * overlapSum, int * overlapN);
void countLowOverlapValues(bytea * sign, MolSparseFingerPrint data, int numInts,
int * querySum, int *keySum, int * overlapUp, int * overlapDown);
/*
* Various mol -> fp transformation
*/
MolBitmapFingerPrint makeLayeredBFP(CROMol data);
MolBitmapFingerPrint makeRDKitBFP(CROMol data);
MolBitmapFingerPrint makeMorganBFP(CROMol data, int radius);
MolSparseFingerPrint makeMorganSFP(CROMol data, int radius);
MolBitmapFingerPrint makeFeatMorganBFP(CROMol data, int radius);
MolSparseFingerPrint makeFeatMorganSFP(CROMol data, int radius);
MolSparseFingerPrint makeAtomPairSFP(CROMol data);
MolSparseFingerPrint makeTopologicalTorsionSFP(CROMol data);
MolBitmapFingerPrint makeAtomPairBFP(CROMol data);
MolBitmapFingerPrint makeTopologicalTorsionBFP(CROMol data);
MolBitmapFingerPrint makeMACCSBFP(CROMol data);
MolBitmapFingerPrint makeAvalonBFP(CROMol data,bool isQuery,unsigned int bitFlags);
/*
* Indexes
*/
#define NUMBITS (2048)
#define NUMRANGE (120)
#define INTRANGEMAX (0xff)
typedef struct IntRange {
uint8 low;
uint8 high;
} IntRange;
#define RDKitTanimotoStrategy (1)
#define RDKitDiceStrategy (2)
#if PG_VERSION_NUM >= 90100
#define RDKitOrderByTanimotoStrategy (3)
#define RDKitOrderByDiceStrategy (4)
#endif
#define RDKitContains (3)
#define RDKitContained (4)
#define RDKitEquals (6)
#define RDKitSmaller (7)
#define RDKitGreater (8)
bool calcConsistency(bool isLeaf, uint16 strategy,
double nCommonUp, double nCommonDown, double nKey, double nQuery);
/*
* Cache subsystem. Molecules and fingerprints I/O is extremely expensive.
*/
struct MemoryContextData; /* forward declaration to prevent conflicts with C++ */
void* SearchMolCache( void *cache, struct MemoryContextData * ctx, Datum a,
Mol **m, CROMol *mol, bytea **sign);
void* SearchBitmapFPCache( void *cache, struct MemoryContextData * ctx, Datum a,
BitmapFingerPrint **f, MolBitmapFingerPrint *fp, bytea **val);
void* SearchSparseFPCache( void *cache, struct MemoryContextData * ctx, Datum a,
SparseFingerPrint **f, MolSparseFingerPrint *fp, bytea **val);
/* Chemical Reactions
* RDKit::ChemicalReaction */
typedef void * CChemicalReaction;
void* SearchChemReactionCache( void *cache, struct MemoryContextData * ctx, Datum a,
ChemReactionBA **r, CChemicalReaction *rxn, bytea **sign);
void freeChemReaction(CChemicalReaction data);
CChemicalReaction constructChemReact(ChemReactionBA* data);
ChemReactionBA * deconstructChemReact(CChemicalReaction data);
CChemicalReaction parseChemReactBlob(char *data,int len);
CChemicalReaction parseChemReactText(char *data,bool asSmarts,bool warnOnFail);
CChemicalReaction parseChemReactCTAB(char *data,bool warnOnFail);
char *makeChemReactBlob(CChemicalReaction data, int *len);
char *makeChemReactText(CChemicalReaction data, int *len,bool asSmarts);
char *makeCTABChemReact(CChemicalReaction data, int *len);
int ChemReactNumReactants(CChemicalReaction rxn);
int ChemReactNumProducts(CChemicalReaction rxn);
int ChemReactNumAgents(CChemicalReaction rxn);
/* Reaction substructure search */
bytea *makeReactionSign(CChemicalReaction data);
int ReactionSubstruct(CChemicalReaction rxn, CChemicalReaction rxn2);
int reactioncmp(CChemicalReaction rxn, CChemicalReaction rxn2);
MolBitmapFingerPrint makeReactionBFP(CChemicalReaction data, int size, int fpType);
/* Reaction difference fingerprint */
MolSparseFingerPrint makeReactionDifferenceSFP(CChemicalReaction data, int size, int fpType);
char* computeMolHash(CROMol data, int* len);
char* findMCSsmiles(char* smiles, char* params);
void* addMol2list(void* lst, Mol* mol);
char* findMCS(void* lst, char* params);
#ifdef __cplusplus
}
#endif
#endif