Ignore:
Timestamp:
Feb 10, 2008, 11:24:55 PM (14 years ago)
Author:
Peter
Message:

some documentation on matrix

File:
1 edited

Legend:

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

    r1064 r1065  
    158158
    159159    /**
     160       Iterator iterates along a row. When end of row is reached it
     161       jumps to beginning of next row.
     162
     163       \return iterator pointing to upper-left element.
    160164     */
    161165    iterator begin(void);
    162166
    163167    /**
     168       Iterator iterates along a row. When end of row is reached it
     169       jumps to beginning of next row.
     170
     171       \return const_iterator pointing to upper-left element.
    164172     */
    165173    const_iterator begin(void) const;
    166174
    167175    /**
    168      */
    169     iterator begin_column(size_t);
    170 
    171     /**
    172      */
    173     const_iterator begin_column(size_t) const;
    174 
    175     /**
    176      */
    177     iterator begin_row(size_t);
    178 
    179     /**
    180      */
    181     const_iterator begin_row(size_t) const;
     176       Iterator iterates along a column.
     177
     178       \return iterator pointing to first element of column \a i.
     179     */
     180    iterator begin_column(size_t i);
     181
     182    /**
     183       Iterator iterates along a column.
     184
     185       \return const_iterator pointing to first element of column \a i.
     186     */
     187    const_iterator begin_column(size_t i) const;
     188
     189    /**
     190       Iterator iterates along a row.
     191
     192       \return iterator pointing to first element of row \a i.
     193     */
     194    iterator begin_row(size_t i);
     195
     196    /**
     197       Iterator iterates along a row.
     198
     199       \return const_iterator pointing to first element of row \a i.
     200     */
     201    const_iterator begin_row(size_t i) const;
    182202
    183203    /**
     
    190210
    191211    /**
    192      */
    193     VectorView column_view(size_t);
    194 
    195     /**
     212       \return Vector view of column \a i
     213     */
     214    VectorView column_view(size_t i);
     215
     216    /**
     217       \return const vector view of column \a i
    196218     */
    197219    const VectorConstView column_const_view(size_t) const;
     
    212234
    213235    /**
     236       \return iterator pointing to end of matrix
    214237     */
    215238    iterator end(void);
    216239
    217240    /**
     241       \return iterator pointing to end of matrix
    218242     */
    219243    const_iterator end(void) const;
    220244
    221245    /**
    222      */
    223     iterator end_column(size_t);
    224 
    225     /**
    226      */
    227     const_iterator end_column(size_t) const;
    228 
    229     /**
    230      */
    231     iterator end_row(size_t);
    232 
    233     /**
    234      */
    235     const_iterator end_row(size_t) const;
     246       \return iterator pointing to end of column \a i
     247     */
     248    iterator end_column(size_t i);
     249
     250    /**
     251       \return const_iterator pointing to end of column \a i
     252     */
     253    const_iterator end_column(size_t i) const;
     254
     255    /**
     256       \return iterator pointing to end of row \a i
     257     */
     258    iterator end_row(size_t i);
     259
     260    /**
     261       \return const_iterator pointing to end of row \a i
     262     */
     263    const_iterator end_row(size_t i) const;
    236264
    237265    /**
     
    289317
    290318    /**
     319       \return Vector view of \a i
    291320     */
    292321    VectorView row_view(size_t);
    293322
    294323    /**
     324       \return const vector view of \a i
    295325     */
    296326    const VectorConstView row_const_view(size_t) const;
Note: See TracChangeset for help on using the changeset viewer.