Skip to content

Commit

Permalink
Merge pull request #5 from DragonGamesStudios/math-docs
Browse files Browse the repository at this point in the history
New version
  • Loading branch information
DragonGamesStudios authored Dec 11, 2024
2 parents 6199635 + 6c5efae commit 33134ae
Show file tree
Hide file tree
Showing 5 changed files with 202 additions and 8 deletions.
103 changes: 100 additions & 3 deletions print.html
Original file line number Diff line number Diff line change
Expand Up @@ -1132,21 +1132,42 @@ <h2 id="point-collections-1"><a class="header" href="#point-collections-1">Point
<p><strong>Return type</strong>: <a href="reference/types.html#circle">Circle</a></p>
<p><strong>Returns</strong>: The circle circumscribed on the three points.</p>
<ul>
<li><code>circumcenter()</code> (alias <code>circumcentre</code>) if the collection has length of 3.</li>
</ul>
<p><strong>Return type</strong>: <a href="reference/types.html#point">Point</a></p>
<p><strong>Returns</strong>: The center of the circle circumscribed on the three points.</p>
<ul>
<li><code>dst()</code> (alias <code>len</code>) if the collection has length of 2.</li>
</ul>
<p><strong>Return type</strong>: <a href="reference/types.html#number">Number (distance)</a></p>
<p><strong>Returns</strong>: the distance between the two points.</p>
<ul>
<li><code>excircle</code> if the collection has length of 3</li>
</ul>
<p><strong>Return type</strong>: <a href="reference/types.html#Circle">Circle</a></p>
<p><strong>Returns</strong>: the circle excribed to the points given, with the center on the bisector of angle <code>ABC</code>.</p>
<ul>
<li><code>incircle()</code> if the collection has length of 3.</li>
</ul>
<p><strong>Return type</strong>: <a href="reference/types.html#circle">Circle</a></p>
<p><strong>Returns</strong>: The circle inscribed in the three points.</p>
<p><strong>Returns</strong>: the distance between the two points.</p>
<ul>
<li><code>incenter()</code> (alias <code>incentre</code>) if the collection has length of 3.</li>
</ul>
<p><strong>Return type</strong>: <a href="reference/types.html#point">Point</a></p>
<p><strong>Returns</strong>: The cetner of the circle inscribed in the three points.</p>
<ul>
<li><code>mid()</code> for any length.</li>
</ul>
<p><strong>Return type</strong>: <a href="reference/types.html#point">Point</a></p>
<p><strong>Returns</strong>: The arithmetic average of the points included in the collection (coordinates-wise).</p>
<ul>
<li><code>orthocenter()</code> (alias <code>orthocentre</code>) if the collection has length of 3.</li>
</ul>
<p><strong>Return type</strong>: <a href="reference/types.html#point">Point</a></p>
<p><strong>Returns</strong>: The intersection of the triangle's altitudes.</p>
<ul>
<li><code>vector()</code> (alias <code>vec</code>) if the collection has length of 2.</li>
</ul>
<p><strong>Return type</strong>: <a href="reference/types.html#number">Number (distance)</a></p>
Expand Down Expand Up @@ -1273,7 +1294,7 @@ <h2 id="bisector"><a class="header" href="#bisector"><code>bisector</code></a></
<ul>
<li><code>angle(k: Line, l: Line)</code></li>
</ul>
<h2 id="center"><a class="header" href="#center"><code>center</code></a></h2>
<h2 id="center-alias-centre"><a class="header" href="#center-alias-centre"><code>center</code> (alias <code>centre</code>)</a></h2>
<ul>
<li><code>center(circle: Circle)</code></li>
</ul>
Expand All @@ -1296,7 +1317,14 @@ <h2 id="circumcircle"><a class="header" href="#circumcircle"><code>circumcircle<
<li><code>circumcircle(abc: 3-P)</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#Circle">Circle</a></p>
<p><strong>Returns</strong>: a circle circumscribed on the three points given.</p>
<p><strong>Returns</strong>: the circle circumscribed on the three points given.</p>
<h2 id="circumcenter"><a class="header" href="#circumcenter"><code>circumcenter</code></a></h2>
<ul>
<li><code>circumcenter(a: Point, b: Point, c: Point)</code></li>
<li><code>icircumcenter(abc: 3-P)</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#Point">Point</a></p>
<p><strong>Returns</strong>: the cetner of the circle circumscribed on the three points given.</p>
<h2 id="conjugate"><a class="header" href="#conjugate"><code>conjugate</code></a></h2>
<ul>
<li><code>conjugate(v: Number (any unit))</code></li>
Expand Down Expand Up @@ -1377,6 +1405,19 @@ <h2 id="dst-alias-len"><a class="header" href="#dst-alias-len"><code>dst</code>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#number">Number (angle)</a></p>
<p><strong>Returns</strong>: the value with a distance unit.</p>
<h2 id="equilateral-alias-equilateral_triangle"><a class="header" href="#equilateral-alias-equilateral_triangle"><code>equilateral</code> (alias <code>equilateral_triangle</code>)</a></h2>
<ul>
<li><code>equilateral()</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#point-collections">Point collection (3)</a></p>
<p><strong>Returns</strong>: an equilateral triangle.</p>
<h2 id="excircle"><a class="header" href="#excircle"><code>excircle</code></a></h2>
<ul>
<li><code>excircle(a: Point, b: Point, c: Point)</code></li>
<li><code>excircle(abc: 3-P)</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#Circle">Circle</a></p>
<p><strong>Returns</strong>: the circle excribed to the points given, with the center on the bisector of angle <code>ABC</code>.</p>
<h2 id="homothety"><a class="header" href="#homothety"><code>homothety</code></a></h2>
<ul>
<li><code>homothety(origin: Point, scale: Number (no unit))</code></li>
Expand All @@ -1396,7 +1437,14 @@ <h2 id="incircle"><a class="header" href="#incircle"><code>incircle</code></a></
<li><code>incircle(abc: 3-P)</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#Circle">Circle</a></p>
<p><strong>Returns</strong>: a circle inscribed in the three points given.</p>
<p><strong>Returns</strong>: the circle inscribed in the three points given.</p>
<h2 id="incenter"><a class="header" href="#incenter"><code>incenter</code></a></h2>
<ul>
<li><code>incenter(a: Point, b: Point, c: Point)</code></li>
<li><code>incenter(abc: 3-P)</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#Point">Point</a></p>
<p><strong>Returns</strong>: the cetner of the circle inscribed in the three points given.</p>
<h2 id="intersection"><a class="header" href="#intersection"><code>intersection</code></a></h2>
<p>All overloads by default don't display the point dot. This can be changed with properties.</p>
<ul>
Expand All @@ -1416,6 +1464,12 @@ <h2 id="intersection"><a class="header" href="#intersection"><code>intersection<
<p><strong>Return type</strong>: <a href="reference/./types.html#point">Point</a></p>
<p><strong>Returns</strong>: intersection of circles <code>o1</code> and <code>o2</code>.</p>
<p><strong>Note</strong>: <code>display_dot</code> property is not currently supported.</p>
<h2 id="isosceles-alias-isosceles_triangle"><a class="header" href="#isosceles-alias-isosceles_triangle"><code>isosceles</code> (alias <code>isosceles_triangle</code>)</a></h2>
<ul>
<li><code>isosceles()</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#point-collections">Point collection (3)</a></p>
<p><strong>Returns</strong>: an isosceles triangle with <code>AC = BC</code>.</p>
<h2 id="line-1"><a class="header" href="#line-1"><code>line</code></a></h2>
<ul>
<li><code>line(col: 2-PC)</code></li>
Expand All @@ -1424,6 +1478,30 @@ <h2 id="line-1"><a class="header" href="#line-1"><code>line</code></a></h2>
<p><strong>Return type</strong>: <a href="reference/./types.html#Line">Line</a></p>
<p><strong>Returns</strong>: a line through two given points.</p>
<p><strong>Displays</strong>: The created line.</p>
<h2 id="main_equilateral-alias-main_equilateral_triangle"><a class="header" href="#main_equilateral-alias-main_equilateral_triangle"><code>main_equilateral</code> (alias <code>main_equilateral_triangle</code>)</a></h2>
<ul>
<li><code>main_equilateral()</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#point-collections">Point collection (3)</a></p>
<p><strong>Returns</strong>: an equilateral triangle with <code>C.y &gt; A.y = B.y</code> and <code>A.x &lt; B.x</code>.</p>
<h2 id="main_isosceles-alias-main_isosceles_triangle"><a class="header" href="#main_isosceles-alias-main_isosceles_triangle"><code>main_isosceles</code> (alias <code>main_isosceles_triangle</code>)</a></h2>
<ul>
<li><code>main_isosceles()</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#point-collections">Point collection (3)</a></p>
<p><strong>Returns</strong>: an isosceles triangle with <code>AC = BC</code>, <code>C.y &gt; A.y = B.y</code> and <code>A.x &lt; B.x</code>.</p>
<h2 id="main_right-alias-main_right_triangle"><a class="header" href="#main_right-alias-main_right_triangle"><code>main_right</code> (alias <code>main_right_triangle</code>)</a></h2>
<ul>
<li><code>main_right()</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#point-collections">Point collection (3)</a></p>
<p><strong>Returns</strong>: a right triangle with <code>angle(ACB) = deg(90)</code>, <code>B.y &gt; A.y = C.y</code> and <code>C.x &lt; A.x</code>.</p>
<h2 id="main_triangle-alias-main_triangle"><a class="header" href="#main_triangle-alias-main_triangle"><code>main_triangle</code> (alias <code>main_triangle</code>)</a></h2>
<ul>
<li><code>main_triangle()</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#point-collections">Point collection (3)</a></p>
<p><strong>Returns</strong>: a triangle with <code>C.y &gt; A.y = B.y</code> and <code>A.x &lt; B.x</code>.</p>
<h2 id="mid"><a class="header" href="#mid"><code>mid</code></a></h2>
<ul>
<li><code>mid(col: 0-P)</code></li>
Expand All @@ -1441,6 +1519,13 @@ <h2 id="mid"><a class="header" href="#mid"><code>mid</code></a></h2>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#Point">Point</a></p>
<p><strong>Returns</strong>: The middle point of <code>P_1</code>, <code>P_2</code>, ... <code>P_n</code>. Special cases: when <code>n=2</code>, the middle of a segment; When <code>n=3</code>, the centroid of a triangle.</p>
<h2 id="orthocenter-alias-orthocentre"><a class="header" href="#orthocenter-alias-orthocentre"><code>orthocenter</code> (alias <code>orthocentre</code>)</a></h2>
<ul>
<li><code>orthocenter(A: Point, B: Point, C: Point)</code></li>
<li><code>orthocenter(ABC: 3-P)</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#Point">Point</a></p>
<p><strong>Returns</strong>: The intersection of the triangles altitudes.</p>
<h2 id="parallel_through-alias-parallel"><a class="header" href="#parallel_through-alias-parallel"><code>parallel_through</code> (alias <code>parallel</code>)</a></h2>
<ul>
<li><code>parallel_through(P: Point, k: Line)</code></li>
Expand Down Expand Up @@ -1515,6 +1600,12 @@ <h2 id="rotate-alias-rotation"><a class="header" href="#rotate-alias-rotation"><
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#transformtype">TransformType</a></p>
<p><strong>Returns</strong>: A rotation around an origin by an angle (possibly negative), along with an optional homothety at the same point.</p>
<h2 id="right-alias-right_triangle"><a class="header" href="#right-alias-right_triangle"><code>right</code> (alias <code>right_triangle</code>)</a></h2>
<ul>
<li><code>right()</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#point-collections">Point collection (3)</a></p>
<p><strong>Returns</strong>: a right triangle with <code>angle(ACB) = deg(90)</code>.</p>
<h2 id="sec"><a class="header" href="#sec"><code>sec</code></a></h2>
<ul>
<li><code>sec(v: Number (angle))</code></li>
Expand Down Expand Up @@ -1582,6 +1673,12 @@ <h2 id="translate-alias-translation"><a class="header" href="#translate-alias-tr
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#transformtype">TransformType</a></p>
<p><strong>Returns</strong>: A translation by a vector.</p>
<h2 id="triagngle-alias-triangle"><a class="header" href="#triagngle-alias-triangle"><code>triagngle</code> (alias <code>triangle</code>)</a></h2>
<ul>
<li><code>triangle()</code></li>
</ul>
<p><strong>Return type</strong>: <a href="reference/./types.html#point-collections">Point collection (3)</a></p>
<p><strong>Returns</strong>: a triangle.</p>
<h2 id="x"><a class="header" href="#x"><code>x</code></a></h2>
<ul>
<li><code>x(P: Point)</code></li>
Expand Down
Loading

0 comments on commit 33134ae

Please sign in to comment.