lib-sql/functions/ranking.sql

   1 -- SPDX-License-Identifier: GPL-2.0-only
   2 --
   3 -- This file is part of Nominatim. (https://nominatim.org)
   4 --
   5 -- Copyright (C) 2022 by the Nominatim developer community.
   6 -- For a full list of authors see the git log.
   7
   8 -- Functions related to search and address ranks
   9
  10 -- Return an approximate search radius according to the search rank.
  11 CREATE OR REPLACE FUNCTION reverse_place_diameter(rank_search SMALLINT)
  12   RETURNS FLOAT
  13   AS $$
  14 BEGIN
  15   IF rank_search <= 4 THEN
  16     RETURN 5.0;
  17   ELSIF rank_search <= 8 THEN
  18     RETURN 1.8;
  19   ELSIF rank_search <= 12 THEN
  20     RETURN 0.6;
  21   ELSIF rank_search <= 17 THEN
  22     RETURN 0.16;
  23   ELSIF rank_search <= 18 THEN
  24     RETURN 0.08;
  25   ELSIF rank_search <= 19 THEN
  26     RETURN 0.04;
  27   END IF;
  28
  29   RETURN 0.02;
  30 END;
  31 $$
  32 LANGUAGE plpgsql IMMUTABLE;
  33
  34
  35 -- Return an approximate update radius according to the search rank.
  36 CREATE OR REPLACE FUNCTION update_place_diameter(rank_search SMALLINT)
  37   RETURNS FLOAT
  38   AS $$
  39 BEGIN
  40   -- postcodes
  41   IF rank_search = 11 or rank_search = 5 THEN
  42     RETURN 0.05;
  43   -- anything higher than city is effectively ignored (polygon required)
  44   ELSIF rank_search < 16 THEN
  45     RETURN 0;
  46   ELSIF rank_search < 18 THEN
  47     RETURN 0.1;
  48   ELSIF rank_search < 20 THEN
  49     RETURN 0.05;
  50   ELSIF rank_search = 21 THEN
  51     RETURN 0.001;
  52   ELSIF rank_search < 24 THEN
  53     RETURN 0.02;
  54   ELSIF rank_search < 26 THEN
  55     RETURN 0.002;
  56   ELSIF rank_search < 28 THEN
  57     RETURN 0.001;
  58   END IF;
  59
  60   RETURN 0;
  61 END;
  62 $$
  63 LANGUAGE plpgsql IMMUTABLE;
  64
  65 -- Compute a base address rank from the extent of the given geometry.
  66 --
  67 -- This is all simple guess work. We don't need particularly good estimates
  68 -- here. This just avoids to have very high ranked address parts in features
  69 -- that span very large areas (or vice versa).
  70 CREATE OR REPLACE FUNCTION geometry_to_rank(search_rank SMALLINT, geometry GEOMETRY, country_code TEXT)
  71   RETURNS SMALLINT
  72   AS $$
  73 DECLARE
  74   area FLOAT;
  75 BEGIN
  76   IF ST_GeometryType(geometry) in ('ST_Polygon','ST_MultiPolygon') THEN
  77       area := ST_Area(geometry);
  78   ELSIF ST_GeometryType(geometry) in ('ST_LineString','ST_MultiLineString') THEN
  79       area := (ST_Length(geometry)^2) * 0.1;
  80   ELSE
  81     RETURN search_rank;
  82   END IF;
  83
  84   -- adjust for the fact that countries come in different sizes
  85   IF country_code IN ('ca', 'au', 'ru') THEN
  86     area := area / 5;
  87   ELSIF country_code IN ('br', 'kz', 'cn', 'us', 'ne', 'gb', 'za', 'sa', 'id', 'eh', 'ml', 'tm') THEN
  88     area := area / 3;
  89   ELSIF country_code IN ('bo', 'ar', 'sd', 'mn', 'in', 'et', 'cd', 'mz', 'ly', 'cl', 'zm') THEN
  90     area := area / 2;
  91   END IF;
  92
  93   IF area > 1 THEN
  94     RETURN 7;
  95   ELSIF area > 0.1 THEN
  96     RETURN 9;
  97   ELSIF area > 0.01 THEN
  98     RETURN 13;
  99   ELSIF area > 0.001 THEN
 100     RETURN 17;
 101   ELSIF area > 0.0001 THEN
 102     RETURN 19;
 103   ELSIF area > 0.000005 THEN
 104     RETURN 21;
 105   END IF;
 106
 107    RETURN 23;
 108 END;
 109 $$
 110 LANGUAGE plpgsql IMMUTABLE;
 111
 112
 113 -- Guess a ranking for postcodes from country and postcode format.
 114 CREATE OR REPLACE FUNCTION get_postcode_rank(country_code VARCHAR(2), postcode TEXT,
 115                                              OUT rank_search SMALLINT,
 116                                              OUT rank_address SMALLINT)
 117 AS $$
 118 DECLARE
 119   part TEXT;
 120 BEGIN
 121     rank_search := 30;
 122     rank_address := 30;
 123     postcode := upper(postcode);
 124
 125     IF country_code = 'gb' THEN
 126         IF postcode ~ '^([A-Z][A-Z]?[0-9][0-9A-Z]? [0-9][A-Z][A-Z])$' THEN
 127             rank_search := 25;
 128             rank_address := 5;
 129         ELSEIF postcode ~ '^([A-Z][A-Z]?[0-9][0-9A-Z]? [0-9])$' THEN
 130             rank_search := 23;
 131             rank_address := 5;
 132         ELSEIF postcode ~ '^([A-Z][A-Z]?[0-9][0-9A-Z])$' THEN
 133             rank_search := 21;
 134             rank_address := 5;
 135         END IF;
 136
 137     ELSEIF country_code = 'sg' THEN
 138         IF postcode ~ '^([0-9]{6})$' THEN
 139             rank_search := 25;
 140             rank_address := 11;
 141         END IF;
 142
 143     ELSEIF country_code = 'de' THEN
 144         IF postcode ~ '^([0-9]{5})$' THEN
 145             rank_search := 21;
 146             rank_address := 11;
 147         END IF;
 148
 149     ELSE
 150         -- Guess at the postcode format and coverage (!)
 151         IF postcode ~ '^[A-Z0-9]{1,5}$' THEN -- Probably too short to be very local
 152             rank_search := 21;
 153             rank_address := 11;
 154         ELSE
 155             -- Does it look splitable into and area and local code?
 156             part := substring(postcode from '^([- :A-Z0-9]+)([- :][A-Z0-9]+)$');
 157
 158             IF part IS NOT NULL THEN
 159                 rank_search := 25;
 160                 rank_address := 11;
 161             ELSEIF postcode ~ '^[- :A-Z0-9]{6,}$' THEN
 162                 rank_search := 21;
 163                 rank_address := 11;
 164             END IF;
 165         END IF;
 166     END IF;
 167
 168 END;
 169 $$
 170 LANGUAGE plpgsql IMMUTABLE;
 171
 172
 173 -- Get standard search and address rank for an object.
 174 --
 175 -- \param country        Two-letter country code where the object is in.
 176 -- \param extended_type  OSM type (N, W, R) or area type (A).
 177 -- \param place_class    Class (or tag key) of object.
 178 -- \param place_type     Type (or tag value) of object.
 179 -- \param admin_level    Value of admin_level tag.
 180 -- \param is_major       If true, boost search rank by one.
 181 -- \param postcode       Value of addr:postcode tag.
 182 -- \param[out] search_rank   Computed search rank.
 183 -- \param[out] address_rank  Computed address rank.
 184 --
 185 CREATE OR REPLACE FUNCTION compute_place_rank(country VARCHAR(2),
 186                                               extended_type VARCHAR(1),
 187                                               place_class TEXT, place_type TEXT,
 188                                               admin_level SMALLINT,
 189                                               is_major BOOLEAN,
 190                                               postcode TEXT,
 191                                               OUT search_rank SMALLINT,
 192                                               OUT address_rank SMALLINT)
 193 AS $$
 194 DECLARE
 195   classtype TEXT;
 196 BEGIN
 197   IF place_class in ('place','boundary')
 198      and place_type in ('postcode','postal_code')
 199   THEN
 200     SELECT * INTO search_rank, address_rank
 201       FROM get_postcode_rank(country, postcode);
 202   ELSEIF extended_type = 'N' AND place_class = 'highway' THEN
 203     search_rank = 30;
 204     address_rank = 30;
 205   ELSEIF place_class = 'landuse' AND extended_type != 'A' THEN
 206     search_rank = 30;
 207     address_rank = 30;
 208   ELSE
 209     IF place_class = 'boundary' and place_type = 'administrative' THEN
 210       classtype = place_type || admin_level::TEXT;
 211     ELSE
 212       classtype = place_type;
 213     END IF;
 214
 215     SELECT l.rank_search, l.rank_address INTO search_rank, address_rank
 216       FROM address_levels l
 217      WHERE (l.country_code = country or l.country_code is NULL)
 218            AND l.class = place_class AND (l.type = classtype or l.type is NULL)
 219      ORDER BY l.country_code, l.class, l.type LIMIT 1;
 220
 221     IF search_rank is NULL OR address_rank is NULL THEN
 222       search_rank := 30;
 223       address_rank := 30;
 224     END IF;
 225
 226     -- some postcorrections
 227     IF place_class = 'waterway' AND extended_type = 'R' THEN
 228         -- Slightly promote waterway relations so that they are processed
 229         -- before their members.
 230         search_rank := search_rank - 1;
 231     END IF;
 232
 233     IF is_major THEN
 234       search_rank := search_rank - 1;
 235     END IF;
 236   END IF;
 237 END;
 238 $$
 239 LANGUAGE plpgsql IMMUTABLE;
 240
 241 CREATE OR REPLACE FUNCTION get_addr_tag_rank(key TEXT, country TEXT,
 242                                              OUT from_rank SMALLINT,
 243                                              OUT to_rank SMALLINT,
 244                                              OUT extent FLOAT)
 245   AS $$
 246 DECLARE
 247   ranks RECORD;
 248 BEGIN
 249   from_rank := null;
 250
 251   FOR ranks IN
 252     SELECT * FROM
 253       (SELECT l.rank_search, l.rank_address FROM address_levels l
 254         WHERE (l.country_code = country or l.country_code is NULL)
 255                AND l.class = 'place' AND l.type = key
 256         ORDER BY l.country_code LIMIT 1) r
 257       WHERE rank_address > 0
 258   LOOP
 259     extent := reverse_place_diameter(ranks.rank_search);
 260
 261     IF ranks.rank_address <= 4 THEN
 262         from_rank := 4;
 263         to_rank := 4;
 264     ELSEIF ranks.rank_address <= 9 THEN
 265         from_rank := 5;
 266         to_rank := 9;
 267     ELSEIF ranks.rank_address <= 12 THEN
 268         from_rank := 10;
 269         to_rank := 12;
 270     ELSEIF ranks.rank_address <= 16 THEN
 271         from_rank := 13;
 272         to_rank := 16;
 273     ELSEIF ranks.rank_address <= 21 THEN
 274         from_rank := 17;
 275         to_rank := 21;
 276     ELSEIF ranks.rank_address <= 24 THEN
 277         from_rank := 22;
 278         to_rank := 24;
 279     ELSE
 280         from_rank := 25;
 281         to_rank := 25;
 282     END IF;
 283   END LOOP;
 284 END;
 285 $$
 286 LANGUAGE plpgsql IMMUTABLE;
 287
 288
 289 CREATE OR REPLACE FUNCTION weigh_search(search_vector INT[],
 290                                         rankings TEXT,
 291                                         def_weight FLOAT)
 292   RETURNS FLOAT
 293   AS $$
 294 DECLARE
 295   rank JSON;
 296 BEGIN
 297   FOR rank IN
 298     SELECT * FROM json_array_elements(rankings::JSON)
 299   LOOP
 300     IF true = ALL(SELECT x::int = ANY(search_vector) FROM json_array_elements_text(rank->1) as x) THEN
 301       RETURN (rank->>0)::float;
 302     END IF;
 303   END LOOP;
 304   RETURN def_weight;
 305 END;
 306 $$
 307 LANGUAGE plpgsql IMMUTABLE;