Modified file structure, added readme

F23-CS131-YUEN-17240 · Dec 4, 2023 · 175bdcb · 175bdcb
1 parent a830f8a
commit 175bdcb
Show file tree

Hide file tree

Showing 12 changed files with 29 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -6,5 +6,5 @@ REFERENCES
 - J.Sawada, "Generating bracelets in constant amortized time,", Society for Industrial and Applied Mathematics 31, No.1 (2001) 259-268
 - J.Davies, “Combinatorial Necklaces and Bracelets”, www.jasondavies.com/necklaces, Accessed 15 Nov. 2023
 
-
+[Necklace Generator](https://f23-cs131-yuen-17240.github.io/DL_Project_Yeunha_Kim/)
 [Presentation](https://www.youtube.com/watch?v=zEdcliSFmLo)
diff --git a/docs/Project_Brief.md b/docs/Project_Brief.md
@@ -0,0 +1,4 @@
+### Brief
+
+In the `src` folder, the source codes for getting unique bracelets and necklaces are listed.
+A little bit of a modification to the original algorithm was necessary, but the backbone of the algorithms are the same as Sawada and FKM algorithm.
diff --git a/docs/References.md b/docs/References.md
@@ -0,0 +1,7 @@
+### REFERENCES
+
+- H. Fredricksen and I. J. Kessler, "An algorithm for generating necklaces of beads in two colors," Discrete Mathematics 61 (1986) 181-188
+- H. Fredricksen and J. Maiorana, "Necklaces of beads in k colors and k-ary de Bruijn sequences," Discrete Mathematics 23, No. 3 (1978) 207-210
+- F. Ruskey, C. Savage, and T. Wang, "Generating Necklaces," Journal of Algorithms 13, No.3 (1992) 414-430
+- J.Sawada, "Generating bracelets in constant amortized time,", Society for Industrial and Applied Mathematics 31, No.1 (2001) 259-268
+- J.Davies, “Combinatorial Necklaces and Bracelets”, www.jasondavies.com/necklaces, Accessed 15 Nov. 2023
diff --git a/presentation/Yeunha_DL_Presentation.mp4 b/presentation/Yeunha_DL_Presentation.mp4
diff --git a/src/README.md b/src/README.md
@@ -0,0 +1,17 @@
+[Necklace Generator](https://f23-cs131-yuen-17240.github.io/DL_Project_Yeunha_Kim/)
+
+### generate.js
+
+This file contains the main javascript function that calls getBracelets or gerNecklace based on user inputs.
+
+### getBracelets.js
+
+The function getBracelets returns a 2D array, where each sub array represents a single unique arrangement.
+
+### getNecklaces.js
+
+The function getNecklaces returns a 2D array, where each sub array represents a single unique arrangement.
+
+### linearFinite.js and linearInfinite.js
+
+While these are not really important functions of the project, I decided to include these two files as well, since I used it as a part of the presentation.
diff --git a/generate.js → src/generate.js b/generate.js → src/generate.js
diff --git a/getBracelets.js → src/getBracelets.js b/getBracelets.js → src/getBracelets.js
diff --git a/getNecklaces.js → src/getNecklaces.js b/getNecklaces.js → src/getNecklaces.js
diff --git a/index.html → src/index.html b/index.html → src/index.html
diff --git a/linearFinite.js → src/linearFinite.js b/linearFinite.js → src/linearFinite.js
diff --git a/linearInfinite.js → src/linearInfinite.js b/linearInfinite.js → src/linearInfinite.js
diff --git a/style.css → src/style.css b/style.css → src/style.css