npm - @live-change/flatten-interval-tree - Versions diffs - 0.8.26 - Mend

@live-change/flatten-interval-tree 0.8.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (65) hide show

package/.babelrc +8 -0
package/.travis.yml +14 -0
package/LICENSE +21 -0
package/README.md +172 -0
package/dist/main.cjs.js +799 -0
package/dist/main.esm.js +794 -0
package/dist/main.umd.js +805 -0
package/docs/Interval.html +1609 -0
package/docs/IntervalTree.html +1506 -0
package/docs/classes_interval.js.html +173 -0
package/docs/fonts/OpenSans-Bold-webfont.eot +0 -0
package/docs/fonts/OpenSans-Bold-webfont.svg +1830 -0
package/docs/fonts/OpenSans-Bold-webfont.woff +0 -0
package/docs/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
package/docs/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Italic-webfont.eot +0 -0
package/docs/fonts/OpenSans-Italic-webfont.svg +1830 -0
package/docs/fonts/OpenSans-Italic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Light-webfont.eot +0 -0
package/docs/fonts/OpenSans-Light-webfont.svg +1831 -0
package/docs/fonts/OpenSans-Light-webfont.woff +0 -0
package/docs/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
package/docs/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Regular-webfont.eot +0 -0
package/docs/fonts/OpenSans-Regular-webfont.svg +1831 -0
package/docs/fonts/OpenSans-Regular-webfont.woff +0 -0
package/docs/fonts/OpenSans-Semibold-webfont.eot +0 -0
package/docs/fonts/OpenSans-Semibold-webfont.svg +1830 -0
package/docs/fonts/OpenSans-Semibold-webfont.ttf +0 -0
package/docs/fonts/OpenSans-Semibold-webfont.woff +0 -0
package/docs/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-SemiboldItalic-webfont.svg +1830 -0
package/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
package/docs/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
package/docs/index.html +197 -0
package/docs/index.js.html +624 -0
package/docs/interval.js.html +184 -0
package/docs/intervalTree.js.html +624 -0
package/docs/scripts/linenumber.js +25 -0
package/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
package/docs/scripts/prettify/lang-css.js +2 -0
package/docs/scripts/prettify/prettify.js +28 -0
package/docs/styles/jsdoc-default.css +692 -0
package/docs/styles/prettify-jsdoc.css +111 -0
package/docs/styles/prettify-tomorrow.css +132 -0
package/examples/browser/index.html +49 -0
package/examples/create-react-app/package.json +15 -0
package/examples/create-react-app/public/index.html +11 -0
package/examples/create-react-app/src/App.js +38 -0
package/examples/create-react-app/src/ComposersList.js +15 -0
package/examples/create-react-app/src/index.js +5 -0
package/examples/es6-module/index.html +50 -0
package/examples/nodejs/index.js +23 -0
package/index.d.ts +65 -0
package/index.js +6 -0
package/package.json +52 -0
package/rollup.config.js +21 -0
package/src/classes/interval.js +131 -0
package/src/classes/intervalTree.js +564 -0
package/src/classes/node.js +97 -0
package/src/utils/constants.js +16 -0
package/test/intervalTree.js +232 -0
package/test/node.js +64 -0

package/docs/interval.js.html ADDED Viewed

