← Back to branch summary

~ubuntu-branches/ubuntu/raring/samtools/raring

« back to all changes in this revision

Viewing changes to faidx.h

  • Committer: Bazaar Package Importer
  • Author(s): Charles Plessy
  • Date: 2009-11-17 21:38:24 UTC
  • Revision ID: james.westby@ubuntu.com-20091117213824-dfouynpy3r7ismpj
Tags: 0.1.7a~dfsg-1
* New upstream release: new script sam2vcf.pl, and many other changes.
* Package converted to the format ‘3.0 (quilt)’ (debian/source/format).
* Wrote a manual page for razip (debian/razip.1).
* Better clean the example directory to make the source package
  buildable twice in a row (debian/rules).

Show diffs side-by-side

added added

removed removed

Lines of Context:
faidx.h
75
75
         */
76
76
        char *fai_fetch(const faidx_t *fai, const char *reg, int *len);
77
77
 
 
78
        /*!
 
79
          @abstract        Fetch the number of sequences. 
 
80
          @param  fai  Pointer to the faidx_t struct
 
81
          @return          The number of sequences
 
82
         */
 
83
        int faidx_fetch_nseq(const faidx_t *fai);
 
84
 
 
85
        /*!
 
86
          @abstract    Fetch the sequence in a region.
 
87
          @param  fai  Pointer to the faidx_t struct
 
88
          @param  c_name Region name
 
89
          @param  p_beg_i  Beginning position number (zero-based)
 
90
          @param  p_end_i  End position number (zero-based)
 
91
          @param  len  Length of the region
 
92
          @return      Pointer to the sequence; null on failure
 
93
 
 
94
          @discussion The returned sequence is allocated by malloc family
 
95
          and should be destroyed by end users by calling free() on it.
 
96
         */
 
97
        char *faidx_fetch_seq(const faidx_t *fai, char *c_name, int p_beg_i, int p_end_i, int *len);
 
98
 
78
99
#ifdef __cplusplus
79
100
}
80
101
#endif