doc: Rework tables for built-in operator classes of index AMs

The tables listing all the operator classes available for BRIN, GIN,
GiST and SP-GiST had a confusing format where the same operator could be
listed multiple times, for different data types.  This improves the
shape of these tables by adding the types associated to each operator,
for their associated operator class.

Each table included previously the data type that could be used for an
operator class in an extra column.  This is removed to reduce the width
of the tables as this is now described within each operator.  This also
makes the tables fit better in the PDF documentation.

Reported-by: osdba
Author: Michael Paquier
Reviewed-by: Álvaro Herrera, Tom Lane, Bruce Momjian
Discussion: https://postgr.es/m/[email protected]

1 files changed, 97 insertions, 128 deletions

diff --git a/doc/src/sgml/gist.sgml b/doc/src/sgml/gist.sgml
index a505815f4ec..f9226e7a35c 100644
--- a/doc/src/sgml/gist.sgml
+++ b/doc/src/sgml/gist.sgml
@@ -53,157 +53,126 @@
 
   <table id="gist-builtin-opclasses-table">
    <title>Built-in <acronym>GiST</acronym> Operator Classes</title>
-   <tgroup cols="4">
+   <tgroup cols="3">
     <thead>
      <row>
       <entry>Name</entry>
-      <entry>Indexed Data Type</entry>
       <entry>Indexable Operators</entry>
       <entry>Ordering Operators</entry>
      </row>
     </thead>
     <tbody>
      <row>
-      <entry><literal>box_ops</literal></entry>
-      <entry><type>box</type></entry>
-      <entry>
-       <literal>&amp;&amp;</literal>
-       <literal>&amp;&gt;</literal>
-       <literal>&amp;&lt;</literal>
-       <literal>&amp;&lt;|</literal>
-       <literal>&gt;&gt;</literal>
-       <literal>&lt;&lt;</literal>
-       <literal>&lt;&lt;|</literal>
-       <literal>&lt;@</literal>
-       <literal>@&gt;</literal>
-       <literal>@</literal>
-       <literal>|&amp;&gt;</literal>
-       <literal>|&gt;&gt;</literal>
-       <literal>~</literal>
-       <literal>~=</literal>
-      </entry>
-      <entry>
-       <literal>&lt;-&gt;</literal>
-      </entry>
+      <entry valign="middle" morerows="13"><literal>box_ops</literal></entry>
+      <entry><literal>&lt;&lt; (box,box)</literal></entry>
+      <entry valign="middle" morerows="13"><literal>&lt;-&gt; (box,point)</literal></entry>
      </row>
+     <row><entry><literal>&amp;&lt; (box,box)</literal></entry></row>
+     <row><entry><literal>&amp;&amp; (box,box)</literal></entry></row>
+     <row><entry><literal>&amp;&gt; (box,box)</literal></entry></row>
+     <row><entry><literal>&gt;&gt; (box,box)</literal></entry></row>
+     <row><entry><literal>~= (box,box)</literal></entry></row>
+     <row><entry><literal>@&gt; (box,box)</literal></entry></row>
+     <row><entry><literal>&lt;@ (box,box)</literal></entry></row>
+     <row><entry><literal>&amp;&lt;| (box,box)</literal></entry></row>
+     <row><entry><literal>&lt;&lt;| (box,box)</literal></entry></row>
+     <row><entry><literal>|&gt;&gt; (box,box)</literal></entry></row>
+     <row><entry><literal>|&amp;&gt; (box,box)</literal></entry></row>
+     <row><entry><literal>~ (box,box)</literal></entry></row>
+     <row><entry><literal>@ (box,box)</literal></entry></row>
+
      <row>
-      <entry><literal>circle_ops</literal></entry>
-      <entry><type>circle</type></entry>
-      <entry>
-       <literal>&amp;&amp;</literal>
-       <literal>&amp;&gt;</literal>
-       <literal>&amp;&lt;</literal>
-       <literal>&amp;&lt;|</literal>
-       <literal>&gt;&gt;</literal>
-       <literal>&lt;&lt;</literal>
-       <literal>&lt;&lt;|</literal>
-       <literal>&lt;@</literal>
-       <literal>@&gt;</literal>
-       <literal>@</literal>
-       <literal>|&amp;&gt;</literal>
-       <literal>|&gt;&gt;</literal>
-       <literal>~</literal>
-       <literal>~=</literal>
-      </entry>
-      <entry>
-       <literal>&lt;-&gt;</literal>
-      </entry>
+      <entry valign="middle" morerows="13"><literal>circle_ops</literal></entry>
+      <entry><literal>&lt;&lt; (circle,circle)</literal></entry>
+      <entry valign="middle" morerows="13"><literal>&lt;-&gt; (circle,point)</literal></entry>
      </row>
