<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Regular (geoml.Geoml.Polygon.Convex.Regular)</title><link rel="stylesheet" href="../../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> â€“ <a href="../../../../index.html">geoml</a> &#x00BB; <a href="../../../index.html">Geoml</a> &#x00BB; <a href="../../index.html">Polygon</a> &#x00BB; <a href="../index.html">Convex</a> &#x00BB; Regular</nav><h1>Module <code>Convex.Regular</code></h1></header><aside><p>Module for Regular polygons</p></aside><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = <span class="keyword">private</span> </code><code>{</code><table class="record"><tr id="type-t.center" class="anchored"><td class="def field"><a href="#type-t.center" class="anchor"></a><code>center : <a href="../../../Point/index.html#type-t">Point.t</a>;</code></td></tr><tr id="type-t.fst" class="anchored"><td class="def field"><a href="#type-t.fst" class="anchor"></a><code>fst : <a href="../../../Point/index.html#type-t">Point.t</a>;</code></td></tr><tr id="type-t.snd" class="anchored"><td class="def field"><a href="#type-t.snd" class="anchor"></a><code>snd : <a href="../../../Point/index.html#type-t">Point.t</a>;</code></td></tr><tr id="type-t.len" class="anchored"><td class="def field"><a href="#type-t.len" class="anchor"></a><code>len : float;</code></td></tr><tr id="type-t.apothem" class="anchored"><td class="def field"><a href="#type-t.apothem" class="anchor"></a><code>apothem : float;</code></td><td class="doc"><p>Distance between the center and the middle of one of the edges</p></td></tr><tr id="type-t.edges" class="anchored"><td class="def field"><a href="#type-t.edges" class="anchor"></a><code>edges : int;</code></td></tr></table><code>}</code></dt></dl><dl><dt class="spec value" id="val-make"><a href="#val-make" class="anchor"></a><code><span class="keyword">val</span> make : <a href="../../../Point/index.html#type-t">Point.t</a> <span>&#45;&gt;</span> <a href="../../../Point/index.html#type-t">Point.t</a> <span>&#45;&gt;</span> int <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p>Create a regular polygon from the center, an arbitrary point and the number of edges</p></dd></dl><dl><dt class="spec value" id="val-next_point"><a href="#val-next_point" class="anchor"></a><code><span class="keyword">val</span> next_point : <span>?&#8288;nth:int</span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="../../../Point/index.html#type-t">Point.t</a></code></dt><dt class="spec value" id="val-fold_stop"><a href="#val-fold_stop" class="anchor"></a><code><span class="keyword">val</span> fold_stop : <span>(<a href="../../../Point/index.html#type-t">Point.t</a> <span>&#45;&gt;</span> <a href="../../../Point/index.html#type-t">Point.t</a> <span>&#45;&gt;</span> bool)</span> <span>&#45;&gt;</span> <span>(int <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> <a href="../../../Point/index.html#type-t">Point.t</a> <span>&#45;&gt;</span> <a href="../../../Point/index.html#type-t">Point.t</a> <span>&#45;&gt;</span> <span class="type-var">'a</span>)</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span class="type-var">'a</span></code></dt><dt class="spec value" id="val-perimeter"><a href="#val-perimeter" class="anchor"></a><code><span class="keyword">val</span> perimeter : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> float</code></dt><dt class="spec value" id="val-area"><a href="#val-area" class="anchor"></a><code><span class="keyword">val</span> area : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> float</code></dt><dt class="spec value" id="val-to_polygon"><a href="#val-to_polygon" class="anchor"></a><code><span class="keyword">val</span> to_polygon : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="../../index.html#type-polygon">polygon</a></code></dt><dt class="spec value" id="val-to_randomized_polygon"><a href="#val-to_randomized_polygon" class="anchor"></a><code><span class="keyword">val</span> to_randomized_polygon : <span>?&#8288;minp:int</span> <span>&#45;&gt;</span> <span>?&#8288;prob:float</span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="../../index.html#type-polygon">polygon</a></code></dt><dt class="spec value" id="val-translate"><a href="#val-translate" class="anchor"></a><code><span class="keyword">val</span> translate : float <span>&#45;&gt;</span> float <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-transform"><a href="#val-transform" class="anchor"></a><code><span class="keyword">val</span> transform : <a href="../../../../Geoml__/Affine/index.html#type-t">Geoml__.Affine.t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-is_square"><a href="#val-is_square" class="anchor"></a><code><span class="keyword">val</span> is_square : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> bool</code></dt><dt class="spec value" id="val-contains"><a href="#val-contains" class="anchor"></a><code><span class="keyword">val</span> contains : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="../../../Point/index.html#type-t">Point.t</a> <span>&#45;&gt;</span> bool</code></dt><dt class="spec value" id="val-map"><a href="#val-map" class="anchor"></a><code><span class="keyword">val</span> map : <span>(<a href="../../../Point/index.html#type-t">Point.t</a> <span>&#45;&gt;</span> <a href="../../../Point/index.html#type-t">Point.t</a>)</span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt></dl></div></body></html>