Skip to content

Commit bca0f60

Browse files
tglsfdctglsfdc
committed
Clarify documentation of ceil/ceiling/floor functions.
Document these as "nearest integer >= argument" and "nearest integer <= argument", which will hopefully be less confusing than the old formulation. New wording is from Matlab via Dean Rasheed. I changed the pg_description entries as well as the SGML docs. In the back branches, this will only affect installations initdb'd in the future, but it should be harmless otherwise. Discussion: <CAEZATCW3yzJo-NMSiQs5jXNFbTsCEftZS-Og8=FvFdiU+kYuSA@mail.gmail.com>
1 parent b5dd25b commit bca0f60

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

‎doc/src/sgml/func.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -659,7 +659,7 @@
659659
<literal><function>ceil(<type>dp</type> or <type>numeric</type>)</function></literal>
660660
</entry>
661661
<entry>(same as input)</entry>
662-
<entry>smallest integer not less than argument</entry>
662+
<entry>nearest integer greater than or equal to argument</entry>
663663
<entry><literal>ceil(-42.8)</literal></entry>
664664
<entry><literal>-42</literal></entry>
665665
</row>
@@ -672,7 +672,7 @@
672672
<literal><function>ceiling(<type>dp</type> or <type>numeric</type>)</function></literal>
673673
</entry>
674674
<entry>(same as input)</entry>
675-
<entry>smallest integer not less than argument (alias for <function>ceil</function>)</entry>
675+
<entry>nearest integer greater than or equal to argument (same as <function>ceil</function>)</entry>
676676
<entry><literal>ceiling(-95.3)</literal></entry>
677677
<entry><literal>-95</literal></entry>
678678
</row>
@@ -725,7 +725,7 @@
725725
<literal><function>floor(<type>dp</type> or <type>numeric</type>)</function></literal>
726726
</entry>
727727
<entry>(same as input)</entry>
728-
<entry>largest integer not greater than argument</entry>
728+
<entry>nearest integer less than or equal to argument</entry>
729729
<entry><literal>floor(-42.8)</literal></entry>
730730
<entry><literal>-43</literal></entry>
731731
</row>

‎src/include/catalog/pg_proc.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -396,11 +396,11 @@ DESCR("round to nearest integer");
396396
DATA(insert OID = 229 ( dtrunc PGNSP PGUID 12 1 0 0 0 f f f f t f i 1 0 701 "701" _null_ _null_ _null_ _null_ dtrunc _null_ _null_ _null_ ));
397397
DESCR("truncate to integer");
398398
DATA(insert OID = 2308 ( ceil PGNSP PGUID 12 1 0 0 0 f f f f t f i 1 0 701 "701" _null_ _null_ _null_ _null_ dceil _null_ _null_ _null_ ));
399-
DESCR("smallest integer >= value");
399+
DESCR("nearest integer >= value");
400400
DATA(insert OID = 2320 ( ceiling PGNSP PGUID 12 1 0 0 0 f f f f t f i 1 0 701 "701" _null_ _null_ _null_ _null_ dceil _null_ _null_ _null_ ));
401-
DESCR("smallest integer >= value");
401+
DESCR("nearest integer >= value");
402402
DATA(insert OID = 2309 ( floor PGNSP PGUID 12 1 0 0 0 f f f f t f i 1 0 701 "701" _null_ _null_ _null_ _null_ dfloor _null_ _null_ _null_ ));
403-
DESCR("largest integer <= value");
403+
DESCR("nearest integer <= value");
404404
DATA(insert OID = 2310 ( sign PGNSP PGUID 12 1 0 0 0 f f f f t f i 1 0 701 "701" _null_ _null_ _null_ _null_ dsign _null_ _null_ _null_ ));
405405
DESCR("sign of value");
406406
DATA(insert OID = 230 ( dsqrt PGNSP PGUID 12 1 0 0 0 f f f f t f i 1 0 701 "701" _null_ _null_ _null_ _null_ dsqrt _null_ _null_ _null_ ));
@@ -2193,11 +2193,11 @@ DESCR("value truncated to 'scale'");
21932193
DATA(insert OID = 1710 ( trunc PGNSP PGUID 14 1 0 0 0 f f f f t f i 1 0 1700 "1700" _null_ _null_ _null_ _null_ "select pg_catalog.trunc($1,0)" _null_ _null_ _null_ ));
21942194
DESCR("value truncated to 'scale' of zero");
21952195
DATA(insert OID = 1711 ( ceil PGNSP PGUID 12 1 0 0 0 f f f f t f i 1 0 1700 "1700" _null_ _null_ _null_ _null_ numeric_ceil _null_ _null_ _null_ ));
2196-
DESCR("smallest integer >= value");
2196+
DESCR("nearest integer >= value");
21972197
DATA(insert OID = 2167 ( ceiling PGNSP PGUID 12 1 0 0 0 f f f f t f i 1 0 1700 "1700" _null_ _null_ _null_ _null_ numeric_ceil _null_ _null_ _null_ ));
2198-
DESCR("smallest integer >= value");
2198+
DESCR("nearest integer >= value");
21992199
DATA(insert OID = 1712 ( floor PGNSP PGUID 12 1 0 0 0 f f f f t f i 1 0 1700 "1700" _null_ _null_ _null_ _null_ numeric_floor _null_ _null_ _null_ ));
2200-
DESCR("largest integer <= value");
2200+
DESCR("nearest integer <= value");
22012201
DATA(insert OID = 1718 ( numeric_eq PGNSP PGUID 12 1 0 0 0 f f f f t f i 2 0 16 "1700 1700" _null_ _null_ _null_ _null_ numeric_eq _null_ _null_ _null_ ));
22022202
DATA(insert OID = 1719 ( numeric_ne PGNSP PGUID 12 1 0 0 0 f f f f t f i 2 0 16 "1700 1700" _null_ _null_ _null_ _null_ numeric_ne _null_ _null_ _null_ ));
22032203
DATA(insert OID = 1720 ( numeric_gt PGNSP PGUID 12 1 0 0 0 f f f f t f i 2 0 16 "1700 1700" _null_ _null_ _null_ _null_ numeric_gt _null_ _null_ _null_ ));

0 commit comments

Comments
 (0)