lhapdf is hosted by Hepforge, IPPP Durham
LHAPDF  6.4.0
Utils.h
1 // -*- C++ -*-
2 //
3 // This file is part of LHAPDF
4 // Copyright (C) 2012-2021 The LHAPDF collaboration (see AUTHORS for details)
5 //
6 #pragma once
7 #ifndef LHAPDF_Utils_H
8 #define LHAPDF_Utils_H
9 
10 // STL includes
11 #include <cassert>
12 #include <stdexcept>
13 #include <vector>
14 #include <map>
15 #include <string>
16 #include <algorithm>
17 #include <memory>
18 #include <iostream>
19 #include <iomanip>
20 #include <sstream>
21 #include <limits>
22 #include <cmath>
23 
24 
26 namespace LHAPDF {
27 
28 
29  // Allow implicit use of the std namespace within namespace LHAPDF
30  using namespace std;
31 
32 
35 
38 
40  struct bad_lexical_cast : public std::runtime_error {
42  bad_lexical_cast(const std::string& what) : std::runtime_error(what) {}
43  };
44 
46  template<typename T, typename U>
47  T lexical_cast(const U& in) {
48  try {
49  std::stringstream ss;
50  ss << in;
51  T out;
52  ss >> out;
53  return out;
54  } catch (const std::exception& e) {
55  throw bad_lexical_cast(e.what());
56  }
57  }
58 
60  template <typename T>
61  inline std::string to_str(const T& val) {
62  return lexical_cast<string>(val);
63  }
64 
66  template <typename T>
67  inline std::string to_str(const std::vector<T>& vec) {
68  string rtn = "[";
69  for (size_t i = 0; i < vec.size(); ++i) {
70  rtn += to_str(vec[i]);
71  if (i < vec.size()-1) rtn += ", ";
72  }
73  rtn += "]";
74  return rtn;
75  }
76 
78  inline std::string to_str_zeropad(int val, size_t nchars=4) {
79  stringstream ss;
80  ss << setfill('0') << setw(nchars) << val;
81  return ss.str();
82  }
83 
85  inline std::string join(const std::vector<std::string>& svec, const std::string& sep) {
86  string rtn;
87  for (size_t i = 0; i < svec.size(); ++i) {
88  rtn += svec[i];
89  if (i < svec.size()-1) rtn += sep;
90  }
91  return rtn;
92  }
93 
95  inline std::vector<std::string> split(const std::string& s, const std::string& sep) {
96  vector<string> rtn;
97  string tmp = s; // non-const working copy, to be incrementally truncated
98  while (true) {
99  const size_t delim_pos = tmp.find(sep);
100  if (delim_pos == string::npos) break;
101  const string s = tmp.substr(0, delim_pos);
102  if (!s.empty()) rtn.push_back(s); // Don't insert "empties"
103  tmp.replace(0, delim_pos+1, ""); // Remove already-processed part
104  }
105  if (!tmp.empty()) rtn.push_back(tmp); // Don't forget the trailing component!
106  return rtn;
107  }
108 
110  inline bool contains(const std::string& s, const std::string& sub) {
111  return s.find(sub) != string::npos;
112  }
113 
115  inline bool startswith(const std::string& s, const std::string& sub) {
116  return s.find(sub) == 0;
117  }
118 
120  inline bool endswith(const std::string& s, const std::string& sub) {
121  return s.find(sub) == s.length()-sub.length();
122  }
123 
125  inline size_t countchar(const std::string& s, const char c) {
126  return std::count(s.begin(), s.end(), c);
127  }
128 
130  inline std::string trim(const std::string& s) {
131  const size_t firstnonspacepos = s.find_first_not_of(" ");
132  const size_t lastnonspacepos = s.find_last_not_of(" ");
133  if (firstnonspacepos == std::string::npos) return "";
134  return s.substr(firstnonspacepos, lastnonspacepos-firstnonspacepos+1);
135  }
136 
138  inline std::string to_lower(const std::string& s) {
139  string rtn = s;
140  transform(rtn.begin(), rtn.end(), rtn.begin(), (int(*)(int)) tolower);
141  return rtn;
142  }
143 
145  inline std::string to_upper(const std::string& s) {
146  string rtn = s;
147  transform(rtn.begin(), rtn.end(), rtn.begin(), (int(*)(int)) toupper);
148  return rtn;
149  }
150 
152 
153 
156 
158  bool path_exists(const std::string& p,int mode=0);
159 
161  bool file_exists(const std::string& p,int mode=0);
162 
164  bool dir_exists(const std::string& p,int mode=0);
165 
167  inline std::string operator / (const std::string& a, const std::string& b) {
168  // Ensure that a doesn't end with a slash, and b doesn't start with one, to avoid "//"
169  const string anorm = (a.find("/") != std::string::npos) ? a.substr(0, a.find_last_not_of("/")+1) : a;
170  const string bnorm = (b.find("/") != std::string::npos) ? b.substr(b.find_first_not_of("/")) : b;
171  return anorm + "/" + bnorm;
172  }
173 
175  inline std::string basename(const std::string& p) {
176  if (!contains(p, "/")) return p;
177  return p.substr(p.rfind("/")+1);
178  }
179 
181  inline std::string dirname(const std::string& p) {
182  if (!contains(p, "/")) return "";
183  return p.substr(0, p.rfind("/"));
184  }
185 
187  inline std::string file_stem(const std::string& f) {
188  if (!contains(f, ".")) return f;
189  return f.substr(0, f.rfind("."));
190  }
191 
193  inline std::string file_extn(const std::string& f) {
194  if (!contains(f, ".")) return "";
195  return f.substr(f.rfind(".")+1);
196  }
197 
199 
201 
202 
205 
207  template <typename N>
208  inline N sqr(const N& x) { return x*x; }
209 
211  template <typename N>
212  inline int sgn(N val) { return (N(0) < val) - (val < N(0)); }
213 
215  inline int in_range(double x, double low, double high) { return x >= low && x < high; }
216 
218  inline int in_closed_range(double x, double low, double high) { return x >= low && x <= high; }
219 
221  inline int in_open_range(double x, double low, double high) { return x > low && x < high; }
222 
224 
226  double norm_quantile(double p);
227 
229  double chisquared_quantile(double p, double ndf);
230 
232 
233 
236 
238  template <typename T>
239  inline bool contains(const std::vector<T>& container, const T& item) {
240  return find(container.begin(), container.end(), item) != container.end();
241  }
242 
243  // /// Does the set<T> @a container contain @a item?
244  // template <typename T>
245  // inline bool contains(const std::set<T>& container, const T& item) {
246  // return container.find(item) != container.end();
247  // }
248 
250  template <typename K, typename T>
251  inline bool has_key(const std::map<K,T>& container, const K& key) {
252  return container.find(key) != container.end();
253  }
254 
255  // /// @name Implementation of generic begin/end container identification by traits
256  // /// taken from http://stackoverflow.com/a/9407420/91808 . Needs C++11 (or maybe just C++0x).
257  // //@{
258 
259  // #include <type_traits>
260 
261  // template<typename T>
262  // struct has_const_iterator {
263  // private:
264  // typedef char yes;
265  // typedef struct { char array[2]; } no;
266  // template<typename C> static yes test(typename C::const_iterator*);
267  // template<typename C> static no test(...);
268  // public:
269  // static const bool value = sizeof(test<T>(0)) == sizeof(yes);
270  // typedef T type;
271  // };
272 
273  // template <typename T>
274  // struct has_begin_end {
275  // template<typename C> static char (&f(typename std::enable_if<
276  // std::is_same<decltype(static_cast<typename C::const_iterator (C::*)() const>(&C::begin)),
277  // typename C::const_iterator(C::*)() const>::value, void>::type*))[1];
278 
279  // template<typename C> static char (&f(...))[2];
280 
281  // template<typename C> static char (&g(typename std::enable_if<
282  // std::is_same<decltype(static_cast<typename C::const_iterator (C::*)() const>(&C::end)),
283  // typename C::const_iterator(C::*)() const>::value, void>::type*))[1];
284 
285  // template<typename C> static char (&g(...))[2];
286 
287  // static bool const beg_value = sizeof(f<T>(0)) == 1;
288  // static bool const end_value = sizeof(g<T>(0)) == 1;
289  // };
290 
291  // template<typename T>
292  // struct is_container
293  // : std::integral_constant<bool, has_const_iterator<T>::value &&
294  // has_begin_end<T>::beg_value && has_begin_end<T>::end_value>
295  // { };
296 
298 
299 
300 }
301 #endif
N sqr(const N &x)
Convenience function for squaring (of any type)
Definition: Utils.h:208
int sgn(N val)
Get the sign of a number.
Definition: Utils.h:212
bool endswith(const std::string &s, const std::string &sub)
Does a string s end with the sub substring?
Definition: Utils.h:120
std::string file_stem(const std::string &f)
Get the stem (i.e. part without a file extension) from a filename f.
Definition: Utils.h:187
int in_closed_range(double x, double low, double high)
Check if a number is in a range (closed-closed)
Definition: Utils.h:218
STL namespace.
bool contains(const std::string &s, const std::string &sub)
Does a string s contain the sub substring?
Definition: Utils.h:110
double norm_quantile(double p)
Quantiles of the standard normal probability distribution function.
std::string file_extn(const std::string &f)
Get the file extension from a filename f.
Definition: Utils.h:193
bool dir_exists(const std::string &p, int mode=0)
Check if a dir p exists.
std::string trim(const std::string &s)
Strip leading and trailing spaces (not in-place)
Definition: Utils.h:130
std::string operator/(const std::string &a, const std::string &b)
Operator for joining strings a and b with filesystem separators.
Definition: Utils.h:167
double chisquared_quantile(double p, double ndf)
Quantiles of the chi-squared probability distribution function.
std::string dirname(const std::string &p)
Get the dirname (i.e. path to the penultimate directory) from a path p.
Definition: Utils.h:181
bool has_key(const std::map< K, T > &container, const K &key)
Does the map<K,T> container have a key K key?
Definition: Utils.h:251
When lexical_cast goes bad.
Definition: Utils.h:40
std::string to_lower(const std::string &s)
Convert a string to lower-case (not in-place)
Definition: Utils.h:138
int in_range(double x, double low, double high)
Check if a number is in a range (closed-open)
Definition: Utils.h:215
bool file_exists(const std::string &p, int mode=0)
Check if a file p exists.
std::string to_str_zeropad(int val, size_t nchars=4)
Format an integer val as a zero-padded string of length nchars.
Definition: Utils.h:78
Namespace for all LHAPDF functions and classes.
Definition: AlphaS.h:14
bool startswith(const std::string &s, const std::string &sub)
Does a string s start with the sub substring?
Definition: Utils.h:115
std::string to_str(const T &val)
Make a string representation of val.
Definition: Utils.h:61
std::string basename(const std::string &p)
Get the basename (i.e. terminal file name) from a path p.
Definition: Utils.h:175
std::string to_upper(const std::string &s)
Convert a string to upper-case (not in-place)
Definition: Utils.h:145
bad_lexical_cast(const std::string &what)
Constructor.
Definition: Utils.h:42
T lexical_cast(const U &in)
Convert between types via stringstream.
Definition: Utils.h:47
std::vector< std::string > split(const std::string &s, const std::string &sep)
Split a string by a given separator.
Definition: Utils.h:95
size_t countchar(const std::string &s, const char c)
How many times does a string s contain the character c?
Definition: Utils.h:125
bool path_exists(const std::string &p, int mode=0)
Check if a path p (either file or dir) exists.
int in_open_range(double x, double low, double high)
Check if a number is in a range (open-open)
Definition: Utils.h:221
std::string join(const std::vector< std::string > &svec, const std::string &sep)
Concatenate strings with separator strings between each element.
Definition: Utils.h:85