ajtree.c

Prototype

AjPTree ajTreeNew (
      void
);

Type Name Read/Write Description

AjPTree RETURN new tree;

Type	Name	Read/Write	Description
`AjPTree`		RETURN	new tree;

From EMBOSS 2.9.0

Function ajTreeNewNewick

Creates a new general tree using a Newick's format phylogenetic tree as input

Prototype

AjPTree ajTreeNewNewick (
      const AjPStr newick
);

Type Name Read/Write Description

const AjPStr newick Input Newick's format tree

AjPTree RETURN new tree;

Type	Name	Read/Write	Description
`const AjPStr`	`newick`	Input	Newick's format tree
`AjPTree`		RETURN	new tree;

From EMBOSS 6.0.0

Prototype

AjPTree ajTreestrNew (
      void
);

Type Name Read/Write Description

AjPTree RETURN new tree;

Type	Name	Read/Write	Description
`AjPTree`		RETURN	new tree;

From EMBOSS 2.9.0

Prototype

AjPTree ajTreestrCopy (
      const AjPTree thys
);

Type Name Read/Write Description

const AjPTree thys Input Tree to be copied

AjPTree RETURN New, copied, tree.

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	Tree to be copied
`AjPTree`		RETURN	New, copied, tree.

From EMBOSS 2.9.0

Prototype

AjPTree ajTreeCopy (
      const AjPTree thys
);

Type Name Read/Write Description

const AjPTree thys Input tree to be copied

AjPTree RETURN new copied tree.

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	tree to be copied
`AjPTree`		RETURN	new copied tree.

From EMBOSS 2.9.0

Function ajTreeLength

get the number of nodes in the linked tree.

Prototype

ajuint ajTreeLength (
      const AjPTree thys
);

Type Name Read/Write Description

const AjPTree thys Input Tree

ajuint RETURN Number of nodes in tree.

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	Tree
`ajuint`		RETURN	Number of nodes in tree.

From EMBOSS 2.9.0

Function ajTreestrLength

get the number of nodes in the linked tree.

Prototype

ajuint ajTreestrLength (
      const AjPTree thys
);

Type Name Read/Write Description

const AjPTree thys Input Tree

ajuint RETURN Number of nodes in tree.

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	Tree
`ajuint`		RETURN	Number of nodes in tree.

From EMBOSS 2.9.0

Function ajTreeFree

Free all nodes in the tree. NOTE: The data is only freed with a specified tree type. For undefined data types we recommend you to use ajTreeMap with a routine to free the memory.

Prototype

void ajTreeFree (
      AjPTree* pthis
);

Type Name Read/Write Description

AjPTree* pthis Delete Tree

void RETURN

Type	Name	Read/Write	Description
`AjPTree*`	`pthis`	Delete	Tree
`void`		RETURN

From EMBOSS 2.9.0

Function ajTreestrFree

Free all nodes in a string tree. Also deletes all the strings. If these are to be preserved, use ajTreestrDel instead.

Prototype

void ajTreestrFree (
      AjPTree* pthis
);

Type Name Read/Write Description

AjPTree* pthis Delete Tree

void RETURN

Type	Name	Read/Write	Description
`AjPTree*`	`pthis`	Delete	Tree
`void`		RETURN

From EMBOSS 2.9.0

Free the tree. Do not attempt to free the nodes. For use where the node data has been saved elsewhere, for example by ajTreeToArray or where the tree is a temporary structure referring to permanent data.

Prototype

void ajTreeDel (
      AjPTree* pthis
);

Type Name Read/Write Description

AjPTree* pthis Delete Tree

void RETURN

Type	Name	Read/Write	Description
`AjPTree*`	`pthis`	Delete	Tree
`void`		RETURN

From EMBOSS 2.9.0

Function ajTreestrDel

Prototype

void ajTreestrDel (
      AjPTree* pthis
);

Type Name Read/Write Description

AjPTree* pthis Delete Tree

void RETURN

Type	Name	Read/Write	Description
`AjPTree*`	`pthis`	Delete	Tree
`void`		RETURN

From EMBOSS 2.9.0

Function ajTreeMap

For each data node in the tree call function apply.

Prototype

void ajTreeMap (
      AjPTree thys,
      void function apply,
      void* cl
);

