Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 97080b5

Browse files
committed
Adding documentation for the max_order function
1 parent 4b878b4 commit 97080b5

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

doc/functions.sgm

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -638,6 +638,34 @@
638638
</programlisting>
639639
</example>
640640

641+
<funcsynopsis>
642+
<funcprototype>
643+
<funcdef><function>max_order</function></funcdef>
644+
<paramdef>smoc</paramdef>
645+
</funcprototype>
646+
</funcsynopsis>
647+
<para>
648+
Returns the maximal order of an smoc.
649+
</para>
650+
<para>
651+
The maximal order of a MOC can be higher than than the highest
652+
order appearing in the serialisation. For instance, in the example
653+
below the full-sky coverage given at order 6 means that no patch
654+
larger than about 1 degree is not covered. In the ASCII
655+
serialisation, give the maximum order with an with an empty cell
656+
list.
657+
</para>
658+
659+
<example>
660+
<title>Obtaining a MOC order</title>
661+
<programlisting>
662+
<![CDATA[SELECT max_order(smoc('0/0-11 6/')) as order;]]>
663+
<![CDATA[ order]]>
664+
<![CDATA[-----------]]>
665+
<![CDATA[ 6 ]]>
666+
</programlisting>
667+
</example>
668+
641669
</sect2>
642670

643671
</sect1>

0 commit comments

Comments
 (0)