[search] [coding] Added undefined state to a FixedBitsDDVector.

coding/coding_tests/fixed_bits_ddvector_test.cpp

@@ -22,7 +22,7 @@ template <size_t Bits> void TestWithData(vector<uint32_t> const & lst)
     typename TVector::template Builder<TWriter> builder(writer);
 
     uint32_t optCount = 0;
-    uint32_t const optBound = (1 << Bits) - 1;
+    uint32_t const optBound = (1 << Bits) - 2;
 
     for (uint32_t v : lst)
     {
@@ -40,8 +40,13 @@ template <size_t Bits> void TestWithData(vector<uint32_t> const & lst)
   auto const vec = TVector::Create(reader);
 
   size_t i = 0;
-  for (uint32_t v : lst)
-    TEST_EQUAL(vec->Get(i++), v, ());
+  for (uint32_t actual : lst)
+  {
+    uint32_t expected;
+    TEST(vec->Get(i, expected), ());
+    TEST_EQUAL(expected, actual, ());
+    ++i;
+  }
 }
 
 } // namespace

coding/fixed_bits_ddvector.hpp

@@ -16,7 +16,8 @@
 /// 4 bytes to store vector's size
 /// Buffer of ceil(Size * Bits / 8) bytes, e.g. vector of Bits-sized elements.
 /// - values in range [0, (1 << Bits) - 2] stored as is
-/// - value (1 << Bits) - 1 tells that actual value is stored in the exceptions table below.
+/// - value (1 << Bits) - 2 tells that actual value is stored in the exceptions table below.
+/// - value (1 << Bits) - 1 tells that the value is undefined.
 /// Buffer with exceptions table, e.g. vector of (index, value) pairs till the end of the reader,
 /// sorted by index parameter.
 /// Component is stored and used in host's endianness, without any conversions.
@@ -33,6 +34,7 @@ class FixedBitsDDVector
   static_assert(is_unsigned<TSize>::value, "");
   static_assert(is_unsigned<TValue>::value, "");
   // 16 - is the maximum bits count to get all needed bits in random access within uint32_t.
+  static_assert(Bits > 0, "");
   static_assert(Bits <= 16, "");
 
   using TSelf = FixedBitsDDVector<Bits, TReader, TSize, TValue>;
@@ -59,6 +61,8 @@ class FixedBitsDDVector
   }
 
   static TBlock constexpr kMask = (1 << Bits) - 1;
+  static TBlock constexpr kLargeValue = kMask - 1;
+  static TBlock constexpr kUndefined = kMask;
 
   TValue FindInVector(TSize index) const
   {
@@ -88,7 +92,7 @@ public:
                                        size));
   }
 
-  TValue Get(TSize index) const
+  bool Get(TSize index, TValue & value) const
   {
     ASSERT_LESS(index, m_size, ());
     uint64_t const bitsOffset = index * Bits;
@@ -101,7 +105,11 @@ public:
     TBlock v = ReadPrimitiveFromPos<TBlock>(m_bits, bytesOffset);
     v >>= (bitsOffset - bytesOffset * CHAR_BIT);
     v &= kMask;
-    return (v == kMask ? FindInVector(index) : v);
+    if (v == kUndefined)
+      return false;
+
+    value = v < kLargeValue ? v : FindInVector(index);
+    return true;
   }
 
   template <class TWriter> class Builder
@@ -147,9 +155,9 @@ public:
 
     void PushBack(TValue v)
     {
-      if (v >= kMask)
+      if (v >= kLargeValue)
       {
-        m_bits->WriteAtMost32Bits(kMask, Bits);
+        m_bits->WriteAtMost32Bits(kLargeValue, Bits);
         m_excepts.push_back({m_count, v});
       }
       else
@@ -161,6 +169,14 @@ public:
       ++m_count;
     }
 
