ajdmx.c


Section: Constructors

All constructors return a pointer to a new instance. It is the responsibility of the user to first destroy any previous instance. The target pointer does not need to be initialised to NULL, but it is good programming practice to do so anyway.

Functions:
ajDmxScophitNewScophit object constructor.
ajDmxScopalgNewScopalg object constructor. This is normally called by the ajDmxScopalgRead function. Fore-knowledge of the number of sequences is required.
ajDmxScopalgReadRead a Scopalg object from a file.


Function ajDmxScophitNew

Scophit object constructor.

Prototype

AjPScophit ajDmxScophitNew (
      void
);

TypeNameRead/WriteDescription
AjPScophit RETURNPointer to a Scophit object

From EMBOSS 2.9.0


Function ajDmxScopalgNew

Scopalg object constructor. This is normally called by the ajDmxScopalgRead function. Fore-knowledge of the number of sequences is required.

Prototype

AjPScopalg ajDmxScopalgNew (
      ajint n
);

TypeNameRead/WriteDescription
ajintnInputNumber of sequences
AjPScopalg RETURNPointer to a Scopalg object

From EMBOSS 2.9.0


Function ajDmxScopalgRead

Read a Scopalg object from a file.

Prototype

AjBool ajDmxScopalgRead (
      AjPFile inf,
      AjPScopalg* thys
);

TypeNameRead/WriteDescription
AjPFileinfModifyInput file stream
AjPScopalg*thysOutputScopalg object
AjBool RETURNTrue if the file contained any data, even an empty alignment. False if the file did not contain a 'TY' record, which is taken to indicate a domain alignment file.

From EMBOSS 2.9.0


Section: Structure Destructors

All destructor functions receive the address of the instance to be deleted. The original pointer is set to NULL so is ready for re-use.

Functions:
ajDmxScophitDelDestructor for Scophit object.
ajDmxScophitDelWrapWrapper to destructor for Scophit object for use with generic functions.
ajDmxScopalgDelDestructor for Scopalg object.


Function ajDmxScophitDel

Destructor for Scophit object.

Prototype

void ajDmxScophitDel (
      AjPScophit* pthis
);

TypeNameRead/WriteDescription
AjPScophit*pthisOutputScophit object pointer
void RETURN

From EMBOSS 2.9.0


Function ajDmxScophitDelWrap

Wrapper to destructor for Scophit object for use with generic functions.

Prototype

void ajDmxScophitDelWrap (
      void** ptr
);

TypeNameRead/WriteDescription
void**ptrDeleteObject pointer
void RETURN

From EMBOSS 2.9.0


Function ajDmxScopalgDel

Destructor for Scopalg object.

Prototype

void ajDmxScopalgDel (
      AjPScopalg* pthis
);

TypeNameRead/WriteDescription
AjPScopalg*pthisDeleteScopalg object pointer
void RETURN

From EMBOSS 2.9.0


Section: Assignments

These functions overwrite the instance provided as the first argument A NULL value is always acceptable so these functions are often used to create a new instance by assignment.

Functions:
ajDmxScophitListCopyRead a list of Scophit structures and returns a pointer to a duplicate of the list.
ajDmxScophitCopyCopies the contents from one Scophit object to another.


Function ajDmxScophitListCopy

Read a list of Scophit structures and returns a pointer to a duplicate of the list.

Prototype

AjPList ajDmxScophitListCopy (
      const AjPList ptr
);

TypeNameRead/WriteDescription
const AjPListptrInputList of Scophit objects
AjPList RETURNTrue on success (list was duplicated ok)

From EMBOSS 2.9.0


Function ajDmxScophitCopy

Copies the contents from one Scophit object to another.

Prototype

AjBool ajDmxScophitCopy (
      AjPScophit* to,
      const AjPScophit from
);

TypeNameRead/WriteDescription
AjPScophit*toOutputScophit object pointer
const AjPScophitfromInputScophit object
AjBool RETURNTrue if copy was successful.

From EMBOSS 2.9.0


Section: Modifiers

These functions use the contents of an instance and update them.

Functions:
ajDmxScophitTargetLowPrioritySets the Target element of a Scophit object to True if its Priority is low.
ajDmxScophitTarget2Sets the Target2 element of a Scophit object to True.
ajDmxScophitTargetSets the Target element of a Scophit object to True.


Function ajDmxScophitTargetLowPriority

Sets the Target element of a Scophit object to True if its Priority is low.

Prototype

AjBool ajDmxScophitTargetLowPriority (
      AjPScophit* h
);

TypeNameRead/WriteDescription
AjPScophit*hModifyPointer to Scophit object
AjBool RETURNTrue on success. False otherwise.

From EMBOSS 2.9.0


Function ajDmxScophitTarget2

