CYANA Function: inpk: Difference between revisions

From CYANA Wiki
Jump to navigation Jump to search
m (1 revision)
 
No edit summary
 
Line 1: Line 1:
== Synopsis ==


Synopsis: inpk(''integer'') = ''integer''
'''inpk(''integer'') = ''integer'''''
 
== Description ==


For the peak assignment with the given index, this function retuns
For the peak assignment with the given index, this function retuns

Latest revision as of 14:53, 12 August 2009

Synopsis

inpk(integer) = integer

Description

For the peak assignment with the given index, this function retuns either the number of assignments of the peak that has the selected assignment as its first assignment, or, if the selected assignment is not the first assignment of an ambiguously assigned peak, the difference between the indices of the first assignment and of the selected assignment, a negative number.

For instance, for a peak with three ambiguous assignments, the inpk function will return 3 for the first assignment, -1 for the second assignment, and -2 for the third assignment. For unambiuously assigned peaks, the function retuns 1.