Update docs

Author: tomas-novotny

CHANGELOG.md

@@ -10,3 +10,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - `Point`
 - `Vector`
+- `Size`
+- `Line`
+- `Circle`
+- `Rectangle`
+- `Polygon`
+- `RegularPolygon`

README.md

@@ -3,7 +3,6 @@
 [![Latest Stable Version][ico-release]][link-release]
 [![Build Status][ico-workflow]][link-workflow]
 [![Coverage Status][ico-coverage]][link-coverage]
-[![Quality Score][ico-code-quality]][link-code-quality]
 [![Go Report Card][ico-go-report-card]][link-go-report-card]
 [![Go Dev Reference][ico-go-dev-reference]][link-go-dev-reference]
 [![Software License][ico-license]][link-licence]
@@ -28,6 +27,191 @@ import (
 )
 ```
 
+## API
+
+All types and methods are generic and can be used with any numeric type.
+
+```go
+type Number interface {
+    ~int | ~int8 | ~int16 | ~int32 | ~int64 | ~float32 | ~float64
+}
+```
+
+### Point
+
+```go
+type Point[T Number] struct{ 
+	X, Y T 
+}
+
+// Properties
+func (p Point[T]) XY() (T, T)
+
+// Mathematical operations
+func (p Point[T]) Add(vector Vector[T]) Point[T
+func (p Point[T]) AddXY(deltaX, deltaY T) Point[T
+func (p Point[T]) Subtract(other Point[T]) Vector[T] 
+func (p Point[T]) Multiply(scale float64) Point[T]
+func (p Point[T]) MultiplyXY(scaleX, scaleY float64) Point[T]
+func (p Point[T]) Divide(scale float64) Point[T]
+func (p Point[T]) DivideXY(scaleX, scaleY float64) Point[T]
+
+// Geometric operations
+func (p Point[T]) DistanceTo(point Point[T]) float64
+func (p Point[T]) DistanceSquaredTo(point Point[T]) T
+func (p Point[T]) Midpoint(point Point[T]) Point[T]
+func (p Point[T]) Lerp(point Point[T], t float64) Point[T]
+func (p Point[T]) AngleTo(point Point[T]) float64
+
+// Utilities
+func (p Point[T]) Equal(point Point[T]) bool
+func (p Point[T]) Zero() bool
+```
+
+### Vector
+
+```go
+type Vector[T Number] struct { 
+	X, Y T 
+}
+
+// Properties
+func (v Vector[T]) XY() (T, T)
+
+// Mathematical operations
+func (v Vector[T]) Add(vector Vector[T]) Vector[T]
+func (v Vector[T]) AddXY(deltaX, deltaY T) Vector[T]
+func (v Vector[T]) Sub(vector Vector[T]) Vector[T]
+func (v Vector[T]) SubXY(deltaX, deltaY T) Vector[T]
+func (v Vector[T]) Multiply(scale float64) Vector[T]
+func (v Vector[T]) MultiplyXY(scaleX, scaleY float64) Vector[T]
+func (v Vector[T]) Divide(scale float64) Vector[T]
+func (v Vector[T]) DivideXY(scaleX, scaleY float64) Vector[T]
+func (v Vector[T]) Negate() Vector[T]
+
+// Vector operations
+func (v Vector) Dot(vector Vector[T]) float64
+func (v Vector) Cross(vector Vector[T]) float64
+func (v Vector) Length() float64
+func (v Vector) LengthSquared() T
+func (v Vector) Normalize() Vector[T]
+func (v Vector) Angle() float64
+
+// Transformations
+func (v Vector) Rotate(angle float64) Vector[T]
+func (v Vector) Normal() Vector[T]
+
+// Utilities
+func (v Vector) Equal(vector Vector) bool
+func (v Vector) Zero() bool
+```
+
+### Size
+
+```go
+type Size[T Number] struct { 
+	Width, Height T
+}
+
+// Properties
+func (s Size[T]) XY() (T, T)
+func (s Size[T]) Area() float64
+func (s Size[T]) Perimeter() T
+func (s Size[T]) AspectRatio() float64
+
+
+// Dimension operations
+func (s Size[T]) Scaled(factor float64) Size[T]
+func (s Size[T]) ScaledXY(scaleX, scaleY float64) Size[T]
+func (s Size[T]) Expand(deltaWidth, deltaHeight T) Size[T]
+func (s Size[T]) Shrunk(deltaWidth, deltaHeight T) Size [T]
+
+// Utilities
+func (s Size) Equal(other Size[T]) bool
+func (s Size) Zero() bool
+```
+
+### Circle
+
+```go
+type Circle[T Number] struct { 
+    Center Point[T]
+    Radius T
+}
+
+// Properties
+func (c Circle[T]) Area() float64
+func (c Circle[T]) Circumference() float64
+func (c Circle[T]) Diameter() T
+func (c Circle[T]) Bounds() Rectangle[T]
+
+// Transformations
+func (c Circle[T]) Translate(vector Vector) Circle[T]
+func (c Circle[T]) MoveTo(center Point) Circle[T]
+func (c Circle[T]) Scale(factor float64) Circle[T]
+
+// Size operations
+func (c Circle[T]) Resize(radius T) Circle[T]
+func (c Circle[T]) Expand(amount T) Circle[T]
+func (c Circle[T]) Shrunk(amount T) Circle[T]
+
+// Geometric queries
+func (c Circle[T]) Contains(point Point[T]) bool
+
+// Utilities
+func (c Circle) Equal(circle Circle) bool
+```
+
+### Rectangle
+
+```go
+type Rectangle[T Number] struct{
+    Center Point[T]
+    Size   Size[T]
+}
+```
+
+### Line
+
+```go
+type Line[T Number] struct{
+    Start Point[T]
+    End   Point[T]
+}
+```
+
+### Polygon
+
+```go
+type Polygon[T Number] struct{
+    Vertices []Point[T]
+}
+```
+
+### Regular Polygon
+
+```go
+type RegularPolygon[T Number] struct {
+    Center Point[T]
+    Size   Size[T]
+    N      int
+}
+```
+
+### Constructor Functions
+
+Short constructors for convenience
+
+```go
+func P(x, y T) Point[T]
+func V(x, y T) Vector[T]
+func S(w, h T) Size[T]
+func C(center Point[T], radius T) Circle[T]
+func R(center Point[T], size Size[T]) Rectangle[T]
+func L(start, end Point[T]) Line[T]
+func RP(center Point[T], size Size[T], n int) RegularPolygon[T]
+```
+
 
 ## Credits
 
@@ -45,8 +229,7 @@ The MIT License (MIT). Please see [License File][link-licence] for more informat
 [ico-release]:              https://img.shields.io/github/v/release/gravitton/geometry?style=flat-square&colorB=blue
 [ico-go-dev-reference]:     https://img.shields.io/badge/go.dev-reference-blue?style=flat-square
 [ico-go-report-card]:       https://goreportcard.com/badge/github.com/gravitton/geometry?style=flat-square
-[ico-coverage]:             https://img.shields.io/scrutinizer/coverage/g/gravitton/geometry/main.svg?style=flat-square
-[ico-code-quality]:         https://img.shields.io/scrutinizer/g/gravitton/geometry.svg?style=flat-square
+[ico-coverage]:             https://img.shields.io/coverallsCoverage/github/gravitton/assert?style=flat-square
 
 [link-author]:              https://github.com/gravitton
 [link-release]:             https://github.com/gravitton/geometry/releases
@@ -56,5 +239,4 @@ The MIT License (MIT). Please see [License File][link-licence] for more informat
 [link-workflow]:            https://github.com/gravitton/geometry/actions
 [link-go-dev-reference]:    https://pkg.go.dev/github.com/gravitton/geometry
 [link-go-report-card]:      https://goreportcard.com/report/github.com/gravitton/geometry
-[link-coverage]:            https://scrutinizer-ci.com/g/gravitton/geometry/code-structure
-[link-code-quality]:        https://scrutinizer-ci.com/g/gravitton/geometry
+[link-coverage]:            https://coveralls.io/github/gravitton/geometry

point.go

@@ -55,8 +55,8 @@ func (p Point[T]) DistanceTo(point Point[T]) float64 {
 	return point.Subtract(p).Length()
 }
 
-// DistanceToSquared return euclidean distance squared (for faster comparison) from the current point to the given point.
-func (p Point[T]) DistanceToSquared(point Point[T]) T {
+// DistanceSquaredTo return euclidean distance squared (for faster comparison) from the current point to the given point.
+func (p Point[T]) DistanceSquaredTo(point Point[T]) T {
 	return point.Subtract(p).LengthSquared()
 }
 

point_test.go

@@ -56,9 +56,9 @@ func TestPoint_DistanceTo(t *testing.T) {
 	assert.EqualDelta(t, P(0.4, -0.25).DistanceTo(P(0.5, -0.35)), math.Sqrt(0.02), Delta)
 }
 
-func TestPoint_DistanceToSquared(t *testing.T) {
-	assert.Equal(t, P(1, 2).DistanceToSquared(P(2, 3)), 2)
-	assert.EqualDelta(t, P(0.4, -0.25).DistanceToSquared(P(0.5, -0.35)), 0.02, Delta)
+func TestPoint_DistanceSquaredTo(t *testing.T) {
+	assert.Equal(t, P(1, 2).DistanceSquaredTo(P(2, 3)), 2)
+	assert.EqualDelta(t, P(0.4, -0.25).DistanceSquaredTo(P(0.5, -0.35)), 0.02, Delta)
 }
 
 func TestPoint_AngleTo(t *testing.T) {