aGrUM 3.2.0
a C++ library for (probabilistic) graphical models
utils_string.h
Go to the documentation of this file.
1/****************************************************************************
2 * This file is part of the aGrUM/pyAgrum library. *
3 * *
4 * Copyright (c) 2005-2026 by *
5 * - Pierre-Henri WUILLEMIN(_at_LIP6) *
6 * - Christophe GONZALES(_at_AMU) *
7 * *
8 * The aGrUM/pyAgrum library is free software; you can redistribute it *
9 * and/or modify it under the terms of either : *
10 * *
11 * - the GNU Lesser General Public License as published by *
12 * the Free Software Foundation, either version 3 of the License, *
13 * or (at your option) any later version, *
14 * - the MIT license (MIT), *
15 * - or both in dual license, as here. *
16 * *
17 * (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html) *
18 * *
19 * This aGrUM/pyAgrum library is distributed in the hope that it will be *
20 * useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
21 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
22 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, *
25 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR *
26 * OTHER DEALINGS IN THE SOFTWARE. *
27 * *
28 * See LICENCES for more details. *
29 * *
30 * SPDX-FileCopyrightText: Copyright 2005-2026 *
31 * - Pierre-Henri WUILLEMIN(_at_LIP6) *
32 * - Christophe GONZALES(_at_AMU) *
33 * SPDX-License-Identifier: LGPL-3.0-or-later OR MIT *
34 * *
35 * Contact : info_at_agrum_dot_org *
36 * homepage : http://agrum.gitlab.io *
37 * gitlab : https://gitlab.com/agrumery/agrum *
38 * *
39 ****************************************************************************/
40
41
49#ifndef GUM_UTILS_STRING_H
50#define GUM_UTILS_STRING_H
51
52#include <cctype>
53#include <cstdlib>
54#include <sstream>
55#include <string>
56#include <vector>
57
58#include <agrum/agrum.h>
59
60#include <string_view>
61
62namespace gum {
65
70 GUM_SHARED_PUBLIC std::string getUniqueFileName();
71
76 GUM_SHARED_PUBLIC std::string toLower(std::string_view str);
77
84 GUM_SHARED_PUBLIC bool contains(std::string_view s, std::string_view needle);
85
90 GUM_SHARED_PUBLIC bool endsWith(const std::string_view& value, const std::string_view& ending);
91
98 GUM_SHARED_PUBLIC std::vector< std::string > split(std::string_view orig,
99 std::string_view delimiter);
100
108 GUM_SHARED_PUBLIC std::string
109 replace(std::string_view s, std::string_view val, std::string_view new_val);
110
116 GUM_SHARED_PUBLIC bool isInteger(std::string_view val);
117
123 GUM_SHARED_PUBLIC bool isIntegerWithResult(std::string_view val, int* res);
124
130 GUM_SHARED_PUBLIC bool isNumerical(std::string_view val);
131
137 GUM_SHARED_PUBLIC bool isNumericalWithResult(std::string_view val, double* res);
138
139
144 GUM_SHARED_PUBLIC void ltrim(std::string& s);
145
150 GUM_SHARED_PUBLIC void rtrim(std::string& s);
151
156 GUM_SHARED_PUBLIC void trim(std::string& s);
157
163 GUM_SHARED_PUBLIC std::string trim_copy(std::string_view s);
164
170 GUM_SHARED_PUBLIC std::string remove_newline(std::string_view s);
171
172 template < typename T >
173 std::string compact_tostr(T value);
174
176} /* namespace gum */
177
178#ifndef GUM_NO_INLINE
179# include <agrum/base/core/utils_string_inl.h>
180#endif // GUM_NO_INLINE
181
182#include <agrum/base/core/utils_string_tpl.h>
183
184#endif /* GUM_UTILS_STRING_H */
gum::isNumericalWithResult
bool isNumericalWithResult(std::string_view val, double *res)
return true is a string contains a numerical (double) value
Definition utils_string.cpp:126
gum::contains
GUM_SHARED_PUBLIC bool contains(std::string_view s, std::string_view needle)
true if needle in s
Definition utils_string_inl.h:67
gum::remove_newline
GUM_SHARED_PUBLIC std::string remove_newline(std::string_view s)
remove all newlines in a string
Definition utils_string_inl.h:91
gum::toLower
GUM_SHARED_PUBLIC std::string toLower(std::string_view str)
Returns the lowercase version of str.
Definition utils_string_inl.h:60
gum::isIntegerWithResult
bool isIntegerWithResult(std::string_view val, int *res)
return true is a string contains an integer value
Definition utils_string.cpp:112
gum::compact_tostr
std::string compact_tostr(T value)
Returns a path to a unique file name.
Definition utils_string_tpl.h:51
gum::ltrim
GUM_SHARED_PUBLIC void ltrim(std::string &s)
trim from start (in place)
Definition utils_string_inl.h:72
gum::trim_copy
GUM_SHARED_PUBLIC std::string trim_copy(std::string_view s)
trim from both ends (copying)
Definition utils_string_inl.h:105
gum::isInteger
GUM_SHARED_PUBLIC bool isInteger(std::string_view val)
return true is a string contains an integer value
Definition utils_string_inl.h:99
gum::endsWith
bool endsWith(const std::string_view &value, const std::string_view &ending)
Returns true if value ends with ending.
Definition utils_string.cpp:82
gum::trim
GUM_SHARED_PUBLIC void trim(std::string &s)
trim from both ends (in place)
Definition utils_string_inl.h:85
gum::isNumerical
GUM_SHARED_PUBLIC bool isNumerical(std::string_view val)
return true is a string contains a numerical (double) value
Definition utils_string_inl.h:102
gum::getUniqueFileName
std::string getUniqueFileName()
Returns a path to a unique file name.
Definition utils_string.cpp:62
gum::rtrim
GUM_SHARED_PUBLIC void rtrim(std::string &s)
trim from end (in place)
Definition utils_string_inl.h:78
gum::replace
std::string replace(std::string_view s, std::string_view val, std::string_view new_val)
Replace val by new_val in s.
Definition utils_string.cpp:100
gum::split
std::vector< std::string > split(std::string_view str, std::string_view delim)
Split str using the delimiter.
Definition utils_string.cpp:87
gum
gum is the global namespace for all aGrUM entities
Definition agrum.h:46
utils_string_inl.h
Contains useful methods for random stuff.
utils_string_tpl.h