Sets the Target2 element of a Scophit object to True.

Prototype

AjBool ajDmxScophitTarget2 (
      AjPScophit* h
);

TypeNameRead/WriteDescription
AjPScophit*hModifyPointer to Scophit object
AjBool RETURNTrue on success. False otherwise.

From EMBOSS 2.9.0


Function ajDmxScophitTarget

Sets the Target element of a Scophit object to True.

Prototype

AjBool ajDmxScophitTarget (
      AjPScophit* h
);

TypeNameRead/WriteDescription
AjPScophit*hModifyPointer to Scophit object
AjBool RETURNTrue on success. False otherwise.

From EMBOSS 2.9.0


Section: Operators

These functions use the contents of an instance but do not make any changes.

Functions:
ajDmxScophitCheckTargetChecks to see if the Target element of a Scophit object == ajTrue.


Function ajDmxScophitCheckTarget

Checks to see if the Target element of a Scophit object == ajTrue.

Prototype

AjBool ajDmxScophitCheckTarget (
      const AjPScophit ptr
);

TypeNameRead/WriteDescription
const AjPScophitptrInputScophit object pointer
AjBool RETURNReturns ajTrue if the Target element of the Scophit object == ajTrue, returns ajFalse otherwise.

From EMBOSS 2.9.0


Section: Reporters

These functions return the contents of an instance but do not make any changes.

Functions:
ajDmxScophitCompScoreFunction to sort Scophit objects by Score element. Usually called by ajListSort.
ajDmxScophitCompPvalFunction to sort AjOScophit objects by Pval record. Usually called by ajListSort.
ajDmxScophitCompAccFunction to sort Scophit objects by Acc element.
ajDmxScophitCompSunidFunction to sort Scophit object by Sunid_Family.
ajDmxScophitCompSprFunction to sort Scophit object by Spr element.
ajDmxScophitCompEndFunction to sort Scophit object by End element.
ajDmxScophitCompStartFunction to sort Scophit object by Start element.
ajDmxScophitCompFamFunction to sort Scophit object by Family element.
ajDmxScophitCompSfamFunction to sort Scophit object by Superfamily element.
ajDmxScophitCompClassFunction to sort Scophit object by Class element.
ajDmxScophitCompFoldFunction to sort Scophit object by Fold element.
ajDmxScopalgGetseqsRead a Scopalg object and writes an array of AjPStr containing the sequences without gaps.
ajDmxScophitsWriteWrite contents of a list of Scophits to an output file in embl-like format Text for Class, Architecture, Topology, Fold, Superfamily and Family is only written if the text is available.
ajDmxScophitsWriteFastaWrite contents of a list of Scophits to an output file in DHF format Text for Class, Archhitecture, Topology, Fold, Superfamily and Family is only written if the text is available.
ajDmxScophitReadFastaRead a Scophit object from a file in extended FASTA format (see documentation for the DOMAINATRIX "seqsearch" application).
ajDmxScopalgWriteWrite a Scopalg object to file in EMBOSS simple multiple sequence format (same as that used by clustal) annotated with domain classification as below (records are for SCOP domains in this example):
ajDmxScopalgWriteClustalWrites a Scopalg object to a specified file in CLUSTAL format (just the alignment without the domain classification information).
ajDmxScopalgWriteClustal2Writes a Scopalg object to a specified file in CLUSTAL format (just the alignment without the domain classification information).
ajDmxScopalgWriteFastaWrites a Scopalg object to a specified file in FASTA format (just the alignment without the domain classification information).


Function ajDmxScophitCompScore

Function to sort Scophit objects by Score element. Usually called by ajListSort.

Prototype

ajint ajDmxScophitCompScore (
      const void* hit1,
      const void* hit2
);

TypeNameRead/WriteDescription
const void*hit1InputPointer to Hit object 1
const void*hit2InputPointer to Hit object 2
ajint RETURN1 if score1<score2, 0 if score1==score2, else -1.

From EMBOSS 2.9.0


Function ajDmxScophitCompPval

Function to sort AjOScophit objects by Pval record. Usually called by ajListSort.

Prototype

ajint ajDmxScophitCompPval (
      const void* hit1,
      const void* hit2
);

TypeNameRead/WriteDescription
const void*hit1InputPointer to Hit object 1
const void*hit2InputPointer to Hit object 2
ajint RETURN1 if Pval1>Pval2, 0 if Pval1==Pval2, else -1.

From EMBOSS 2.9.0


Function ajDmxScophitCompAcc

Function to sort Scophit objects by Acc element.

Prototype

ajint ajDmxScophitCompAcc (
      const void* hit1,
      const void* hit2
);

