Idris2Doc : Chem.Query

Chem.Query

(source)

Definitions

0TargetBond : Type
  The type of bond we use at the target molecule of
a substructure search

Totality: total
Visibility: public export
0QueryBond : Type
  The type of bond we use at the query molecule of
a substructure search

Totality: total
Visibility: public export
matchBond : QueryBond->TargetBond->Bool
  Default matcher for bonds in a substructure search

Totality: total
Visibility: export
qbond : CastbBondOrder=>AromBondb->AromBondBondOrder
Totality: total
Visibility: export
recordTotH : Type
  Total number (explicit and implicit) of hydrogens bound to an atom.

Totality: total
Visibility: public export
Constructor: 
TH : Nat->TotH

Projection: 
.count : TotH->Nat
.count : TotH->Nat
Totality: total
Visibility: public export
count : TotH->Nat
Totality: total
Visibility: public export
0TargetAtom : Type
  Atom type we use for the target in a substructure search.

Note: `TotH` is a counter corresponding to the total number (explicit and
implicit) of hydrogen atoms bound to an atom.

Totality: total
Visibility: public export
recordExplicitH : Type
  Number of explicit hydrogens bound to an atom.

Totality: total
Visibility: public export
Constructor: 
EH : Nat->ExplicitH

Projection: 
.count : ExplicitH->Nat
.count : ExplicitH->Nat
Totality: total
Visibility: public export
count : ExplicitH->Nat
Totality: total
Visibility: public export
0QueryAtom : Type
  Atom type we use for the query in a substructure search.

Note: `ExplicitH` is a counter corresponding to number of explicit
hydrogens bound to an atom.

Totality: total
Visibility: public export
matchAtom : QueryAtom->TargetAtom->Bool
  Default matcher for atoms in a substructure search

Totality: total
Visibility: export
0QueryGraph : Type
  Graph type we use for the query in substructure searches.

Totality: total
Visibility: public export
0TargetGraph : Type
  Graph type we use for the target in substructure searches.

Totality: total
Visibility: public export
toTarget : CastbBondOrder=>CasteIsotope=>CastcCharge=>IGraphk (AromBondb) (Atomecprhtchl) ->CasthHCount=>IGraphkTargetBondTargetAtom
  Convert an aromatized molecular graph to a target graph to be
used in a subgraph query.

Totality: total
Visibility: export
toQuery : CastbBondOrder=>CasteIsotope=>CastcCharge=>IGraphk (AromBondb) (Atomecprhtchl) ->GraphQueryBondQueryAtom
  Convert an aromatized molecular graph to a query graph to be
used in a subgraph query.

Totality: total
Visibility: export
smilesQuery : SmilesGraphAT->QueryGraph
  Convert a SMILES graph to one used as a query in a substructure search.

Totality: total
Visibility: export
smilesTarget : SmilesGraphAT->TargetGraph
  Convert a SMILES graph to one used as a target in a substructure search.

Totality: total
Visibility: export
molQuery : MolGraphAT->QueryGraph
  Convert a .mol-file graph to one used as a query in a substructure search.

Totality: total
Visibility: export
molTarget : MolGraphAT->TargetGraph
  Convert a .mol-file graph to one used as a target in a substructure search.

Totality: total
Visibility: export
substructureI : IGraphqQueryBondQueryAtom->IGraphtTargetBondTargetAtom->Maybe (Vectq (Fint))
  Tries to find a mapping from the query graph to the target graph

TODO: Add support for a search limit to make this provably total!

Totality: total
Visibility: export
substructure : QueryGraph->TargetGraph->Maybe (ListNat)
  Tries to find a mapping from the query graph to the target graph.

The mapping is returned as a list of node indices. If you need stronger
quarantees about the indices, consider using `substructureI` for
order-indexed graphs.

Totality: total
Visibility: export