+    // Pushes a special (undefined) value.
+    void PushBackUndefined()
+    {
+      m_bits->WriteAtMost32Bits(kUndefined, Bits);
+      ++m_optCount;
+      ++m_count;
+    }
+
     /// @return (number of stored as-is elements, number of all elements)
     pair<TSize, TSize> GetCount() const { return make_pair(m_optCount, m_count); }
   };

generator/search_index_builder.cpp

@@ -313,7 +313,6 @@ void AddFeatureNameIndexPairs(FeaturesVectorTest const & features,
 void BuildAddressTable(FilesContainerR & container, Writer & writer)
 {
   ReaderSource<ModelReaderPtr> src = container.GetReader(SEARCH_TOKENS_FILE_TAG);
-  uint32_t index = 0;
   uint32_t address = 0, missing = 0;
   map<size_t, size_t> bounds;
 
@@ -326,12 +325,13 @@ void BuildAddressTable(FilesContainerR & container, Writer & writer)
     FixedBitsDDVector<3, FileReader>::Builder<Writer> building2Street(writer);
 
     FeaturesVectorTest features(container);
-    while (src.Size() > 0)
+    for (uint32_t index = 0; src.Size() > 0; ++index)
     {
       feature::AddressData data;
       data.Deserialize(src);
 
-      size_t ind = 0;
+      size_t streetIndex;
+      bool streetMatched = false;
       string street;
       search::GetStreetNameAsKey(data.Get(feature::AddressData::STREET), street);
       if (!street.empty())
@@ -343,20 +343,23 @@ void BuildAddressTable(FilesContainerR & container, Writer & writer)
         vector<TStreet> streets;
         rgc.GetNearbyStreets(ft, streets);
 
-        ind = rgc.GetMatchedStreetIndex(street, streets);
-        if (ind == streets.size())
+        streetIndex = rgc.GetMatchedStreetIndex(street, streets);
+        if (streetIndex < streets.size())
         {
-          ++missing;
-          ind = 0;
+          ++bounds[streetIndex];
+          streetMatched = true;
         }
-        else
-          ++bounds[ind];
-
         ++address;
       }
-
-      ++index;
-      building2Street.PushBack(ind);
+      if (streetMatched)
+      {
+        building2Street.PushBack(streetIndex);
+      }
+      else
+      {
+        building2Street.PushBackUndefined();
+        ++missing;
+      }
     }
 
     LOG(LINFO, ("Address: Building -> Street (opt, all)", building2Street.GetCount()));

search/reverse_geocoder.cpp

@@ -113,8 +113,11 @@ void ReverseGeocoder::GetNearbyAddress(m2::PointD const & center, Address & addr
 
     GetNearbyStreets(b.m_center, streets);
 
-    uint32_t const ind = table->Get(b.m_id.m_index);
-    if (ind < streets.size())
+    uint32_t ind;
+
+    // False result of table->Get(...) means that there're no street
+    // for a building. Somehow it should be used in a Features Editor.
+    if (table->Get(b.m_id.m_index, ind) && ind < streets.size())
     {
       addr.m_building = b;
       addr.m_street = streets[ind];

search/search_integration_tests/search_query_v2_test.cpp

@@ -107,6 +107,8 @@ UNIT_TEST(SearchQueryV2_Smoke)
       vector<m2::PointD>{
           {10.0005, 10.0005}, {10.0006, 10.0005}, {10.0006, 10.0006}, {10.0005, 10.0006}},
       "Hilbert house", "1 unit 2", *bohrStreet1, "en");
+  auto const descartesHouse =
+      make_shared<TestBuilding>(m2::PointD(10, 10), "Descartes house", "2", "en");
   auto const lantern1 = make_shared<TestPOI>(m2::PointD(10.0005, 10.0005), "lantern 1", "en");
   auto const lantern2 = make_shared<TestPOI>(m2::PointD(10.0006, 10.0005), "lantern 2", "en");
 
@@ -129,6 +131,8 @@ UNIT_TEST(SearchQueryV2_Smoke)
     builder.Add(*hilbertHouse);
     builder.Add(*lantern1);
     builder.Add(*lantern2);
+
+    builder.Add(*descartesHouse);
   }
 
   {
@@ -228,4 +232,26 @@ UNIT_TEST(SearchQueryV2_Smoke)
     vector<shared_ptr<MatchingRule>> rules = {make_shared<ExactMatch>(wonderlandId, feynmanHouse)};
     TEST(MatchResults(engine, rules, request.Results()), ());
   }
+
+  {
+    // It's possible to find Descartes house by name.
+    TestSearchRequest request(engine, "Los Alamos Descartes", "en", search::SearchParams::ALL,
+                              viewport);
+    request.Wait();
+    vector<shared_ptr<MatchingRule>> rules = {
+        make_shared<ExactMatch>(wonderlandId, descartesHouse)};
+    TEST(MatchResults(engine, rules, request.Results()), ());
+  }
+
+  {
+    // It's not possible to find Descartes house by house number,
+    // because it doesn't belong to Los Alamos streets. But it still
+    // exists.
+    TestSearchRequest request(engine, "Los Alamos 2", "en", search::SearchParams::ALL, viewport);
+    request.Wait();
+    vector<shared_ptr<MatchingRule>> rules = {
+        make_shared<ExactMatch>(wonderlandId, lantern2),
+        make_shared<ExactMatch>(wonderlandId, quantumTeleport2)};
+    TEST(MatchResults(engine, rules, request.Results()), ());
+  }
 }