TypeNameRead/WriteDescription
const void*hit1InputPointer to Scophit object 1
const void*hit2InputPointer to Scophit object 2
ajint RETURN-1 if Acc1 should sort before Acc2, +1 if the Acc2 should sort first. 0 if they are identical in length and content.

From EMBOSS 2.9.0


Function ajDmxScophitCompSunid

Function to sort Scophit object by Sunid_Family.

Prototype

ajint ajDmxScophitCompSunid (
      const void* entry1,
      const void* entry2
);

TypeNameRead/WriteDescription
const void*entry1InputPointer to AjOScophit object 1
const void*entry2InputPointer to AjOScophit object 2
ajint RETURN-1 if Sunid_Family1 < Sunid_Family2, +1 if the Sunid_Family2 should sort first. 0 if they are identical.

From EMBOSS 2.9.0


Function ajDmxScophitCompSpr

Function to sort Scophit object by Spr element.

Prototype

ajint ajDmxScophitCompSpr (
      const void* hit1,
      const void* hit2
);

TypeNameRead/WriteDescription
const void*hit1InputPointer to Scophit object 1
const void*hit2InputPointer to Scophit object 2
ajint RETURN-1 if Spr1 should sort before Spr2, +1 if the Spr2 should sort first. 0 if they are identical in length and content.

From EMBOSS 2.9.0


Function ajDmxScophitCompEnd

Function to sort Scophit object by End element.

Prototype

ajint ajDmxScophitCompEnd (
      const void* hit1,
      const void* hit2
);

TypeNameRead/WriteDescription
const void*hit1InputPointer to Scophit object 1
const void*hit2InputPointer to Scophit object 2
ajint RETURN-1 if End1 should sort before End2, +1 if the End2 should sort first. 0 if they are identical.

From EMBOSS 2.9.0


Function ajDmxScophitCompStart

Function to sort Scophit object by Start element.

Prototype

ajint ajDmxScophitCompStart (
      const void* hit1,
      const void* hit2
);

TypeNameRead/WriteDescription
const void*hit1InputPointer to Scophit object 1
const void*hit2InputPointer to Scophit object 2
ajint RETURN-1 if Start1 should sort before Start2, +1 if the Start2 should sort first. 0 if they are identical.

From EMBOSS 2.9.0


Function ajDmxScophitCompFam

Function to sort Scophit object by Family element.

Prototype

ajint ajDmxScophitCompFam (
      const void* hit1,
      const void* hit2
);

TypeNameRead/WriteDescription
const void*hit1InputPointer to Scophit object 1
const void*hit2InputPointer to Scophit object 2
ajint RETURN-1 if Family1 should sort before Family2, +1 if the Family2 should sort first. 0 if they are identical.

From EMBOSS 2.9.0


Function ajDmxScophitCompSfam

Function to sort Scophit object by Superfamily element.

Prototype

ajint ajDmxScophitCompSfam (
      const void* hit1,
      const void* hit2
);

TypeNameRead/WriteDescription
const void*hit1InputPointer to Scophit object 1
const void*hit2InputPointer to Scophit object 2
ajint RETURN-1 if Superfamily1 should sort before Superfamily2, +1 if the Superfamily2 should sort first. 0 if they are identical.

From EMBOSS 2.9.0


Function ajDmxScophitCompClass

Function to sort Scophit object by Class element.

Prototype

ajint ajDmxScophitCompClass (
      const void* hit1,
      const void* hit2
);

TypeNameRead/WriteDescription
const void*hit1InputPointer to Scophit object 1
const void*hit2InputPointer to Scophit object 2
ajint RETURN-1 if Class1 should sort before Class2, +1 if the Class2 should sort first. 0 if they are identical.

From EMBOSS 3.0.0


Function ajDmxScophitCompFold

Function to sort Scophit object by Fold element.

Prototype

ajint ajDmxScophitCompFold (
      const void* hit1,
      const void* hit2
);

TypeNameRead/WriteDescription
const void*hit1InputPointer to Scophit object 1
const void*hit2InputPointer to Scophit object 2
ajint RETURN-1 if Fold1 should sort before Fold2, +1 if the Fold2 should sort first. 0 if they are identical.

From EMBOSS 2.9.0


Function ajDmxScopalgGetseqs

Read a Scopalg object and writes an array of AjPStr containing the sequences without gaps.

Prototype

ajint ajDmxScopalgGetseqs (
      const AjPScopalg thys,
      AjPStr** arr
);

TypeNameRead/WriteDescription
const AjPScopalgthysInputScopalg object
AjPStr**arrOutputArray of AjPStr
ajint RETURNNumber of sequences read

From EMBOSS 2.9.0


Function ajDmxScophitsWrite

Write contents of a list of Scophits to an output file in embl-like format Text for Class, Architecture, Topology, Fold, Superfamily and Family is only written if the text is available.

