/**
* @file hashed_string.h
* @author Benjamin Navarro
* @brief include file for c++11 hashed string implementation
* @date 2022-06-10
* @ingroup hashed-string
*
*/
#pragma once
#include <pid/cxx11/detail/hashed_string.h>
#include <string>
namespace pid {
//! \brief Hash function for std::basic_string<T> (a.k.a std::string /
//! std::wstring)
//!
//! In C++20 mode, this function can be used on constexpr contexts
//!
//! \tparam CharT Character type, automatically deduced
//! \param str The string to hash
//! \return constexpr uint64_t The resulting hash value
template <typename CharT = char>
inline constexpr std::uint64_t
hashed_string(std::basic_string<CharT> str) noexcept {
return detail::hashed_string(str);
}
//! \deprecated use hashed_string()
template <typename CharT = char>
[[deprecated("use hashed_string() instead")]] inline constexpr std::uint64_t
hashedString( // NOLINT(readability-identifier-naming)
std::basic_string<CharT> str) noexcept {<--- Function parameter 'str' should be passed by const reference. [+]Parameter 'str' is passed by value. It could be passed as a const reference which is usually faster and recommended in C++.
return hashed_string(str);
}
//! \brief Hash function for character arrays
//!
//! \tparam CharT Character type, automatically deduced
//! \param str The string to hash
//! \return constexpr uint64_t The resulting hash value
template <typename CharT = char>
inline constexpr std::uint64_t hashed_string(const CharT* str) noexcept {
return detail::hashed_string(str);
}
//! \deprecated use hashed_string()
template <typename CharT = char>
[[deprecated("use hashed_string() instead")]] inline constexpr std::uint64_t
hashedString( // NOLINT(readability-identifier-naming)
const CharT* str) noexcept {
return hashed_string(str);
}
} // namespace pid