ajindex.c

Function ajBtreeFieldGetLenC

Prototype

ajuint ajBtreeFieldGetLenC (
      const char* nametxt
);

Type	Name	Read/Write	Description
const char*	nametxt	Input	Field name
ajuint		RETURN	Field name length

From EMBOSS 6.4.0

Function ajBtreeFieldGetLenS

Prototype

ajuint ajBtreeFieldGetLenS (
      const AjPStr name
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	Field name
ajuint		RETURN	Field name length

From EMBOSS 6.4.0

Function ajBtreeFieldGetExtensionC

Prototype

const AjPStr ajBtreeFieldGetExtensionC (
      const char* nametxt
);

Type	Name	Read/Write	Description
const char*	nametxt	Input	Field name
const AjPStr		RETURN	Filename extension

From EMBOSS 6.4.0

Function ajBtreeFieldGetExtensionS

Prototype

const AjPStr ajBtreeFieldGetExtensionS (
      const AjPStr name
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	Field name
const AjPStr		RETURN	Filename extension

From EMBOSS 6.4.0

Function ajBtreeFieldGetSecondaryC

Prototype

AjBool ajBtreeFieldGetSecondaryC (
      const char* nametxt
);

Type	Name	Read/Write	Description
const char*	nametxt	Input	Field name
AjBool		RETURN	True for a secondary index where indexed terms treturn IDs False for an ID index where terms return file positions.

From EMBOSS 6.4.0

Function ajBtreeFieldGetSecondaryS

Prototype

AjBool ajBtreeFieldGetSecondaryS (
      const AjPStr name
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	Field name
AjBool		RETURN	True for a secondary index where indexed terms treturn IDs False for an ID index where terms return file positions.

From EMBOSS 6.4.0

Function ajBtreeIdcacheNewC

Prototype

AjPBtcache ajBtreeIdcacheNewC (
      const char* filetxt,
      const char* exttxt,
      const char* idirtxt,
      const char* mode,
      AjBool compressed,
      ajuint kwlimit,
      ajuint refcount,
      ajuint pripagesize,
      ajuint secpagesize,
      ajuint pricachesize,
      ajuint seccachesize,
      ajulong pripagecount,
      ajulong secpagecount,
      ajuint order,
      ajuint fill,
      ajuint level,
      ajuint sorder,
      ajuint sfill,
      ajulong count,
      ajulong countall
);

Type	Name	Read/Write	Description
const char*	filetxt	Input	name of file
const char*	exttxt	Input	extension of file
const char*	idirtxt	Input	index file directory
const char*	mode	Input	opening mode
AjBool	compressed	Input	Compressed index flag
ajuint	kwlimit	Input	Max key size
ajuint	refcount	Input	Extra files for each entry
ajuint	pripagesize	Input	Primary pagesize
ajuint	secpagesize	Input	Secondary pagesize
ajuint	pricachesize	Input	size of primary cache
ajuint	seccachesize	Input	size of secondary cache
ajulong	pripagecount	Input	Primary page count
ajulong	secpagecount	Input	Secondary page count
ajuint	order	Input	Tree order
ajuint	fill	Input	Number of entries per bucket
ajuint	level	Input	level of tree
ajuint	sorder	Input	order of secondary tree
ajuint	sfill	Input	Number of entries per secondary bucket
ajulong	count	Input	Number of entries in the index
ajulong	countall	Input	Number of total entries in the index
AjPBtcache		RETURN	initialised disc block cache structure

From EMBOSS 3.0.0

Function ajBtreeIdcacheNewS

Prototype

AjPBtcache ajBtreeIdcacheNewS (
      const AjPStr file,
      const AjPStr ext,
      const AjPStr idir,
      const char* mode,
      AjBool compressed,
      ajuint refcount,
      ajuint kwlimit,
      ajuint pripagesize,
      ajuint secpagesize,
      ajuint pricachesize,
      ajuint seccachesize,
      ajulong pripagecount,
      ajulong secpagecount,
      ajuint order,
      ajuint fill,
      ajuint level,
      ajuint sorder,
      ajuint sfill,
      ajulong count,
      ajulong countall
);

Type	Name	Read/Write	Description
const AjPStr	file	Input	name of file
const AjPStr	ext	Input	extension of file
const AjPStr	idir	Input	index file directory
const char*	mode	Input	opening mode
AjBool	compressed	Input	Compressed index flag
ajuint	refcount	Input	Extra files for each entry
ajuint	kwlimit	Input	Max key size
ajuint	pripagesize	Input	Primary pagesize
ajuint	secpagesize	Input	Secondary pagesize
ajuint	pricachesize	Input	size of primary cache
ajuint	seccachesize	Input	size of secondary cache
ajulong	pripagecount	Input	Primary page count
ajulong	secpagecount	Input	Secondary page count
ajuint	order	Input	Tree order
ajuint	fill	Input	Number of entries per bucket
ajuint	level	Input	level of tree
ajuint	sorder	Input	order of secondary tree
ajuint	sfill	Input	Number of entries per secondary bucket
ajulong	count	Input	Number of entries in the index
ajulong	countall	Input	Number of total entries in the index
AjPBtcache		RETURN	initialised disc block cache structure

From EMBOSS 6.4.0

Function ajBtreeCacheNewReadC

Prototype

AjPBtcache ajBtreeCacheNewReadC (
      const char* filetxt,
      const char* exttxt,
      const char* idirtxt
);

Type	Name	Read/Write	Description
const char*	filetxt	Input	name of file
const char*	exttxt	Input	extension of file
const char*	idirtxt	Input	index file directory
AjPBtcache		RETURN	initialised disc block cache structure

From EMBOSS 6.4.0

Function ajBtreeCacheNewReadS

Prototype

AjPBtcache ajBtreeCacheNewReadS (
      const AjPStr file,
      const AjPStr ext,
      const AjPStr idir
);

Type	Name	Read/Write	Description
const AjPStr	file	Input	name of file
const AjPStr	ext	Input	extension of file
const AjPStr	idir	Input	index file directory
AjPBtcache		RETURN	initialised disc block cache structure

From EMBOSS 6.4.0

Function ajBtreeCacheNewUpdateC

Prototype

AjPBtcache ajBtreeCacheNewUpdateC (
      const char* filetxt,
      const char* exttxt,
      const char* idirtxt
);

Type	Name	Read/Write	Description
const char*	filetxt	Input	name of file
const char*	exttxt	Input	extension of file
const char*	idirtxt	Input	index file directory
AjPBtcache		RETURN	initialised disc block cache structure

From EMBOSS 6.4.0

Function ajBtreeCacheNewUpdateS

Prototype

AjPBtcache ajBtreeCacheNewUpdateS (
      const AjPStr file,
      const AjPStr ext,
      const AjPStr idir
);

Type	Name	Read/Write	Description
const AjPStr	file	Input	name of file
const AjPStr	ext	Input	extension of file
const AjPStr	idir	Input	index file directory
AjPBtcache		RETURN	initialised disc block cache structure

From EMBOSS 6.4.0

Function ajBtreeCacheDel

Prototype

ajulong ajBtreeCacheDel (
      AjPBtcache* Pthis
);

Type	Name	Read/Write	Description
AjPBtcache*	Pthis	Output	Cache object
ajulong		RETURN	Index file size

From EMBOSS 3.0.0

Function ajBtreeCacheIsCompressed

Prototype

AjBool ajBtreeCacheIsCompressed (
      const AjPBtcache cache
);

Type	Name	Read/Write	Description
const AjPBtcache	cache	Input	cache
AjBool		RETURN	True if index is compressed

From EMBOSS 6.5.0

Function ajBtreeCacheIsSecondary

Prototype

AjBool ajBtreeCacheIsSecondary (
      const AjPBtcache thys
);

Type	Name	Read/Write	Description
const AjPBtcache	thys	Input	Cache object
AjBool		RETURN	True if cache is secondary

From EMBOSS 6.4.0

Function ajBtreeCacheStatsOut

Prototype

void ajBtreeCacheStatsOut (
      AjPFile outf,
      const AjPBtcache cache,
      ajulong* Ppricache,
      ajulong* Pseccache,
      ajulong* Pprireads,
      ajulong* Psecreads,
      ajulong* Ppriwrites,
      ajulong* Psecwrites,
      ajulong* Pprisize,
      ajulong* Psecsize
);

Type	Name	Read/Write	Description
AjPFile	outf	Modify	output file file
const AjPBtcache	cache	Input	cache object
ajulong*	Ppricache	Modify	Number of cache reads to date
ajulong*	Pseccache	Modify	Number of cache reads to date
ajulong*	Pprireads	Modify	Number of disk reads to date
ajulong*	Psecreads	Modify	Number of disk reads to date
ajulong*	Ppriwrites	Modify	Number of disk writes to date
ajulong*	Psecwrites	Modify	Number of disk writes to date
ajulong*	Pprisize	Modify	Number of primary cache pages to date
ajulong*	Psecsize	Modify	Number of secondary cache pages to date
void		RETURN

From EMBOSS 6.4.0

Function ajBtreeCacheRead

Prototype

AjPBtpage ajBtreeCacheRead (
      AjPBtcache cache,
      ajulong pagepos
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Output	cache
ajulong	pagepos	Input	page number
AjPBtpage		RETURN	disc cache page pointer

From EMBOSS 6.5.0

Function ajBtreeIdNew

Prototype

AjPBtId ajBtreeIdNew (
      ajuint refcount
);

Type	Name	Read/Write	Description
ajuint	refcount	Input	Number of reference files for each entry
AjPBtId		RETURN	Index ID object

From EMBOSS 3.0.0

Function ajBtreeIdDel

Prototype

void ajBtreeIdDel (
      AjPBtId* thys
);

Type	Name	Read/Write	Description
AjPBtId*	thys	Output	index ID object
void		RETURN

From EMBOSS 3.0.0

Function ajBtreeIdDelVoid

Prototype

void ajBtreeIdDelVoid (
      void** voidarg
);

Type	Name	Read/Write	Description
void**	voidarg	Output	Index ID object, passed as void for use by list and table destructors.
void		RETURN

From EMBOSS 6.4.0

Function ajBtreeIdIsMulti

Prototype

AjBool ajBtreeIdIsMulti (
      const AjPBtId thys
);

Type	Name	Read/Write	Description
const AjPBtId	thys	Input	index ID object
AjBool		RETURN	True if ID object points to duplicated identifiers

From EMBOSS 6.5.0

Function ajBtreeHitNew

Prototype

AjPBtHit ajBtreeHitNew (
      void
);

Type	Name	Read/Write	Description
AjPBtHit		RETURN	Index hit object

From EMBOSS 6.5.0

Function ajBtreeHitNewId

Prototype

AjPBtHit ajBtreeHitNewId (
      const AjPBtId btid
);

Type	Name	Read/Write	Description
const AjPBtId	btid	Input	Index id object
AjPBtHit		RETURN	Index hit object

From EMBOSS 6.5.0

Function ajBtreeHitDel

Prototype

void ajBtreeHitDel (
      AjPBtHit* thys
);

Type	Name	Read/Write	Description
AjPBtHit*	thys	Output	index hit object
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeHitDelVoid

Prototype

void ajBtreeHitDelVoid (
      void** voidarg
);

Type	Name	Read/Write	Description
void**	voidarg	Output	Index hit object, passed as void for use by list and table destructors.
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeHitrefNew

Prototype

AjPBtHitref ajBtreeHitrefNew (
      void
);

Type	Name	Read/Write	Description
AjPBtHitref		RETURN	Index reference hit object

From EMBOSS 6.5.0

Function ajBtreeHitrefNewId

Prototype

AjPBtHitref ajBtreeHitrefNewId (
      const AjPBtId btid
);

Type	Name	Read/Write	Description
const AjPBtId	btid	Input	Index id object
AjPBtHitref		RETURN	Index hit object

From EMBOSS 6.5.0

Function ajBtreeHitrefDel

Prototype

void ajBtreeHitrefDel (
      AjPBtHitref* thys
);

Type	Name	Read/Write	Description
AjPBtHitref*	thys	Output	index reference hit object
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeHitrefDelVoid

Prototype

void ajBtreeHitrefDelVoid (
      void** voidarg
);

Type	Name	Read/Write	Description
void**	voidarg	Output	Index reference hit object, passed as void for use by list and table destructors.
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeDumpKeywords

Prototype

void ajBtreeDumpKeywords (
      AjPBtcache cache,
      ajuint dmin,
      ajuint dmax,
      AjPFile outf
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
ajuint	dmin	Input	minimum number of times the key should appear
ajuint	dmax	Input	maximum number of times the key should appear
AjPFile	outf	Modify	output file
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeIdentFetchId

Prototype

void ajBtreeIdentFetchId (
      AjPBtcache cache,
      const AjPStr key,
      AjPList btidlist
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPStr	key	Input	key
AjPList	btidlist	Output	List of ID objects
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeIdentFetchHit

Prototype

void ajBtreeIdentFetchHit (
      AjPBtcache cache,
      const AjPStr key,
      AjPList hitlist
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPStr	key	Input	key
AjPList	hitlist	Output	List of hit objects
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeIdentFetchHitref

Prototype

void ajBtreeIdentFetchHitref (
      AjPBtcache cache,
      const AjPStr key,
      AjPList hitlist
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPStr	key	Input	key
AjPList	hitlist	Output	List of reference hit objects
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeWriteParamsC

Prototype

void ajBtreeWriteParamsC (
      const AjPBtcache cache,
      const char* fntxt,
      const char* exttxt,
      const char* idirtxt
);

Type	Name	Read/Write	Description
const AjPBtcache	cache	Input	cache
const char*	fntxt	Input	file name
const char*	exttxt	Input	index file extension name
const char*	idirtxt	Input	index file directory
void		RETURN

From EMBOSS 6.4.0

Function ajBtreeWriteParamsS

Prototype

void ajBtreeWriteParamsS (
      const AjPBtcache cache,
      const AjPStr fn,
      const AjPStr ext,
      const AjPStr idir
);

Type	Name	Read/Write	Description
const AjPBtcache	cache	Input	cache
const AjPStr	fn	Input	file name
const AjPStr	ext	Input	index file extension name
const AjPStr	idir	Input	index file directory
void		RETURN

From EMBOSS 6.4.0

Function ajBtreeReadParamsC

Prototype

AjBool ajBtreeReadParamsC (
      const char* filetxt,
      const char* exttxt,
      const char* idirtxt,
      AjBool* secondary,
      AjBool* compressed,
      ajuint* kwlimit,
      ajuint* idlimit,
      ajuint* refcount,
      ajuint* pripagesize,
      ajuint* secpagesize,
      ajuint* pricachesize,
      ajuint* seccachesize,
      ajulong* pripagecount,
      ajulong* secpagecount,
      ajuint* order,
      ajuint* nperbucket,
      ajuint* level,
      ajuint* sorder,
      ajuint* snperbucket,
      ajulong* count,
      ajulong* countall
);

Type	Name	Read/Write	Description
const char*	filetxt	Input	file
const char*	exttxt	Input	file extension
const char*	idirtxt	Input	index directory
AjBool*	secondary	Output	true for a secondary index
AjBool*	compressed	Output	true for a compressed index
ajuint*	kwlimit	Output	maximum length of a keyword
ajuint*	idlimit	Output	maximum length of a secondary id
ajuint*	refcount	Output	reference file(s) per entry
ajuint*	pripagesize	Output	size of primary pages
ajuint*	secpagesize	Output	size of secondary pages
ajuint*	pricachesize	Output	Primary cachesize
ajuint*	seccachesize	Output	Secondary cachesize
ajulong*	pripagecount	Output	Primary page count
ajulong*	secpagecount	Output	Secondary page count
ajuint*	order	Output	tree order
ajuint*	nperbucket	Output	bucket fill
ajuint*	level	Output	depth of tree (0 = root leaf)
ajuint*	sorder	Output	secondary tree order
ajuint*	snperbucket	Output	secondary bucket fill
ajulong*	count	Output	number of primary keywords in the index
ajulong*	countall	Output	number of total keywords in the index
AjBool		RETURN	True on success

From EMBOSS 6.4.0

Function ajBtreeReadParamsS

Prototype

AjBool ajBtreeReadParamsS (
      const AjPStr file,
      const AjPStr ext,
      const AjPStr idir,
      AjBool* secondary,
      AjBool* compressed,
      ajuint* kwlimit,
      ajuint* idlimit,
      ajuint* refcount,
      ajuint* pripagesize,
      ajuint* secpagesize,
      ajuint* pricachesize,
      ajuint* seccachesize,
      ajulong* pripagecount,
      ajulong* secpagecount,
      ajuint* order,
      ajuint* nperbucket,
      ajuint* level,
      ajuint* sorder,
      ajuint* snperbucket,
      ajulong* count,
      ajulong* countall
);

Type	Name	Read/Write	Description
const AjPStr	file	Input	file
const AjPStr	ext	Input	file extension
const AjPStr	idir	Input	index directory
AjBool*	secondary	Output	true for a secondary index
AjBool*	compressed	Output	true for a compressed index
ajuint*	kwlimit	Output	maximum length of a keyword
ajuint*	idlimit	Output	maximum length of a secondary id
ajuint*	refcount	Output	reference file(s) per entry
ajuint*	pripagesize	Output	size of primary pages
ajuint*	secpagesize	Output	size of secondary pages
ajuint*	pricachesize	Output	Primary cachesize
ajuint*	seccachesize	Output	Secondary cachesize
ajulong*	pripagecount	Output	Primary page count
ajulong*	secpagecount	Output	Secondary page count
ajuint*	order	Output	tree order
ajuint*	nperbucket	Output	bucket fill
ajuint*	level	Output	depth of tree (0 = root leaf)
ajuint*	sorder	Output	secondary tree order
ajuint*	snperbucket	Output	secondary bucket fill
ajulong*	count	Output	number of primary keywords in the index
ajulong*	countall	Output	number of total keywords in the index
AjBool		RETURN	True on success

From EMBOSS 6.4.0

Function ajBtreeIdwildNew

Prototype

AjPBtIdwild ajBtreeIdwildNew (
      AjPBtcache cache,
      const AjPStr wild
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPStr	wild	Input	wildcard id prefix (without asterisk)
AjPBtIdwild		RETURN	b+ tree wildcard object

From EMBOSS 3.0.0

Function ajBtreeIdwildDel

Prototype

void ajBtreeIdwildDel (
      AjPBtIdwild* Pthis
);

Type	Name	Read/Write	Description
AjPBtIdwild*	Pthis	Modify	b+ tree identifier wildcard structure
void		RETURN

From EMBOSS 3.0.0

Function ajBtreeKeywildNew

Prototype

AjPBtKeywild ajBtreeKeywildNew (
      AjPBtcache cache,
      const AjPStr wild
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPStr	wild	Input	wildcard keyword prefix (without asterisk)
AjPBtKeywild		RETURN	b+ tree keyword wildcard object

From EMBOSS 3.0.0

Function ajBtreeKeywildDel

Prototype

void ajBtreeKeywildDel (
      AjPBtKeywild* Pthis
);

Type	Name	Read/Write	Description
AjPBtKeywild*	Pthis	Modify	b+ tree wildcard keyword structure
void		RETURN

From EMBOSS 3.0.0

Function ajBtreeIdwildQuery

Prototype

AjPBtId ajBtreeIdwildQuery (
      AjPBtcache cache,
      AjPBtIdwild wild
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
AjPBtIdwild	wild	Modify	Wildcard
AjPBtId		RETURN	next matching Id or NULL

From EMBOSS 6.5.0

Function ajBtreeIdentFetchwildId

Prototype

void ajBtreeIdentFetchwildId (
      AjPBtcache cache,
      const AjPStr key,
      AjPList idlist
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPStr	key	Input	Wildcard key
AjPList	idlist	Modify	list of matching AjPBtIds
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeIdentFetchwildHit

Prototype

void ajBtreeIdentFetchwildHit (
      AjPBtcache cache,
      const AjPStr key,
      AjPList hitlist
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPStr	key	Input	Wildcard key
AjPList	hitlist	Modify	list of matching AjPBtHits
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeIdentFetchwildHitref

Prototype

void ajBtreeIdentFetchwildHitref (
      AjPBtcache cache,
      const AjPStr key,
      AjPList hitlist
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPStr	key	Input	Wildcard key
AjPList	hitlist	Modify	list of matching AjPBtHitrefs
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeReplaceId

Prototype

AjBool ajBtreeReplaceId (
      AjPBtcache cache,
      const AjPBtId rid
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPBtId	rid	Input	replacement id object
AjBool		RETURN	true if success

From EMBOSS 3.0.0

Function ajBtreeReadEntriesC

Prototype

ajuint ajBtreeReadEntriesC (
      const char* filename,
      const char* indexdir,
      const char* directory,
      AjPStr** seqfiles,
      AjPStr*** reffiles,
      ajuint* refcount
);

Type	Name	Read/Write	Description
const char*	filename	Input	file name
const char*	indexdir	Input	index file directory
const char*	directory	Input	file directory
AjPStr**	seqfiles	Output	sequence file names
AjPStr***	reffiles	Output	reference file names (if any)
ajuint*	refcount	Output	Number of reference file(s) per entry
ajuint		RETURN	number of entries

From EMBOSS 6.5.0

Function ajBtreeReadEntriesS

Prototype

ajuint ajBtreeReadEntriesS (
      const AjPStr filename,
      const AjPStr indexdir,
      const AjPStr directory,
      AjPStr** seqfiles,
      AjPStr*** reffiles,
      ajuint* refcount
);

Type	Name	Read/Write	Description
const AjPStr	filename	Input	file name
const AjPStr	indexdir	Input	index file directory
const AjPStr	directory	Input	file directory
AjPStr**	seqfiles	Output	sequence file names
AjPStr***	reffiles	Output	reference file names (if any)
ajuint*	refcount	Output	Number of reference file(s) per entry
ajuint		RETURN	number of entries

From EMBOSS 6.4.0

Function ajBtreePriNew

Prototype

AjPBtPri ajBtreePriNew (
      void
);

Type	Name	Read/Write	Description
AjPBtPri		RETURN	Index ID object

From EMBOSS 3.0.0

Function ajBtreePriDel

Prototype

void ajBtreePriDel (
      AjPBtPri* thys
);

Type	Name	Read/Write	Description
AjPBtPri*	thys	Output	index keyword primary object
void		RETURN

From EMBOSS 3.0.0

Function ajBtreeKeyIndex

Prototype

AjBool ajBtreeKeyIndex (
      AjPBtcache cache,
      const AjPStr keyword,
      const AjPStr id
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPStr	keyword	Input	keyword
const AjPStr	id	Input	entry identifier
AjBool		RETURN	True if keyword and ID combination was inserted False if keyword exists already for ID

From EMBOSS 6.5.0

Function ajBtreeKeyFindLen

Prototype

AjBool ajBtreeKeyFindLen (
      AjPBtcache cache,
      const AjPStr key,
      ajulong* treeblock
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPStr	key	Input	key
ajulong*	treeblock	Output	Tree block number for id
AjBool		RETURN	ajTrue if found

From EMBOSS 6.4.0

Function ajBtreeSeccacheNewC

Prototype

AjPBtcache ajBtreeSeccacheNewC (
      const char* filetxt,
      const char* exttxt,
      const char* idirtxt,
      const char* mode,
      AjBool compressed,
      ajuint kwlimit,
      ajuint idlimit,
      ajuint pripagesize,
      ajuint secpagesize,
      ajuint pricachesize,
      ajuint seccachesize,
      ajulong pripagecount,
      ajulong secpagecount,
      ajuint order,
      ajuint fill,
      ajuint level,
      ajuint sorder,
      ajuint sfill,
      ajulong count,
      ajulong countall
);

Type	Name	Read/Write	Description
const char*	filetxt	Input	name of file
const char*	exttxt	Input	extension of file
const char*	idirtxt	Input	index file directory
const char*	mode	Input	opening mode
AjBool	compressed	Input	Compressed index flag
ajuint	kwlimit	Input	Max key size
ajuint	idlimit	Input	Max secondary id size
ajuint	pripagesize	Input	pagesize
ajuint	secpagesize	Input	secondary pagesize
ajuint	pricachesize	Input	size of cache
ajuint	seccachesize	Input	size of secondary cache
ajulong	pripagecount	Input	page count
ajulong	secpagecount	Input	page count
ajuint	order	Input	Tree order
ajuint	fill	Input	Number of entries per bucket
ajuint	level	Input	level of tree
ajuint	sorder	Input	order of secondary tree
ajuint	sfill	Input	Number of entries per secondary bucket
ajulong	count	Input	Number of entries in the index
ajulong	countall	Input	Number of total entries in the index
AjPBtcache		RETURN	initialised disc block cache structure

From EMBOSS 3.0.0

Function ajBtreeSeccacheNewS

Prototype

AjPBtcache ajBtreeSeccacheNewS (
      const AjPStr file,
      const AjPStr ext,
      const AjPStr idir,
      const char* mode,
      AjBool compressed,
      ajuint kwlimit,
      ajuint idlimit,
      ajuint pripagesize,
      ajuint secpagesize,
      ajuint pricachesize,
      ajuint seccachesize,
      ajulong pripagecount,
      ajulong secpagecount,
      ajuint order,
      ajuint fill,
      ajuint level,
      ajuint sorder,
      ajuint sfill,
      ajulong count,
      ajulong countall
);

Type	Name	Read/Write	Description
const AjPStr	file	Input	name of file
const AjPStr	ext	Input	extension of file
const AjPStr	idir	Input	index file directory
const char*	mode	Input	opening mode
AjBool	compressed	Input	Compressed index flag
ajuint	kwlimit	Input	Max key size
ajuint	idlimit	Input	Max secondary id size
ajuint	pripagesize	Input	Primary pagesize
ajuint	secpagesize	Input	Secondary pagesize
ajuint	pricachesize	Input	size of primary cache
ajuint	seccachesize	Input	size of secondary cache
ajulong	pripagecount	Input	Primary page count
ajulong	secpagecount	Input	Secondary page count
ajuint	order	Input	Tree order
ajuint	fill	Input	Number of entries per bucket
ajuint	level	Input	level of tree
ajuint	sorder	Input	order of secondary tree
ajuint	sfill	Input	Number of entries per secondary bucket
ajulong	count	Input	Number of entries in the index
ajulong	countall	Input	Number of total entries in the index
AjPBtcache		RETURN	initialised disc block cache structure

From EMBOSS 6.4.0

Function btreeKeyidFind

Prototype

AjPBtpage btreeKeyidFind (
      AjPBtcache cache,
      const AjPStr key
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPStr	key	Input	key to search for
AjPBtpage		RETURN	leaf node where item should be inserted

From EMBOSS 3.0.0

Function ajBtreeKeywildQuery

Prototype

AjPBtId ajBtreeKeywildQuery (
      AjPBtcache cache,
      AjPBtKeywild wild,
      AjPBtcache idcache
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
AjPBtKeywild	wild	Modify	Wildcard
AjPBtcache	idcache	Modify	id cache
AjPBtId		RETURN	next matching Id or NULL

From EMBOSS 3.0.0

Function ajBtreeKeyFetchId

Prototype

void ajBtreeKeyFetchId (
      AjPBtcache cache,
      AjPBtcache idcache,
      const AjPStr key,
      AjPList btidlist
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
AjPBtcache	idcache	Modify	id cache
const AjPStr	key	Input	key
AjPList	btidlist	Modify	List of matching AjPBtId entries
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeKeyFetchHit

Prototype

void ajBtreeKeyFetchHit (
      AjPBtcache cache,
      AjPBtcache idcache,
      const AjPStr key,
      AjPList hitlist
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
AjPBtcache	idcache	Modify	id cache
const AjPStr	key	Input	key
AjPList	hitlist	Modify	List of matching AjPBtHit entries
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeKeyFetchHitref

Prototype

void ajBtreeKeyFetchHitref (
      AjPBtcache cache,
      AjPBtcache idcache,
      const AjPStr key,
      AjPList hitlist
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
AjPBtcache	idcache	Modify	id cache
const AjPStr	key	Input	key
AjPList	hitlist	Modify	List of matching AjPBtHitref entries
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeKeyFetchwildId

Prototype

void ajBtreeKeyFetchwildId (
      AjPBtcache cache,
      AjPBtcache idcache,
      const AjPStr key,
      AjPList btidlist
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
AjPBtcache	idcache	Modify	id cache
const AjPStr	key	Input	key
AjPList	btidlist	Modify	List of matching AjPBtId entries
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeKeyFetchwildHit

Prototype

void ajBtreeKeyFetchwildHit (
      AjPBtcache cache,
      AjPBtcache idcache,
      const AjPStr key,
      AjPList hitlist
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
AjPBtcache	idcache	Modify	id cache
const AjPStr	key	Input	key
AjPList	hitlist	Modify	List of matching AjPBtHit entries
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeKeyFetchwildHitref

Prototype

void ajBtreeKeyFetchwildHitref (
      AjPBtcache cache,
      AjPBtcache idcache,
      const AjPStr key,
      AjPList hitlist
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
AjPBtcache	idcache	Modify	id cache
const AjPStr	key	Input	key
AjPList	hitlist	Modify	List of matching AjPBtHitref entries
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeIdentIndex

Prototype

void ajBtreeIdentIndex (
      AjPBtcache cache,
      AjPBtId id
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
AjPBtId	id	Modify	Id object
void		RETURN	pointer to a page

From EMBOSS 6.5.0

Function ajBtreeDumpIdentifiers

Prototype

void ajBtreeDumpIdentifiers (
      AjPBtcache cache,
      ajuint dmin,
      ajuint dmax,
      AjPFile outf
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
ajuint	dmin	Input	minimum number of times the key should appear
ajuint	dmax	Input	maximum number of times the key should appear
AjPFile	outf	Modify	output file
void		RETURN

From EMBOSS 5.0.0

Function ajBtreeDeleteIdent

Prototype

AjBool ajBtreeDeleteIdent (
      AjPBtcache cache,
      const AjPBtId btid
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPBtId	btid	Input	hybrid object
AjBool		RETURN	True if found and deleted

From EMBOSS 6.5.0

Function ajBtreeDeletePriId

Prototype

AjBool ajBtreeDeletePriId (
      AjPBtcache cache,
      const AjPBtPri pri
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Modify	cache
const AjPBtPri	pri	Input	keyword object
AjBool		RETURN	True if found and deleted

From EMBOSS 6.1.0

Function ajBtreePageIsPrimary

Prototype

AjBool ajBtreePageIsPrimary (
      const AjPBtpage page
);

Type	Name	Read/Write	Description
const AjPBtpage	page	Input	Page
AjBool		RETURN	True if page is primary index or bucket

From EMBOSS 6.5.0

Function ajBtreeCacheGetPagecount

Prototype

ajulong ajBtreeCacheGetPagecount (
      const AjPBtcache cache
);

Type	Name	Read/Write	Description
const AjPBtcache	cache	Input	cache
ajulong		RETURN	number of pages in a tree index

From EMBOSS 6.4.0

Function ajBtreeCacheGetPripagesize

Prototype

ajuint ajBtreeCacheGetPripagesize (
      const AjPBtcache cache
);

Type	Name	Read/Write	Description
const AjPBtcache	cache	Input	cache
ajuint		RETURN	Page size of a tree index

From EMBOSS 6.5.0

Function ajBtreeCacheGetSecpagesize

Prototype

ajuint ajBtreeCacheGetSecpagesize (
      const AjPBtcache cache
);

Type	Name	Read/Write	Description
const AjPBtcache	cache	Input	cache
ajuint		RETURN	Page size of a tree index

From EMBOSS 6.5.0

Function ajBtreeCacheGetTotsize

Prototype

ajulong ajBtreeCacheGetTotsize (
      const AjPBtcache cache
);

Type	Name	Read/Write	Description
const AjPBtcache	cache	Input	cache
ajulong		RETURN	number of bytes in a tree index

From EMBOSS 6.4.0

Function ajBtreePageGetTypename

Prototype

const char* ajBtreePageGetTypename (
      const AjPBtpage page
);

Type	Name	Read/Write	Description
const AjPBtpage	page	Input	Page
const char*		RETURN	Name of page type

From EMBOSS 6.4.0

Function ajBtreeStatNode

Prototype

AjBool ajBtreeStatNode (
      AjPBtcache cache,
      const AjPBtpage page,
      AjBool full,
      ajuint* nkeys,
      ajuint* overflows,
      ajuint* freespace,
      ajulong* refs,
      const AjPTable newpostable
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Output	cache
const AjPBtpage	page	Input	Page
AjBool	full	Input	If true, write detailed debug report
ajuint*	nkeys	Output	Number of keys
ajuint*	overflows	Output	Number of overflow pages
ajuint*	freespace	Output	Unused space in this page
ajulong*	refs	Modify	References to pages
const AjPTable	newpostable	Input	Page numbers for page offsets
AjBool		RETURN	True on success

From EMBOSS 6.4.0

Function ajBtreeStatNumnode

Prototype

AjBool ajBtreeStatNumnode (
      AjPBtcache cache,
      const AjPBtpage page,
      AjBool full,
      ajuint* nkeys,
      ajuint* overflows,
      ajuint* freespace,
      ajulong* refs,
      const AjPTable newpostable
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Output	cache
const AjPBtpage	page	Input	Page
AjBool	full	Input	If true, write detailed debug report
ajuint*	nkeys	Output	Number of keys
ajuint*	overflows	Output	Number of overflow pages
ajuint*	freespace	Output	Unused space in this page
ajulong*	refs	Modify	References to pages
const AjPTable	newpostable	Input	Page numbers for page offsets
AjBool		RETURN	True on success

From EMBOSS 6.4.0

Function ajBtreeStatIdbucket

Prototype

AjBool ajBtreeStatIdbucket (
      AjPBtcache cache,
      const AjPBtpage page,
      AjBool full,
      ajuint* nentries,
      ajuint* ndups,
      ajuint* nextra,
      ajuint* overflows,
      ajuint* freespace,
      ajulong* refs,
      const AjPTable newpostable
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Output	cache
const AjPBtpage	page	Input	Page
AjBool	full	Input	If true, write detailed debug report
ajuint*	nentries	Output	Number of entries
ajuint*	ndups	Output	Number of entries with duplicates
ajuint*	nextra	Output	Number of extra entries as duplicates
ajuint*	overflows	Output	Number of overflow pages
ajuint*	freespace	Output	Unused space in this page
ajulong*	refs	Modify	References to pages
const AjPTable	newpostable	Input	Page numbers for page offsets
AjBool		RETURN	True on success

From EMBOSS 6.4.0

Function ajBtreeStatNumbucket

Prototype

AjBool ajBtreeStatNumbucket (
      AjPBtcache cache,
      const AjPBtpage page,
      AjBool full,
      ajuint* nentries,
      ajuint* overflows,
      ajuint* freespace
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Output	cache
const AjPBtpage	page	Input	Page
AjBool	full	Input	If true, write detailed debug report
ajuint*	nentries	Output	Number of entries
ajuint*	overflows	Output	Number of overflow pages
ajuint*	freespace	Output	Unused space in this page
AjBool		RETURN	True on success

From EMBOSS 6.4.0

Function ajBtreeStatPribucket

Prototype

AjBool ajBtreeStatPribucket (
      AjPBtcache cache,
      const AjPBtpage page,
      AjBool full,
      ajuint* nentries,
      ajuint* overflows,
      ajuint* freespace,
      ajulong* refs,
      const AjPTable newpostable
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Output	cache
const AjPBtpage	page	Input	Page
AjBool	full	Input	If true, write detailed debug report
ajuint*	nentries	Output	Number of entries
ajuint*	overflows	Output	Number of overflow pages
ajuint*	freespace	Output	Unused space in this page
ajulong*	refs	Modify	References to pages
const AjPTable	newpostable	Input	Page numbers for page offsets
AjBool		RETURN	True on success

From EMBOSS 6.4.0

Function ajBtreeStatSecbucket

Prototype

AjBool ajBtreeStatSecbucket (
      AjPBtcache cache,
      const AjPBtpage page,
      AjBool full,
      ajuint* nentries,
      ajuint* overflows,
      ajuint* freespace
);

Type	Name	Read/Write	Description
AjPBtcache	cache	Output	cache
const AjPBtpage	page	Input	Page
AjBool	full	Input	If true, write detailed debug report
ajuint*	nentries	Output	Number of entries
ajuint*	overflows	Output	Number of overflow pages
ajuint*	freespace	Output	Unused space in this page
AjBool		RETURN	True on success

From EMBOSS 6.4.0

Function ajBtreePageGetSize

Prototype

ajuint ajBtreePageGetSize (
      const AjPBtpage page,
      ajuint refcount
);

Type	Name	Read/Write	Description
const AjPBtpage	page	Input	Page 8
ajuint	refcount	Input	Number of reference offsets
ajuint		RETURN	Used page size

From EMBOSS 6.4.0

Function ajBtreeStatsOut

Prototype

void ajBtreeStatsOut (
      AjPFile outf,
      ajulong* Psplitrootid,
      ajulong* Psplitrootnum,
      ajulong* Psplitrootkey,
      ajulong* Psplitrootsec,
      ajulong* Psplitleafid,
      ajulong* Psplitleafnum,
      ajulong* Psplitleafkey,
      ajulong* Psplitleafsec,
      ajulong* Preorderid,
      ajulong* Preordernum,
      ajulong* Preorderkey,
      ajulong* Preordersec
);

Type	Name	Read/Write	Description
AjPFile	outf	Modify	output file file
ajulong*	Psplitrootid	Modify	Number of hyb splitroot calls to date
ajulong*	Psplitrootnum	Modify	Number of num splitroot calls to date
ajulong*	Psplitrootkey	Modify	Number of pri splitroot calls to date
ajulong*	Psplitrootsec	Modify	Number of sec splitroot calls to date
ajulong*	Psplitleafid	Modify	Number of id splitleaf calls to date
ajulong*	Psplitleafnum	Modify	Number of num splitleaf calls to date
ajulong*	Psplitleafkey	Modify	Number of pri splitleaf calls to date
ajulong*	Psplitleafsec	Modify	Number of sec splitleaf calls to date
ajulong*	Preorderid	Modify	Number of id reorderings to date
ajulong*	Preordernum	Modify	Number of num reorderings to date
ajulong*	Preorderkey	Modify	Number of pri reorderings to date
ajulong*	Preordersec	Modify	Number of sec reorderings to date
void		RETURN

From EMBOSS 6.5.0

Function ajBtreeExit

Prototype

void ajBtreeExit (
      void
);

Type	Name	Read/Write	Description
void		RETURN

From EMBOSS 6.4.0

Function ajBtreeIdCmp

Prototype

ajint ajBtreeIdCmp (
      const void* x,
      const void* y
);

Type	Name	Read/Write	Description
const void*	x	Input	Standard argument. Item value.
const void*	y	Input	Standard argument. Comparison item value.
ajint		RETURN	Comparison result. Zero if equal, non-zero if different.

From EMBOSS 6.4.0

Function ajBtreeIdHash

Prototype

ajulong ajBtreeIdHash (
      const void* key,
      ajulong hashsize
);

Type	Name	Read/Write	Description
const void*	key	Input	Standard argument. Table key.
ajulong	hashsize	Input	Standard argument. Estimated Hash size.
ajulong		RETURN	Hash value in range 0 to hashsize-1

From EMBOSS 6.4.0

Function ajBtreeHitCmp

Prototype

ajint ajBtreeHitCmp (
      const void* x,
      const void* y
);

Type	Name	Read/Write	Description
const void*	x	Input	Standard argument. Item value.
const void*	y	Input	Standard argument. Comparison item value.
ajint		RETURN	Comparison result. Zero if equal, non-zero if different.

From EMBOSS 6.5.0

Function ajBtreeHitHash

Prototype

ajulong ajBtreeHitHash (
      const void* key,
      ajulong hashsize
);

Type	Name	Read/Write	Description
const void*	key	Input	Standard argument. Table key.
ajulong	hashsize	Input	Standard argument. Estimated Hash size.
ajulong		RETURN	Hash value in range 0 to hashsize-1

From EMBOSS 6.5.0

Function ajBtreeHitrefCmp

Prototype

ajint ajBtreeHitrefCmp (
      const void* x,
      const void* y
);

Type	Name	Read/Write	Description
const void*	x	Input	Standard argument. Item value.
const void*	y	Input	Standard argument. Comparison item value.
ajint		RETURN	Comparison result. Zero if equal, non-zero if different.

From EMBOSS 6.5.0

Function ajBtreeHitrefHash

Prototype

ajulong ajBtreeHitrefHash (
      const void* key,
      ajulong hashsize
);

Type	Name	Read/Write	Description
const void*	key	Input	Standard argument. Table key.
ajulong	hashsize	Input	Standard argument. Estimated Hash size.
ajulong		RETURN	Hash value in range 0 to hashsize-1

From EMBOSS 6.5.0