Type Name Read/Write Description

AjPTree thys Modify Tree.

void function apply Function Function to call for each tree item.

void* cl Modify Standard, usually NULL.

void RETURN

Type	Name	Read/Write	Description
`AjPTree`	`thys`	Modify	Tree.
`void function`	`apply`	Function	Function to call for each tree item.
`void*`	`cl`	Modify	Standard, usually NULL.
`void`		RETURN

From EMBOSS 2.9.0

Function ajTreestrMap

For each node in the tree call function apply, with the address of the string and a client pointer.

Prototype

void ajTreestrMap (
      AjPTree thys,
      void function apply,
      void* cl
);

Type Name Read/Write Description

AjPTree thys Modify Tree.

void function apply Function Function to call for each tree item.

void* cl Modify Standard, usually NULL.

void RETURN

Type	Name	Read/Write	Description
`AjPTree`	`thys`	Modify	Tree.
`void function`	`apply`	Function	Function to call for each tree item.
`void*`	`cl`	Modify	Standard, usually NULL.
`void`		RETURN

From EMBOSS 2.9.0

Function ajTreeToArray

Create an array of the pointers to the data.

Prototype

ajuint ajTreeToArray (
      const AjPTree thys,
      void*** array
);

Type Name Read/Write Description

const AjPTree thys Input Tree

void*** array Output Array of pointers to tree items.

ajuint RETURN Size of array of pointers.

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	Tree
`void***`	`array`	Output	Array of pointers to tree items.
`ajuint`		RETURN	Size of array of pointers.

From EMBOSS 2.9.0

Function ajTreestrToArray

Create an array of the pointers to the data.

Prototype

ajuint ajTreestrToArray (
      const AjPTree thys,
      AjPStr** array
);

Type Name Read/Write Description

const AjPTree thys Input Tree

AjPStr** array Output Array of Strings.

ajuint RETURN Size of array of pointers.

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	Tree
`AjPStr**`	`array`	Output	Array of Strings.
`ajuint`		RETURN	Size of array of pointers.

From EMBOSS 2.9.0

Function ajTreeDummyFunction

Dummy function to catch all unused functions defined in ajtree

Prototype

void ajTreeDummyFunction (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 2.9.0

Function ajTreeAddData

Sets the data value in a terminal tree node.

Prototype

AjBool ajTreeAddData (
      AjPTree thys,
      const AjPStr name,
      void* data
);

Type Name Read/Write Description

AjPTree thys Modify Terminal tree node. Must have no descendants

const AjPStr name Input Leaf name

void* data Unknown Data value

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPTree`	`thys`	Modify	Terminal tree node. Must have no descendants
`const AjPStr`	`name`	Input	Leaf name
`void*`	`data`	Unknown	Data value
`AjBool`		RETURN	ajTrue on success

From EMBOSS 2.9.0

Function ajTreestrAddData

Sets the data value in a terminal string tree node.

Prototype

AjBool ajTreestrAddData (
      AjPTree thys,
      const AjPStr name,
      AjPStr data
);

Type Name Read/Write Description

AjPTree thys Modify Terminal tree node. Must have no descendants

const AjPStr name Input Leaf name

AjPStr data Unknown Data value

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPTree`	`thys`	Modify	Terminal tree node. Must have no descendants
`const AjPStr`	`name`	Input	Leaf name
`AjPStr`	`data`	Unknown	Data value
`AjBool`		RETURN	ajTrue on success

From EMBOSS 4.1.0

Function ajTreeAddNode

Creates a new child node of the parent

Prototype

AjPTree ajTreeAddNode (
      AjPTree thys
);

Type Name Read/Write Description

AjPTree thys Modify Parent tree node

AjPTree RETURN New tree node created. It has no data value so far, so ajTreeAddNode or ajTreeAddData should be called to define data or further nodes.

Type	Name	Read/Write	Description
`AjPTree`	`thys`	Modify	Parent tree node
`AjPTree`		RETURN	New tree node created. It has no data value so far, so ajTreeAddNode or ajTreeAddData should be called to define data or further nodes.

From EMBOSS 2.9.0

Function ajTreeAddSubNode

Creates a new sibling node of the parent

Prototype

AjPTree ajTreeAddSubNode (
      AjPTree thys
);

Type Name Read/Write Description

AjPTree thys Modify Left tree node

AjPTree RETURN New tree node created. It has no data value so far, so ajTreeAddNode or ajTreeAddData should be called to define data or further nodes.

Type	Name	Read/Write	Description
`AjPTree`	`thys`	Modify	Left tree node
`AjPTree`		RETURN	New tree node created. It has no data value so far, so ajTreeAddNode or ajTreeAddData should be called to define data or further nodes.

From EMBOSS 2.9.0

Function ajTreeToNewick

Prints a trace of a tree to debug output

Prototype

void ajTreeToNewick (
      const AjPTree thys,
      AjPStr* Pnewick
);

Type Name Read/Write Description

const AjPTree thys Input Tree object

AjPStr* Pnewick Output Newick format string

void RETURN

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	Tree object
`AjPStr*`	`Pnewick`	Output	Newick format string
`void`		RETURN

From EMBOSS 6.0.0

Function ajTreeTrace

Prints a trace of a tree to debug output

Prototype

void ajTreeTrace (
      const AjPTree thys
);

Type Name Read/Write Description

const AjPTree thys Input Tree object

void RETURN

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	Tree object
`void`		RETURN

From EMBOSS 2.9.0

Function ajTreestrTrace

Prints a trace of a string tree to debug output

Prototype

void ajTreestrTrace (
      const AjPTree thys
);

Type Name Read/Write Description

const AjPTree thys Input Tree object

void RETURN

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	Tree object
`void`		RETURN

From EMBOSS 4.1.0

Function ajTreeFollow

Returns the next node through the tree.

Prototype

AjPTree ajTreeFollow (
      const AjPTree thys,
      const AjPTree parent
);

Type Name Read/Write Description

const AjPTree thys Input Current tree node

const AjPTree parent Input Parent tree node

AjPTree RETURN New tree node created. It has no data value so far, so ajTreeAddNode or ajTreeAddData should be called to define data or further nodes.

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	Current tree node
`const AjPTree`	`parent`	Input	Parent tree node
`AjPTree`		RETURN	New tree node created. It has no data value so far, so ajTreeAddNode or ajTreeAddData should be called to define data or further nodes.

From EMBOSS 4.1.0

Function ajTreeNext

Returns the next node at the same level

Prototype

AjPTree ajTreeNext (
      const AjPTree thys
);

Type Name Read/Write Description

const AjPTree thys Input Parent tree node

AjPTree RETURN New tree node created. It has no data value so far, so ajTreeAddNode or ajTreeAddData should be called to define data or further nodes.

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	Parent tree node
`AjPTree`		RETURN	New tree node created. It has no data value so far, so ajTreeAddNode or ajTreeAddData should be called to define data or further nodes.

From EMBOSS 4.1.0

Function ajTreePrev

Returns the previous node at the same level

Prototype

AjPTree ajTreePrev (
      const AjPTree thys
);

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	Parent tree node
`AjPTree`		RETURN	New tree node created. It has no data value so far, so ajTreeAddNode or ajTreeAddData should be called to define data or further nodes.

From EMBOSS 4.1.0

Function ajTreeDown

Returns the next node down 1 level

Prototype

AjPTree ajTreeDown (
      const AjPTree thys
);

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	Parent tree node
`AjPTree`		RETURN	New tree node created. It has no data value so far, so ajTreeAddNode or ajTreeAddData should be called to define data or further nodes.

From EMBOSS 4.1.0

Function ajTreeUp

Returns the parent of the present node

Prototype

AjPTree ajTreeUp (
      const AjPTree thys
);

Type Name Read/Write Description

const AjPTree thys Input Child tree node

AjPTree RETURN New tree node created. It has no data value so far, so ajTreeAddNode or ajTreeAddData should be called to define data or further nodes.

Type	Name	Read/Write	Description
`const AjPTree`	`thys`	Input	Child tree node
`AjPTree`		RETURN	New tree node created. It has no data value so far, so ajTreeAddNode or ajTreeAddData should be called to define data or further nodes.

From EMBOSS 4.1.0

Function ajTreeExit

Prints a summary of tree usage with debug calls

Prototype

void ajTreeExit (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 2.9.0