source: trunk/lib/gslapi/utility.h @ 295

// $Id: utility.h 295 2005-04-29 09:15:58Z peter $

#ifndef _theplu_gslapi_utility_ 
#define _theplu_gslapi_utility_

#include <utility>

#include <c++_tools/gslapi/vector.h>


namespace theplu {
// Jari, this should probably go somewhere else for doxygen to process.
///
/// All GSL wrapper functionality is to be defined within gslapi
/// namespace.
///
/// There are a number of support operators and functions for the
/// wrapper classes that do not belong to the classes themselves, but
/// still are defined in this namespace.
///
namespace gslapi {

  ///
  /// This function returns the indices of the minimum and maximum
  /// values in the sub-vector (defined by \a subset), storing them in
  /// imin and imax. When there are several equal minimum or maximum
  /// elements then the lowest indices are returned. The returned
  /// index is the index from the complete vector (not the sub-vector)
  ///
  /// @return Index corresponding to the smallest and largest value.
  ///
  /// @note If \a subset is emtpy, the result is undefined.
  ///
  std::pair<size_t,size_t> minmax_index(const vector& vec,
                                        const std::vector<size_t>& subset);

  ///
  /// Randomly shuffles the elements in vector \a invec
  ///
  void shuffle(vector& invec); 

}} // of namespace gslapi and namespace theplu

#endif