+     <row><entry><literal>&amp;&lt; (circle,circle)</literal></entry></row>
+     <row><entry><literal>&amp;&gt; (circle,circle)</literal></entry></row>
+     <row><entry><literal>&gt;&gt; (circle,circle)</literal></entry></row>
+     <row><entry><literal>&lt;@ (circle,circle)</literal></entry></row>
+     <row><entry><literal>@&gt; (circle,circle)</literal></entry></row>
+     <row><entry><literal>~= (circle,circle)</literal></entry></row>
+     <row><entry><literal>&amp;&amp; (circle,circle)</literal></entry></row>
+     <row><entry><literal>|&gt;&gt; (circle,circle)</literal></entry></row>
+     <row><entry><literal>&lt;&lt;| (circle,circle)</literal></entry></row>
+     <row><entry><literal>&amp;&lt;| (circle,circle)</literal></entry></row>
+     <row><entry><literal>|&amp;&gt; (circle,circle)</literal></entry></row>
+     <row><entry><literal>@ (circle,circle)</literal></entry></row>
+     <row><entry><literal>~ (circle,circle)</literal></entry></row>
+
      <row>
-      <entry><literal>inet_ops</literal></entry>
-      <entry><type>inet</type>, <type>cidr</type></entry>
-      <entry>
-       <literal>&amp;&amp;</literal>
-       <literal>&gt;&gt;</literal>
-       <literal>&gt;&gt;=</literal>
-       <literal>&gt;</literal>
-       <literal>&gt;=</literal>
-       <literal>&lt;&gt;</literal>
-       <literal>&lt;&lt;</literal>
-       <literal>&lt;&lt;=</literal>
-       <literal>&lt;</literal>
-       <literal>&lt;=</literal>
-       <literal>=</literal>
-      </entry>
-      <entry>
-      </entry>
+      <entry valign="middle" morerows="10"><literal>inet_ops</literal></entry>
+      <entry><literal>&lt;&lt; (inet,inet)</literal></entry>
+      <entry valign="middle" morerows="10"></entry>
      </row>
+     <row><entry><literal>&lt;&lt;= (inet,inet)</literal></entry></row>
+     <row><entry><literal>&gt;&gt; (inet,inet)</literal></entry></row>
+     <row><entry><literal>&gt;&gt;= (inet,inet)</literal></entry></row>
+     <row><entry><literal>= (inet,inet)</literal></entry></row>
+     <row><entry><literal>&lt;&gt; (inet,inet)</literal></entry></row>
+     <row><entry><literal>&lt; (inet,inet)</literal></entry></row>
+     <row><entry><literal>&lt;= (inet,inet)</literal></entry></row>
+     <row><entry><literal>&gt; (inet,inet)</literal></entry></row>
+     <row><entry><literal>&gt;= (inet,inet)</literal></entry></row>
+     <row><entry><literal>&amp;&amp; (inet,inet)</literal></entry></row>
+
      <row>
-      <entry><literal>point_ops</literal></entry>
-      <entry><type>point</type></entry>
-      <entry>
-       <literal>&gt;&gt;</literal>
-       <literal>&gt;^</literal>
-       <literal>&lt;&lt;</literal>
-       <literal>&lt;@</literal>
-       <literal>&lt;@</literal>
-       <literal>&lt;@</literal>
-       <literal>&lt;^</literal>
-       <literal>~=</literal>
-      </entry>
-      <entry>
-       <literal>&lt;-&gt;</literal>
-      </entry>
+      <entry valign="middle" morerows="7"><literal>point_ops</literal></entry>
+      <entry><literal>&gt;^ (point,point)</literal></entry>
+      <entry valign="middle" morerows="7"><literal>&lt;-&gt; (point,point)</literal></entry>
      </row>
+     <row><entry><literal>&lt;&lt; (point,point)</literal></entry></row>
+     <row><entry><literal>&gt;&gt; (point,point)</literal></entry></row>
+     <row><entry><literal>&lt;^ (point,point)</literal></entry></row>
+     <row><entry><literal>~= (point,point)</literal></entry></row>
+     <row><entry><literal>&lt;@ (point,box)</literal></entry></row>
+     <row><entry><literal>&lt;@ (point,polygon)</literal></entry></row>
+     <row><entry><literal>&lt;@ (point,circle)</literal></entry></row>
+
      <row>