search/v2/features_layer_matcher.cpp

@@ -71,9 +71,12 @@ vector<ReverseGeocoder::Street> const & FeaturesLayerMatcher::GetNearbyStreets(
 uint32_t FeaturesLayerMatcher::GetMatchingStreetImpl(uint32_t houseId, FeatureType & houseFeature)
 {
   auto const & streets = GetNearbyStreets(houseId, houseFeature);
-  uint32_t const streetIndex = m_houseToStreetTable->Get(houseId);
 
   uint32_t streetId = kInvalidId;
+  uint32_t streetIndex;
+  if (!m_houseToStreetTable->Get(houseId, streetIndex))
+    streetIndex = streets.size();;
+
   if (streetIndex < streets.size() && streets[streetIndex].m_id.m_mwmId == m_context.m_id)
     streetId = streets[streetIndex].m_id.m_index;
   m_matchingStreetsCache[houseId] = streetId;

search/v2/house_to_street_table.cpp

@@ -28,7 +28,11 @@ public:
     ASSERT(m_vector.get(), ("Can't instantiate FixedBitsDDVector."));
   }
 
-  uint32_t Get(uint32_t houseId) const override { return m_vector->Get(houseId); }
+  // HouseToStreetTable overrides:
+  bool Get(uint32_t houseId, uint32_t & streetIndex) const override
+  {
+    return m_vector->Get(houseId, streetIndex);
+  }
 
 private:
   unique_ptr<TVector> m_vector;
@@ -37,7 +41,8 @@ private:
 class DummyTable : public HouseToStreetTable
 {
 public:
-  uint32_t Get(uint32_t /* houseId */) const override { return 0; }
+  // HouseToStreetTable overrides:
+  bool Get(uint32_t /* houseId */, uint32_t & /* streetIndex */) const override { return false; }
 };
 }  // namespace
 

search/v2/house_to_street_table.hpp

@@ -18,9 +18,11 @@ public:
   /// It's better to construct a table from MwmHandle.
   static unique_ptr<HouseToStreetTable> Load(MwmValue & value);
 
-  // Returns an index number of a correct street corresponding to a
-  // house in a list of streets generated by ReverseGeocoder.
-  virtual uint32_t Get(uint32_t houseId) const = 0;
+  // Returns true and stores to |streetIndex| an index number of a
+  // correct street corresponding to a house in a list of streets
+  // generated by ReverseGeocoder.  Returns false if there're no such
+  // street.
+  virtual bool Get(uint32_t houseId, uint32_t & streetIndex) const = 0;
 };
 }  // namespace v2
 }  // namespace search