Circle Boundary

A single purpose library. This library aim is to return a circle boundry as represetned in descriete pixels as show in the following diagram.

Usage

Include the library into your application with the following line at the top of your main file.

rust extern crate circle_boundry;

And then get access to the public calculate function by adding the following line at the top of the file you want to use it in.

rust use circle_boundry::calculate;

Then you can use the calculate function to get a vector of boundry data structures back. Each boundry structure holds a pair of cartesian coordinates (x and y) where x is represented by a single number indicating it's position, and y is represented by a range to show where on the y-axis the boundry applies.

The calculate function expects the origin as represented by the first two arguments, a x value as an i32 integer and a y value as an i32 integer. The final argument is the radius of the circule you want a boundry for as represetned as a i32 integer.

rust let bounds = calculate(0, 0, 3);

As noted above the value returned is a vector that represents the boundry as such:

rust vec![ Boundary { x: -3, y: -1..1 }, Boundary { x: -2, y: -2..2 }, Boundary { x: -1, y: -3..3 }, Boundary { x: 0, y: -3..3 }, Boundary { x: 1, y: -3..3 }, Boundary { x: 2, y: -2..2 }, Boundary { x: 3, y: -1..1 }, ];

Which could be represetned as in the following diagram. Where the dark grey square represents the origin, the green squares represent the lower bounds of the y range, and the red squares represent the upper bounds of the y range.

Off origin example

As noted the calculate function can be given cooradanates that offset the results from a (0,0) origin. If you pass in an offset like:

rust calculate(9, 3, 7);

This is returns the following vector:

rust vec![ Boundary { x: 2, y: 1..5 }, Boundary { x: 3, y: -1..7 }, Boundary { x: 4, y: -2..8 }, Boundary { x: 5, y: -3..9 }, Boundary { x: 6, y: -3..9 }, Boundary { x: 7, y: -4..10 }, Boundary { x: 8, y: -4..10 }, Boundary { x: 9, y: -4..10 }, Boundary { x: 10, y: -4..10 }, Boundary { x: 11, y: -4..10 }, Boundary { x: 12, y: -3..9 }, Boundary { x: 13, y: -3..9 }, Boundary { x: 14, y: -2..8 }, Boundary { x: 15, y: -1..7 }, Boundary { x: 16, y: 1..5 }, ];

Which represents the following circle boundry where the black square represents the (0,0) origin: