ajnexus.c


Function ajNexusParse

Parses a nexus buffered file

Synopsis

Prototype
AjPNexus ajNexusParse (
      AjPFilebuff buff
);

TypeNameRead/WriteDescription
AjPFilebuffbuffModifyInput buffered file
AjPNexus RETURNNexus data object

Input & Output
buff:(Modify)Input buffered file
Returns
AjPNexus:Nexus data object

Description

Parses a nexus buffered file

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNexusNew

Constructor for AjPNexus

Synopsis

Prototype
AjPNexus ajNexusNew (
      void
);

TypeNameRead/WriteDescription
AjPNexus RETURNNew AjPNexus object

Returns
AjPNexus:New AjPNexus object

Description

Constructor for AjPNexus

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNexusDel

Destructor for AjPNexus

Synopsis

Prototype
void ajNexusDel (
      AjPNexus* pthys
);

TypeNameRead/WriteDescription
AjPNexus*pthysDeleteAjPNexus object
void RETURN

Output
pthys:(Delete)AjPNexus object
Returns
void:No return value

Description

Destructor for AjPNexus

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNexusTrace

Reports the contents of a Nexus object to the debug file

Synopsis

Prototype
void ajNexusTrace (
      const AjPNexus thys
);

TypeNameRead/WriteDescription
const AjPNexusthysInputnexus object
void RETURN

Input
thys:(Input)nexus object
Returns
void:No return value

Description

Reports the contents of a Nexus object to the debug file

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNexusGetTaxa

Returns the taxa as a string array

Synopsis

Prototype
AjPStr* ajNexusGetTaxa (
      const AjPNexus thys
);

TypeNameRead/WriteDescription
const AjPNexusthysInputNexus object
AjPStr* RETURNtaxa string array, NULL terminated, read only

Input
thys:(Input)Nexus object
Returns
AjPStr*:taxa string array, NULL terminated, read only

Description

Returns the taxa as a string array

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNexusGetNtaxa

Returns the number of taxa

Synopsis

Prototype
ajuint ajNexusGetNtaxa (
      const AjPNexus thys
);

TypeNameRead/WriteDescription
const AjPNexusthysInputNexus object
ajuint RETURNNumber of taxa

Input
thys:(Input)Nexus object
Returns
ajuint:Number of taxa

Description

Returns the number of taxa

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajNexusGetSequences

Returns the sequences from the character matrix as a string array.

Sequences are in the same order as the taxa returned by ajNexusGetTaxa. Sequences may need to be set if not already done.

Synopsis

Prototype
AjPStr* ajNexusGetSequences (
      AjPNexus thys
);

TypeNameRead/WriteDescription
AjPNexusthysModifyNexus object
AjPStr* RETURNtaxa string array, NULL terminated, read only

Input & Output
thys:(Modify)Nexus object
Returns
AjPStr*:taxa string array, NULL terminated, read only

Description

Returns the sequences from the character matrix as a string array.

Sequences are in the same order as the taxa returned by ajNexusGetTaxa. Sequences may need to be set if not already done.

See Also

See other functions in this section

Availability

In release 6.4.0