Ignore:
Timestamp:
Mar 10, 2007, 9:49:31 PM (15 years ago)
Author:
Jari Häkkinen
Message:

Addresses #193. Fixing doxygen docs, and operator=.

File:
1 edited

Legend:

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

    r789 r790  
    5959     utility::vector::isview(), that can be used to check if a vector
    6060     object is a view. Note that view vectors do not own the
    61      underlying data, and a view is not valid if the vector owing the
    62      data is deallocated.
     61     underlying data, and a view is not valid if the vector/matrix
     62     owing the data is deallocated.
    6363
    6464     \par
     
    8181  v2(0)=-123;              // not acceptable for the compiler
    8282     @endcode
    83 
    84      @note Missing support to underlying GSL vector features can in
    85      principle be included to this class if requested by the user
    86      community.
    8783  */
    8884
     
    349345       \return True if all elements are equal otherwise false.
    350346
    351        \see equal
     347       \see equal(const vector&, const double precision=0)
    352348    */
    353349    bool operator==(const vector&) const;
     
    362358       \return False if all elements are equal otherwise true.
    363359
    364        \see equal
     360       \see equal(const vector&, const double precision=0)
    365361    */
    366362    bool operator!=(const vector&) const;
     
    374370       \brief The assignment operator.
    375371
    376        There is no requirements on dimensions, i.e. the vector is
    377        remapped in memory if necessary. This implies that in general
    378        views cannot be assigned using this operator. Views will be
    379        mutated into normal vectors. The only exception to this
    380        behaviour on views is when self-assignemnt is done, since
    381        self-assignment is ignored.
     372       Dimensions of the vectors must match. If the LHS vector is a
     373       view, the underlying data will be changed.
    382374
    383375       \return A const reference to the resulting vector.
     
    385377       \see void set(const vector&).
    386378
    387        \throw A GSL_error is indirectly thrown if memory allocation
    388        fails, or if dimensions mis-match.
     379       \throw GSL_error if dimensions mis-match.
    389380    */
    390381    const vector& operator=(const vector&);
Note: See TracChangeset for help on using the changeset viewer.