Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

apollonius

Package Overview
Dependencies
Maintainers
1
Versions
11
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

apollonius

Solves Apollonius' problem by finding a fourth circle tangent to three given circles

  • 0.2.3
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
6
decreased by-92.86%
Maintainers
1
Weekly downloads
 
Created
Source

apollonius

Figure: Tangent Circles

npm version license NPM Type Definitions

The apollonius function finds a circle that touches three known circles. The resulting circle is a solution to the Problem of Apollonius. In other words, it finds a circle that is tangent to each of the known three circles if such a circle exists and it usually does. The three known circles can be placed freely and are allowed to overlap each other.

Because a circle can be either internally or externally tangent to another circle, the problem of Apollonius has eight solutions, one for each combination of tangency rules of the three circles. The function here finds one solution at a time but can be used to find all eight.

The function is extremely efficient. It has time complexity of O(1) and does not call any trigonometric functions.

Usage

Install via NPM or Yarn:

$ npm install apollonius

Specify your three known circles as { x, y, r } objects, where x and y are the circle center coordinates and r is the radius. Then call the apollonius function with the circles. The order of the circles does not matter.

import 'apollonius'

// Prepare three known circles.
const c1 = { x: 3, y: 2, r: 1 }
const c2 = { x: 7, y: 2, r: 2 }
const c3 = { x: 3, y: 5, r: 1 }

// Compute a fourth circle that touches the three.
const c = apollonius(c1, c2, c3)

// Result equals { x: 4.367544..., y: 3.5, r: 1.029822... }

The result is a circle object { x, y, r }. By default, the resulting circle is externally tangent to each of the three given circles. To find a circle that is internally tangent to some of the circles, specify those circles with negative radius. See below for an example.

// Prepare circles.
const c1 = { x: 3, y: 2, r: -1 }  // r < 0, thus internally tangent
const c2 = { x: 7, y: 2, r: 2 }   // r > 0, thus externally tangent
const c3 = { x: 3, y: 5, r: -1 }  // r < 0, thus internally tangent

// Compute the fourth circle.
const c = apollonius(c1, c2, c3)

// Result equals { x: 2.732213..., y: 3.5, r: 2.523715... }

The code above is illustrated below:

Figure: Internally Tangent Circles

The resulting circle is internally tangent to the known circles c1 and c3 and externally tangent to the known circle c2. Note that while the known circles can have negative radii, the output circle always has positive or zero radius.

Special cases

The fourth circle cannot be found for some configurations of known circles. These configurations may appear when there are:

  • nested circles: a circle cannot be internally or externally tangent two or more nested circles at the same time.
  • identical circles along a line: when three same-size circles are arranged along a straight line, the radius of the tangent circle would go to infinity.

If the fourth circle cannot be found, the function will return null.

API

apollonius(c1, c2, c3)

This function finds a circle that is tangent to three other circles. If no such circle exists, it returns null.

Parameters:

  • c1
    • an object { x, y, r }, representing a circle in 2D. The properties x, y, and r must be real numbers and are allowed to be negative.
  • c2
    • an object { x, y, r }
  • c3
    • an object { x, y, r }

Returns:

  • an object { x, y, r }.
  • null if no circle can be found or if the radius of the circle is infinite.

Contribute

Pull requests and bug reports are highly appreciated.

Clone the repository:

$ git clone git@github.com:axelpale/apollonius.git

Install development tooling:

$ cd apollonius; npm install

Please test your contribution. Run the test suite:

$ npm run test

Run only linter:

$ npm run lint

Thank you.

License

The apollonius source code is released under MIT license.

Keywords

FAQs

Package last updated on 12 Oct 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc