Changeset 2903


Ignore:
Timestamp:
Dec 14, 2012, 12:40:05 AM (9 years ago)
Author:
Peter
Message:

refs #729. document bam_pair_analyse

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/omic/algorithm.h

    r2902 r2903  
    3131
    3232  /**
     33     \c bam_pair_analyse performs an operation on bam read pairs as
     34     defined by \a visitor. The function iterates over sorted input
     35     range of reads; if read is first read, it is cached for later
     36     use; if read is second read and mate is present in cache, \a
     37     visitor operates on pair, i.e., \c Visitor (\c mate, \c read) is
     38     called.
     39
     40     Type Requirements:
     41     - \c Iterator must be an \input_iterator
     42     - \c Iterator 's \c reference type must be convertible to BamRead
     43     - \c Visitor must have an \c operator()(BamRead, BamRead) (or any
     44       \c const or reference combination)
     45
     46     \note Input range \c [\a first, \a last \c ) must be sorted or behaviour is
     47     undefined.
     48
    3349     \since New in yat 0.10
    3450   */
Note: See TracChangeset for help on using the changeset viewer.