@@ -0,0 +1,184 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>interval.js - Documentation</title>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <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"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Interval.html">Interval</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interval.html#.comparable_less_than">comparable_less_than</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interval.html#.comparable_max">comparable_max</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interval.html#clone">clone</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interval.html#equal_to">equal_to</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interval.html#intersect">intersect</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interval.html#less_than">less_than</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interval.html#merge">merge</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interval.html#not_intersect">not_intersect</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Interval.html#output">output</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="IntervalTree.html">IntervalTree</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IntervalTree.html#exist">exist</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IntervalTree.html#forEach">forEach</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IntervalTree.html#insert">insert</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IntervalTree.html#isEmpty">isEmpty</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IntervalTree.html#map">map</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IntervalTree.html#remove">remove</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IntervalTree.html#search">search</a></span></li>
+</nav>
+<div id="main">
+    <h1 class="page-title">interval.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/**
+ * Created by Alex Bol on 4/1/2017.
+ */
+/**
+ * Interval is a pair of numbers or a pair of any comparable objects on which may be defined predicates
+ * *equal*, *less* and method *max(p1, p1)* that returns maximum in a pair.
+ * When interval is an object rather than pair of numbers, this object should have properties *low*, *high*, *max*
+ * and implement methods *less_than(), equal_to(), intersect(), not_intersect(), clone(), output()*.
+ * Two static methods *comparable_max(), comparable_less_than()* define how to compare values in pair. &lt;br/>
+ * This interface is described in typescript definition file *index.d.ts*
+ *
+ * Axis aligned rectangle is an example of such interval.
+ * We may look at rectangle as an interval between its low left and top right corners.
+ * See **Box** class in [flatten-js](https://github.com/alexbol99/flatten-js) library as the example
+ * of Interval interface implementation
+ * @type {Interval}
+ */
+const Interval = class Interval {
+    /**
+     * Accept two comparable values and creates new instance of interval
+     * Predicate Interval.comparable_less(low, high) supposed to return true on these values
+     * @param low
+     * @param high
+     */
+    constructor(low, high) {
+        this.low = low;
+        this.high = high;
+    }
+    /**
+     * Clone interval
+     * @returns {Interval}
+     */
+    clone() {
+        return new Interval(this.low, this.high);
+    }
+    /**
+     * Propery max returns clone of this interval
+     * @returns {Interval}
+     */
+    get max() {
+        return this.clone();   // this.high;
+    }
+    /**
+     * Predicate returns true is this interval less than other interval
+     * @param other_interval
+     * @returns {boolean}
+     */
+    less_than(other_interval) {
+        return this.low &lt; other_interval.low ||
+            this.low == other_interval.low &amp;&amp; this.high &lt; other_interval.high;
+    }
+    /**
+     * Predicate returns true is this interval equals to other interval
+     * @param other_interval
+     * @returns {boolean}
+     */
+    equal_to(other_interval) {
+        return this.low == other_interval.low &amp;&amp; this.high == other_interval.high;
+    }
+    /**
+     * Predicate returns true if this interval intersects other interval
+     * @param other_interval
+     * @returns {boolean}
+     */
+    intersect(other_interval) {
+        return !this.not_intersect(other_interval);
+    }
+    /**
+     * Predicate returns true if this interval does not intersect other interval
+     * @param other_interval
+     * @returns {boolean}
+     */
+    not_intersect(other_interval) {
+        return (this.high &lt; other_interval.low || other_interval.high &lt; this.low);
+    }
+    /**
+     * Returns new interval merged with other interval
+     * @param {Interval} interval - Other interval to merge with
+     * @returns {Interval}
+     */
+    merge(other_interval) {
+        return new Interval(
+            this.low === undefined ? other_interval.low : Math.min(this.low, other_interval.low),
+            this.high === undefined ? other_interval.high : Math.max(this.high, other_interval.high)
+        );
+    }
+    /**
+     * Returns how key should return
+     */
+    output() {
+        return [this.low, this.high];
+    }
+    /**
+     * Function returns maximum between two comparable values
+     * @param interval1
+     * @param interval2
+     * @returns {Interval}
+     */
+    static comparable_max(interval1, interval2) {
+        return interval1.merge(interval2);
+    }
+    /**
+     * Predicate returns true if first value less than second value
+     * @param val1
+     * @param val2
+     * @returns {boolean}
+     */
+    static comparable_less_than(val1, val2 ) {
+        return val1 &lt; val2;
+    }
+};
+export default Interval;
+</code></pre>
+        </article>
+    </section>
+</div>
+<br class="clear">
+<footer>
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> on Thu Jul 04 2019 20:41:00 GMT+0300 (Israel Daylight Time) using the Minami theme.
+</footer>
+<script>prettyPrint();</script>
+<script src="scripts/linenumber.js"></script>
+</body>
+</html>