ajindex.c

Function ajBtreeFieldGetLenC

Returns the default indexed name length for a named field

Prototype

ajuint ajBtreeFieldGetLenC (
      const char* nametxt
);

Type Name Read/Write Description

const char* nametxt Input Field name

ajuint RETURN Field name length

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

From EMBOSS 6.4.0

Function ajBtreeFieldGetLenS

Returns the default indexed name length for a named field

Prototype

ajuint ajBtreeFieldGetLenS (
      const AjPStr name
);

Type Name Read/Write Description

const AjPStr name Input Field name

ajuint RETURN Field name length

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

From EMBOSS 6.4.0

Function ajBtreeFieldGetExtensionC

Returns the default index file extension for a named field

Prototype

const AjPStr ajBtreeFieldGetExtensionC (
      const char* nametxt
);

Type Name Read/Write Description

const char* nametxt Input Field name

const AjPStr RETURN Filename extension

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

From EMBOSS 6.4.0

Function ajBtreeFieldGetExtensionS

Returns the default index file extension for a named field

Prototype

const AjPStr ajBtreeFieldGetExtensionS (
      const AjPStr name
);

Type Name Read/Write Description

const AjPStr name Input Field name

const AjPStr RETURN Filename extension

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

From EMBOSS 6.4.0

Function ajBtreeFieldGetSecondaryC

Returns whether a named field uses a secondary index

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.

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

Returns whether a named field uses a secondary index

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.

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 ajBtreeCacheNewC

Open a b+tree index file and initialise a cache object

Prototype

