Changeset 755 for trunk/yat/utility/vector.h
 Timestamp:
 Feb 18, 2007, 1:01:39 AM (16 years ago)
 File:

 1 edited
Legend:
 Unmodified
 Added
 Removed

trunk/yat/utility/vector.h
r754 r755 228 228 void add(double term); 229 229 230 /// 231 /// This function performs elementwise division, \f$ this_i = 232 /// this_i/other_i \; \forall i \f$. 233 /// 234 /// @return GSL_SUCCESS on normal exit. 235 /// 236 // Jari, doxygen group as Vector operators 237 int div(const vector& other); 230 /** 231 \brief This function performs elementwise division, \f$ this_i = 232 this_i/other_i \; \forall i \f$. 233 234 \throw GSL_error if dimensions mismatch. 235 */ 236 void div(const vector& other); 238 237 239 238 /// … … 303 302 std::pair<size_t,size_t> minmax_index(void) const; 304 303 305 /// 306 /// This function performs elementwise multiplication, \f$ this_i = 307 /// this_i * other_i \; \forall i \f$. 308 /// 309 /// @return GSL_SUCCESS on normal exit. 310 /// 311 // Jari, doxygen group as Vector operators 312 int mul(const vector& other); 313 314 /// 315 /// Reverse the order of elements in the vector. 316 /// 317 /// @return GSL_SUCCESS on normal exit. 318 /// 319 // Jari, doxygen group as Exchanging elements 320 int reverse(void); 304 /** 305 \brief This function performs elementwise multiplication, \f$ 306 this_i = this_i * other_i \; \forall i \f$. 307 308 \throw GSL_error if dimensions mismatch. 309 */ 310 void mul(const vector& other); 311 312 /** 313 \brief Reverse the order of elements in the vector. 314 */ 315 void reverse(void); 321 316 322 317 /** … … 384 379 double sum(void) const; 385 380 386 /// 387 /// Swap vector elements by copying. The two vectors must have the 388 /// same length. 389 /// 390 /// @return GSL_SUCCESS on normal exit. 391 /// 392 int swap(vector& other); 393 394 /// 395 /// Exchange elements \a i and \a j. 396 /// 397 /// @return GSL_SUCCESS on normal exit. 398 /// 399 // Jari, doxygen group as Exchanging elements 400 int swap_elements(size_t i,size_t j); 401 402 /// 403 /// Element access operator. 404 /// 405 /// @return Reference to element \a i. 406 /// 407 // Jari, doxygen group as Accessing vector elements 381 /** 382 \brief Swap vector elements by copying. 383 384 The two vectors must have the same length. 385 386 \throw GSL_error if vector lengths differs. 387 */ 388 void swap(vector& other); 389 390 /** 391 \brief Exchange elements \a i and \a j. 392 393 \throw GSL_error if vector lengths differs. 394 */ 395 void swap_elements(size_t i, size_t j); 396 397 /** 398 \brief Element access operator. 399 400 \return Reference to element \a i. 401 402 \throw If GSL range checks are enabled in the underlying GSL 403 library a GSL_error exception is thrown if either index is out 404 of range. 405 */ 408 406 double& operator()(size_t i); 409 407 410 /// 411 /// Const element access operator. 412 /// 413 /// @return The value of element \a i. 414 /// 415 // Jari, doxygen group as Accessing vector elements 408 /** 409 \brief Element access operator. 410 411 \return Const reference to element \a i. 412 413 \throw If GSL range checks are enabled in the underlying GSL 414 library a GSL_error exception is thrown if either index is out 415 of range. 416 */ 416 417 const double& operator()(size_t i) const; 417 418
Note: See TracChangeset
for help on using the changeset viewer.