source: trunk/yat/utility/stl_utility.h @ 715

Last change on this file since 715 was 715, checked in by Jari Häkkinen, 15 years ago

Addresses #170.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.1 KB
Line 
1#ifndef _theplu_yat_utility_stl_utility_
2#define _theplu_yat_utility_stl_utility_
3
4// $Id: stl_utility.h 715 2006-12-22 08:42:39Z jari $
5
6/*
7  Copyright (C) 2004 Jari Häkkinen
8  Copyright (C) 2005 Jari Häkkinen, Peter Johansson, Markus Ringnér
9  Copyright (C) 2006 Jari Häkkinen
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 stl_utility.h
31///
32/// There are a number of useful functionality missing in the Standard
33/// Template Library, STL. This file is an effort to provide
34/// extensions to STL functionality.
35///
36
37#include <ostream>
38#include <string>
39#include <utility>
40#include <vector>
41
42namespace std {
43
44  ///
45  /// Print out a pair
46  ///
47  // This is in namespace std because we have not figured out how to have
48  // pair and its operator<< in different namespaces
49  template <class T1, class T2> 
50  std::ostream& operator<<(std::ostream& out, const std::pair<T1,T2>& p) 
51  { out << p.first << "\t" << p.second; return out; }
52
53}
54
55namespace theplu {
56namespace yat {
57namespace utility {
58
59
60  ///
61  /// STL provides operator< for the pair.first element, but none for
62  /// pair.second. This template provides this and can be used as the
63  /// comparison object in generic functions such as the STL sort.
64  ///
65  template <class T1,class T2>
66  struct pair_value_compare
67  {
68    ///
69    /// @return true if x.second<y.second or (x.second==y.second and
70    /// x.first<y.first)
71    ///
72    inline bool operator()(const std::pair<T1,T2>& x,
73                           const std::pair<T1,T2>& y) {
74      return ((x.second<y.second) ||
75              (!(y.second<x.second) && (x.first<y.first))); 
76    }
77  };
78
79  ///
80  /// Function reading from istream to vector of doubles. Function
81  /// reads the line until next '\\n'. The line is splitted with
82  /// respect to whitespaces and push_backed into the vector. The
83  /// vector is emptied before the reading starts. Unexpected
84  /// characters are currently skipped with a warning message.
85  /// NaN is supported to be a double (case-insensitive)
86  ///
87  /// @return false if end of stream
88  ///
89  /// @note The functionality of this function will change in the
90  /// future. The overall functionality will be the same but the
91  /// outcome of unexpected events will change.
92  ///
93  bool read_to_double(std::istream&, std::vector<double>&);
94
95  ///
96  /// Function reading from istream to vector of ints. Function
97  /// reads the line until next '\\n'. The line is splitted with
98  /// respect to whitespaces and push_backed into the vector. The
99  /// vector is emptied before the reading starts. Unexpected
100  /// characters are currently skipped with a warning message.
101  /// NaN is supported to be an int (case-insensitive)
102  ///
103  /// @return false if end of stream
104  ///
105  /// @note The functionality of this function will change in the
106  /// future. The overall functionality will be the same but the
107  /// outcome of unexpected events will change.
108  ///
109  bool read_to_int(std::istream&, std::vector<int>&);
110
111  ///
112  /// Function reading from istream to vector of strings. Function
113  /// reads the line until next '\\n'. The line is splitted with
114  /// respect to whitespaces and push_backed into the vector. The
115  /// vector is emptied before the reading starts.
116  ///
117  /// @return false if end of stream
118  ///
119  bool read_to_string(std::istream&, std::vector<std::string>&);
120
121  ///
122  /// @brief Function converting a string to lower case
123  ///
124  void to_lower(std::string& s);
125
126  ///
127  /// @brief Function converting a string to upper case
128  ///
129  void to_upper(std::string& s);
130
131}}} // of namespace utility, yat, and theplu
132
133#endif
Note: See TracBrowser for help on using the repository browser.