Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitc5433d3

Browse files
df7cbmsdemlei
authored andcommitted
smoc documentation
1 parentae87e3a commitc5433d3

File tree

5 files changed

+163
-9
lines changed

5 files changed

+163
-9
lines changed

‎doc/constructors.sgm

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -405,4 +405,50 @@
405405
</example>
406406
</sect2>
407407

408+
<sect2 id="contr.smoc">
409+
<title>
410+
<type>smoc</type>
411+
</title>
412+
413+
<funcsynopsis>
414+
<funcprototype>
415+
<funcdef><function>smoc</function></funcdef>
416+
<paramdef><parameter>order</parameter> int</paramdef>
417+
<paramdef>spoint</paramdef>
418+
</funcprototype>
419+
</funcsynopsis>
420+
<para>
421+
creates a single-pixel <type>smoc</type> of the given order at <parameter>spoint</parameter>
422+
</para>
423+
424+
<funcsynopsis>
425+
<funcprototype>
426+
<funcdef><function>smoc_disc</function></funcdef>
427+
<paramdef><parameter>order</parameter> int</paramdef>
428+
<paramdef><parameter>lng</parameter> double precision</paramdef>
429+
<paramdef><parameter>lat</parameter> double precision</paramdef>
430+
<paramdef><parameter>radius</parameter> double precision</paramdef>
431+
</funcprototype>
432+
<funcprototype>
433+
<funcdef><function>smoc</function></funcdef>
434+
<paramdef><parameter>order</parameter> int</paramdef>
435+
<paramdef>scircle</paramdef>
436+
</funcprototype>
437+
</funcsynopsis>
438+
<para>
439+
creates an <type>smoc</type> of the given order covering the circle
440+
</para>
441+
442+
<funcsynopsis>
443+
<funcprototype>
444+
<funcdef><function>smoc</function></funcdef>
445+
<paramdef><parameter>order</parameter> int</paramdef>
446+
<paramdef>spoly</paramdef>
447+
</funcprototype>
448+
</funcsynopsis>
449+
<para>
450+
creates an <type>smoc</type> of the given order covering the spoly
451+
</para>
452+
</sect2>
453+
408454
</sect1>

‎doc/functions.sgm

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -566,6 +566,66 @@
566566
<![CDATA[sql> SELECT sw ( sbox '( (0d,0d), (90d,0d) )' ) ;]]>
567567
</programlisting>
568568
</example>
569+
</sect2>
570+
571+
<sect2 id="funcs.smoc">
572+
<title>
573+
<type>smoc</type> functions
574+
</title>
575+
576+
<funcsynopsis>
577+
<funcprototype>
578+
<funcdef><function>smoc_info</function></funcdef>
579+
<paramdef>smoc</paramdef>
580+
</funcprototype>
581+
</funcsynopsis>
582+
<para>
583+
Returns information about the internal representation of the smoc.
584+
</para>
585+
<example>
586+
<title>A circle</title>
587+
<programlisting>
588+
<![CDATA[sql> SELECT smoc_info('0/4 1/0 2 12-13 34-35 45 47 2/4 6 12 14 56-57 60-61 88 90-91 116-117 119 130-131 134-135 177 179 185 187');]]>
589+
<![CDATA[ smoc_info]]>
590+
<![CDATA[--------------------------------------------------------------------------------------------------------------------------------]]>
591+
<![CDATA[ version: 0, order: 2, depth: 1, first: 0, last: 3458764513820540928, area: 1261007895663738880, tree_begin: 48, data_begin: 72]]>
592+
</programlisting>
593+
</example>
594+
595+
<funcsynopsis>
596+
<funcprototype>
597+
<funcdef><function>smoc_area</function></funcdef>
598+
<paramdef>smoc</paramdef>
599+
</funcprototype>
600+
</funcsynopsis>
601+
<para>
602+
Returns the size of an smoc in order 29 pixels.
603+
</para>
604+
605+
<funcsynopsis>
606+
<funcprototype>
607+
<funcdef><function>smoc_degrade</function></funcdef>
608+
<paramdef><parameter>order</parameter> int</paramdef>
609+
<paramdef>smoc</paramdef>
610+
</funcprototype>
611+
</funcsynopsis>
612+
<para>
613+
Adjusts the order of an smoc to be more or less precise.
614+
</para>
615+
616+
<funcsynopsis>
617+
<funcprototype>
618+
<funcdef><function>sum</function></funcdef>
619+
<paramdef>smoc</paramdef>
620+
</funcprototype>
621+
<funcprototype>
622+
<funcdef><function>intersection</function></funcdef>
623+
<paramdef>smoc</paramdef>
624+
</funcprototype>
625+
</funcsynopsis>
626+
<para>
627+
Aggregate functions for smoc union and intersection.
628+
</para>
569629

