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) 2025 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 PARALLEL SAFE;
  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 PARALLEL SAFE;
  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   ELSIF country_code IN ('sg', 'ws', 'st', 'kn') THEN
  92     area := area * 5;
  93   ELSIF country_code IN ('dm', 'mt', 'lc', 'gg', 'sc', 'nr') THEN
  94     area := area * 20;
  95   END IF;
  96
  97   IF area > 1 THEN
  98     RETURN 7;
  99   ELSIF area > 0.1 THEN
 100     RETURN 9;
 101   ELSIF area > 0.01 THEN
 102     RETURN 13;
 103   ELSIF area > 0.001 THEN
 104     RETURN 17;
 105   ELSIF area > 0.0001 THEN
 106     RETURN 19;
 107   ELSIF area > 0.000005 THEN
 108     RETURN 21;
 109   END IF;
 110
 111    RETURN 23;
 112 END;
 113 $$
 114 LANGUAGE plpgsql IMMUTABLE PARALLEL SAFE;
 115
 116
 117 -- Get standard search and address rank for an object.
 118 --
 119 -- \param country        Two-letter country code where the object is in.
 120 -- \param extended_type  OSM type (N, W, R) or area type (A).
 121 -- \param place_class    Class (or tag key) of object.
 122 -- \param place_type     Type (or tag value) of object.
 123 -- \param admin_level    Value of admin_level tag.
 124 -- \param is_major       If true, boost search rank by one.
 125 -- \param postcode       Value of addr:postcode tag.
 126 -- \param[out] search_rank   Computed search rank.
 127 -- \param[out] address_rank  Computed address rank.
 128 --
 129 CREATE OR REPLACE FUNCTION compute_place_rank(country VARCHAR(2),
 130                                               extended_type VARCHAR(1),
 131                                               place_class TEXT, place_type TEXT,
 132                                               admin_level SMALLINT,
 133                                               is_major BOOLEAN,
 134                                               postcode TEXT,
 135                                               OUT search_rank SMALLINT,
 136                                               OUT address_rank SMALLINT)
 137 AS $$
 138 DECLARE
 139   classtype TEXT;
 140 BEGIN
 141   IF extended_type = 'N' AND place_class = 'highway' THEN
 142     search_rank = 30;
 143     address_rank = 30;
 144   ELSEIF place_class = 'landuse' AND extended_type != 'A' THEN
 145     search_rank = 30;
 146     address_rank = 30;
 147   ELSE
 148     IF place_class = 'boundary' and place_type = 'administrative' THEN
 149       classtype = place_type || admin_level::TEXT;
 150     ELSE
 151       classtype = place_type;
 152     END IF;
 153
 154     SELECT l.rank_search, l.rank_address INTO search_rank, address_rank
 155       FROM address_levels l
 156      WHERE (l.country_code = country or l.country_code is NULL)
 157            AND l.class = place_class AND (l.type = classtype or l.type is NULL)
 158      ORDER BY l.country_code, l.class, l.type LIMIT 1;
 159
 160     IF search_rank is NULL OR address_rank is NULL THEN
 161       search_rank := 30;
 162       address_rank := 30;
 163     END IF;
 164
 165     -- some postcorrections
 166     IF place_class = 'waterway' AND extended_type = 'R' THEN
 167         -- Slightly promote waterway relations so that they are processed
 168         -- before their members.
 169         search_rank := search_rank - 1;
 170     END IF;
 171
 172     IF is_major THEN
 173       search_rank := search_rank - 1;
 174     END IF;
 175   END IF;
 176 END;
 177 $$
 178 LANGUAGE plpgsql IMMUTABLE PARALLEL SAFE;
 179
 180 CREATE OR REPLACE FUNCTION get_addr_tag_rank(key TEXT, country TEXT,
 181                                              OUT from_rank SMALLINT,
 182                                              OUT to_rank SMALLINT,
 183                                              OUT extent FLOAT)
 184   AS $$
 185 DECLARE
 186   ranks RECORD;
 187 BEGIN
 188   from_rank := null;
 189
 190   FOR ranks IN
 191     SELECT * FROM
 192       (SELECT l.rank_search, l.rank_address FROM address_levels l
 193         WHERE (l.country_code = country or l.country_code is NULL)
 194                AND l.class = 'place' AND l.type = key
 195         ORDER BY l.country_code LIMIT 1) r
 196       WHERE rank_address > 0
 197   LOOP
 198     extent := reverse_place_diameter(ranks.rank_search);
 199
 200     IF ranks.rank_address <= 4 THEN
 201         from_rank := 4;
 202         to_rank := 4;
 203     ELSEIF ranks.rank_address <= 9 THEN
 204         from_rank := 5;
 205         to_rank := 9;
 206     ELSEIF ranks.rank_address <= 12 THEN
 207         from_rank := 10;
 208         to_rank := 12;
 209     ELSEIF ranks.rank_address <= 16 THEN
 210         from_rank := 13;
 211         to_rank := 16;
 212     ELSEIF ranks.rank_address <= 21 THEN
 213         from_rank := 17;
 214         to_rank := 21;
 215     ELSEIF ranks.rank_address <= 24 THEN
 216         from_rank := 22;
 217         to_rank := 24;
 218     ELSE
 219         from_rank := 25;
 220         to_rank := 25;
 221     END IF;
 222   END LOOP;
 223 END;
 224 $$
 225 LANGUAGE plpgsql IMMUTABLE PARALLEL SAFE;
 226
 227
 228 CREATE OR REPLACE FUNCTION weigh_search(search_vector INT[],
 229                                         rankings TEXT,
 230                                         def_weight FLOAT)
 231   RETURNS FLOAT
 232   AS $$
 233 DECLARE
 234   rank JSON;
 235 BEGIN
 236   FOR rank IN
 237     SELECT * FROM json_array_elements(rankings::JSON)
 238   LOOP
 239     IF true = ALL(SELECT x::int = ANY(search_vector) FROM json_array_elements_text(rank->1) as x) THEN
 240       RETURN (rank->>0)::float;
 241     END IF;
 242   END LOOP;
 243   RETURN def_weight;
 244 END;
 245 $$
 246 LANGUAGE plpgsql IMMUTABLE PARALLEL SAFE;