Prototype

AjBool ajDmxScophitsWrite (
      AjPFile outf,
      const AjPList list
);

TypeNameRead/WriteDescription
AjPFileoutfOutputOutput file stream
const AjPListlistInputList object
AjBool RETURNTrue on success

From EMBOSS 2.9.0


Function ajDmxScophitsWriteFasta

Write contents of a list of Scophits to an output file in DHF format Text for Class, Archhitecture, Topology, Fold, Superfamily and Family is only written if the text is available.

Prototype

AjBool ajDmxScophitsWriteFasta (
      AjPFile outf,
      const AjPList list
);

TypeNameRead/WriteDescription
AjPFileoutfOutputOutput file stream
const AjPListlistInputList object
AjBool RETURNTrue on success

From EMBOSS 3.0.0


Function ajDmxScophitReadFasta

Read a Scophit object from a file in extended FASTA format (see documentation for the DOMAINATRIX "seqsearch" application).

Prototype

AjPScophit ajDmxScophitReadFasta (
      AjPFile inf
);

TypeNameRead/WriteDescription
AjPFileinfModifyInput file stream
AjPScophit RETURNScophit object, or NULL if the file was not in extended FASTA (DHF) format (indicated by a token count of the the lines beginning with '>').

From EMBOSS 3.0.0


Function ajDmxScopalgWrite

Write a Scopalg object to file in EMBOSS simple multiple sequence format (same as that used by clustal) annotated with domain classification as below (records are for SCOP domains in this example):

Prototype

AjBool ajDmxScopalgWrite (
      const AjPScopalg scop,
      AjPFile outf
);

TypeNameRead/WriteDescription
const AjPScopalgscopInputScopalg object
AjPFileoutfModifyOutput file stream
AjBool RETURNTrue on success (an alignment was written)

From EMBOSS 2.9.0


Function ajDmxScopalgWriteClustal

Writes a Scopalg object to a specified file in CLUSTAL format (just the alignment without the domain classification information).

Prototype

AjBool ajDmxScopalgWriteClustal (
      const AjPScopalg align,
      AjPFile outf
);

TypeNameRead/WriteDescription
const AjPScopalgalignInputScopalg object
AjPFileoutfModifyOutfile file pointer
AjBool RETURNTrue on success (a file has been written)

From EMBOSS 2.9.0


Function ajDmxScopalgWriteClustal2

Writes a Scopalg object to a specified file in CLUSTAL format (just the alignment without the domain classification information).

Prototype

AjBool ajDmxScopalgWriteClustal2 (
      const AjPScopalg align,
      AjPFile outf
);

TypeNameRead/WriteDescription
const AjPScopalgalignInputScopalg object.
AjPFileoutfModifyOutfile file pointer.
AjBool RETURNTrue on success (a file has been written)

From EMBOSS 2.9.0


Function ajDmxScopalgWriteFasta

Writes a Scopalg object to a specified file in FASTA format (just the alignment without the domain classification information).

Prototype

AjBool ajDmxScopalgWriteFasta (
      const AjPScopalg align,
      AjPFile outf
);

TypeNameRead/WriteDescription
const AjPScopalgalignInputA list of hit list structures.
AjPFileoutfModifyOutfile file pointer
AjBool RETURNTrue on success (a file has been written)

From EMBOSS 2.9.0


Section: Miscellaneous

These functions may have diverse functions that do not fit into the other categories.

Functions:
ajDmxScopSeqFromSunidWrites a sequence corresponding to a Scop domain given a Sunid for the domain. The sequence is taken from one of a list of Scop objects that is provided. The swissprot sequence is taken in priority over the pdb sequence.
ajDmxExitCleanup of Dmx function internals.
ajDmxDummyFunctionDummy function to catch all unused functions defined in the ajdmx source file.


Function ajDmxScopSeqFromSunid

Writes a sequence corresponding to a Scop domain given a Sunid for the domain. The sequence is taken from one of a list of Scop objects that is provided. The swissprot sequence is taken in priority over the pdb sequence.

Prototype

AjBool ajDmxScopSeqFromSunid (
      ajint id,
      AjPStr* seq,
      const AjPList list
);

TypeNameRead/WriteDescription
ajintidInputSearch term
AjPStr*seqOutputResult sequence
const AjPListlistInputSorted list of Scop objects
AjBool RETURNTrue if a swissprot identifier code was found for the Pdb code.

From EMBOSS 2.9.0


Function ajDmxExit

Cleanup of Dmx function internals.

Prototype

void ajDmxExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 6.1.0


Function ajDmxDummyFunction

Dummy function to catch all unused functions defined in the ajdmx source file.

Prototype

void ajDmxDummyFunction (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 2.9.0