npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

planar-face-discovery

v2.0.7

Published

Given a planar, undirected, graph enumerate all of the faces of the graph. Can also be described as finding all of the polygons within the graph, or the minimum cycle basis

Downloads

706

Readme

Planar Graph Face Discovery

About

Given graph with the following properties;

  1. The graph is undirected
  2. The graph is planar
  3. Each vertex in the graph has a defined (x,y) position

enumerate all of the faces of the graph. Can also be described as finding all of the polygons within the graph, or the minimum cycle basis.

That is from the following;

Determine the following closed regions;

Installation

npm install --save planar-face-discovery

Usage

1. PlanarFaceTree

This exposes the raw algorithm to find the faces of the graph.

Input

import { PlanarFaceTree } from "planar-face-discovery";

const solver = new PlanarFaceTree();

/**
 * Each node is defined by its [X,Y] position.
 * The coordinate system is oriented as such
 * 
 *  +y
 *   |
 *   |
 *   |
 *   |__________ +x
 *   
 * That is you should have your nodes exist in positive
 * XY space only, negative positions are not allowed.
 * 
 * The index in the array defines the nodes "id"
 */
const nodes: Array<[number, number]> = []

/**
 * Edges are defined by [source id, target id]
 */
const edges: Array<[number, number]> = []

const result = solver.discover(nodes, edges)

Output

The output of the algorithm is a set of trees, aptly named a "forest". Each tree will contain a cycle and/or child cycles

Trees can be converted to JSON via their toJSON method, an example output will look like

[
    {
        "cycle": [],
        "children": [
            {
                "cycle": [0, 1, 3, 0],
                "children": []
            },
            {
                "cycle": [1, 2, 3, 1],
                "children": []
            }
        ]
    }
]

With the cycle indicating the path of vertices for each enclosed shape or "face"

2. getAreaTree

Get the faces formed by the graph in a tree structure where each has an area attached which is calculated exclusive of the areas of its children.

The nodes and edges values are the same as described for PlanarFaceTree

import { getAreaTree } from "planar-face-discovery";

const result = getAreaTree(nodes, edges)

Output

{
  "type": "ROOT",
  "children": [
    {
      "type": "CHILD",
      "polygonIndex": 1,
      "area": {
        "total": 100,
        "withoutChildren": 40
      },
      "polygon": [
        1,
        4,
        5,
        7
      ],
      "children": [...]
    }
  ]
}

Acknowledgement

This module is a typescript port of the algorithm found in the Geometric Tools C++ library.

You can find a fantastic paper that explains the algorithm in detail in their documentation

You can also find this paper and a reference implementation from the library in the reference directory. The document may change in future so the versions stored in this repo are the ones that were used to write the code.

The implementation has been kept as close as possible to the original.

License

The original algorithm and by extension this code are released under the Creative Commons Attribution 4.0 International License