doc: fix: Added documentations that works with the autogenerated documentation (TheAlgorithms#339)

* doc: fix: Add documentation that works with the autogenerated documentation

* Update go.mod to accept go version 1.17

* test: add a few tests for one of the issues

Author: tjgurwara99

ciphers/caesar/caesar.go renamed to cipher/caesar/caesar.go

@@ -0,0 +1,2 @@
+// Package cipher is a package containing different implementations of certain ciphers
+package cipher

ciphers/caesar/caesar_test.go renamed to cipher/caesar/caesar_test.go

@@ -3,7 +3,7 @@
 package rot13
 
 import (
-	"github.com/TheAlgorithms/Go/ciphers/caesar"
+	"github.com/TheAlgorithms/Go/cipher/caesar"
 )
 
 // rot13 is a special case, which is fixed the shift of 13, of the Caesar cipher

ciphers/diffiehellman/diffiehellmankeyexchange.go renamed to cipher/diffiehellman/diffiehellmankeyexchange.go

@@ -0,0 +1,2 @@
+// Package conversion is a package of implementations which converts one data structure to another.
+package conversion

ciphers/diffiehellman/diffiehellmankeyexchange_test.go renamed to cipher/diffiehellman/diffiehellmankeyexchange_test.go

@@ -1,11 +1,10 @@
-/*
-This algorithm will convert a standard roman number to an integer
-https://en.wikipedia.org/wiki/Roman_numerals
-Function receives a string as a roman number and outputs an integer
-Maximum output will be 3999
-Only standard form is supported
-*/
-package conversions
+// This algorithm will convert a standard roman number to an integer
+// https://en.wikipedia.org/wiki/Roman_numerals
+// Function receives a string as a roman number and outputs an integer
+// Maximum output will be 3999
+// Only standard form is supported
+
+package conversion
 
 var romans = map[string]int{"I": 1, "V": 5, "X": 10, "L": 50, "C": 100, "D": 500, "M": 1000}
 

cipher/doc.go

@@ -1,4 +1,4 @@
-package conversions
+package conversion
 
 import "testing"
 

ciphers/polybius/polybius.go renamed to cipher/polybius/polybius.go

@@ -0,0 +1,2 @@
+// Package dynamic is a package of certain implementations of dynamically run algorithms.
+package dynamic

ciphers/polybius/polybius_test.go renamed to cipher/polybius/polybius_test.go

@@ -2,7 +2,6 @@
 // https://en.wikipedia.org/wiki/Matrix_chain_multiplication
 // www.geeksforgeeks.org/dynamic_programming-set-8-matrix-chain-multiplication/
 
-// Package dynamic_programming Package for dynamically run algorithms
 package dynamic
 
 // MatrixChainRec function

ciphers/rot13/rot13.go renamed to cipher/rot13/rot13.go

@@ -1,3 +1,3 @@
 module github.com/TheAlgorithms/Go
 
-go 1.15
+go 1.17

ciphers/rot13/rot13_test.go renamed to cipher/rot13/rot13_test.go

@@ -1,5 +1,3 @@
-// Package graph demonstates Graph search algorithms
-// reference: https://en.wikipedia.org/wiki/Tree_traversal
 package graph
 
 // BreadthFirstSearch is an algorithm for traversing and searching graph data structures.

ciphers/rsa/rsa.go renamed to cipher/rsa/rsa.go

@@ -0,0 +1,3 @@
+// Package graph demonstates Graph search algorithms
+// reference: https://en.wikipedia.org/wiki/Tree_traversal
+package graph

ciphers/rsa/rsa_test.go renamed to cipher/rsa/rsa_test.go

@@ -0,0 +1,2 @@
+// Package math is a package that contains mathematical algorithms and its different implementations.
+package math

ciphers/xor/xor.go renamed to cipher/xor/xor.go

@@ -0,0 +1,3 @@
+// Empty test file to keep track of all the tests for the algorithms.
+
+package math

ciphers/xor/xor_test.go renamed to cipher/xor/xor_test.go

@@ -0,0 +1,10 @@
+package max
+
+// Int gives max of two integers
+// defining it here to be used in other subpackages of the repo.
+func Int(x int, y int) int {
+	if x < y {
+		return y
+	}
+	return x
+}

conversion/doc.go

@@ -0,0 +1,35 @@
+package max
+
+import "testing"
+
+func TestMax(t *testing.T) {
+	testCases := []struct {
+		name  string
+		left  int
+		right int
+		max   int
+	}{
+		{
+			name:  "Left is max",
+			left:  10,
+			right: 9,
+			max:   10,
+		},
+		{
+			name:  "right is max",
+			left:  1,
+			right: 10,
+			max:   10,
+		},
+	}
+
+	for _, test := range testCases {
+		t.Run(test.name, func(t *testing.T) {
+			returnedMax := Int(test.left, test.right)
+			if returnedMax != test.max {
+				t.Errorf("Failed test %s\n\tleft: %v, right: %v, max: %v but received: %v",
+					test.name, test.left, test.right, test.max, returnedMax)
+			}
+		})
+	}
+}

conversions/romantointeger.go renamed to conversion/romantointeger.go

@@ -0,0 +1,3 @@
+// Package other is dedicated to algorithms that
+// do not quite fit into any of the other subpackages in this repository.
+package other

conversions/romantointeger_test.go renamed to conversion/romantointeger_test.go

@@ -1,28 +1,25 @@
 /* O(n) solution, for calculating
 maximum contiguous sum in the given array. */
 
+// Package maxsubarraysum is a package containing a solution to a common
+// problem of finding max contigious sum within a array of ints.
 package maxsubarraysum
 
-// Max - already defined somewhere in this repository TODO: remove this definition and add the import path
-func Max(x int, y int) int {
-	if x < y {
-		return y
-	}
-	return x
-}
+import (
+	"github.com/TheAlgorithms/Go/math/max"
+)
 
 // MaxSubarraySum returns the maximum subarray sum
 func MaxSubarraySum(array []int) int {
-	var currentMax int = 0
-	var maxTillNow int = 0
+	var currentMax int
+	var maxTillNow int
+	if len(array) != 0 {
+		currentMax = array[0]
+		maxTillNow = array[0]
+	}
 	for _, v := range array {
-		currentMax = Max(v, currentMax+v)
-		maxTillNow = Max(maxTillNow, currentMax)
+		currentMax = max.Int(v, currentMax+v)
+		maxTillNow = max.Int(maxTillNow, currentMax)
 	}
 	return maxTillNow
 }
-
-// func main() {
-// 	array := []int{-2, -5, 6, 0, -2, 0, -3, 1, 0, 5, -6}
-// 	fmt.Println("Maximum contiguous sum: ", maxSubarraySum(array))
-// }

dynamic/doc.go

@@ -0,0 +1,41 @@
+package maxsubarraysum
+
+import (
+	"testing"
+)
+
+func TestMaxSubarraySum(t *testing.T) {
+	testCases := []struct {
+		name     string
+		slice    []int
+		expected int
+	}{
+		{
+			name:     "Empty slice",
+			slice:    []int{},
+			expected: 0,
+		},
+		{
+			name:     "Max is 0",
+			slice:    []int{0, -1, -2, -4, -5},
+			expected: 0,
+		},
+		{
+			name:     "Max is -1",
+			slice:    []int{-1, -3, -2, -5, -7},
+			expected: -1,
+		},
+		{
+			name:     "Max is 7",
+			slice:    []int{-2, -5, 6, 0, -2, 0, -3, 1, 0, 5, -6},
+			expected: 7,
+		},
+	}
+	for _, test := range testCases {
+		t.Run(test.name, func(t *testing.T) {
+			if result := MaxSubarraySum(test.slice); result != test.expected {
+				t.Fatalf("%s\n\tslice: %v, expected: %v, returned: %v", test.name, test.slice, test.expected, result)
+			}
+		})
+	}
+}

dynamic/matrixmultiplication.go

@@ -1,4 +1,4 @@
-// Package nested_brackets provides functions for testing
+// Package nested provides functions for testing
 // strings propper brackets nesting.
 package nested
 

go.mod

@@ -2,7 +2,8 @@
 // You must provide a minimum length and a maximum length
 // This length is not fixed if you generate multiple passwords for the same range
 
-package password_generator
+// Package password contains functions to help generate random passwords
+package password
 
 import (
 	"crypto/rand"

graph/breadthfirstsearch.go

@@ -0,0 +1,2 @@
+// Package search is a subpackage dedicated to all searching algorithms related to slices/arrays.
+package search

graph/doc.go

@@ -0,0 +1,3 @@
+// Package strings is a package that contains all algorithms
+// that are used to analyse and manipulate strings.
+package strings

math/doc.go

@@ -0,0 +1,4 @@
+// Package structure is a subpackage that is dedicated to
+// different implementations of data structures in the
+// domain of computer science.
+package structure