Gogeom - A Geometrical library for the Go programming language.

This is a Geometrical library for Go Language.
Which includes multiple Geometrical calculations like Circle, Lines etc in different forms.

Installation

Installation is done using go get.

go get -u github.com/MindorksOpenSource/gogeom

These are following shape calculation which is supported by gogeom.

• [x] Circle
• [x] Line
• [x] Ellipse
• [x] Parabola
• [x] Triangle
• [x] Quadrilaterals
• [x] N-agons(polygons)
• [ ] more to come..

Circle

gogeom can handle two form of Circle.

• Radius Form

  (x-a)^2 + (y-b)^2 = r^2 
  where,
  (a,b) is the center and "r" is the radius of the circle
  

• General Form

  x2 + y2 + Ax + By+ C = 0
  where,
  A,B and C are real numbers
  

Step to follow :

• import shape "github.com/MindorksOpenSource/gogeom"
• Initalize two circles as (in Radius Form),

import geometry "github.com/MindorksOpenSource/gogeom"

func main() {
    // (x-a)^2 + (y-b)^2 = r^2 and (x-c)^2 + (y-d)^2 = s^2  are circle equation
    // r, s are radius of two circles
r := shape.RadiusFormCircle{
        // a, b , r , c, d, s
        2, 3, 4, 5, 6, 7,
	}
}

• Initalize two circles as (in General Form),

import `shape "github.com/MindorksOpenSource/gogeom"

func main() {
// x2 + y2 + Ax + By+ C = 0 and  x2 + y2 + Dx + Ey + F = 0 are circle equation
g := shape.GeneralFormOfCircle{
        // a, b , r , c, d, s
        2, 3, 4, 5, 6, 7,
	}
}

Calculations for Circles

Line

gogeom can handle two form of Line.

• General Form

  Ax+By+C =0
  where A, B and C are any real number and A and B are not both zero.``` 
  

• Two Point Form

  (x1,y1) and (x2,y2) form two lines passing through it
  

  Step to follow :

• import shape "github.com/MindorksOpenSource/gogeom"

• Initalize two lines as (in General Form),

// initialise one line 
l := shape.GeneralLine{
        // a, b, c
        2, 3, 4,
	}
}

---- or if you have to initialise multiple line ----
l := shape.GeneralLines{
        // a, b, c, d, e, f
        2, 3, 4, 5, 6, 7,
	}
}
---- or if you have two point line ----
l := shape.GeneralLines{
        // a, b, c, d, e, f
        2, 3, 4, 5, 
	}
}

• Initalize two lines as (in Two Point Form Line Form),

Calculations for Line

Ellipse

Ellipse Equation,

x^2/a^2 + y^2/b^2 = 1,
(center at   x = 0   y = 0)

Step to follow :

• import shape "github.com/MindorksOpenSource/gogeom"
• Initalize ellipse,

e := shape.Ellipse {
        // a, b
        1,2
}

Parabola

Gogeom can support two form

• Equation of Parabola

  y^2 = 4ax
  or 
  x^2 = 4ay
  or 
  (y - k)^2 = 4a(x - h)
  where, (h,k) are vertex
  or
  (x - h)^2 = 4a(y - k)
  where, (h,k) are vertex

• import shape "github.com/MindorksOpenSource/gogeom"
• Initalize Parabola,

p := shape.Parabola {
        1,
        true // where this boolean value indicates if the parabola is on Y-Axis or not.
}
---- or ----

p :=shape.Parabola {
        1,
        true // where this boolean value indicates if the parabola is on Y-Axis or not.
}

Step to follow :

Triangle

Gogeom supports the following types of triangle and their respective calculations

• Right Angled Triangle
• Isosceles Triangle
• Equilateral Triangle
• Scalene Triangle

Step to follow :

• import shape "github.com/MindorksOpenSource/gogeom"
• Initialize triangles

//Right Triangle
rt := shape.RightTriangleSides {
	//base, height, hypotenuse
	4, 3, 5,
}

//Isosceles Triangle
it := shape.IsoscelesTriangleSides {
	//base, slants
	6,8,
}

//Equilateral Triangle
et := shape.EquilateralTriangleSides {
	//side
	6,
}

//Scalene Triangle
st := shape.ScaleneTriangleSides {
	//side1, side2, side3
	3,4,5,
}

Calculations for Triangles

Quadrilaterals

Gogeom supports the following types of quadrilaterals and their respective calculations

• Square
• Rectangle
• Parallelogram
• Trapezium/Trapezoid
• Rhombus
• Scalene Quadrilaterals

Step to follow :

• import shape "github.com/MindorksOpenSource/gogeom"
• Initialize quadrilaterals

//when Square sides are known
sqs := shape.SquareSides {
	//side
	4,
}

//when Square diagonals are known
sqd := shape.SquareDiagonals {
	//diagonal
	9,
}

//rectangle
rct := shape.RectangleSides {
	//length, breadth
	6,10,
}

//parallelogram
plg := shape.ParallelogramSides {
	//base, slant, height
	10,6,4.5,
}

//trapezium sides with height
tph := shape.TrapeziumSidesWithHeight {
	//base, top, height
	10,5,4.6,
}

//trapezium sides with slants
tps := shape.TrapeziumSidesWithSlants {
	//base, top, slant1, slant2
	10,5,5.2,5.7,
}

//rhombus with diagonals are known
rmd := shape.RhombusDiagonals {
	//diagonal1, diagonal2
	10,8,
}

//rhombus with sides and height known
rms := shape.RhombusSides {
	//side, height
	8,7,
}

//scalene quadrilateral
scq := shape.ScaleneQuadrilateralSides {
	//side1, side2, side3, side4
	4,8,6,5,
}

Calculations for Quadrilaterals

N-Agon

Gogeom can handle any polygon with given their number of sides, length of sides and apothem of the shape.

Step to follow :

• import shape "github.com/MindorksOpenSource/gogeom"
• Initialize n-agon

//if polygon
n := shape.CountAndLengthAndApothemOfAgonSide {
	//side_count, side_length, side_apothem
	5,6,4.2,
}

//OR, if hexagon
n := shape.CountAndLengthAndApothemOfAgonSide {
	//side_count, side_length, side_apothem
	6,6,4.6,
}

Calculations for n-agon (polygons)

TODO

• More features related to Geometrical Functions

If this library helps you in anyway, show your love ❤️ by putting a ⭐️ on this project ✌️

Check out Mindorks awesome open source projects here

Contributor

Himanshu Singh
Nishchal Raj

License

   Copyright (C) 2018 MINDORKS NEXTGEN PRIVATE LIMITED

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.