AjPBtcache ajBtreeCacheNewC (
      const char* filetxt,
      const char* exttxt,
      const char* idirtxt,
      const char* mode,
      AjBool compressed,
      ajuint kwlimit,
      ajuint pagesize,
      ajuint cachesize,
      ajulong pagecount,
      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 pagesize Input pagesize

ajuint cachesize Input size of cache

ajulong pagecount 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

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`	`pagesize`	Input	pagesize
`ajuint`	`cachesize`	Input	size of cache
`ajulong`	`pagecount`	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 ajBtreeCacheNewS

Open a b+tree index file and initialise a cache object

Prototype

AjPBtcache ajBtreeCacheNewS (
      const AjPStr file,
      const AjPStr ext,
      const AjPStr idir,
      const char* mode,
      AjBool compressed,
      ajuint kwlimit,
      ajuint pagesize,
      ajuint cachesize,
      ajulong pagecount,
      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 pagesize Input pagesize

ajuint cachesize Input size of cache

ajulong pagecount 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

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`	`pagesize`	Input	pagesize
`ajuint`	`cachesize`	Input	size of cache
`ajulong`	`pagecount`	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 6.4.0

Function ajBtreeCacheNewReadC

Open an existing b+tree index file and initialise a cache object

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

Open an existing b+tree index file and initialise a cache object

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

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

Open an existing b+tree index file for update and initialise a cache object

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

Open an existing b+tree index file for update and initialise a cache object

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

Close a b+tree cache

Prototype

ajulong ajBtreeCacheDel (
      AjPBtcache* Pthis
);

Type Name Read/Write Description

AjPBtcache* Pthis Output Cache object

ajulong RETURN Index file size

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

From EMBOSS 3.0.0

Function ajBtreeCacheIsSecondary

Test whether a cache is a secondary index

Prototype

AjBool ajBtreeCacheIsSecondary (
      const AjPBtcache thys
);

Type Name Read/Write Description

const AjPBtcache thys Input Cache object

AjBool RETURN True if cache is secondary

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

Cache statistics for writing a new index

Prototype

void ajBtreeCacheStatsOut (
      AjPFile outf,
      const AjPBtcache cache,
      ajulong* Pcache,
      ajulong* Preads,
      ajulong* Pwrites,
      ajulong* Psize
);

Type Name Read/Write Description

AjPFile outf Modify output file file

const AjPBtcache cache Input cache object

ajulong* Pcache Modify Number of cache reads to date

ajulong* Preads Modify Number of disk reads to date

ajulong* Pwrites Modify Number of disk writes to date

ajulong* Psize Modify Number of cache pages to date

void RETURN

Type	Name	Read/Write	Description
`AjPFile`	`outf`	Modify	output file file
`const AjPBtcache`	`cache`	Input	cache object
`ajulong*`	`Pcache`	Modify	Number of cache reads to date
`ajulong*`	`Preads`	Modify	Number of disk reads to date
`ajulong*`	`Pwrites`	Modify	Number of disk writes to date
`ajulong*`	`Psize`	Modify	Number of cache pages to date
`void`		RETURN

From EMBOSS 6.4.0

Function ajBtreeCacheRead

Get a pointer to a disc cache page

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

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

From EMBOSS 3.0.0

Function ajBtreeCacheSync

Sync all dirty cache pages

Prototype

void ajBtreeCacheSync (
      AjPBtcache cache,
      ajulong rootpage
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

ajulong rootpage Input root page

void RETURN

Type	Name	Read/Write	Description
`AjPBtcache`	`cache`	Modify	cache
`ajulong`	`rootpage`	Input	root page
`void`		RETURN

From EMBOSS 3.0.0

Function ajBtreeCacheRootSync

Reset locked pages to dirty and relock the specified secondary root page.

Prototype

void ajBtreeCacheRootSync (
      AjPBtcache cache,
      ajulong rootpage
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

ajulong rootpage Input secondary (locked) root page

void RETURN

Type	Name	Read/Write	Description
`AjPBtcache`	`cache`	Modify	cache
`ajulong`	`rootpage`	Input	secondary (locked) root page
`void`		RETURN

From EMBOSS 6.4.0

Function ajBtreeCacheWrite

Get a pointer to a disc cache page for writing

Prototype

AjPBtpage ajBtreeCacheWrite (
      AjPBtcache cache,
      ajulong pagepos
);

Type Name Read/Write Description

AjPBtcache cache Output cache

ajulong pagepos Input page number

AjPBtpage RETURN disc cache page pointer

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

From EMBOSS 3.0.0

Function ajBtreeCacheWriteBucket

Get a pointer to a disc cache page for writing

Prototype

AjPBtpage ajBtreeCacheWriteBucket (
      AjPBtcache cache,
      ajulong pagepos
);

Type Name Read/Write Description

AjPBtcache cache Output cache

ajulong pagepos Input page number

AjPBtpage RETURN disc cache page pointer

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

From EMBOSS 6.4.0

Function ajBtreeCacheWriteNode

Get a pointer to a disc cache page for writing a node

Prototype

AjPBtpage ajBtreeCacheWriteNode (
      AjPBtcache cache,
      ajulong pagepos
);

Type Name Read/Write Description

AjPBtcache cache Output cache

ajulong pagepos Input page number

AjPBtpage RETURN disc cache page pointer

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

From EMBOSS 6.4.0

Function ajBtreeCacheWriteBucketnew

Get a pointer to a new disc cache page for writing a bucket.

Prototype

AjPBtpage ajBtreeCacheWriteBucketnew (
      AjPBtcache cache
);

Type Name Read/Write Description

AjPBtcache cache Output cache

AjPBtpage RETURN disc cache page pointer

Type	Name	Read/Write	Description
`AjPBtcache`	`cache`	Output	cache
`AjPBtpage`		RETURN	disc cache page pointer

From EMBOSS 6.4.0

Function ajBtreeCacheWriteNodenew

Get a pointer to a new disc cache page for writing a node

Prototype

AjPBtpage ajBtreeCacheWriteNodenew (
      AjPBtcache cache
);

Type Name Read/Write Description

AjPBtcache cache Output cache

AjPBtpage RETURN disc cache page pointer

Type	Name	Read/Write	Description
`AjPBtcache`	`cache`	Output	cache
`AjPBtpage`		RETURN	disc cache page pointer

From EMBOSS 6.4.0

Function ajBtreeCacheWriteOverflownew

Get a pointer to a new disc cache page for writing an overflow node

Prototype

AjPBtpage ajBtreeCacheWriteOverflownew (
      AjPBtcache cache
);

Type Name Read/Write Description

AjPBtcache cache Output cache

AjPBtpage RETURN disc cache page pointer

Type	Name	Read/Write	Description
`AjPBtcache`	`cache`	Output	cache
`AjPBtpage`		RETURN	disc cache page pointer

From EMBOSS 6.4.0

Function ajBtreeCreateRootNode

Create and write an empty root node. Set it as root, write it to disc and then lock the page in the disc cache. The root node is at block 0L

Prototype

void ajBtreeCreateRootNode (
      AjPBtcache cache,
      ajulong rootpage
);

Type Name Read/Write Description

AjPBtcache cache Output cache

ajulong rootpage Input root block

void RETURN

Type	Name	Read/Write	Description
`AjPBtcache`	`cache`	Output	cache
`ajulong`	`rootpage`	Input	root block
`void`		RETURN

From EMBOSS 3.0.0

Function ajBtreeFindInsert

Find the node that should contain a new key for insertion

Prototype

AjPBtpage ajBtreeFindInsert (
      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

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 ajBtreeIdNew

Constructor for index bucket ID information

Prototype

AjPBtId ajBtreeIdNew (
      void
);

Type Name Read/Write Description

AjPBtId RETURN Index ID object

Type	Name	Read/Write	Description
`AjPBtId`		RETURN	Index ID object

From EMBOSS 3.0.0

Function ajBtreeIdDel

Destructor for index bucket ID information

Prototype

void ajBtreeIdDel (
      AjPBtId* thys
);

Type Name Read/Write Description

AjPBtId* thys Output index ID object

void RETURN

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

From EMBOSS 3.0.0

Function ajBtreeIdDelVoid

Destructor for index bucket ID information

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

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 ajBtreeDumpKeywords

Read the leaves of a secondary keywords tree

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

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.4.0

Function ajBtreeInsertId

Insert an ID structure into the tree

Prototype

void ajBtreeInsertId (
      AjPBtcache cache,
      const AjPBtId id
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

const AjPBtId id Input Id object

void RETURN pointer to a page

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

From EMBOSS 3.0.0

Function ajBtreeIdFromKey

Get an ID structure from a leaf node given a key

Prototype

AjPBtId ajBtreeIdFromKey (
      AjPBtcache cache,
      const AjPStr key
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

const AjPStr key Input key

AjPBtId RETURN pointer to an ID structure or NULL if not found

Type	Name	Read/Write	Description
`AjPBtcache`	`cache`	Modify	cache
`const AjPStr`	`key`	Input	key
`AjPBtId`		RETURN	pointer to an ID structure or NULL if not found

From EMBOSS 3.0.0

Function ajBtreeWriteParamsC

Write B+ tree parameters to file

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

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

Write B+ tree parameters to file

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

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

Read B+ tree parameters from file

Prototype

AjBool ajBtreeReadParamsC (
      const char* filetxt,
      const char* exttxt,
      const char* idirtxt,
      AjBool* secondary,
      AjBool* compressed,
      ajuint* kwlimit,
      ajuint* pagesize,
      ajuint* cachesize,
      ajulong* pagecount,
      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* pagesize Output size of pages

ajuint* cachesize Output cachesize

ajulong* pagecount Output 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

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*`	`pagesize`	Output	size of pages
`ajuint*`	`cachesize`	Output	cachesize
`ajulong*`	`pagecount`	Output	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

Read B+ tree parameters from file

Prototype

AjBool ajBtreeReadParamsS (
      const AjPStr file,
      const AjPStr ext,
      const AjPStr idir,
      AjBool* secondary,
      AjBool* compressed,
      ajuint* kwlimit,
      ajuint* pagesize,
      ajuint* cachesize,
      ajulong* pagecount,
      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* pagesize Output size of pages

ajuint* cachesize Output cachesize

ajulong* pagecount Output 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

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*`	`pagesize`	Output	size of pages
`ajuint*`	`cachesize`	Output	cachesize
`ajulong*`	`pagecount`	Output	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 ajBtreeWildNew

Construct a wildcard search object

Prototype

AjPBtWild ajBtreeWildNew (
      AjPBtcache cache,
      const AjPStr wild
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

const AjPStr wild Input wildcard id prefix (without asterisk)

AjPBtWild RETURN b+ tree wildcard object

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

From EMBOSS 3.0.0

Function ajBtreeWildDel

Destroy a wildcard search object

Prototype

void ajBtreeWildDel (
      AjPBtWild* Pthis
);

Type Name Read/Write Description

AjPBtWild* Pthis Modify b+ tree wildcard structure

void RETURN

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

From EMBOSS 3.0.0

Function ajBtreeKeyWildNew

Construct a wildcard keyword search object

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 wildcard object

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

From EMBOSS 3.0.0

Function ajBtreeKeyWildDel

Destroy a wildcard keyword search object

Prototype

void ajBtreeKeyWildDel (
      AjPBtKeyWild* Pthis
);

Type Name Read/Write Description

AjPBtKeyWild* Pthis Modify b+ tree wildcard keyword structure

void RETURN

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

From EMBOSS 3.0.0

Function ajBtreeFindInsertW

Find the node that should contain a key (wild)

Prototype

AjPBtpage ajBtreeFindInsertW (
      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

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 ajBtreeIdFromKeyW

Wildcard retrieval of entries

Prototype

AjPBtId ajBtreeIdFromKeyW (
      AjPBtcache cache,
      AjPBtWild wild
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

AjPBtWild wild Modify Wildcard

AjPBtId RETURN next matching Id or NULL

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

From EMBOSS 3.0.0

Function ajBtreeListFromKeyW

Wildcard retrieval of entries

Prototype

void ajBtreeListFromKeyW (
      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

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 3.0.0

Function ajBtreeReplaceId

Replace an ID structure in a leaf node given a key

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

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 ajBtreeReadEntries

Read B+ tree entries from file

Prototype

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

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 RETURN number of entries

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`		RETURN	number of entries

From EMBOSS 3.0.0

Function ajBtreeReadEntriesS

Read B+ tree entries from file

Prototype

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

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 RETURN number of entries

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`		RETURN	number of entries

From EMBOSS 6.4.0

Function ajBtreeInsertDupId

Get an ID structure from a leaf node given a key

Prototype

void ajBtreeInsertDupId (
      AjPBtcache cache,
      AjPBtId id
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

AjPBtId id Modify potentially duplicate id

void RETURN

Type	Name	Read/Write	Description
`AjPBtcache`	`cache`	Modify	cache
`AjPBtId`	`id`	Modify	potentially duplicate id
`void`		RETURN

From EMBOSS 3.0.0

Function ajBtreeDupFromKey

Write B+ tree parameters to file

Prototype

AjPList ajBtreeDupFromKey (
      AjPBtcache cache,
      const AjPStr key
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

const AjPStr key Input key

AjPList RETURN list of matching AjPBtIds or NULL

Type	Name	Read/Write	Description
`AjPBtcache`	`cache`	Modify	cache
`const AjPStr`	`key`	Input	key
`AjPList`		RETURN	list of matching AjPBtIds or NULL

From EMBOSS 3.0.0

Function ajBtreePriNew

Constructor for index bucket keyword information

Prototype

AjPBtPri ajBtreePriNew (
      void
);

Type Name Read/Write Description

AjPBtPri RETURN Index ID object

Type	Name	Read/Write	Description
`AjPBtPri`		RETURN	Index ID object

From EMBOSS 3.0.0

Function ajBtreePriDel

Destructor for keyword index primary bucket information

Prototype

void ajBtreePriDel (
      AjPBtPri* thys
);

Type Name Read/Write Description

AjPBtPri* thys Output index keyword primary object

void RETURN

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

From EMBOSS 3.0.0

Function ajBtreeInsertKeyword

Insert a keyword structure into the tree

Prototype

AjBool ajBtreeInsertKeyword (
      AjPBtcache cache,
      AjPBtPri pri
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

AjPBtPri pri Modify Id object

AjBool RETURN True if keyword and ID combination was inserted False if keyword exists alraedy for ID

From EMBOSS 3.0.0

Function ajBtreePriFindKeyword

Get Pri structure matching a keyword

Prototype

AjBool ajBtreePriFindKeyword (
      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 ajBtreePriFindKeywordLen

Get Pri structure matching a keyword truncated to maximum indexed length

Prototype

AjBool ajBtreePriFindKeywordLen (
      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

Open a b+tree index file and initialise a cache object for keyword index

Prototype

AjPBtcache ajBtreeSecCacheNewC (
      const char* filetxt,
      const char* exttxt,
      const char* idirtxt,
      const char* mode,
      AjBool compressed,
      ajuint kwlimit,
      ajuint pagesize,
      ajuint cachesize,
      ajulong pagecount,
      ajuint order,
      ajuint fill,
      ajuint level,
      ajuint sorder,
      ajuint sfill,
      ajulong count,
      ajulong countall
);

From EMBOSS 3.0.0

Function ajBtreeSecCacheNewS

Open a b+tree index file and initialise a cache object for keyword index

Prototype

AjPBtcache ajBtreeSecCacheNewS (
      const AjPStr file,
      const AjPStr ext,
      const AjPStr idir,
      const char* mode,
      AjBool compressed,
      ajuint kwlimit,
      ajuint pagesize,
      ajuint cachesize,
      ajulong pagecount,
      ajuint order,
      ajuint fill,
      ajuint level,
      ajuint sorder,
      ajuint sfill,
      ajulong count,
      ajulong countall
);

From EMBOSS 6.4.0

Function ajBtreeSecInsertId

Insert a secondary ID into the tree

Prototype

AjBool ajBtreeSecInsertId (
      AjPBtcache cache,
      const AjPStr id
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

const AjPStr id Input Id

AjBool RETURN True if ID was inserted False if ID already exists

From EMBOSS 6.4.0

Function ajBtreeSecFindId

See whether ID already exists in the tree

Prototype

AjBool ajBtreeSecFindId (
      AjPBtcache cache,
      const AjPStr key
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

const AjPStr key Input key

AjBool RETURN true if ID already added

From EMBOSS 6.4.0

Function ajBtreeSecFindInsert

Find the node that should contain a new key for insertion

Prototype

AjPBtpage ajBtreeSecFindInsert (
      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 ajBtreeLockTest

Test function: show if a primary tree root block is unlocked

Prototype

void ajBtreeLockTest (
      AjPBtcache cache
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

void RETURN

From EMBOSS 3.0.0

Function ajBtreeSecLeafList

Read the leaves of a secondary tree

Prototype

AjPList ajBtreeSecLeafList (
      AjPBtcache cache,
      ajulong rootblock
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

ajulong rootblock Input root page of secondary tree

AjPList RETURN List of IDs matching a keyword

From EMBOSS 3.0.0

Function ajBtreeVerifyId

Test routine: test for ID within a secondary tree

Prototype

AjBool ajBtreeVerifyId (
      AjPBtcache cache,
      ajulong rootblock,
      const AjPStr id
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

ajulong rootblock Input root page of secondary tree

const AjPStr id Input test ID

AjBool RETURN true if ID found

From EMBOSS 3.0.0

Function ajBtreeIdFromKeywordW

Wildcard retrieval of keyword index entries

Prototype

AjPBtId ajBtreeIdFromKeywordW (
      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 ajBtreeListFromKeywordW

Wildcard retrieval of keyword index entries

Prototype

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

Type Name Read/Write Description

AjPBtcache cache Modify cache

const AjPStr key Input key

AjPBtcache idcache Modify id cache

AjPList btidlist Modify List of matching AjPBtId entries

void RETURN

From EMBOSS 3.0.0

Function ajBtreeHybNew

Constructor for index bucket ID information

Prototype

AjPBtHybrid ajBtreeHybNew (
      void
);

Type Name Read/Write Description

AjPBtHybrid RETURN Index ID object

From EMBOSS 4.0.0

Function ajBtreeHybDel

Destructor for index bucket ID information

Prototype

void ajBtreeHybDel (
      AjPBtHybrid* Pthis
);

Type Name Read/Write Description

AjPBtHybrid* Pthis Output index ID object

void RETURN

From EMBOSS 4.0.0

Function ajBtreeHybFindInsert

Find the node that should contain a new key for insertion

Prototype

AjPBtpage ajBtreeHybFindInsert (
      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 4.0.0

Function ajBtreeHybInsertId

Insert an ID structure into the tree

Prototype

void ajBtreeHybInsertId (
      AjPBtcache cache,
      AjPBtHybrid hyb
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

AjPBtHybrid hyb Modify Id object

void RETURN pointer to a page

From EMBOSS 4.0.0

Function ajBtreeNumFindInsert

Find the node that should contain a new key for insertion

Prototype

AjPBtpage ajBtreeNumFindInsert (
      AjPBtcache cache,
      const ajulong key
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

const ajulong key Input key to search for

AjPBtpage RETURN leaf node where item should be inserted

From EMBOSS 4.0.0

Function ajBtreeInsertNum

Insert a file offset key into a secondary tree

Prototype

void ajBtreeInsertNum (
      AjPBtcache cache,
      const AjPBtNumId num,
      AjPBtpage page
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

const AjPBtNumId num Input Id object

AjPBtpage page Output cache page

void RETURN pointer to a page

From EMBOSS 4.0.0

Function ajBtreeFreePriArray

Free karray and parray arrays for a primary key

Prototype

void ajBtreeFreePriArray (
      AjPBtcache cache
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

void RETURN

From EMBOSS 4.0.0

Function ajBtreeFreeSecArray

Free karray and parray arrays for a secondary key

Prototype

void ajBtreeFreeSecArray (
      AjPBtcache cache
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

void RETURN

From EMBOSS 4.0.0

Function ajBtreeHybLeafList

Read the leaves of a secondary hybrid tree

Prototype

void ajBtreeHybLeafList (
      AjPBtcache cache,
      ajulong rootblock,
      const AjPStr idname,
      AjPList list
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

ajulong rootblock Input root page of secondary tree

const AjPStr idname Input id name

AjPList list Modify list to add BtIDs to

void RETURN

From EMBOSS 4.0.0

Function ajBtreeDumpHybKeys

Read the leaves of a primary hybrid tree (requested by EBI services)

Prototype

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

From EMBOSS 5.0.0

Function ajBtreeDeleteHybId

Entry point for hybrid ID deletion.

Prototype

AjBool ajBtreeDeleteHybId (
      AjPBtcache cache,
      const AjPBtHybrid hyb
);

Type Name Read/Write Description

AjPBtcache cache Modify cache

const AjPBtHybrid hyb Input hybrid object

AjBool RETURN True if found and deleted

From EMBOSS 6.1.0

Function ajBtreeDeletePriId

Entry point for keyword tree ID deletion.

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 ajBtreeGetPagecount

Returns the number of pages in a tree index

Prototype

ajulong ajBtreeGetPagecount (
      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 ajBtreeGetPagesize

Returns the page size a tree index

Prototype

ajuint ajBtreeGetPagesize (
      const AjPBtcache cache
);

Type Name Read/Write Description

const AjPBtcache cache Input cache

ajuint RETURN Page size of a tree index

From EMBOSS 6.4.0

Function ajBtreeGetTotsize

Returns the number of bytes in a tree index

Prototype

ajulong ajBtreeGetTotsize (
      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

Returns the node type name of a tree index page

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

Returns number of keys, overflow pages visited and free space unused for a b+ tree node page

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

Returns number of keys, overflow pages visited and free space unused for a b+ tree numeric node page

Prototype

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

From EMBOSS 6.4.0

Function ajBtreeStatBucket

Returns number of keys, overflow pages visited and free space unused for a b+ tree bucket page

Prototype

AjBool ajBtreeStatBucket (
      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

Returns number of keys, overflow pages visited and free space unused for a b+ tree secondary bucket page

Prototype

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

From EMBOSS 6.4.0

Function ajBtreeStatPribucket

Returns number of keys, overflow pages visited and free space unused for a b+ tree primary bucket page

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

Returns number of keys, overflow pages visited and free space unused for a b+ tree numeric bucket page

Prototype

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

From EMBOSS 6.4.0

Function ajBtreePageGetSize

Return the used size of a cache page

Prototype

ajuint ajBtreePageGetSize (
      const AjPBtpage page
);

Type Name Read/Write Description

const AjPBtpage page Input Page

ajuint RETURN Used page size

From EMBOSS 6.4.0

Function ajBtreeExit

Cleans up B+tree indexing internal memory

Prototype

void ajBtreeExit (
      void
);

Type Name Read/Write Description

void RETURN

From EMBOSS 6.4.0

Function ajBtreeIdCmp

Comparison function for sorting B+tree ID objects by database file number and offset.

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

Hash function for a table with a B+tree primary key

Prototype

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

Type Name Read/Write Description

const void* key Input Standard argument. Table key.

ajuint hashsize Input Standard argument. Estimated Hash size.

ajuint RETURN Hash value in range 0 to hashsize-1

From EMBOSS 6.4.0

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

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.