@flatten-js/core

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>utils/utils.js - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav> <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading">C<a href="Arc.html">Arc</a></li><li class="nav-item">F<a href="Arc.html#clone">clone</a></li><li class="nav-item">F<a href="Arc.html#contains">contains</a></li><li class="nav-item">F<a href="Arc.html#split">split</a></li><li class="nav-item">F<a href="Arc.html#middle">middle</a></li><li class="nav-item">F<a href="Arc.html#chordHeight">chordHeight</a></li><li class="nav-item">F<a href="Arc.html#intersect">intersect</a></li><li class="nav-item">F<a href="Arc.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Arc.html#breakToFunctional">breakToFunctional</a></li><li class="nav-item">F<a href="Arc.html#tangentInStart">tangentInStart</a></li><li class="nav-item">F<a href="Arc.html#tangentInEnd">tangentInEnd</a></li><li class="nav-item">F<a href="Arc.html#reverse">reverse</a></li><li class="nav-item">F<a href="Arc.html#translate">translate</a></li><li class="nav-item">F<a href="Arc.html#rotate">rotate</a></li><li class="nav-item">F<a href="Arc.html#scale">scale</a></li><li class="nav-item">F<a href="Arc.html#transform">transform</a></li><li class="nav-item">F<a href="Arc.html#sortPoints">sortPoints</a></li><li class="nav-item">F<a href="Arc.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Arc.html#svg">svg</a></li><li class="nav-heading">C<a href="Box.html">Box</a></li><li class="nav-item">F<a href="Box.html#clone">clone</a></li><li class="nav-item">F<a href="Box.html#not_intersect">not_intersect</a></li><li class="nav-item">F<a href="Box.html#intersect">intersect</a></li><li class="nav-item">F<a href="Box.html#merge">merge</a></li><li class="nav-item">F<a href="Box.html#less_than">less_than</a></li><li class="nav-item">F<a href="Box.html#equal_to">equal_to</a></li><li class="nav-item">F<a href="Box.html#set">set</a></li><li class="nav-item">F<a href="Box.html#toPoints">toPoints</a></li><li class="nav-item">F<a href="Box.html#toSegments">toSegments</a></li><li class="nav-item">F<a href="Box.html#svg">svg</a></li><li class="nav-heading">C<a href="Circle.html">Circle</a></li><li class="nav-item">F<a href="Circle.html#clone">clone</a></li><li class="nav-item">F<a href="Circle.html#contains">contains</a></li><li class="nav-item">F<a href="Circle.html#toArc">toArc</a></li><li class="nav-item">F<a href="Circle.html#intersect">intersect</a></li><li class="nav-item">F<a href="Circle.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Circle.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Circle.html#svg">svg</a></li><li class="nav-heading">C<a href="Edge.html">Edge</a></li><li class="nav-item">F<a href="Edge.html#middle">middle</a></li><li class="nav-item">F<a href="Edge.html#contains">contains</a></li><li class="nav-item">F<a href="Edge.html#setInclusion">setInclusion</a></li><li class="nav-item">F<a href="Edge.html#setOverlap">setOverlap</a></li><li class="nav-heading">C<a href="Face.html">Face</a></li><li class="nav-item">F<a href="Face.html#append">append</a></li><li class="nav-item">F<a href="Face.html#insert">insert</a></li><li class="nav-item">F<a href="Face.html#remove">remove</a></li><li class="nav-item">F<a href="Face.html#reverse">reverse</a></li><li class="nav-item">F<a href="Face.html#setArcLength">setArcLength</a></li><li class="nav-item">F<a href="Face.html#area">area</a></li><li class="nav-item">F<a href="Face.html#signedArea">signedArea</a></li><li class="nav-item">F<a href="Face.html#orientation">orientation</a></li><li class="nav-item">F<a href="Face.html#isSimple">isSimple</a></li><li class="nav-item">F<a href="Face.html#findEdgeByPoint">findEdgeByPoint</a></li><li class="nav-item">F<a href="Face.html#toPolygon">toPolygon</a></li><li class="nav-item">F<a href="Face.html#svg">svg</a></li><li class="nav-heading">C<a href="Line.html">Line</a></li><li class="nav-item">F<a href="Line.html#clone">clone</a></li><li class="nav-item">F<a href="Line.html#parallelTo">parallelTo</a></li><li class="nav-item">F<a href="Line.html#incidentTo">incidentTo</a></li><li class="nav-item">F<a href="Line.html#contains">contains</a></li><li class="nav-item">F<a href="Line.html#coord">coord</a></li><li class="nav-item">F<a href="Line.html#intersect">intersect</a></li><li class="nav-item">F<a href="Line.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Line.html#split">split</a></li><li class="nav-item">F<a href="Line.html#sortPoints">sortPoints</a></li><li class="nav-item">F<a href="Line.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Line.html#svg">svg</a></li><li class="nav-heading">C<a href="Matrix.html">Matrix</a></li><li class="nav-item">F<a href="Matrix.html#clone">clone</a></li><li class="nav-item">F<a href="Matrix.html#transform">transform</a></li><li class="nav-item">F<a href="Matrix.html#multiply">multiply</a></li><li class="nav-item">F<a href="Matrix.html#translate">translate</a></li><li class="nav-item">F<a href="Matrix.html#rotate">rotate</a></li><li class="nav-item">F<a href="Matrix.html#scale">scale</a></li><li class="nav-item">F<a href="Matrix.html#equalTo">equalTo</a></li><li class="nav-heading">C<a href="Multiline.html">Multiline</a></li><li class="nav-item">F<a href="Multiline.html#clone">clone</a></li><li class="nav-item">F<a href="Multiline.html#addVertex">addVertex</a></li><li class="nav-item">F<a href="Multiline.html#split">split</a></li><li class="nav-item">F<a href="Multiline.html#findEdgeByPoint">findEdgeByPoint</a></li><li class="nav-item">F<a href="Multiline.html#translate">translate</a></li><li class="nav-item">F<a href="Multiline.html#rotate">rotate</a></li><li class="nav-item">F<a href="Multiline.html#transform">transform</a></li><li class="nav-item">F<a href="Multiline.html#toShapes">toShapes</a></li><li class="nav-item">F<a href="Multiline.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Multiline.html#svg">svg</a></li><li class="nav-heading">C<a href="Point.html">Point</a></li><li class="nav-item">F<a href="Point.html#clone">clone</a></li><li class="nav-item">F<a href="Point.html#equalTo">equalTo</a></li><li class="nav-item">F<a href="Point.html#lessThan">lessThan</a></li><li class="nav-item">F<a href="Point.html#rotate">rotate</a></li><li class="nav-item">F<a href="Point.html#translate">translate</a></li><li class="nav-item">F<a href="Point.html#transform">transform</a></li><li class="nav-item">F<a href="Point.html#projectionOn">projectionOn</a></li><li class="nav-item">F<a href="Point.html#leftTo">leftTo</a></li><li class="nav-item">F<a href="Point.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Point.html#on">on</a></li><li class="nav-item">F<a href="Point.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Point.html#svg">svg</a></li><li class="nav-heading">C<a href="Polygon.html">Polygon</a></li><li class="nav-item">F<a href="Polygon.html#clone">clone</a></li><li class="nav-item">F<a href="Polygon.html#isEmpty">isEmpty</a></li><li class="nav-item">F<a href="Polygon.html#isValid">isValid</a></li><li class="nav-item">F<a href="Polygon.html#area">area</a></li><li class="nav-item">F<a href="Polygon.html#addFace">addFace</a></li><li class="nav-item">F<a href="Polygon.html#deleteFace">deleteFace</a></li><li class="nav-item">F<a href="Polygon.html#removeChain">removeChain</a></li><li class="nav-item">F<a href="Polygon.html#addVertex">addVertex</a></li><li class="nav-item">F<a href="Polygon.html#cut">cut</a></li><li class="nav-item">F<a href="Polygon.html#cutFace">cutFace</a></li><li class="nav-item">F<a href="Polygon.html#findEdgeByPoint">findEdgeByPoint</a></li><li class="nav-item">F<a href="Polygon.html#splitToIslands">splitToIslands</a></li><li class="nav-item">F<a href="Polygon.html#reverse">reverse</a></li><li class="nav-item">F<a href="Polygon.html#contains">contains</a></li><li class="nav-item">F<a href="Polygon.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Polygon.html#intersect">intersect</a></li><li class="nav-item">F<a href="Polygon.html#translate">translate</a></li><li class="nav-item">F<a href="Polygon.html#rotate">rotate</a></li><li class="nav-item">F<a href="Polygon.html#transform">transform</a></li><li class="nav-item">F<a href="Polygon.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Polygon.html#toArray">toArray</a></li><li class="nav-item">F<a href="Polygon.html#svg">svg</a></li><li class="nav-heading">C<a href="Ray.html">Ray</a></li><li class="nav-item">F<a href="Ray.html#clone">clone</a></li><li class="nav-item">F<a href="Ray.html#contains">contains</a></li><li class="nav-item">F<a href="Ray.html#split">split</a></li><li class="nav-item">F<a href="Ray.html#intersect">intersect</a></li><li class="nav-item">F<a href="Ray.html#svg">svg</a></li><li class="nav-heading">C<a href="Segment.html">Segment</a></li><li class="nav-item">F<a href="Segment.html#clone">clone</a></li><li class="nav-item">F<a href="Segment.html#equalTo">equalTo</a></li><li class="nav-item">F<a href="Segment.html#contains">contains</a></li><li class="nav-item">F<a href="Segment.html#intersect">intersect</a></li><li class="nav-item">F<a href="Segment.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Segment.html#tangentInStart">tangentInStart</a></li><li class="nav-item">F<a href="Segment.html#tangentInEnd">tangentInEnd</a></li><li class="nav-item">F<a href="Segment.html#reverse">reverse</a></li><li class="nav-item">F<a href="Segment.html#split">split</a></li><li class="nav-item">F<a href="Segment.html#middle">middle</a></li><li class="nav-item">F<a href="Segment.html#translate">translate</a></li><li class="nav-item">F<a href="Segment.html#rotate">rotate</a></li><li class="nav-item">F<a href="Segment.html#transform">transform</a></li><li class="nav-item">F<a href="Segment.html#isZeroLength">isZeroLength</a></li><li class="nav-item">F<a href="Segment.html#sortPoints">sortPoints</a></li><li class="nav-item">F<a href="Segment.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Segment.html#svg">svg</a></li><li class="nav-heading">C<a href="Vector.html">Vector</a></li><li class="nav-item">F<a href="Vector.html#clone">clone</a></li><li class="nav-item">F<a href="Vector.html#equalTo">equalTo</a></li><li class="nav-item">F<a href="Vector.html#multiply">multiply</a></li><li class="nav-item">F<a href="Vector.html#dot">dot</a></li><li class="nav-item">F<a href="Vector.html#cross">cross</a></li><li class="nav-item">F<a href="Vector.html#normalize">normalize</a></li><li class="nav-item">F<a href="Vector.html#rotate">rotate</a></li><li class="nav-item">F<a href="Vector.html#rotate90CCW">rotate90CCW</a></li><li class="nav-item">F<a href="Vector.html#rotate90CW">rotate90CW</a></li><li class="nav-item">F<a href="Vector.html#invert">invert</a></li><li class="nav-item">F<a href="Vector.html#add">add</a></li><li class="nav-item">F<a href="Vector.html#subtract">subtract</a></li><li class="nav-item">F<a href="Vector.html#angleTo">angleTo</a></li><li class="nav-item">F<a href="Vector.html#projectionOn">projectionOn</a></li><li class="nav-item">F<a href="Vector.html#toJSON">toJSON</a></li><li class="nav-heading">C<a href="CircularLinkedList.html">CircularLinkedList</a></li><li class="nav-item">F<a href="CircularLinkedList.html#append">append</a></li><li class="nav-item">F<a href="CircularLinkedList.html#insert">insert</a></li><li class="nav-item">F<a href="CircularLinkedList.html#remove">remove</a></li><li class="nav-heading">C<a href="DE9IM.html">DE9IM</a></li><li class="nav-item">F<a href="DE9IM.html#toString">toString</a></li><li class="nav-heading">C<a href="LinkedList.html">LinkedList</a></li><li class="nav-item">F<a href="LinkedList.html#toArray">toArray</a></li><li class="nav-item">F<a href="LinkedList.html#append">append</a></li><li class="nav-item">F<a href="LinkedList.html#insert">insert</a></li><li class="nav-item">F<a href="LinkedList.html#remove">remove</a></li><li class="nav-item">F<a href="LinkedList.html#isEmpty">isEmpty</a></li><li class="nav-item">F<a href="LinkedList.html#.testInfiniteLoop">testInfiniteLoop</a></li><li class="nav-heading">C<a href="PlanarSet.html">PlanarSet</a></li><li class="nav-item">F<a href="PlanarSet.html#add">add</a></li><li class="nav-item">F<a href="PlanarSet.html#delete">delete</a></li><li class="nav-item">F<a href="PlanarSet.html#clear">clear</a></li><li class="nav-item">F<a href="PlanarSet.html#search">search</a></li><li class="nav-item">F<a href="PlanarSet.html#hit">hit</a></li><li class="nav-item">F<a href="PlanarSet.html#svg">svg</a></li><li class="nav-heading">C<a href="Errors.html">Errors</a></li><li class="nav-heading">Modules</li><li class="nav-heading">M<a href="module-BooleanOperations.html">BooleanOperations</a></li><li class="nav-item">F<a href="module-BooleanOperations.html#.unify">unify</a></li><li class="nav-item">F<a href="module-BooleanOperations.html#.subtract">subtract</a></li><li class="nav-item">F<a href="module-BooleanOperations.html#.intersect">intersect</a></li><li class="nav-item">F<a href="module-BooleanOperations.html#.innerClip">innerClip</a></li><li class="nav-item">F<a href="module-BooleanOperations.html#.outerClip">outerClip</a></li><li class="nav-item">F<a href="module-BooleanOperations.html#.calculateIntersections">calculateIntersections</a></li><li class="nav-heading">M<a href="module-RayShoot.html">RayShoot</a></li><li class="nav-item">F<a href="module-RayShoot.html#.ray_shoot">ray_shoot</a></li><li class="nav-heading">M<a href="module-Relation.html">Relation</a></li><li class="nav-item">F<a href="module-Relation.html#.equal">equal</a></li><li class="nav-item">F<a href="module-Relation.html#.intersect">intersect</a></li><li class="nav-item">F<a href="module-Relation.html#.touch">touch</a></li><li class="nav-item">F<a href="module-Relation.html#.disjoint">disjoint</a></li><li class="nav-item">F<a href="module-Relation.html#.inside">inside</a></li><li class="nav-item">F<a href="module-Relation.html#.covered">covered</a></li><li class="nav-item">F<a href="module-Relation.html#.contain">contain</a></li><li class="nav-item">F<a href="module-Relation.html#.cover">cover</a></li><li class="nav-item">F<a href="module-Relation.html#.relate">relate</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item">F<a href="global.html#inverse">inverse</a></li><li class="nav-item">M<a href="global.html#arc">arc</a></li><li class="nav-item">M<a href="global.html#box">box</a></li><li class="nav-item">M<a href="global.html#circle">circle</a></li><li class="nav-item">M<a href="global.html#line">line</a></li><li class="nav-item">M<a href="global.html#matrix">matrix</a></li><li class="nav-item">M<a href="global.html#multiline">multiline</a></li><li class="nav-item">M<a href="global.html#point">point</a></li><li class="nav-item">M<a href="global.html#polygon">polygon</a></li><li class="nav-item">M<a href="global.html#segment">segment</a></li><li class="nav-item">M<a href="global.html#vector">vector</a></li><li class="nav-item">M<a href="global.html#CCW">CCW</a></li><li class="nav-item">M<a href="global.html#CW">CW</a></li><li class="nav-item">M<a href="global.html#ORIENTATION">ORIENTATION</a></li><li class="nav-item">M<a href="global.html#DP_TOL">DP_TOL</a></li><li class="nav-item">F<a href="global.html#setTolerance">setTolerance</a></li><li class="nav-item">F<a href="global.html#getTolerance">getTolerance</a></li><li class="nav-item">F<a href="global.html#EQ_0">EQ_0</a></li><li class="nav-item">F<a href="global.html#EQ">EQ</a></li><li class="nav-item">F<a href="global.html#GT">GT</a></li><li class="nav-item">F<a href="global.html#GE">GE</a></li><li class="nav-item">F<a href="global.html#LT">LT</a></li><li class="nav-item">F<a href="global.html#LE">LE</a></li> </nav> <div id="main"> <h1 class="page-title">utils/utils.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>/** * Created by Alex Bol on 2/18/2017. */ /** * Floating point comparison tolerance. * Default value is 0.000001 (10e-6) * @type {number} */ let DP_TOL = 0.000001; /** * Set new floating point comparison tolerance * @param {number} tolerance */ export function setTolerance(tolerance) {DP_TOL = tolerance;} /** * Get floating point comparison tolerance * @returns {number} */ export function getTolerance() {return DP_TOL;} export const DECIMALS = 3; /** * Returns *true* if value comparable to zero * @param {number} x * @param {number} y * @return {boolean} */ export function EQ_0(x) { return (x < DP_TOL && x > -DP_TOL); } /** * Returns *true* if two values are equal up to DP_TOL * @param {number} x * @param {number} y * @return {boolean} */ export function EQ(x, y) { return (x - y < DP_TOL && x - y > -DP_TOL); } /** * Returns *true* if first argument greater than second argument up to DP_TOL * @param {number} x * @param {number} y * @return {boolean} */ export function GT(x, y) { return (x - y > DP_TOL); } /** * Returns *true* if first argument greater than or equal to second argument up to DP_TOL * @param {number} x * @param {number} y * @returns {boolean} */ export function GE(x, y) { return (x - y > -DP_TOL); } /** * Returns *true* if first argument less than second argument up to DP_TOL * @param {number} x * @param {number} y * @return {boolean} */ export function LT(x, y) { return (x - y < -DP_TOL) } /** * Returns *true* if first argument less than or equal to second argument up to DP_TOL * @param {number} x * @param {number} y * @return {boolean} */ export function LE(x, y) { return (x - y < DP_TOL); } </code></pre> </article> </section> </div> <footer> Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun May 16 2021 15:05:05 GMT+0300 (Israel Daylight Time) using the Minami theme. </footer> <script>prettyPrint();</script> <script src="scripts/linenumber.js"></script> </body> </html>