doc/parts/extensions/Shapes-Numeric-Constant-constants.sxml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <?xml-stylesheet type="text/xsl" href="formats/html.xsl"?>
   3
   4 <!-- This file is part of Shapes.                                           -->
   5 <!--                                                                        -->
   6 <!-- Shapes is free software: you can redistribute it and/or modify         -->
   7 <!-- it under the terms of the GNU General Public License as published by   -->
   8 <!-- the Free Software Foundation, either version 3 of the License, or      -->
   9 <!-- any later version.                                                     -->
  10 <!--                                                                        -->
  11 <!-- Shapes is distributed in the hope that it will be useful,              -->
  12 <!-- but WITHOUT ANY WARRANTY; without even the implied warranty of         -->
  13 <!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          -->
  14 <!-- GNU General Public License for more details.                           -->
  15 <!--                                                                        -->
  16 <!-- You should have received a copy of the GNU General Public License      -->
  17 <!-- along with Shapes.  If not, see <http://www.gnu.org/licenses/>.        -->
  18 <!--                                                                        -->
  19 <!-- Copyright 2008, 2014 Henrik Tidefelt                                   -->
  20
  21
  22 <book>
  23         <title>constants</title>
  24         <description>
  25                 <p>Numeric constants.</p>
  26         </description>
  27         <meta-selflink><self-href /></meta-selflink>
  28         <base href=<!--#expand-next-string-->"$(BASE)" />
  29         <examples-home href=<!--#expand-next-string-->"$(EXAMPLES)" />
  30         <shapes-version number=<!--#expand-next-string-->"$(SHAPES_VERSION)" />
  31         <up-link><parent-namespace /></up-link>
  32         <prelude />
  33         <needs></needs>
  34         <public-namespace>Shapes..Numeric</public-namespace>
  35   <external>
  36     <!--#include virtual="^/toc.xml" -->
  37   </external>
  38         <top>
  39                 <alphabetical-index/>
  40                 <p>This this extension is included by the standard prelude, it contains only numeric constants of general interest.</p>
  41         </top>
  42
  43         <section id="extensions/numeric-constants/all">
  44                 <title>Bindings</title>
  45                 <body>
  46
  47                         <system-binding identifier="golden">
  48                                 <simple-value>
  49                                         <type><named-type name="Float" /></type>
  50                                         <description>
  51                                                 <p>The golden ratio, approximately <eq>1.618</eq>.</p>
  52                                         </description>
  53                                 </simple-value>
  54                         </system-binding>
  55
  56                         <system-binding identifier="Golden">
  57                                 <simple-value>
  58                                         <type><named-type name="Float" /></type>
  59                                         <description>
  60                                                 <p>The inverse of the golden ratio, approximately <eq>0.618</eq>.</p>
  61                                         </description>
  62                                 </simple-value>
  63                         </system-binding>
  64
  65                 </body>
  66         </section> <!-- End of all -->
  67 </book>