244 lines
10 KiB
C++
244 lines
10 KiB
C++
#ifndef OSRM_UTIL_GUIDANCE_NAME_ANNOUNCEMENT_HPP_
|
|
#define OSRM_UTIL_GUIDANCE_NAME_ANNOUNCEMENT_HPP_
|
|
|
|
/* A set of tools required for guidance in both pre and post-processing */
|
|
|
|
#include "extractor/name_table.hpp"
|
|
#include "extractor/suffix_table.hpp"
|
|
|
|
#include "util/attributes.hpp"
|
|
#include "util/typedefs.hpp"
|
|
|
|
#include <algorithm>
|
|
#include <string>
|
|
#include <tuple>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
#include <boost/algorithm/string.hpp>
|
|
#include <boost/algorithm/string/predicate.hpp>
|
|
|
|
namespace osrm::util::guidance
|
|
{
|
|
// Name Change Logic
|
|
// Used both during Extraction as well as during Post-Processing
|
|
|
|
inline std::string_view longest_common_substring(const std::string_view lhs,
|
|
const std::string_view rhs)
|
|
{
|
|
if (lhs.empty() || rhs.empty())
|
|
return "";
|
|
|
|
// array for dynamic programming
|
|
std::vector<std::uint32_t> dp_previous(rhs.size(), 0), dp_current(rhs.size(), 0);
|
|
|
|
// to remember the best location
|
|
std::uint32_t best = 0;
|
|
std::uint32_t best_pos = 0;
|
|
using std::swap;
|
|
for (std::uint32_t i = 0; i < lhs.size(); ++i)
|
|
{
|
|
for (std::uint32_t j = 0; j < rhs.size(); ++j)
|
|
{
|
|
if (lhs[i] == rhs[j])
|
|
{
|
|
dp_current[j] = (j == 0) ? 1 : (dp_previous[j - 1] + 1);
|
|
if (dp_current[j] > best)
|
|
{
|
|
best = dp_current[j];
|
|
best_pos = i + 1;
|
|
}
|
|
}
|
|
}
|
|
swap(dp_previous, dp_current);
|
|
}
|
|
// the best position marks the end of the string
|
|
return lhs.substr(best_pos - best, best);
|
|
}
|
|
|
|
// TODO US-ASCII support only, no UTF-8 support
|
|
// While UTF-8 might work in some cases, we do not guarantee full functionality
|
|
template <typename StringView> inline auto decompose(const StringView &lhs, const StringView &rhs)
|
|
{
|
|
auto const lcs = longest_common_substring(lhs, rhs);
|
|
|
|
// trim spaces, transform to lower
|
|
const auto trim = [](StringView view)
|
|
{
|
|
// we compare suffixes based on this value, it might break UTF chars, but as long as we are
|
|
// consistent in handling, we do not create bad results
|
|
std::string str;
|
|
str.reserve(view.size());
|
|
std::transform(view.begin(),
|
|
view.end(),
|
|
std::back_inserter(str),
|
|
[](unsigned char c) { return std::tolower(c); });
|
|
auto front = str.find_first_not_of(' ');
|
|
|
|
if (front == std::string::npos)
|
|
return str;
|
|
|
|
auto back = str.find_last_not_of(' ');
|
|
return str.substr(front, back - front + 1);
|
|
};
|
|
|
|
if (lcs.empty())
|
|
{
|
|
return std::make_tuple(trim(lhs), trim(rhs), std::string(), std::string());
|
|
}
|
|
|
|
// find the common substring in both
|
|
auto lhs_pos = lhs.find(lcs);
|
|
auto rhs_pos = rhs.find(lcs);
|
|
|
|
BOOST_ASSERT(lhs_pos + lcs.size() <= lhs.size());
|
|
BOOST_ASSERT(rhs_pos + lcs.size() <= rhs.size());
|
|
|
|
// prefixes
|
|
auto lhs_prefix = (lhs_pos > 0) ? lhs.substr(0, lhs_pos) : StringView();
|
|
auto rhs_prefix = (rhs_pos > 0) ? rhs.substr(0, rhs_pos) : StringView();
|
|
|
|
// suffices
|
|
auto lhs_suffix = lhs.substr(lhs_pos + lcs.size());
|
|
auto rhs_suffix = rhs.substr(rhs_pos + lcs.size());
|
|
|
|
return std::make_tuple(trim(lhs_prefix), trim(lhs_suffix), trim(rhs_prefix), trim(rhs_suffix));
|
|
}
|
|
|
|
// Note: there is an overload without suffix checking below.
|
|
// (that's the reason we template the suffix table here)
|
|
template <typename StringView, typename SuffixTable>
|
|
inline bool requiresNameAnnounced(const StringView &from_name,
|
|
const StringView &from_ref,
|
|
const StringView &from_pronunciation,
|
|
const StringView &from_exits,
|
|
const StringView &to_name,
|
|
const StringView &to_ref,
|
|
const StringView &to_pronunciation,
|
|
const StringView &to_exits,
|
|
const SuffixTable &suffix_table)
|
|
{
|
|
// first is empty and the second is not
|
|
if ((from_name.empty() && from_ref.empty()) && !(to_name.empty() && to_ref.empty()))
|
|
return true;
|
|
|
|
// FIXME, handle in profile to begin with?
|
|
// Input for this function should be a struct separating streetname, suffix (e.g. road,
|
|
// boulevard, North, West ...), and a list of references
|
|
|
|
// check similarity of names
|
|
const auto names_are_empty = from_name.empty() && to_name.empty();
|
|
const auto name_is_contained =
|
|
boost::starts_with(from_name, to_name) || boost::starts_with(to_name, from_name);
|
|
|
|
const auto checkForPrefixOrSuffixChange = [](const std::string_view first,
|
|
const std::string_view second,
|
|
const SuffixTable &suffix_table)
|
|
{
|
|
std::string first_prefix, first_suffix, second_prefix, second_suffix;
|
|
std::tie(first_prefix, first_suffix, second_prefix, second_suffix) =
|
|
decompose(first, second);
|
|
const auto checkTable = [&](const std::string &str)
|
|
{ return str.empty() || suffix_table.isSuffix(str); };
|
|
|
|
return checkTable(first_prefix) && checkTable(first_suffix) && checkTable(second_prefix) &&
|
|
checkTable(second_suffix);
|
|
};
|
|
|
|
const auto is_suffix_change = checkForPrefixOrSuffixChange(from_name, to_name, suffix_table);
|
|
const auto names_are_equal = from_name == to_name || name_is_contained || is_suffix_change;
|
|
const auto name_is_removed = !from_name.empty() && to_name.empty();
|
|
// references are contained in one another
|
|
const auto refs_are_empty = from_ref.empty() && to_ref.empty();
|
|
const auto ref_is_contained =
|
|
from_ref.empty() || to_ref.empty() ||
|
|
(from_ref.find(to_ref) != std::string::npos || to_ref.find(from_ref) != std::string::npos);
|
|
const auto ref_is_removed = !from_ref.empty() && to_ref.empty();
|
|
|
|
const auto obvious_change =
|
|
(names_are_empty && refs_are_empty) || (names_are_equal && ref_is_contained) ||
|
|
(names_are_equal && refs_are_empty) || (ref_is_contained && name_is_removed) ||
|
|
(names_are_equal && ref_is_removed) || is_suffix_change;
|
|
|
|
const auto needs_announce =
|
|
// " (Ref)" -> "Name " and reverse
|
|
(from_name.empty() && !from_ref.empty() && !to_name.empty() && to_ref.empty()) ||
|
|
(!from_name.empty() && from_ref.empty() && to_name.empty() && !to_ref.empty()) ||
|
|
// ... or names are empty but reference changed
|
|
(names_are_empty && !ref_is_contained);
|
|
|
|
const auto pronunciation_changes = from_pronunciation != to_pronunciation;
|
|
|
|
// when exiting onto ramps, we need to be careful about exit numbers. These can often be only
|
|
// assigned to the first part of the ramp
|
|
//
|
|
// a . . b . c . . d
|
|
// ` e . . f
|
|
//
|
|
// could assign the exit number to `be` when exiting `abcd` instead of the full ramp.
|
|
//
|
|
// Issuing a new-name instruction here would result in the turn assuming the short segment to be
|
|
// irrelevant and remove the exit number in a collapse scenario. We don't want to issue any
|
|
// instruction from be-ef, since we only loose the exit number. So we want to make sure that we
|
|
// don't just loose an exit number, when exits change
|
|
const auto exits_change = from_exits != to_exits;
|
|
const auto looses_exit = (names_are_equal && !from_exits.empty() && to_exits.empty());
|
|
|
|
return !obvious_change || needs_announce || pronunciation_changes ||
|
|
(exits_change && !looses_exit);
|
|
}
|
|
|
|
// Overload without suffix checking
|
|
inline bool requiresNameAnnounced(const std::string &from_name,
|
|
const std::string &from_ref,
|
|
const std::string &from_pronunciation,
|
|
const std::string &from_exits,
|
|
const std::string &to_name,
|
|
const std::string &to_ref,
|
|
const std::string &to_pronunciation,
|
|
const std::string &to_exits)
|
|
{
|
|
// Dummy since we need to provide a SuffixTable but do not have the data for it.
|
|
// (Guidance Post-Processing does not keep the suffix table around at the moment)
|
|
struct NopSuffixTable final
|
|
{
|
|
NopSuffixTable() {}
|
|
bool isSuffix(const std::string_view) const { return false; }
|
|
} static const table;
|
|
|
|
return requiresNameAnnounced(std::string_view(from_name),
|
|
std::string_view(from_ref),
|
|
std::string_view(from_pronunciation),
|
|
std::string_view(from_exits),
|
|
std::string_view(to_name),
|
|
std::string_view(to_ref),
|
|
std::string_view(to_pronunciation),
|
|
std::string_view(to_exits),
|
|
table);
|
|
}
|
|
|
|
inline bool requiresNameAnnounced(const NameID from_name_id,
|
|
const NameID to_name_id,
|
|
const extractor::NameTable &name_table,
|
|
const extractor::SuffixTable &suffix_table)
|
|
{
|
|
if (from_name_id == to_name_id)
|
|
return false;
|
|
else
|
|
return requiresNameAnnounced(name_table.GetNameForID(from_name_id),
|
|
name_table.GetRefForID(from_name_id),
|
|
name_table.GetPronunciationForID(from_name_id),
|
|
name_table.GetExitsForID(from_name_id),
|
|
//
|
|
name_table.GetNameForID(to_name_id),
|
|
name_table.GetRefForID(to_name_id),
|
|
name_table.GetPronunciationForID(to_name_id),
|
|
name_table.GetExitsForID(to_name_id),
|
|
//
|
|
suffix_table);
|
|
}
|
|
|
|
} // namespace osrm::util::guidance
|
|
|
|
#endif /* OSRM_UTIL_GUIDANCE_NAME_ANNOUNCEMENT_HPP_ */
|