Changeset 782 for trunk/yat/utility/vector.h

Timestamp:

Mar 5, 2007, 10:17:31 PM (16 years ago)

Author:

Jari Häkkinen

Message:

Fixes #195.

File:

• trunk/yat/utility/vector.h (modified) (5 diffs)

trunk/yat/utility/vector.h

@@ -62 +62 @@
 
      \par
-     Currently there is no restriction on how a vector is used in
-     cases when the vector is a const view into another vector or
+     Currently there is no restriction on how a vector is used when
+     the vector is a const view into another vector or
      matrix. To avoid unexpected runtime errors, the programmer must
      declare const view vectors as const in order to get compile time
@@ -234 +234 @@
 
     ///
-    /// @return True if all elements in the vector is zero, false
-    /// othwerwise;
-    ///
-    bool isnull(void) const;
-
-    ///
     /// Check if the vector object is a view (sub-vector) to another
     /// vector.
@@ -247 +241 @@
     bool isview(void) const;
 
-    ///
-    /// @return The maximum value of the vector.
-    ///
-    double max(void) const;
-
-    ///
-    /// @return The element index to the maximum value of the
-    /// vector. The lowest index has precedence.
-    ///
-    size_t max_index(void) const;
-
-    ///
-    /// @return The minimum value of the vector.
-    ///
-    double min(void) const;
-
-    ///
-    /// @return The element index to the minimum value of the
-    /// vector. The lowest index has precedence.
-    ///
-    size_t min_index(void) const;
-
-    ///
-    /// @return The minimum and maximum values of the vector, as the
-    /// \a first and \a second member of the returned \a pair,
-    /// respectively.
-    ///
-    std::pair<double,double> minmax(void) const;
-
-    ///
-    /// @return The indecies to the minimum and maximum values of the
-    /// vector, as the \a first and \a second member of the returned
-    /// \a pair, respectively. The lowest index has precedence.
-    ///
-    std::pair<size_t,size_t> minmax_index(void) const;
-
     /**
        \brief This function performs element-wise multiplication, \f$
@@ -313 +271 @@
 
     ///
-    /// Makes a basis vector by setting all elements to
-    /// zero except the \a i-th element which is set to
-    /// one.
-    ///
-    void set_basis(const size_t i);
-    
-    ///
-    /// Set all elements to zero.
-    ///
-    void set_zero(void);
-
-    ///
     /// @return the number of elements in the vector.
     ///
     size_t size(void) const;
 
-    ///
-    /// Sort the elements in the vector.
-    ///
-    /// Bug in gsl: if vector contains NaN an infinite loop is entered.
-    ///
-    void sort(void);
-
-    ///
-    /// Calculate the sum of all vector elements.
-    ///
-    /// @return The sum.
-    ///
-    double sum(void) const;
-
-    /**
-       \brief Swap vector elements by copying.
-
-       The two vectors must have the same length.
+    /**
+       \brief Exchange elements \a i and \a j.
 
        \throw GSL_error if vector lengths differs.
     */
-    void swap(vector& other);
-
-    /**
-       \brief Exchange elements \a i and \a j.
-
-       \throw GSL_error if vector lengths differs.
-    */
-    void swap_elements(size_t i, size_t j);
+    void swap(size_t i, size_t j);
 
     /**
@@ -496 +419 @@
   };
 
-  ///
-  /// The output operator for the vector class.
-  ///
-  std::ostream& operator<<(std::ostream&, const vector& );
-
+  /**
+     \brief Check if all elements of the vector are zero.
+
+     \return True if all elements in the vector is zero, false
+     othwerwise.
+  */
+  bool isnull(const vector&);
+
+  /**
+     \brief Get the maximum value of the vector.
+
+     \return The maximum value of the vector.
+  */
+  double max(const vector&);
+
+  /**
+     \brief Locate the maximum value in the vector.
+
+     \return The index to the maximum value of the vector.
+
+     \note Lower index has precedence.
+  */
+  size_t max_index(const vector&);
+
+  /**
+     \brief Get the minimum value of the vector.
+
+     \return The minimum value of the vector.
+  */
+  double min(const vector&);
+
+  /**
+     \brief Locate the minimum value in the vector.
+
+     \return The index to the minimum value of the vector.
+
+     \note Lower index has precedence.
+  */
+  size_t min_index(const vector&);
+
+  /**
+     \brief Get the minimum and maximim values of the vector.
+
+     \return The minimum and maximum values of the vector,
+     respectively.
+  */
+  std::pair<double,double> minmax(const vector&);
+
+  /**
+     \brief Locate the maximum and minumum element in the vector.
+
+     \return The indecies to the element with the minimum and maximum
+     values of the vector, respectively.
+
+     \note Lower index has precedence.
+  */
+  std::pair<size_t,size_t> minmax_index(const vector&);
+
+  /**
+     \brief Transforms a vector to a basis vector.
+
+     All elements are set to zero except the \a i-th element which is
+     set to one.
+  */
+  void set_basis(vector&, size_t i);
+
+  /**
+     Sort the elements in the vector.
+
+     \note Bug in GSL: if the vector contains one ore more NaNs the
+     call never returns.
+  */
+  void sort(vector&);
+
+  /**
+     \brief Calculate the sum of all vector elements.
+
+     \return The sum.
+  */
+  double sum(const vector&);
+
+  /**
+     \brief Swap vector elements by copying.
+
+     The two vectors must have the same length.
+
+     \throw GSL_error if vector lengths differs.
+  */
+  void swap(vector&, vector&);
+
+  /**
+     \brief The output operator for the vector class.
+  */
+  std::ostream& operator<<(std::ostream&, const vector&);
 
 }}} // of namespace utility, yat, and theplu