ajnexus.c

Function ajNexusParse

Parses a nexus buffered file

Synopsis

Prototype

AjPNexus ajNexusParse (
      AjPFileBuff buff
);

Input & Output

buff:(Modify)Input buffered file

Returns

AjPNexus:Nexus data object

Description

Parses a nexus buffered file

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajNexusNew

Constructor for AjPNexus

Synopsis

Prototype

AjPNexus ajNexusNew (
      void
);

Returns

AjPNexus:New AjPNexus object

Description

Constructor for AjPNexus

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajNexusDel

Destructor for AjPNexus

Synopsis

Prototype

void ajNexusDel (
      AjPNexus* pthys
);

Output

pthys:(Delete)AjPNexus object

Returns

void:No return value

Description

Destructor for AjPNexus

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajNexusTrace

Reports the contents of a Nexus object to the debug file

Synopsis

Prototype

void ajNexusTrace (
      const AjPNexus thys
);

Input

thys:(Input)nexus object

Returns

void:No return value

Description

Reports the contents of a Nexus object to the debug file

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajNexusGetTaxa

Returns the taxa as a string array

Synopsis

Prototype

AjPStr* ajNexusGetTaxa (
      const AjPNexus thys
);

Input

thys:(Input)Nexus object

Returns

AjPStr*:taxa string array, NULL terminated, read only

Description

Returns the taxa as a string array

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajNexusGetNtaxa

Returns the number of taxa

Synopsis

Prototype

ajint ajNexusGetNtaxa (
      const AjPNexus thys
);

Input

thys:(Input)Nexus object

Returns

ajint:Number of taxa

Description

Returns the number of taxa

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.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
);

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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0