Programming guides (Table 6.1, “Programming Guides for the AJAX Library”) are available for most files in AJAX. These summarise the available C data structures and functions and methods for their use. For some files a programming guide is "Not available", others say "See" a guide only, without any deep coverage. In most cases, you are unlikely to need such files and should see the online library documentation for a description of the datatypes and functions included.
| AJAX Library File | Programming Guide |
|---|---|
acd/ajacd.c/h | Handling ACD Files |
core/ajalign.c/c | Handling Alignments |
core/ajalign.h/c | Handling Alignments |
core/ajarch.h | C Basic Datatypes |
core/ajarr.c/h | Handling Arrays. Also see Handling Simple |
core/ajassert.h/c | Not available |
core/ajax.h | C Basic Datatypes, Your First EMBOSS Application |
core/ajbase.h/c | Handling Sequences |
core/ajcall.h/c | See Handling Graphics |
core/ajcod.h/c | Handling Codon |
core/ajdan.h/c | Handling Sequences |
core/ajdmx.h/c | Not available |
core/ajdefine.h | C Basic Datatypes |
core/ajdomain.h/c | Not available |
core/ajdom.h/c | See Handling Graphics |
core/ajexcept.h/c | Handling Exceptions |
core/ajfeat.h/c | Handling Features |
core/ajfeatdata.h | Handling Features |
core/ajfile.h/c | Handling Files |
core/ajfiledata.h/c | Not available |
core/ajfileio.h/c | Not available |
core/ajfmt.h/c | Handling Strings |
graphics/ajgraph.h/c | Handling Graphics |
graphics/ajgraphstruct.h | Handling Graphics |
graphics/ajgraphxml.h/c | See Handling Graphics |
graphics/ajhist.h/c | Handling Graphics |
core/ajindex.h/c | Not available |
core/ajjava.h/c | Not available |
core/ajlist.h/c | Handling Lists |
core/ajmath.h/c | Handling Maths |
core/ajmatrices.h/c | Handling Matrices |
core/ajmem.h/c | Objects (C Data Structures) |
core/ajmess.h/c | Handling Exceptions |
core/ajnam.h/c | Not available |
core/ajnexus.h/c | See Handling Phylip |
core/ajpat.h/c | Handling Patterns. Also see Handling Simple |
core/ajpdb.h/c | Not available |
core/ajpdbio.h/c | Not available |
core/ajphylo.h/c | Handling Phylip |
core/ajrange.h/c | Handling Simple |
core/ajreg.h/c | HandlingPatterns. Also see Handling Simple |
core/ajreport.h/c | Handling Reports |
core/ajseqabi.h/c | See Handling Sequences |
core/ajseq.h/c | Handling Sequences |
core/ajseqdata.h | Handling Sequences |
ajaxdb/ajseqdb.h/c | See Handling Sequences |
core/ajseqread.h/c | Handling Sequences |
core/ajseqtype.h/c | Handling Sequences |
core/ajseqwrite.h/c | Handling Sequences |
core/ajsort.h/c | Handling Arrays |
core/ajsql.h/c | Not available |
core/ajstr.h/c | HandlingStrings. Also see Handling Simple |
core/ajsys.h/c | Handling System |
core/ajtable.h/c | Handling Tables |
core/ajtime.h/c | Not available |
core/ajtranslate.h/c | Handling Sequences |
core/ajtree.h/c | Not available |
core/ajutil.h/c | Handling System |
core/ajvector.h/c | See Handling Maths |
pcre/pcre.c | See HandlingPatterns |
pcre/pcre_chartables.c | See HandlingPatterns |
pcre/pcre_config.h | See HandlingPatterns |
pcre/pcre_get.c | See HandlingPatterns |
pcre/pcre.h | See HandlingPatterns |
pcre/pcre_internal.h | See HandlingPatterns |
pcre/pcreposix.c | See HandlingPatterns |
pcre/pcreposix.h | See HandlingPatterns |
pcre/pcre_printint.c | See HandlingPatterns |
pcre/pcre_study.c | See HandlingPatterns |
Programming guides are not currently available for the NUCLEUS library. In some cases algorithms and data structures that you might expect to find in NUCLEUS are in fact kept in AJAX. This is usually necessary for purposes of compilation. For example any functions that are called during ACD file processing, which is handled by a part of AJAX, must also live in AJAX.