Changeset 3195


Ignore:
Timestamp:
Apr 22, 2014, 11:46:14 AM (8 years ago)
Author:
Peter
Message:

add first thin documentation for Aligner::Cigar. refs #785

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/utility/Aligner.h

    r3194 r3195  
    77  Copyright (C) 2012 Peter Johansson
    88  Copyright (C) 2013 Jari Häkkinen, Peter Johansson
     9  Copyright (C) 2014 Peter Johansson
    910
    1011  This file is part of the yat library, http://dev.thep.lu.se/yat
     
    135136    {
    136137    public:
     138      /**
     139         Erases all elements.
     140       */
    137141      void clear(void);
     142
     143      /**
     144         Add an operation \a op of length \a len at back of cigar.
     145       */
    138146      void push_back(uint8_t op, uint32_t len=1);
     147
     148      /**
     149         Add an operation \a op of length \a len at front of cigar.
     150       */
    139151      void push_front(uint8_t op, uint32_t len=1);
     152
     153      /**
     154         Erase last operation.
     155       */
    140156      void pop_back(void);
     157
     158      /**
     159         Erase first operation.
     160       */
    141161      void pop_front(void);
    142       uint8_t op(size_t) const;
    143       char opchr(size_t) const;
    144       uint32_t oplen(size_t) const;
     162
     163      /**
     164         \return operation i
     165       */
     166      uint8_t op(size_t i) const;
     167
     168      /**
     169         \return character describing operation i
     170       */
     171      char opchr(size_t i) const;
     172
     173      /**
     174         \return length of element i
     175       */
     176      uint32_t oplen(size_t i) const;
     177
     178      /**
     179         \return cigar element i
     180       */
    145181      uint32_t operator[](size_t) const;
     182
     183      /**
     184         \return number of elements in cigar
     185       */
    146186      size_t size(void) const;
    147187    private:
     
    169209
    170210  /**
     211     Output e.g. '5S44M5I98M' if the cigar has four elements. Each
     212     element is output as the length followed by the character
     213     descibing the operation (see opchr).
     214
     215     \relates Aligner::Cigar
    171216   */
    172217  std::ostream& operator<<(std::ostream& os, const Aligner::Cigar& cigar);
Note: See TracChangeset for help on using the changeset viewer.