Move problem description to test files (#80)

Author: spring1843

backtracking/generate_parenthesis.go

@@ -1,6 +1,6 @@
 package backtracking
 
-// GenerateParenthesis returns all possible variation of n pairs of valid parenthesis.
+// GenerateParenthesis solves the problem in O(2^n) time and O(n) space.
 func GenerateParenthesis(n int) []string {
 	return generateParenthesisRecursive([]string{}, "", 0, 0, n)
 }

backtracking/generate_parenthesis_test.go

@@ -6,6 +6,13 @@ import (
 	"testing"
 )
 
+/*
+TestGenerateParenthesis tests solution(s) with the following signature and problem description:
+
+	GenerateParenthesis(n int) []string
+
+Returns all possible variation of n pairs of valid parenthesis.
+*/
 func TestGenerateParenthesis(t *testing.T) {
 	tests := []struct {
 		n                int

backtracking/n_queens.go

@@ -8,8 +8,7 @@ const (
 // Chessboard represents a chessboard.
 type Chessboard [][]int
 
-// NQueens returns possible solutions to the n-queen puzzle in an n x n chessboard
-// where n queens are placed on the chessboard such that none attacks another.
+// NQueens solves the problem in O(n!) time and O(n) space.
 func NQueens(n int) []Chessboard {
 	output := nQueensRecursive(0, n, make([]int, n), make(Chessboard, 0))
 	return toPrettyChessboard(output, n)

backtracking/n_queens_test.go

@@ -5,6 +5,14 @@ import (
 	"testing"
 )
 
+/*
+TestNQueens tests solution(s) with the following signature and problem description:
+
+	func NQueens(n int) []Chessboard
+
+Returns possible solutions to the n-queen puzzle in an n x n chessboard
+where n queens are placed on the chessboard such that none attacks another.
+*/
 func TestNQueens(t *testing.T) {
 	tests := []struct {
 		n         int

backtracking/permutations.go

@@ -1,7 +1,6 @@
 package backtracking
 
-// Permutations intakes a list of numbers and returns all possible permutations of their orders
-// For example for {1,2} it would return {1,2}, {2,1}.
+// Permutations solves the problem in O(n!) time and O(n) space.
 func Permutations(input []int) [][]int {
 	permutations := make([][]int, 0)
 	permutationsRecursive(input, 0, &permutations)

backtracking/permutations_test.go

@@ -5,6 +5,14 @@ import (
 	"testing"
 )
 
+/*
+TestPermutations tests solution(s) with the following signature and problem description:
+
+	func Permutations(input []int) [][]int {
+
+Intakes a list of numbers and returns all possible permutations of their orders
+For example for {1,2} it would return {1,2}, {2,1}.
+*/
 func TestPermutations(t *testing.T) {
 	tests := []struct {
 		nums         []int

backtracking/phone_letter_combinations.go

@@ -11,8 +11,7 @@ var phone = map[byte]string{
 	'9': "wxyz",
 }
 
-// PhoneLetterCombinations intakes the digits from 2 to 9 that represent phone buttons
-// and returns all possible combinations of letters that could be generated from those.
+// PhoneLetterCombinations solves the problem in O(3^n) time and O(3^n) space.
 func PhoneLetterCombinations(digits string) []string {
 	combinations := []string{}
 	if len(digits) > 0 {

backtracking/phone_letter_combinations_test.go

@@ -6,6 +6,14 @@ import (
 	"testing"
 )
 
+/*
+TestPhoneLetterCombinations tests solution(s) with the following signature and problem description:
+
+	func PhoneLetterCombinations(digits string) []string
+
+Intakes the digits from 2 to 9 that represent phone buttons
+and returns all possible combinations of letters that could be generated from those.
+*/
 func TestPhoneLetterCombinations(t *testing.T) {
 	tests := []struct {
 		digits       string

backtracking/sudoku.go

@@ -1,8 +1,6 @@
 package backtracking
 
-// Sudoku solves a given partially filled or empty 9x9 Soduku board by placing
-// integers between 1 and 9 in empty spot designated by 0 such that
-// In each row, column, and 3x3 sub square the values are unique.
+// Sudoku solves the problem in O(9^(n*n)) time and O(n*n) space.
 func Sudoku(board [][]int) bool {
 	for i := 0; i < len(board); i++ {
 		for j := 0; j < len(board[0]); j++ {

backtracking/sudoku_test.go

@@ -10,6 +10,15 @@ type boardAndSolution struct {
 	solution [][]int
 }
 
+/*
+TestSudoku tests solution(s) with the following signature and problem description:
+
+	func Sudoku(board [][]int) bool {
+
+Solves a given partially filled or empty 9x9 Sudoku board by placing integers
+between 1 and 9 in empty spot designated by 0 such that In each row, column, and
+3x3 sub square the values are unique.
+*/
 func TestSudoku(t *testing.T) {
 	tests := []boardAndSolution{
 		testBoard1(),