-      <entry><literal>poly_ops</literal></entry>
-      <entry><type>polygon</type></entry>
-      <entry>
-       <literal>&amp;&amp;</literal>
-       <literal>&amp;&gt;</literal>
-       <literal>&amp;&lt;</literal>
-       <literal>&amp;&lt;|</literal>
-       <literal>&gt;&gt;</literal>
-       <literal>&lt;&lt;</literal>
-       <literal>&lt;&lt;|</literal>
-       <literal>&lt;@</literal>
-       <literal>@&gt;</literal>
-       <literal>@</literal>
-       <literal>|&amp;&gt;</literal>
-       <literal>|&gt;&gt;</literal>
-       <literal>~</literal>
-       <literal>~=</literal>
-      </entry>
-      <entry>
-       <literal>&lt;-&gt;</literal>
-      </entry>
+      <entry valign="middle" morerows="13"><literal>poly_ops</literal></entry>
+      <entry><literal>&lt;&lt; (polygon,polygon)</literal></entry>
+      <entry valign="middle" morerows="13"><literal>&lt;-&gt; (polygon,point)</literal></entry>
      </row>
+     <row><entry><literal>&amp;&lt; (polygon,polygon)</literal></entry></row>
+     <row><entry><literal>&amp;&gt; (polygon,polygon)</literal></entry></row>
+     <row><entry><literal>&gt;&gt; (polygon,polygon)</literal></entry></row>
+     <row><entry><literal>&lt;@ (polygon,polygon)</literal></entry></row>
+     <row><entry><literal>@&gt; (polygon,polygon)</literal></entry></row>
+     <row><entry><literal>~= (polygon,polygon)</literal></entry></row>
+     <row><entry><literal>&amp;&amp; (polygon,polygon)</literal></entry></row>
+     <row><entry><literal>&lt;&lt;| (polygon,polygon)</literal></entry></row>
+     <row><entry><literal>&amp;&lt;| (polygon,polygon)</literal></entry></row>
+     <row><entry><literal>|&amp;&gt; (polygon,polygon)</literal></entry></row>
+     <row><entry><literal>|&gt;&gt; (polygon,polygon)</literal></entry></row>
+     <row><entry><literal>@ (polygon,polygon)</literal></entry></row>
+     <row><entry><literal>~ (polygon,polygon)</literal></entry></row>
+
      <row>
-      <entry><literal>range_ops</literal></entry>
-      <entry>any range type</entry>
-      <entry>
-       <literal>&amp;&amp;</literal>
-       <literal>&amp;&gt;</literal>
-       <literal>&amp;&lt;</literal>
-       <literal>&gt;&gt;</literal>
-       <literal>&lt;&lt;</literal>
-       <literal>&lt;@</literal>
-       <literal>-|-</literal>
-       <literal>=</literal>
-       <literal>@&gt;</literal>
-       <literal>@&gt;</literal>
-      </entry>
-      <entry>
-      </entry>
+      <entry valign="middle" morerows="9"><literal>range_ops</literal></entry>
+      <entry><literal>= (anyrange,anyrange)</literal></entry>
+      <entry valign="middle" morerows="9"></entry>
      </row>
+     <row><entry><literal>&amp;&amp; (anyrange,anyrange)</literal></entry></row>
+     <row><entry><literal>@&gt; (anyrange,anyelement)</literal></entry></row>
+     <row><entry><literal>@&gt; (anyrange,anyrange)</literal></entry></row>
+     <row><entry><literal>&lt;@ (anyrange,anyrange)</literal></entry></row>
+     <row><entry><literal>&lt;&lt; (anyrange,anyrange)</literal></entry></row>
+     <row><entry><literal>&gt;&gt; (anyrange,anyrange)</literal></entry></row>
+     <row><entry><literal>&amp;&lt; (anyrange,anyrange)</literal></entry></row>
+     <row><entry><literal>&amp;&gt; (anyrange,anyrange)</literal></entry></row>
+     <row><entry><literal>-|- (anyrange,anyrange)</literal></entry></row>
+
      <row>
-      <entry><literal>tsquery_ops</literal></entry>
-      <entry><type>tsquery</type></entry>
-      <entry>
-       <literal>&lt;@</literal>
-       <literal>@&gt;</literal>
-      </entry>
-      <entry>
-      </entry>
+      <entry valign="middle" morerows="1"><literal>tsquery_ops</literal></entry>
+      <entry><literal>&lt;@ (tsquery,tsquery)</literal></entry>
+      <entry valign="middle" morerows="1"></entry>
      </row>
+     <row><entry><literal>@&gt; (tsquery,tsquery)</literal></entry></row>
      <row>
-      <entry><literal>tsvector_ops</literal></entry>
-      <entry><type>tsvector</type></entry>
-      <entry>
-       <literal>@@</literal>
-      </entry>
-      <entry>
-      </entry>
+      <entry valign="middle"><literal>tsvector_ops</literal></entry>
+      <entry><literal>@@ (tsvector,tsquery)</literal></entry>
+      <entry></entry>
      </row>
     </tbody>
    </tgroup>