source: trunk/yat/utility/utility.h @ 734

#ifndef _theplu_yat_utility_utility_
#define _theplu_yat_utility_utility_ 

// $Id: utility.h 734 2007-01-06 17:04:54Z peter $

/*
  Copyright (C) 2005 Jari Häkkinen, Peter Johansson, Markus Ringnér
  Copyright (C) 2006 Jari Häkkinen
  Copyright (C) 2007 Peter Johansson

  This file is part of the yat library, http://lev.thep.lu.se/trac/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of the
  License, or (at your option) any later version.

  The yat library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

///
/// @file utility/utility.h
///
/// @brief Some useful functions are placed here
///

#include "vector.h"

#include <string>
#include <utility>
#include <vector>

namespace theplu {
namespace yat {
namespace utility {

  class matrix;

  ///
  /// @return true if string is a double
  ///
  bool is_double(const std::string&);


  ///
  /// @return true if string is a float
  ///
  bool is_float(const std::string&);

  ///
  /// @return true if string is an int
  ///
  bool is_int(const std::string&);

  ///
  /// @return true if string is "nan" (case-insensitive) 
  ///
  bool is_nan(const std::string& s);

  /**
     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); 


  /**
     @brief matrix vector multiplication
   */
  vector operator*(const matrix&, const vector&);


  /**
     @brief matrix vector multiplication
   */
  vector operator*(const vector&, const matrix&);

}}} // of namespace utility, yat, and theplu

#endif