New module @turf/boolean-disjoint

[rowanwins]

New Module @turf/boolean-disjoint

Geometry Support

• Point
• LineString
• Polygon
• MultiPoint
• MultiLineString
• MultiPolygon

JSDocs

/**
 * Boolean-disjoint returns (TRUE) if the intersection of the two geometries is an empty set.
 *
 * @name booleanDisjoint
 * @param {Geometry|Feature<any>} feature1 GeoJSON Feature or Geometry
 * @param {Geometry|Feature<any>} feature2 GeoJSON Feature or Geometry
 * @returns {Boolean} true/false
 * @example
 * const point = {
 *   "type": "Feature",
 *   "properties": {},
 *   "geometry": {
 *     "type": "Point",
 *     "coordinates": [2, 2]
 *   }
 * }
 * const line = {
 *   "type": "Feature",
 *   "properties": {},
 *   "geometry": {
 *     "type": "LineString",
 *     "coordinates": [[1, 1], [1, 2], [1, 3], [1, 4]]
 *   }
 * }
 * turf.booleanDisjoint(line, point);
 * //=true
 */

• Use a meaningful title for the pull request. Include the name of the package modified.
• Have read How To Contribute.
• Run npm test at the sub modules where changes have occurred.
• Run npm run lint to ensure code style at the turf module level.

Submitting a new TurfJS Module.

• Overview description of proposed module.
• Include JSDocs with a basic example.
• Execute ./scripts/generate-readmes to create README.md.
• Add yourself to contributors in package.json using "Full Name <@github Username>".

Gday @DenisCarriere

The boolean beast continues! Disjoint returns 1 or t (TRUE) if the intersection of the two geometries is an empty set. In other words, geometries are disjoint if they do not intersect one another.

Think this one is a fair bit more straight forward so hopefully we're all good.

[DenisCarriere]

A new benchmark technique we've been adding is the Single process results by adding console.time & console.timeEnd before the suite.add.

Example

console.time(name);
disjoint(feature1, feature2);
console.timeEnd(name);
suite.add(name, () => disjoint(feature1, feature2));

[DenisCarriere]

Not too sure if || false is necessary?

If compareCoords only outputs true/false then if the result is false it would fallback again on false.

I'll look into this, but I'm pretty sure || false can be dropped.

[DenisCarriere]

// /**
//  *

Double commented?

[DenisCarriere]

Woot! 👍 Did this work for you @rowanwins ? (It does for me)

[DenisCarriere]

Updates to boolean-disjoint

• Drop || false from index.js
• Remove extra comments
• Add single process benchmark

[DenisCarriere]

Looks good to me, we can always add more test cases to improve it in the future.

[DenisCarriere]

Pretty sure all (Multi)Geometries would be valid inputs using boolean-disjoint:

• MultiPoint
• MultiLineString (Commit 2f35d08)
• MultiPolygon (Commit 2f35d08)

[DenisCarriere]

Seems like Shapely is able to handle disjoint with Multi Geometries.

Polygon - MultiPolygon (Disjoint = True)

Polygon - MultiPolygon (Disjoint = False)

[DenisCarriere]

@stebogit @rowanwins I've organized/grouped the test fixtures, let me know what you think about it.

Example: LineString (Feature1) => Point (Feature2)

• true/LineString/Point/LineString-Point-1.geojson
• true/LineString/Point/LineString-Point-2.geojson

[DenisCarriere]

@rowanwins I've refactored disjoint to support MultiGeometries, I'm pretty sure this approach could be applied to most of the other boolean modules using flattenEach from @turf/meta.

module.exports = function (feature1, feature2) {
    var boolean;
    flattenEach(feature1, function (flatten1) {
        flattenEach(feature2, function (flatten2) {
            if (boolean === false) return false;
            boolean = disjoint(flatten1.geometry, flatten2.geometry);
        });
    });
    return boolean;
};

This way you only need to focus on support the basic geometries.

/**
 * Disjoint operation for simple Geometries (Point/LineString/Polygon)
 *
 * @private
 * @param {Geometry<any>} geom1 GeoJSON Geometry
 * @param {Geometry<any>} geom2 GeoJSON Geometry
 * @returns {Boolean} true/false
 */
function disjoint(geom1, geom2) {

[DenisCarriere]

@rowanwins Any thoughts how to hit these lines (146 & 151) with Test Fixtures?

$ tap test.js --coverage
test.js ............................................. 74/74
total ............................................... 74/74

  74 passing (4s)

  ok
----------|----------|----------|----------|----------|----------------|
File      |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |
----------|----------|----------|----------|----------|----------------|
All files |    96.36 |       85 |      100 |     96.3 |                |
 index.js |    96.36 |       85 |      100 |     96.3 |        146,151 |
----------|----------|----------|----------|----------|----------------|

[rowanwins]

Put it into a seperate module and test that module 😀

[DenisCarriere]

Where does this source code come from?

Lack of comments is hard to troubleshoot.