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

Last change on this file since 734 was 734, checked in by Peter, 15 years ago

added vector*matrix and matrix*vector operators. fixes #18

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.5 KB
Line 
1#ifndef _theplu_yat_utility_utility_
2#define _theplu_yat_utility_utility_
3
4// $Id: utility.h 734 2007-01-06 17:04:54Z peter $
5
6/*
7  Copyright (C) 2005 Jari Häkkinen, Peter Johansson, Markus Ringnér
8  Copyright (C) 2006 Jari Häkkinen
9  Copyright (C) 2007 Peter Johansson
10
11  This file is part of the yat library, http://lev.thep.lu.se/trac/yat
12
13  The yat library is free software; you can redistribute it and/or
14  modify it under the terms of the GNU General Public License as
15  published by the Free Software Foundation; either version 2 of the
16  License, or (at your option) any later version.
17
18  The yat library is distributed in the hope that it will be useful,
19  but WITHOUT ANY WARRANTY; without even the implied warranty of
20  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21  General Public License for more details.
22
23  You should have received a copy of the GNU General Public License
24  along with this program; if not, write to the Free Software
25  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
26  02111-1307, USA.
27*/
28
29///
30/// @file utility/utility.h
31///
32/// @brief Some useful functions are placed here
33///
34
35#include "vector.h"
36
37#include <string>
38#include <utility>
39#include <vector>
40
41namespace theplu {
42namespace yat {
43namespace utility {
44
45  class matrix;
46
47  ///
48  /// @return true if string is a double
49  ///
50  bool is_double(const std::string&);
51
52
53  ///
54  /// @return true if string is a float
55  ///
56  bool is_float(const std::string&);
57
58  ///
59  /// @return true if string is an int
60  ///
61  bool is_int(const std::string&);
62
63  ///
64  /// @return true if string is "nan" (case-insensitive)
65  ///
66  bool is_nan(const std::string& s);
67
68  /**
69     This function returns the indices of the minimum and maximum
70     values in the sub-vector (defined by \a subset), storing them in
71     imin and imax. When there are several equal minimum or maximum
72     elements then the lowest indices are returned. The returned index
73     is the index from the complete vector (not the sub-vector)
74
75     @return Index corresponding to the smallest and largest value.
76
77     @note If \a subset is emtpy, the result is undefined.
78  */
79  std::pair<size_t,size_t> minmax_index(const vector& vec,
80                                        const std::vector<size_t>& subset);
81
82  /**
83     Randomly shuffles the elements in vector \a invec
84  */
85  void shuffle(vector& invec); 
86
87
88  /**
89     @brief matrix vector multiplication
90   */
91  vector operator*(const matrix&, const vector&);
92
93
94  /**
95     @brief matrix vector multiplication
96   */
97  vector operator*(const vector&, const matrix&);
98
99}}} // of namespace utility, yat, and theplu
100
101#endif
Note: See TracBrowser for help on using the repository browser.