570630
</sect2>
571631

‎doc/indices.sgm

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,5 +68,32 @@
6868
</example>
6969

7070
</sect2>
71-
71+
72+
<sect2 id="ind.smoc">
73+
<title>
74+
<type>smoc</type> index
75+
</title>
76+
<para>
77+
<application>pgSphere</application> uses <literal>GIN</literal>
78+
to create smoc indices. An index speeds up the execution
79+
time of operators <link
80+
linkend="op.over"><literal>&lt;@</literal></link>, <link
81+
linkend="op.over"><literal>@</literal></link>, <link
82+
linkend="op.over"><literal>&amp;&amp;</literal></link>, <link
83+
linkend="op.equal"><literal>=</literal></link>, and <link
84+
linkend="op.equal"><literal>!=</literal></link>.
85+
</para>
86+
<example>
87+
<title>Index of smoc coverage objects</title>
88+
<programlisting>
89+
<![CDATA[CREATE TABLE ivoa (]]>
90+
<![CDATA[ coverage smoc NOT NULL]]>
91+
<![CDATA[);]]>
92+
<![CDATA[-- Put in data now]]>
93+
<![CDATA[CREATE INDEX ON ivoa USING GIN (coverage);]]>
94+
</programlisting>
95+
</example>
96+
97+
</sect2>
98+
7299
</sect1>

‎doc/operators.sgm

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -179,31 +179,31 @@
179179
<tbody>
180180
<row>
181181
<entry>
182-
@ or&lt;@
182+
&lt;@ or@ (deprecated, not for smoc)
183183
</entry>
184184
<entry>
185185
the left object is contained by the right object
186186
</entry>
187187
</row>
188188
<row>
189189
<entry>
190-
&tilde; or@&gt;
190+
@&gt; or&tilde; (deprecated, not for smoc)
191191
</entry>
192192
<entry>
193193
the left object contains the right object
194194
</entry>
195195
</row>
196196
<row>
197197
<entry>
198-
!@or !&lt;@
198+
!&lt;@or !@ (deprecated, not for smoc)
199199
</entry>
200200
<entry>
201201
the left object is not contained by the right object
202202
</entry>
203203
</row>
204204
<row>
205205
<entry>
206-
!&tilde; or !@&gt;
206+
!@&gt; or !&tilde; (deprecated, not for smoc)
207207
</entry>
208208
<entry>
209209
the left object does not contain the right object
@@ -231,14 +231,14 @@
231231
<para>
232232
An overlap or contain operator does not exist for all
233233
combinations of data types.
234-
For instance, scircle @ <type>spoint</type> is
234+
For instance, scircle<@ <type>spoint</type> is
235235
useless because a spherical point can never contain a
236236
spherical circle.
237237
</para>
238238
<example>
239239
<title>Is the left circle contained by the right circle?</title>
240240
<programlisting>
241-
<![CDATA[sql> SELECT scircle '<(0d,20d),2d>' @ scircle '<(355d,20d),10d>' AS test ;]]>
241+
<![CDATA[sql> SELECT scircle '<(0d,20d),2d>'<@ scircle '<(355d,20d),10d>' AS test ;]]>
242242
<![CDATA[test]]>
243243
<![CDATA[------]]>
244244
<![CDATA[ t]]>
@@ -507,5 +507,26 @@
507507
</programlisting>
508508
</example>
509509
</sect2>
510-
510+
511+
<sect2 id="op.smoc">
512+
<title>
513+
<type>smoc</type> operators
514+
</title>
515+
516+
<para>
517+
Union:
518+
</para>
519+
<programlisting>
520+
<![CDATA[smoc | smoc]]>
521+
</programlisting>
522+
523+
<para>
524+
Intersection:
525+
</para>
526+
<programlisting>
527+
<![CDATA[smoc & smoc]]>
528+
</programlisting>
529+
530+
</sect2>
531+
511532
</sect1>

‎doc/types.sgm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,7 @@ i syntax is a somewhat complex.
693693

694694
<sect2 id="dt.smoc">
695695
<title>
696-
HEALPix Multi-Order Coverage map
696+
<type>smoc</type>: HEALPix Multi-Order Coverage map
697697
</title>
698698
<para>
699699
<mediaobject>

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp