advtrains_doc_integration.mathutils.html 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html>
  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
  5. <head>
  6. <title>Manual for advtrains_doc_integration</title>
  7. <link rel="stylesheet" href="../ldoc.css" type="text/css" />
  8. </head>
  9. <body>
  10. <div id="container">
  11. <div id="product">
  12. <div id="product_logo"></div>
  13. <div id="product_name"><big><b></b></big></div>
  14. <div id="product_description"></div>
  15. </div> <!-- id="product" -->
  16. <div id="main">
  17. <!-- Menu -->
  18. <div id="navigation">
  19. <br/>
  20. <h1>Documentation System Integration for Advtrains</h1>
  21. <ul>
  22. <li><a href="../index.html">Index</a></li>
  23. </ul>
  24. <h2>Contents</h2>
  25. <ul>
  26. <li><a href="#Functions">Functions</a></li>
  27. </ul>
  28. <h2>Modules</h2>
  29. <ul class="nowrap">
  30. <li><a href="../modules/advtrains_doc_integration.bc.html">advtrains_doc_integration.bc</a></li>
  31. <li><a href="../modules/advtrains_doc_integration.describe.html">advtrains_doc_integration.describe</a></li>
  32. <li><a href="../modules/advtrains_doc_integration.hypertext.html">advtrains_doc_integration.hypertext</a></li>
  33. <li><a href="../modules/advtrains_doc_integration.html">advtrains_doc_integration</a></li>
  34. <li><a href="../modules/advtrains_doc_integration.latex.html">advtrains_doc_integration.latex</a></li>
  35. <li><strong>advtrains_doc_integration.mathutils</strong></li>
  36. <li><a href="../modules/advtrains_doc_integration.utils.html">advtrains_doc_integration.utils</a></li>
  37. </ul>
  38. <h2>Topics</h2>
  39. <ul class="">
  40. <li><a href="../topics/README.md.html">README</a></li>
  41. </ul>
  42. </div>
  43. <div id="content">
  44. <h1>Module <code>advtrains_doc_integration.mathutils</code></h1>
  45. <p>Math utilities.</p>
  46. <p>
  47. </p>
  48. <h2><a href="#Functions">Functions</a></h2>
  49. <table class="function_list">
  50. <tr>
  51. <td class="name" nowrap><a href="#gcd">gcd (...)</a></td>
  52. <td class="summary">Compute the greatest common divider.</td>
  53. </tr>
  54. <tr>
  55. <td class="name" nowrap><a href="#reduce_fraction">reduce_fraction (num, denom)</a></td>
  56. <td class="summary">Reduce a fraction.</td>
  57. </tr>
  58. </table>
  59. <br/>
  60. <br/>
  61. <h2 class="section-header "><a name="Functions"></a>Functions</h2>
  62. <dl class="function">
  63. <dt>
  64. <a name = "gcd"></a>
  65. <strong>gcd (...)</strong>
  66. </dt>
  67. <dd>
  68. Compute the greatest common divider.
  69. Note that the behavior of this function is undefined if the arguments
  70. include infinity or NaN.
  71. <h3>Parameters:</h3>
  72. <ul>
  73. <li><span class="parameter">...</span>
  74. <span class="types"><span class="type">integer</span></span>
  75. The numbers used for the computation.
  76. </li>
  77. </ul>
  78. <h3>Returns:</h3>
  79. <ol>
  80. <span class="types"><span class="type">integer</span></span>
  81. The GCD of the given numbers.
  82. </ol>
  83. </dd>
  84. <dt>
  85. <a name = "reduce_fraction"></a>
  86. <strong>reduce_fraction (num, denom)</strong>
  87. </dt>
  88. <dd>
  89. Reduce a fraction.
  90. <h3>Parameters:</h3>
  91. <ul>
  92. <li><span class="parameter">num</span>
  93. <span class="types"><span class="type">integer</span></span>
  94. The numerator.
  95. </li>
  96. <li><span class="parameter">denom</span>
  97. <span class="types"><span class="type">integer</span></span>
  98. The denominator.
  99. </li>
  100. </ul>
  101. <h3>Returns:</h3>
  102. <ol>
  103. <span class="types"><span class="type">int,int</span></span>
  104. The reduced fraction.
  105. </ol>
  106. </dd>
  107. </dl>
  108. </div> <!-- id="content" -->
  109. </div> <!-- id="main" -->
  110. <div id="about">
  111. <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
  112. <i style="float:right;">Last updated 2024-01-29 22:34:40 </i>
  113. </div> <!-- id="about" -->
  114. </div> <!-- id="container" -->
  115. </body>
  116. </html>