diff options
Diffstat (limited to 'jaucpp/include/jau/basic_algos.hpp')
-rw-r--r-- | jaucpp/include/jau/basic_algos.hpp | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/jaucpp/include/jau/basic_algos.hpp b/jaucpp/include/jau/basic_algos.hpp new file mode 100644 index 00000000..796a1ce6 --- /dev/null +++ b/jaucpp/include/jau/basic_algos.hpp @@ -0,0 +1,78 @@ +/* + * Author: Sven Gothel <[email protected]> + * Copyright (c) 2020 Gothel Software e.K. + * Copyright (c) 2020 ZAFENA AB + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +#ifndef JAU_BASIC_ALGOS_HPP_ +#define JAU_BASIC_ALGOS_HPP_ + +#include <mutex> + +namespace jau { + + /** + * Custom for_each template, using indices instead of iterators, + * allowing container to be modified within lambda 'callback'. + * <p> + * Method performs UnaryFunction on all elements [0..n-1], + * where n is being retrieved once before the loop! + * </p> + */ + template<class InputArray, class UnaryFunction> + constexpr UnaryFunction for_each_idx(InputArray &array, UnaryFunction f) + { + const size_t size = array.size(); + for (size_t i = 0; i < size; i++) { + f(array[i]); + } + return f; // implicit move since C++11 + } + + /** + * Custom for_each template, using indices instead of iterators, + * allowing container to be modified within lambda 'callback'. + * <p> + * Method performs UnaryFunction on all elements [0..n-1], + * where n is being retrieved once before the loop! + * </p> + * <p> + * This method also utilizes a given mutex to ensure thread-safety, + * by operating within an RAII-style std::lock_guard block. + * </p> + */ + template<class Mutex, class InputArray, class UnaryFunction> + constexpr UnaryFunction for_each_idx_mtx(Mutex &mtx, InputArray &array, UnaryFunction f) + { + const std::lock_guard<Mutex> lock(mtx); // RAII-style acquire and relinquish via destructor + + const size_t size = array.size(); + for (size_t i = 0; i < size; i++) { + f(array[i]); + } + return f; // implicit move since C++11 + } + + +} // namespace jau + +#endif /* JAU_BASIC_ALGOS_HPP_ */ |