+
+
diff --git a/C#/LevenshteinRatio.Tests/LevenshteinRatio.Tests.csproj b/C#/LevenshteinRatio.Tests/LevenshteinRatio.Tests.csproj
new file mode 100644
index 0000000..b441aa7
--- /dev/null
+++ b/C#/LevenshteinRatio.Tests/LevenshteinRatio.Tests.csproj
@@ -0,0 +1,25 @@
+
+
+
+ net9.0
+ enable
+ enable
+ false
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/C#/LevenshteinRatio.Tests/UnitTest1.cs b/C#/LevenshteinRatio.Tests/UnitTest1.cs
new file mode 100644
index 0000000..c00f093
--- /dev/null
+++ b/C#/LevenshteinRatio.Tests/UnitTest1.cs
@@ -0,0 +1,82 @@
+namespace LevenshteinRatio.Tests;
+
+using Xunit;
+using LevenshteinRatio;
+
+public class UnitTest1Test
+{
+ [Fact]
+ public void Test_LevenshteinRatio_EqualStrings()
+ {
+ // Arrange
+ string str1 = "test";
+ string str2 = "test";
+ double expectedRatio = 1.0;
+
+ // Act
+ double actualRatio = Levenshtein.Ratio(str1, str2);
+
+ // Assert
+ Assert.Equal(expectedRatio, actualRatio);
+ }
+
+ [Fact]
+ public void Test_LevenshteinRatio_CompletelyDifferentStrings()
+ {
+ // Arrange
+ string str1 = "test";
+ string str2 = "abcd";
+ double expectedRatio = 0.0;
+
+ // Act
+ double actualRatio = Levenshtein.Ratio(str1, str2);
+
+ // Assert
+ Assert.Equal(expectedRatio, actualRatio);
+ }
+
+ [Fact]
+ public void Test_LevenshteinRatio_SimilarStrings()
+ {
+ // Arrange
+ string str1 = "kitten";
+ string str2 = "sitting";
+ double expectedRatio = 0.5714285714285714; // Example ratio
+
+ // Act
+ double actualRatio = Levenshtein.Ratio(str1, str2);
+
+ // Assert
+ Assert.Equal(expectedRatio, actualRatio, 5);
+ }
+
+ [Fact]
+ public void Test_LevenshteinRatio_EmptyStrings()
+ {
+ // Arrange
+ string str1 = "";
+ string str2 = "";
+ double expectedRatio = 1.0;
+
+ // Act
+ double actualRatio = Levenshtein.Ratio(str1, str2);
+
+ // Assert
+ Assert.Equal(expectedRatio, actualRatio);
+ }
+
+ [Fact]
+ public void Test_LevenshteinRatio_OneEmptyString()
+ {
+ // Arrange
+ string str1 = "test";
+ string str2 = "";
+ double expectedRatio = 0.0;
+
+ // Act
+ double actualRatio = Levenshtein.Ratio(str1, str2);
+
+ // Assert
+ Assert.Equal(expectedRatio, actualRatio);
+ }
+}
\ No newline at end of file
diff --git a/C#/LevenshteinRatio.sln b/C#/LevenshteinRatio.sln
new file mode 100644
index 0000000..83f1116
--- /dev/null
+++ b/C#/LevenshteinRatio.sln
@@ -0,0 +1,62 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.0.31903.59
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "LevenshteinRatio", "LevenshteinRatio\LevenshteinRatio.csproj", "{9F685456-3336-422F-8F4F-1800C80DB10C}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Console", "Console\Console.csproj", "{B49DD477-1671-4FA1-87EC-5E0BFA76C3B4}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "LevenshteinRatio.Tests", "LevenshteinRatio.Tests\LevenshteinRatio.Tests.csproj", "{406046CF-F612-4E57-8DCD-31C4A2B1D455}"
+EndProject
+Global
+ GlobalSection(SolutionConfigurationPlatforms) = preSolution
+ Debug|Any CPU = Debug|Any CPU
+ Debug|x64 = Debug|x64
+ Debug|x86 = Debug|x86
+ Release|Any CPU = Release|Any CPU
+ Release|x64 = Release|x64
+ Release|x86 = Release|x86
+ EndGlobalSection
+ GlobalSection(ProjectConfigurationPlatforms) = postSolution
+ {9F685456-3336-422F-8F4F-1800C80DB10C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {9F685456-3336-422F-8F4F-1800C80DB10C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {9F685456-3336-422F-8F4F-1800C80DB10C}.Debug|x64.ActiveCfg = Debug|Any CPU
+ {9F685456-3336-422F-8F4F-1800C80DB10C}.Debug|x64.Build.0 = Debug|Any CPU
+ {9F685456-3336-422F-8F4F-1800C80DB10C}.Debug|x86.ActiveCfg = Debug|Any CPU
+ {9F685456-3336-422F-8F4F-1800C80DB10C}.Debug|x86.Build.0 = Debug|Any CPU
+ {9F685456-3336-422F-8F4F-1800C80DB10C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {9F685456-3336-422F-8F4F-1800C80DB10C}.Release|Any CPU.Build.0 = Release|Any CPU
+ {9F685456-3336-422F-8F4F-1800C80DB10C}.Release|x64.ActiveCfg = Release|Any CPU
+ {9F685456-3336-422F-8F4F-1800C80DB10C}.Release|x64.Build.0 = Release|Any CPU
+ {9F685456-3336-422F-8F4F-1800C80DB10C}.Release|x86.ActiveCfg = Release|Any CPU
+ {9F685456-3336-422F-8F4F-1800C80DB10C}.Release|x86.Build.0 = Release|Any CPU
+ {B49DD477-1671-4FA1-87EC-5E0BFA76C3B4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {B49DD477-1671-4FA1-87EC-5E0BFA76C3B4}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {B49DD477-1671-4FA1-87EC-5E0BFA76C3B4}.Debug|x64.ActiveCfg = Debug|Any CPU
+ {B49DD477-1671-4FA1-87EC-5E0BFA76C3B4}.Debug|x64.Build.0 = Debug|Any CPU
+ {B49DD477-1671-4FA1-87EC-5E0BFA76C3B4}.Debug|x86.ActiveCfg = Debug|Any CPU
+ {B49DD477-1671-4FA1-87EC-5E0BFA76C3B4}.Debug|x86.Build.0 = Debug|Any CPU
+ {B49DD477-1671-4FA1-87EC-5E0BFA76C3B4}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {B49DD477-1671-4FA1-87EC-5E0BFA76C3B4}.Release|Any CPU.Build.0 = Release|Any CPU
+ {B49DD477-1671-4FA1-87EC-5E0BFA76C3B4}.Release|x64.ActiveCfg = Release|Any CPU
+ {B49DD477-1671-4FA1-87EC-5E0BFA76C3B4}.Release|x64.Build.0 = Release|Any CPU
+ {B49DD477-1671-4FA1-87EC-5E0BFA76C3B4}.Release|x86.ActiveCfg = Release|Any CPU
+ {B49DD477-1671-4FA1-87EC-5E0BFA76C3B4}.Release|x86.Build.0 = Release|Any CPU
+ {406046CF-F612-4E57-8DCD-31C4A2B1D455}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {406046CF-F612-4E57-8DCD-31C4A2B1D455}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {406046CF-F612-4E57-8DCD-31C4A2B1D455}.Debug|x64.ActiveCfg = Debug|Any CPU
+ {406046CF-F612-4E57-8DCD-31C4A2B1D455}.Debug|x64.Build.0 = Debug|Any CPU
+ {406046CF-F612-4E57-8DCD-31C4A2B1D455}.Debug|x86.ActiveCfg = Debug|Any CPU
+ {406046CF-F612-4E57-8DCD-31C4A2B1D455}.Debug|x86.Build.0 = Debug|Any CPU
+ {406046CF-F612-4E57-8DCD-31C4A2B1D455}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {406046CF-F612-4E57-8DCD-31C4A2B1D455}.Release|Any CPU.Build.0 = Release|Any CPU
+ {406046CF-F612-4E57-8DCD-31C4A2B1D455}.Release|x64.ActiveCfg = Release|Any CPU
+ {406046CF-F612-4E57-8DCD-31C4A2B1D455}.Release|x64.Build.0 = Release|Any CPU
+ {406046CF-F612-4E57-8DCD-31C4A2B1D455}.Release|x86.ActiveCfg = Release|Any CPU
+ {406046CF-F612-4E57-8DCD-31C4A2B1D455}.Release|x86.Build.0 = Release|Any CPU
+ EndGlobalSection
+ GlobalSection(SolutionProperties) = preSolution
+ HideSolutionNode = FALSE
+ EndGlobalSection
+EndGlobal
diff --git a/C#/LevenshteinRatio/LevenshteinRatio.cs b/C#/LevenshteinRatio/LevenshteinRatio.cs
new file mode 100644
index 0000000..318e60f
--- /dev/null
+++ b/C#/LevenshteinRatio/LevenshteinRatio.cs
@@ -0,0 +1,61 @@
+namespace LevenshteinRatio;
+
+public static class Levenshtein {
+ ///
+ /// Compare to using Levenshtein Ratio.
+ ///
+ /// The string to compare with .
+ /// The string to compare with .
+ /// The Levenshtein distance ratio between and .
+ ///
+ ///
+ /// float ratio = Levenshtein.Ratio("exampel", "example");
+ /// // ratio => 0.85714287
+ ///
+ ///
+ public static float Ratio(string target, string source) {
+ // edge cases: source or target is empty, source equals target
+ if (source == target) {
+ return 1;
+ }
+
+ if (string.IsNullOrEmpty(source) || string.IsNullOrEmpty(target)) {
+ return 0;
+ }
+
+ // create array to store the distances between each character in the source and target strings
+ var distance = new int[source.Length + 1, target.Length + 1];
+
+ // Populate the distance matrix
+ for (int i = 0; i <= source.Length; i++) {
+ distance[i, 0] = i;
+ }
+
+ for (int i = 0; i <= target.Length; i++) {
+ distance[0, i] = i;
+ }
+
+ // Fill the rows and columns of the distance matrix by comparing the characters in the source
+ // and target strings and calculating the cost (1 if characters are the same)
+ for (int i = 1; i <= source.Length; i++) {
+ for (int j = 1; j <= target.Length; j++) {
+ int cost = target[j - 1] == source[i - 1] ? 0 : 1;
+
+ distance[i, j] =
+ Math.Min(
+ Math.Min(
+ distance[i - 1, j] + 1,
+ distance[i, j - 1] + 1
+ ),
+ distance[i - 1, j - 1] + cost
+ );
+ }
+ }
+
+ // Calculate the ratio of similarity by dividing the distance by the maximum length
+ // of the two strings and subtracting the result from 1.0
+ var distanceAsFloat = Convert.ToSingle(distance[source.Length, target.Length]);
+
+ return 1.0f - distanceAsFloat / Math.Max(source.Length, target.Length);
+ }
+}
diff --git a/C#/LevenshteinRatio/LevenshteinRatio.csproj b/C#/LevenshteinRatio/LevenshteinRatio.csproj
new file mode 100644
index 0000000..125f4c9
--- /dev/null
+++ b/C#/LevenshteinRatio/LevenshteinRatio.csproj
@@ -0,0 +1,9 @@
+
+
+
+ net9.0
+ enable
+ enable
+
+
+
diff --git a/Haskell/.gitignore b/Haskell/.gitignore
new file mode 100644
index 0000000..c368d45
--- /dev/null
+++ b/Haskell/.gitignore
@@ -0,0 +1,2 @@
+.stack-work/
+*~
\ No newline at end of file
diff --git a/Haskell/CHANGELOG.md b/Haskell/CHANGELOG.md
new file mode 100644
index 0000000..8ea70cd
--- /dev/null
+++ b/Haskell/CHANGELOG.md
@@ -0,0 +1,11 @@
+# Changelog for `levenshteinRatio`
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to the
+[Haskell Package Versioning Policy](https://pvp.haskell.org/).
+
+## Unreleased
+
+## 0.1.0.0 - YYYY-MM-DD
diff --git a/Haskell/LICENSE b/Haskell/LICENSE
new file mode 100644
index 0000000..ce36a7b
--- /dev/null
+++ b/Haskell/LICENSE
@@ -0,0 +1,26 @@
+Copyright 2025 Wessel T
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+ may be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/Haskell/README.md b/Haskell/README.md
new file mode 100644
index 0000000..42265b0
--- /dev/null
+++ b/Haskell/README.md
@@ -0,0 +1 @@
+# levenshteinRatio
diff --git a/Haskell/Setup.hs b/Haskell/Setup.hs
new file mode 100644
index 0000000..9a994af
--- /dev/null
+++ b/Haskell/Setup.hs
@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain
diff --git a/Haskell/app/Main.hs b/Haskell/app/Main.hs
new file mode 100644
index 0000000..563a71f
--- /dev/null
+++ b/Haskell/app/Main.hs
@@ -0,0 +1,13 @@
+-- module Main where
+
+import Lib (levenshteinRatio)
+import Text.Format
+
+main :: IO ()
+main = do
+ let source = "kitten"
+ target = "sitting"
+
+ putStrLn $ format "Source\t{0}" [source]
+ putStrLn $ format "Target\t{0}" [target]
+ putStrLn $ format "Ratio\t{0}" [show (levenshteinRatio source target)]
diff --git a/Haskell/bench/Bench.hs b/Haskell/bench/Bench.hs
new file mode 100644
index 0000000..12213a1
--- /dev/null
+++ b/Haskell/bench/Bench.hs
@@ -0,0 +1,22 @@
+{-# LANGUAGE OverloadedStrings #-}
+module Main (main) where
+
+import Criterion.Main
+import Criterion.Types (Config (..))
+import Lib (levenshteinRatio)
+
+main :: IO ()
+main =
+ defaultMainWith config
+ [ bench "levenshteinRatio - short identical strings" $ nf (levenshteinRatio "test") "test",
+ bench "levenshteinRatio - short different strings" $ nf (levenshteinRatio "test") "abcd",
+ bench "levenshteinRatio - short similar strings" $ nf (levenshteinRatio "kitten") "sitting",
+ bench "levenshteinRatio - long identical strings" $ nf (levenshteinRatio longStringA) longStringA,
+ bench "levenshteinRatio - long different strings" $ nf (levenshteinRatio longStringA) longStringB,
+ bench "levenshteinRatio - long partially similar strings" $ nf (levenshteinRatio longStringC) longStringA
+ ]
+ where
+ config = defaultConfig {reportFile = Just "benchmark.html"}
+ longStringA = replicate 1000 'a'
+ longStringB = replicate 1000 'b'
+ longStringC = replicate 500 'a' ++ replicate 500 'b'
diff --git a/Haskell/benchmark.zip b/Haskell/benchmark.zip
new file mode 100644
index 0000000..cb0fe18
Binary files /dev/null and b/Haskell/benchmark.zip differ
diff --git a/Haskell/levenshteinRatio.cabal b/Haskell/levenshteinRatio.cabal
new file mode 100644
index 0000000..be77b89
--- /dev/null
+++ b/Haskell/levenshteinRatio.cabal
@@ -0,0 +1,94 @@
+cabal-version: 2.2
+
+-- This file has been generated from package.yaml by hpack version 0.37.0.
+--
+-- see: https://github.com/sol/hpack
+
+name: levenshteinRatio
+version: 0.1.0.0
+description: Please see the README on GitHub at
+homepage: https://github.com/wessel/levenshteinRatio#readme
+bug-reports: https://github.com/wessel/levenshteinRatio/issues
+author: Wessel T
+maintainer: contact@wessel.gg
+copyright: Wessel Tip <contact@wessel.gg> (https://wessel.gg/)
+license: BSD-3-Clause
+license-file: LICENSE
+build-type: Simple
+extra-source-files:
+ README.md
+ CHANGELOG.md
+
+source-repository head
+ type: git
+ location: https://github.com/wessel/levenshteinRatio
+
+library
+ exposed-modules:
+ Lib
+ other-modules:
+ Paths_levenshteinRatio
+ autogen-modules:
+ Paths_levenshteinRatio
+ hs-source-dirs:
+ src
+ ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints
+ build-depends:
+ array
+ , base >=4.7 && <5
+ , text-format-simple
+ default-language: Haskell2010
+
+executable levenshteinRatio-exe
+ main-is: Main.hs
+ other-modules:
+ Paths_levenshteinRatio
+ autogen-modules:
+ Paths_levenshteinRatio
+ hs-source-dirs:
+ app
+ ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N
+ build-depends:
+ array
+ , base >=4.7 && <5
+ , levenshteinRatio
+ , text-format-simple
+ default-language: Haskell2010
+
+test-suite levenshteinRatio-test
+ type: exitcode-stdio-1.0
+ main-is: Spec.hs
+ other-modules:
+ LevenshteinRatioSpec
+ SpecHelper
+ Paths_levenshteinRatio
+ autogen-modules:
+ Paths_levenshteinRatio
+ hs-source-dirs:
+ test
+ ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N
+ build-depends:
+ array
+ , base >=4.7 && <5
+ , hspec
+ , levenshteinRatio
+ , text-format-simple
+ default-language: Haskell2010
+
+benchmark levenshteinRatio-bench
+ type: exitcode-stdio-1.0
+ main-is: Bench.hs
+ other-modules:
+ Paths_levenshteinRatio
+ autogen-modules:
+ Paths_levenshteinRatio
+ hs-source-dirs:
+ bench
+ ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints
+ build-depends:
+ array
+ , base
+ , criterion
+ , levenshteinRatio
+ , text-format-simple
+ default-language: Haskell2010
diff --git a/Haskell/package.yaml b/Haskell/package.yaml
new file mode 100644
index 0000000..e9e20d7
--- /dev/null
+++ b/Haskell/package.yaml
@@ -0,0 +1,71 @@
+name: levenshteinRatio
+version: 0.1.0.0
+github: "wessel/levenshteinRatio"
+license: BSD-3-Clause
+author: "Wessel T"
+maintainer: "contact@wessel.gg"
+copyright: "Wessel Tip <contact@wessel.gg> (https://wessel.gg/)"
+
+extra-source-files:
+- README.md
+- CHANGELOG.md
+
+# Metadata used when publishing your package
+# synopsis: Short description of your package
+# category: Web
+
+# To avoid duplicated efforts in documentation and dealing with the
+# complications of embedding Haddock markup inside cabal files, it is
+# common to point users to the README.md file.
+description: Please see the README on GitHub at
+
+dependencies:
+- base >= 4.7 && < 5
+- array
+- text-format-simple
+
+ghc-options:
+- -Wall
+- -Wcompat
+- -Widentities
+- -Wincomplete-record-updates
+- -Wincomplete-uni-patterns
+- -Wmissing-export-lists
+- -Wmissing-home-modules
+- -Wpartial-fields
+- -Wredundant-constraints
+
+library:
+ source-dirs: src
+
+executables:
+ levenshteinRatio-exe:
+ main: Main.hs
+ source-dirs: app
+ ghc-options:
+ - -threaded
+ - -rtsopts
+ - -with-rtsopts=-N
+ dependencies:
+ - levenshteinRatio
+
+tests:
+ levenshteinRatio-test:
+ main: Spec.hs
+ source-dirs: test
+ ghc-options:
+ - -threaded
+ - -rtsopts
+ - -with-rtsopts=-N
+ dependencies:
+ - levenshteinRatio
+ - hspec
+
+benchmarks:
+ levenshteinRatio-bench:
+ main: Bench.hs
+ source-dirs: bench
+ dependencies:
+ - levenshteinRatio
+ - base
+ - criterion
diff --git a/Haskell/profiler.sh b/Haskell/profiler.sh
new file mode 100644
index 0000000..950eb56
--- /dev/null
+++ b/Haskell/profiler.sh
@@ -0,0 +1,5 @@
+rm deno-bench.json perf.data perf.data.txt
+
+sudo perf record -F MAX -g /home/wessel/Desktop/functional/Haskell/levenshteinRatio/.stack-work/dist/x86_64-linux/ghc-9.8.4/build/levenshteinRatio-bench/levenshteinRatio-bench
+sudo chown $USER:$USER ./perf.data
+perf script -i perf.data > perf.data.txt
diff --git a/Haskell/src/Lib.hs b/Haskell/src/Lib.hs
new file mode 100644
index 0000000..68296d1
--- /dev/null
+++ b/Haskell/src/Lib.hs
@@ -0,0 +1,56 @@
+module Lib (levenshteinRatio) where
+
+import Data.Array
+
+{-|
+ Compare `target` to `source` using LevenshteinRatio
+
+ Arguments:
+ * `target` - The string to compare with `source`
+ * `source` - The string to compare with `target`
+
+ Returns:
+ * The Levenshtein distance between `target` and `source`
+
+ Example:
+ > levenshteinRatio "exampel" "example" == 0.7142857142857143
+-}
+levenshteinRatio :: String -> String -> Double
+levenshteinRatio source target
+ | source == target = 1.0
+ | otherwise =
+ let distance = fromIntegral (calculateDistance source target)
+ maxLength = fromIntegral (max (length source) (length target))
+ in 1.0 - distance / maxLength
+
+calculateDistance :: String -> String -> Int
+calculateDistance source target = finalDistance sourceLength targetLength
+ where
+ sourceLength = length source
+ targetLength = length target
+
+ -- create matrix to store the distances between each character in
+ -- the source and target strings and populate it
+ distanceMatrix = array
+ ((0, 0), (sourceLength, targetLength)) -- ((Starting Index), (Ending Index))
+ [
+ ((i, j), distanceAtIndices i j) | i <- [0 .. sourceLength],
+ j <- [0 .. targetLength]
+ ] -- Populate
+
+ -- Base cases and recursive step
+ distanceAtIndices 0 j = j
+ distanceAtIndices i 0 = i
+ distanceAtIndices i j =
+ minimum
+ [ distanceMatrix ! (i - 1, j) + 1,
+ distanceMatrix ! (i, j - 1) + 1,
+ distanceMatrix ! (i - 1, j - 1) + cost i j
+ ]
+
+ cost i j
+ | source !! (i - 1) == target !! (j - 1) = 0
+ | otherwise = 1
+
+ -- The final distance (Last element of distanceMatrix)
+ finalDistance i j = distanceMatrix ! (i, j)
diff --git a/Haskell/stack.yaml b/Haskell/stack.yaml
new file mode 100644
index 0000000..04555ea
--- /dev/null
+++ b/Haskell/stack.yaml
@@ -0,0 +1,68 @@
+# This file was automatically generated by 'stack init'
+#
+# Some commonly used options have been documented as comments in this file.
+# For advanced use and comprehensive documentation of the format, please see:
+# https://docs.haskellstack.org/en/stable/configure/yaml/
+
+# A 'specific' Stackage snapshot or a compiler version.
+# A snapshot resolver dictates the compiler version and the set of packages
+# to be used for project dependencies. For example:
+#
+# snapshot: lts-23.0
+# snapshot: nightly-2024-12-13
+# snapshot: ghc-9.8.4
+#
+# The location of a snapshot can be provided as a file or url. Stack assumes
+# a snapshot provided as a file might change, whereas a url resource does not.
+#
+# snapshot: ./custom-snapshot.yaml
+# snapshot: https://example.com/snapshots/2024-01-01.yaml
+snapshot:
+ url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/23/15.yaml
+
+# User packages to be built.
+# Various formats can be used as shown in the example below.
+#
+# packages:
+# - some-directory
+# - https://example.com/foo/bar/baz-0.0.2.tar.gz
+# subdirs:
+# - auto-update
+# - wai
+packages:
+- .
+# Dependency packages to be pulled from upstream that are not in the snapshot.
+# These entries can reference officially published versions as well as
+# forks / in-progress versions pinned to a git hash. For example:
+#
+extra-deps:
+ - text-format-simple-1.1.0@sha256:5815236396328f556b9896fdcb949d15b485ef05394c9dc846e94b0306cb4036,735
+# - acme-missiles-0.3
+# - git: https://github.com/commercialhaskell/stack.git
+# commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a
+#
+# extra-deps: []
+
+# Override default flag values for project packages and extra-deps
+# flags: {}
+
+# Extra package databases containing global packages
+# extra-package-dbs: []
+
+# Control whether we use the GHC we find on the path
+# system-ghc: true
+#
+# Require a specific version of Stack, using version ranges
+# require-stack-version: -any # Default
+# require-stack-version: ">=3.3"
+#
+# Override the architecture used by Stack, especially useful on Windows
+# arch: i386
+# arch: x86_64
+#
+# Extra directories used by Stack for building
+# extra-include-dirs: [/path/to/dir]
+# extra-lib-dirs: [/path/to/dir]
+#
+# Allow a newer minor version of GHC than the snapshot specifies
+# compiler-check: newer-minor
diff --git a/Haskell/stack.yaml.lock b/Haskell/stack.yaml.lock
new file mode 100644
index 0000000..8eea336
--- /dev/null
+++ b/Haskell/stack.yaml.lock
@@ -0,0 +1,20 @@
+# This file was autogenerated by Stack.
+# You should not edit this file by hand.
+# For more information, please see the documentation at:
+# https://docs.haskellstack.org/en/stable/topics/lock_files
+
+packages:
+- completed:
+ hackage: text-format-simple-1.1.0@sha256:5815236396328f556b9896fdcb949d15b485ef05394c9dc846e94b0306cb4036,735
+ pantry-tree:
+ sha256: 026136165778e83cb04c587b3609d95731ccf35da07249c9eb0f29ceb6946cbb
+ size: 215
+ original:
+ hackage: text-format-simple-1.1.0@sha256:5815236396328f556b9896fdcb949d15b485ef05394c9dc846e94b0306cb4036,735
+snapshots:
+- completed:
+ sha256: 3020db98a5e35009543057d6e6b96890d285890fc97688933e1798da92c8bbde
+ size: 683815
+ url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/23/15.yaml
+ original:
+ url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/23/15.yaml
diff --git a/Haskell/test/LevenshteinRatioSpec.hs b/Haskell/test/LevenshteinRatioSpec.hs
new file mode 100644
index 0000000..4410244
--- /dev/null
+++ b/Haskell/test/LevenshteinRatioSpec.hs
@@ -0,0 +1,39 @@
+module LevenshteinRatioSpec (main, spec) where
+
+import Lib (levenshteinRatio)
+import SpecHelper
+
+spec :: Spec
+spec =
+ describe "levenshteinRatio" $ do
+ it "should return 1 for two empty strings" $ do
+ levenshteinRatio "" "" `shouldBe` 1.0
+
+ it "should return 0 if one string is empty" $ do
+ levenshteinRatio "" "test" `shouldBe` 0.0
+ levenshteinRatio "test" "" `shouldBe` 0.0
+
+ it "should return 0 for completely different strings" $ do
+ levenshteinRatio "test" "example" `shouldBe` 0.0
+
+ it "should return 0 for long different strings" $ do
+ levenshteinRatio longStringA longStringB `shouldBe` 0.0
+
+ it "should return a value between 0 and 1 for similar strings" $ do
+ levenshteinRatio "kitten" "sitting" `shouldBe` 0.5714285714285714
+
+ it "should return 0.5 for long 50/50 similar strings" $ do
+ levenshteinRatio longStringA longStringC `shouldBe` 0.5
+
+ it "should return 1 for identical strings" $ do
+ levenshteinRatio "test" "test" `shouldBe` 1.0
+
+ it "should return 1 for long identical strings" $ do
+ levenshteinRatio longStringA longStringA `shouldBe` 1.0
+ where
+ longStringA = replicate 1000 'a'
+ longStringB = replicate 1000 'b'
+ longStringC = replicate 500 'a' ++ replicate 500 'b'
+
+main :: IO ()
+main = hspec spec
\ No newline at end of file
diff --git a/Haskell/test/Spec.hs b/Haskell/test/Spec.hs
new file mode 100644
index 0000000..52ef578
--- /dev/null
+++ b/Haskell/test/Spec.hs
@@ -0,0 +1 @@
+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
\ No newline at end of file
diff --git a/Haskell/test/SpecHelper.hs b/Haskell/test/SpecHelper.hs
new file mode 100644
index 0000000..527fe0d
--- /dev/null
+++ b/Haskell/test/SpecHelper.hs
@@ -0,0 +1,6 @@
+module SpecHelper
+ ( module Test.Hspec,
+ )
+where
+
+import Test.Hspec
diff --git a/Report/.editorconfig b/Report/.editorconfig
new file mode 100644
index 0000000..310f9a8
--- /dev/null
+++ b/Report/.editorconfig
@@ -0,0 +1,66 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+cpp_indent_braces=false
+cpp_indent_multi_line_relative_to=innermost_parenthesis
+cpp_indent_within_parentheses=indent
+cpp_indent_preserve_within_parentheses=false
+cpp_indent_case_labels=false
+cpp_indent_case_contents=true
+cpp_indent_case_contents_when_block=false
+cpp_indent_lambda_braces_when_parameter=true
+cpp_indent_goto_labels=one_left
+cpp_indent_preprocessor=leftmost_column
+cpp_indent_access_specifiers=false
+cpp_indent_namespace_contents=true
+cpp_indent_preserve_comments=false
+cpp_new_line_before_open_brace_namespace=ignore
+cpp_new_line_before_open_brace_type=ignore
+cpp_new_line_before_open_brace_function=ignore
+cpp_new_line_before_open_brace_block=ignore
+cpp_new_line_before_open_brace_lambda=ignore
+cpp_new_line_scope_braces_on_separate_lines=false
+cpp_new_line_close_brace_same_line_empty_type=false
+cpp_new_line_close_brace_same_line_empty_function=false
+cpp_new_line_before_catch=true
+cpp_new_line_before_else=true
+cpp_new_line_before_while_in_do_while=false
+cpp_space_before_function_open_parenthesis=remove
+cpp_space_within_parameter_list_parentheses=false
+cpp_space_between_empty_parameter_list_parentheses=false
+cpp_space_after_keywords_in_control_flow_statements=true
+cpp_space_within_control_flow_statement_parentheses=false
+cpp_space_before_lambda_open_parenthesis=false
+cpp_space_within_cast_parentheses=false
+cpp_space_after_cast_close_parenthesis=false
+cpp_space_within_expression_parentheses=false
+cpp_space_before_block_open_brace=true
+cpp_space_between_empty_braces=false
+cpp_space_before_initializer_list_open_brace=false
+cpp_space_within_initializer_list_braces=true
+cpp_space_preserve_in_initializer_list=true
+cpp_space_before_open_square_bracket=false
+cpp_space_within_square_brackets=false
+cpp_space_before_empty_square_brackets=false
+cpp_space_between_empty_square_brackets=false
+cpp_space_group_square_brackets=true
+cpp_space_within_lambda_brackets=false
+cpp_space_between_empty_lambda_brackets=false
+cpp_space_before_comma=false
+cpp_space_after_comma=true
+cpp_space_remove_around_member_operators=true
+cpp_space_before_inheritance_colon=true
+cpp_space_before_constructor_colon=true
+cpp_space_remove_before_semicolon=true
+cpp_space_after_semicolon=false
+cpp_space_remove_around_unary_operator=true
+cpp_space_around_binary_operator=insert
+cpp_space_around_assignment_operator=insert
+cpp_space_pointer_reference_alignment=left
+cpp_space_around_ternary_operator=insert
+cpp_wrap_preserve_blocks=one_liners
diff --git a/Report/.gitattributes b/Report/.gitattributes
new file mode 100644
index 0000000..dfe0770
--- /dev/null
+++ b/Report/.gitattributes
@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto
diff --git a/Report/.github/CODEOWNERS b/Report/.github/CODEOWNERS
new file mode 100644
index 0000000..bee82d5
--- /dev/null
+++ b/Report/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @{{project.master}}
diff --git a/Report/.github/CODE_OF_CONDUCT.md b/Report/.github/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..45d257b
--- /dev/null
+++ b/Report/.github/CODE_OF_CONDUCT.md
@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+ and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+ community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+ any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+ without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
diff --git a/Report/.github/COMMIT_CONVENTION.md b/Report/.github/COMMIT_CONVENTION.md
new file mode 100644
index 0000000..68dfb06
--- /dev/null
+++ b/Report/.github/COMMIT_CONVENTION.md
@@ -0,0 +1,160 @@
+> This is adapted from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+# Conventional Commits 1.0.0-beta.4
+
+#### TL;DR:
+
+Messages must be matched by the following regex:
+
+```js
+/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,72}/;
+```
+
+## Summary
+
+The Conventional Commits specification is a lightweight convention on top of commit messages.
+It provides an easy set of rules for creating an explicit commit history;
+which makes it easier to write automated tools on top of.
+This convention dovetails with [SemVer](http://semver.org),
+by describing the features, fixes, and breaking changes made in commit messages.
+
+The commit message should be structured as follows:
+
+---
+
+```
+[optional scope]:
+
+[optional body]
+
+[optional footer]
+```
+---
+
+
+The commit contains the following structural elements, to communicate intent to the
+consumers of your library:
+
+1. **fix:** a commit of the _type_ `fix` patches a bug in your codebase (this correlates with [`PATCH`](http://semver.org/#summary) in semantic versioning).
+1. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates with [`MINOR`](http://semver.org/#summary) in semantic versioning).
+1. **BREAKING CHANGE:** a commit that has the text `BREAKING CHANGE:` at the beginning of its optional body or footer section introduces a breaking API change (correlating with [`MAJOR`](http://semver.org/#summary) in semantic versioning).
+A BREAKING CHANGE can be part of commits of any _type_.
+1. Others: commit _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [Angular convention](https://github.com/angular/angular/blob/68a6a07/CONTRIBUTING.md#commit)) recommends `chore:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others.
+
+We also recommend `improvement` for commits that improve a current implementation without adding a new feature or fixing a bug.
+Notice these types are not mandated by the conventional commits specification, and have no implicit effect in semantic versioning (unless they include a BREAKING CHANGE).
+
+A scope may be provided to a commit's type, to provide additional contextual information and is contained within parenthesis, e.g., `feat(parser): add ability to parse arrays`.
+
+## Examples
+
+### Commit message with description and breaking change in body
+```
+feat: allow provided config object to extend other configs
+
+BREAKING CHANGE: `extends` key in config file is now used for extending other config files
+```
+
+### Commit message with optional `!` to draw attention to breaking change
+```
+chore!: drop Node 6 from testing matrix
+
+BREAKING CHANGE: dropping Node 6 which hits end of life in April
+```
+
+### Commit message with no body
+```
+docs: correct spelling of CHANGELOG
+```
+
+### Commit message with scope
+```
+feat(lang): add polish language
+```
+
+### Commit message for a fix using an (optional) issue number.
+```
+fix: correct minor typos in code
+
+see the issue for details on the typos fixed
+
+closes issue #12
+```
+
+## Specification
+
+The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
+
+1. Commits MUST be prefixed with a type, which consists of a noun, `feat`, `fix`, etc., followed
+ by an OPTIONAL scope, and a REQUIRED terminal colon and space.
+1. The type `feat` MUST be used when a commit adds a new feature to your application or library.
+1. The type `fix` MUST be used when a commit represents a bug fix for your application.
+1. A scope MAY be provided after a type. A scope MUST consist of a noun describing a
+ section of the codebase surrounded by parenthesis, e.g., `fix(parser):`
+1. A description MUST immediately follow the space after the type/scope prefix.
+The description is a short summary of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string._
+1. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
+1. A footer of one or more lines MAY be provided one blank line after the body. The footer MUST contain meta-information
+about the commit, e.g., related pull-requests, reviewers, breaking changes, with one piece of meta-information
+per-line.
+1. Breaking changes MUST be indicated at the very beginning of the body section, or at the beginning of a line in the footer section. A breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon and a space.
+1. A description MUST be provided after the `BREAKING CHANGE: `, describing what has changed about the API, e.g., _BREAKING CHANGE: environment variables now take precedence over config files._
+1. Types other than `feat` and `fix` MAY be used in your commit messages.
+1. The units of information that make up conventional commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase.
+1. A `!` MAY be appended prior to the `:` in the type/scope prefix, to further draw attention to breaking changes. `BREAKING CHANGE: description` MUST also be included in the body
+or footer, along with the `!` in the prefix.
+
+## Why Use Conventional Commits
+
+* Automatically generating CHANGELOGs.
+* Automatically determining a semantic version bump (based on the types of commits landed).
+* Communicating the nature of changes to teammates, the public, and other stakeholders.
+* Triggering build and publish processes.
+* Making it easier for people to contribute to your projects, by allowing them to explore
+ a more structured commit history.
+
+## FAQ
+
+### How should I deal with commit messages in the initial development phase?
+
+We recommend that you proceed as if you've already released the product. Typically *somebody*, even if it's your fellow software developers, is using your software. They'll want to know what's fixed, what breaks etc.
+
+### Are the types in the commit title uppercase or lowercase?
+
+Any casing may be used, but it's best to be consistent.
+
+### What do I do if the commit conforms to more than one of the commit types?
+
+Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is its ability to drive us to make more organized commits and PRs.
+
+### Doesn’t this discourage rapid development and fast iteration?
+
+It discourages moving fast in a disorganized way. It helps you be able to move fast long term across multiple projects with varied contributors.
+
+### Might Conventional Commits lead developers to limit the type of commits they make because they'll be thinking in the types provided?
+
+Conventional Commits encourages us to make more of certain types of commits such as fixes. Other than that, the flexibility of Conventional Commits allows your team to come up with their own types and change those types over time.
+
+### How does this relate to SemVer?
+
+`fix` type commits should be translated to `PATCH` releases. `feat` type commits should be translated to `MINOR` releases. Commits with `BREAKING CHANGE` in the commits, regardless of type, should be translated to `MAJOR` releases.
+
+### How should I version my extensions to the Conventional Commits Specification, e.g. `@jameswomack/conventional-commit-spec`?
+
+We recommend using SemVer to release your own extensions to this specification (and
+encourage you to make these extensions!)
+
+### What do I do if I accidentally use the wrong commit type?
+
+#### When you used a type that's of the spec but not the correct type, e.g. `fix` instead of `feat`
+
+Prior to merging or releasing the mistake, we recommend using `git rebase -i` to edit the commit history. After release, the cleanup will be different according to what tools and processes you use.
+
+#### When you used a type *not* of the spec, e.g. `feet` instead of `feat`
+
+In a worst case scenario, it's not the end of the world if a commit lands that does not meet the conventional commit specification. It simply means that commit will be missed by tools that are based on the spec.
+
+### Do all my contributors need to use the conventional commit specification?
+
+No! If you use a squash based workflow on Git lead maintainers can clean up the commit messages as they're merged—adding no workload to casual committers.
+A common workflow for this is to have your git system automatically squash commits from a pull request and present a form for the lead maintainer to enter the proper git commit message for the merge.
\ No newline at end of file
diff --git a/Report/.github/CONTRIBUTING.md b/Report/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..0706835
--- /dev/null
+++ b/Report/.github/CONTRIBUTING.md
@@ -0,0 +1,24 @@
+# Contributing
+
+If you wish to contribute to {{project.name}}, feel free to fork the repository and submit a pull request.
+{{project.linter}} is enforced to correct most typo's you make and keep the code style the same throughout the whole project,
+so it would be much appreciated if you installed {{project.linter}} to your editor of choice
+
+## Prerequisites
+The following prerequisites must be met before installing {{project.name}}:
+{{setup.prerequisites}}
+
+## Setup
+To get ready to work on the codebase, please do the following:
+
+1. Fork & clone the repository, and make sure you are on the **master** branch
+2. Run {{setup.install}}
+3. Code your ideas and test them using {{setup.test}}
+4. [Submit a pull request](https://github.com/{{project.master}}/{{project.name}}/compare)
+
+## Testing
+When creating any new functions, please also create unit tests for them in the `tests` directory.
+Use the library associated with the project when creating such tests.
+
+When modifying existing functions, make sure to test them before making a pull request, this will prevent
+anything from breaking on the production environment.
diff --git a/Report/.github/FUNDING.yml b/Report/.github/FUNDING.yml
new file mode 100644
index 0000000..b3be161
--- /dev/null
+++ b/Report/.github/FUNDING.yml
@@ -0,0 +1 @@
+{{project.funding}}
diff --git a/Report/.github/ISSUE_TEMPLATE/bug_report.yml b/Report/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..01b6643
--- /dev/null
+++ b/Report/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,72 @@
+name: Bug report
+description: Report incorrect or unexpected behavior of a package
+labels: [bug, need repro]
+body:
+ - type: dropdown
+ id: package
+ attributes:
+ label: Which part is this bug report for?
+ options: {{tree.parts}}
+ validations:
+ required: true
+ - type: textarea
+ id: description
+ attributes:
+ label: Issue description
+ description: |
+ Describe the issue in as much detail as possible.
+
+ Tip: You can attach images or log files by clicking this area to highlight it and then dragging files into it.
+ placeholder: |
+ Steps to reproduce with below code sample.
+ validations:
+ required: true
+ - type: textarea
+ id: codesample
+ attributes:
+ label: Code sample
+ description: Include a reproducible, minimal code sample. This will be automatically formatted into code, so no need for backticks.
+ render: {{project.lang}}
+ placeholder: |
+ Your code sample should be...
+ ... Minimal - Use as little code as possible that still produces the same problem (and is understandable)
+ ... Complete - Provide all parts someone else needs to reproduce your problem
+ ... Reproducible - Test the code you're about to provide to make sure it reproduces the problem
+ - type: input
+ id: version
+ attributes:
+ label: Version
+ description: Which version of the package are you using?
+ validations:
+ required: true
+ - type: input
+ id: lang-version
+ attributes:
+ label: '{{project.lang}} version'
+ description: |
+ Which version of {{project.lang}} are you using?
+ validations:
+ required: true
+ - type: input
+ id: os
+ attributes:
+ label: Operating system
+ description: Which OS does your application run on?
+ - type: dropdown
+ id: priority
+ attributes:
+ label: Priority this issue should have
+ description: Please be realistic. If you need to elaborate on your reasoning, please use the Issue description field above.
+ options:
+ - Low (slightly annoying)
+ - Medium (should be fixed soon)
+ - High (immediate attention needed)
+ validations:
+ required: true
+ - type: input
+ id: dev-release
+ attributes:
+ label: I have tested this issue on a development release
+ placeholder: d23280c (commit hash)
+ description: |
+ The issue might already be fixed in a development release or main. This is not required, but helps us greatly.
diff --git a/Report/.github/ISSUE_TEMPLATE/config.yml b/Report/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..a5f5423
--- /dev/null
+++ b/Report/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,2 @@
+blank_issues_enabled: false
+{{project.contact}}
diff --git a/Report/.github/ISSUE_TEMPLATE/feature_request.yml b/Report/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000..14a0911
--- /dev/null
+++ b/Report/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,40 @@
+name: Feature request
+description: Request a new feature
+labels: [feature request]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Please only use this form for submitting new, original ideas.
+ - type: dropdown
+ id: package
+ attributes:
+ label: Which part is this feature request for?
+ options: {{tree.parts}}
+ validations:
+ required: false
+ - type: textarea
+ id: description
+ attributes:
+ label: Feature
+ description: A clear and concise description of what the problem is, or what feature you want to be implemented.
+ placeholder: I'm always frustrated when..., A good addition would be...
+ validations:
+ required: true
+ - type: textarea
+ id: solution
+ attributes:
+ label: Ideal solution or implementation
+ description: A clear and concise description of what you want to happen.
+ validations:
+ required: true
+ - type: textarea
+ id: alternatives
+ attributes:
+ label: Alternative solutions or implementations
+ description: A clear and concise description of any alternative solutions or features you have considered.
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Other context
+ description: Any other context, screenshots, or file uploads that help us understand your feature request.
diff --git a/Report/.github/PULL_REQUEST_TEMPLATE.md b/Report/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..f35130a
--- /dev/null
+++ b/Report/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,17 @@
+---
+name: Pull Request
+about: Propose changes to {{project.name}}
+title: "[PR] Your changes"
+labels: pullrequest
+---
+
+**Please describe the changes this PR makes and why it should be merged:**
+
+
+**Status**
+- [ ] Code changes have been tested and there aren't any typos in it
+
+**Semantic versioning classification:**
+- [ ] This PR changes {{project.name}} core codebase (methods or parameters added)
+ - [ ] This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
+- [ ] This PR **only** includes non-code changes, like changes to documentation, README, etc.
diff --git a/Report/.github/auto_assign.yml b/Report/.github/auto_assign.yml
new file mode 100644
index 0000000..3c8d1f2
--- /dev/null
+++ b/Report/.github/auto_assign.yml
@@ -0,0 +1,4 @@
+addReviewers: true
+reviewers: {{project.reviewers}}
+numberOfReviewers: 0
+runOnDraft: true
diff --git a/Report/.github/labels.yml b/Report/.github/labels.yml
new file mode 100644
index 0000000..00be3c8
--- /dev/null
+++ b/Report/.github/labels.yml
@@ -0,0 +1,62 @@
+- name: bug
+ color: d73a4a
+- name: caching
+ color: 80c042
+- name: chore
+ color: ffffff
+- name: ci
+ color: 0075ca
+- name: dependencies
+ color: 276bd1
+- name: documentation
+ color: 0075ca
+- name: duplicate
+ color: cfd3d7
+- name: error handling
+ color: 80c042
+- name: feature request
+ color: fcf95a
+- name: good first issue
+ color: 7057ff
+- name: has PR
+ color: 4b1f8e
+- name: help wanted
+ color: '008672'
+- name: in progress
+ color: ffccd7
+- name: in review
+ color: aed5fc
+- name: interactions
+ color: 80c042
+- name: invalid
+ color: e4e669
+- name: need repro
+ color: c66037
+- name: priority:high
+ color: fc1423
+- name: question
+ color: d876e3
+- name: ratelimits
+ color: 80c042
+- name: refactor
+ color: 1d637f
+- name: regression
+ color: ea8785
+- name: REST
+ color: 80c042
+- name: semver:major
+ color: c10f47
+- name: semver:minor
+ color: e4f486
+- name: semver:patch
+ color: e8be8b
+- name: tests
+ color: f06dff
+- name: threads
+ color: 80c042
+- name: typings
+ color: 80c042
+- name: utility
+ color: 80c042
+- name: wontfix
+ color: ffffff
\ No newline at end of file
diff --git a/Report/.gitignore b/Report/.gitignore
new file mode 100644
index 0000000..ef0c0e8
--- /dev/null
+++ b/Report/.gitignore
@@ -0,0 +1,13 @@
+# LaTeX build files
+**/tex/**/*.aux
+**/tex/**/*.bbl
+**/tex/**/*.blg
+**/tex/**/*.fdb_latexmk
+**/tex/**/*.fls
+**/tex/**/*.log
+**/tex/**/*.out
+**/tex/**/*.toc
+**/tex/**/*.synctex.*
+
+**/tmp/*
+!.gitkeep
diff --git a/Report/.vscode/LaTeX.code-snippets b/Report/.vscode/LaTeX.code-snippets
new file mode 100644
index 0000000..112bcc8
--- /dev/null
+++ b/Report/.vscode/LaTeX.code-snippets
@@ -0,0 +1,31 @@
+{
+ "Create Table": {
+ "prefix": "tbl",
+ "body": [
+ "\\begin{table}[ht]",
+ " \\centering",
+ " \\begin{threeparttable}",
+ " \\begin{tabular}{p{2.5cm}|p{8.5cm}}",
+ " \\toprule",
+ " $1 & $2 \\\\\\\\",
+ " \\hline",
+ " $3 & $4 \\\\\\\\",
+ " \\bottomrule",
+ " \\end{tabular}",
+ " \\end{threeparttable}",
+ "\\end{table}"
+ ],
+ "description": "Create a table with two columns",
+ },
+ "Create Figure": {
+ "prefix": "fig",
+ "body": [
+ "\\begin{figure}[H]",
+ " \\includegraphics[width=1\\textwidth]{../img/$1}",
+ " \\caption{$2}",
+ " \\label{fig:$3}",
+ "\\end{figure}"
+ ],
+ "description": "Create a figure ",
+ }
+}
diff --git a/Report/.vscode/settings.json b/Report/.vscode/settings.json
new file mode 100644
index 0000000..b154284
--- /dev/null
+++ b/Report/.vscode/settings.json
@@ -0,0 +1,112 @@
+{
+ "latex-workshop.latex.autoBuild.cleanAndRetry.enabled": true,
+ "latex-workshop.latex.clean.subfolder.enabled": true,
+ "latex-workshop.latex.external.build.args": [ "--shell-escape" ],
+ "latex-workshop.latex.outDir": "tmp",
+ "latex-workshop.latex.tools": [
+ {
+ "name": "latexmk",
+ "command": "latexmk",
+ "args": [
+ "-synctex=1",
+ "-interaction=nonstopmode",
+ "-file-line-error",
+ "-pdf",
+ "-outdir=%OUTDIR%",
+ "%DOC%",
+ "--shell-escape",
+ ],
+ "env": {}
+ },
+ {
+ "name": "lualatexmk",
+ "command": "latexmk",
+ "args": [
+ "-synctex=1",
+ "-interaction=nonstopmode",
+ "-file-line-error",
+ "-lualatex",
+ "-outdir=%OUTDIR%",
+ "%DOC%"
+ ],
+ "env": {}
+ },
+ {
+ "name": "xelatexmk",
+ "command": "latexmk",
+ "args": [
+ "-synctex=1",
+ "-interaction=nonstopmode",
+ "-file-line-error",
+ "-xelatex",
+ "-outdir=%OUTDIR%",
+ "%DOC%"
+ ],
+ "env": {}
+ },
+ {
+ "name": "latexmk_rconly",
+ "command": "latexmk",
+ "args": [
+ "%DOC%"
+ ],
+ "env": {}
+ },
+ {
+ "name": "pdflatex",
+ "command": "pdflatex",
+ "args": [
+ "-synctex=1",
+ "-interaction=nonstopmode",
+ "-file-line-error",
+ "%DOC%"
+ ],
+ "env": {}
+ },
+ {
+ "name": "bibtex",
+ "command": "bibtex",
+ "args": [
+ "%DOCFILE%"
+ ],
+ "env": {}
+ },
+ {
+ "name": "rnw2tex",
+ "command": "Rscript",
+ "args": [
+ "-e",
+ "knitr::opts_knit$set(concordance = TRUE); knitr::knit('%DOCFILE_EXT%')"
+ ],
+ "env": {}
+ },
+ {
+ "name": "jnw2tex",
+ "command": "julia",
+ "args": [
+ "-e",
+ "using Weave; weave(\"%DOC_EXT%\", doctype=\"tex\")"
+ ],
+ "env": {}
+ },
+ {
+ "name": "jnw2texmintex",
+ "command": "julia",
+ "args": [
+ "-e",
+ "using Weave; weave(\"%DOC_EXT%\", doctype=\"texminted\")"
+ ],
+ "env": {}
+ },
+ {
+ "name": "tectonic",
+ "command": "tectonic",
+ "args": [
+ "--synctex",
+ "--keep-logs",
+ "%DOC%.tex"
+ ],
+ "env": {}
+ }
+ ]
+}
diff --git a/Report/LICENSE b/Report/LICENSE
new file mode 100644
index 0000000..b4bba09
--- /dev/null
+++ b/Report/LICENSE
@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) {{project.license}}
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/Report/LICENSES/.gitkeep b/Report/LICENSES/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/Report/README.md b/Report/README.md
new file mode 100644
index 0000000..020ea8d
--- /dev/null
+++ b/Report/README.md
@@ -0,0 +1,12 @@
+
+
+
+> {{project.name}}
+
+[](/LICENSE)
+
+{{info.desc}}
+
+
+
+## Table of contents
diff --git a/Report/init_repo.py b/Report/init_repo.py
new file mode 100644
index 0000000..5527d89
--- /dev/null
+++ b/Report/init_repo.py
@@ -0,0 +1,86 @@
+import os
+import yaml
+import re
+import datetime
+
+file_types = ['LICENSE', 'CODEOWNERS', '.md', '.yml']
+script_name = os.path.basename(__file__)
+
+def replace_placeholders(file_path, replacements):
+ with open(file_path, 'r', encoding='utf-8') as file:
+ content = file.read()
+
+ for placeholder, replacement in replacements.items():
+ content = re.sub(re.escape(placeholder), replacement, content)
+
+ with open(file_path, 'w', encoding='utf-8') as file:
+ file.write(content)
+
+def initialize_repository(directory, replacements):
+ for root, _, files in os.walk(directory):
+ for file in files:
+ if file == script_name:
+ continue
+ if any(file.endswith(file_type) for file_type in file_types):
+ file_path = os.path.join(root, file)
+ replace_placeholders(file_path, replacements)
+
+def parse_input(prompt):
+ return [item.strip() for item in input(prompt).split(',')]
+
+def parse_contact(prompt):
+ contacts = []
+ while True:
+ print(prompt)
+ name = input(f"\tName\t\t").strip()
+ if not name:
+ break
+ url = input(f"\tURL\t\t").strip()
+ about = input(f"\tAbout\t\t").strip()
+ contacts.append({'name': name, 'url': url, 'about': about})
+ return {'contact_links': contacts}
+
+def parse_funding(prompt):
+ funding = {}
+ while True:
+ print(prompt)
+ key = input(f"\tKey\t\t").strip()
+ if not key:
+ break
+ value = input(f"\tValue\t\t").strip()
+ funding[key] = value
+
+ return funding
+
+def main():
+ current_year = str(datetime.datetime.now().year)
+
+ replacements = {
+ "{{project.name}}": input("Project name\t\t"),
+ "{{info.desc}}": input("Project Description\t"),
+ "{{project.master}}": input("Master of the repo\t"),
+ "{{project.license}}": f"{current_year} " + input('License holder\t\t'),
+
+ "{{tree.parts}}": yaml.dump(parse_input("Parts of the repo\t"), default_flow_style=True),
+ "{{project.lang}}": input("Language used\t\t"),
+ "{{project.linter}}": input("Linter used\t\t"),
+
+ "{{setup.prerequisites}}": input("Prerequisites\t\t"),
+ "{{setup.install}}": input("Install command\t\t"),
+ "{{setup.test}}": input("Test command\t\t"),
+
+ "{{project.logo}}": input("Project logo URL\t"),
+ "{{project.funding}}": yaml.dump(parse_funding("Funding methods\t\t"), default_flow_style=True),
+ "{{project.contact}}": yaml.dump(parse_contact("Contact information\t"), default_flow_style=False),
+ "{{project.reviewers}}": yaml.dump(parse_input("Auto-assign users (x,y)\t"), default_flow_style=True)
+ }
+
+ directory = input("Initialize directory\t") or '.'
+ initialize_repository(directory, replacements)
+
+ delete = input("Delete this script? (Y/n)\t") or "y"
+ if delete.lower() == "y":
+ os.remove(__file__)
+
+if __name__ == "__main__":
+ main()
diff --git a/Report/tex/doc/.gitkeep b/Report/tex/doc/.gitkeep
new file mode 100644
index 0000000..d47982b
--- /dev/null
+++ b/Report/tex/doc/.gitkeep
@@ -0,0 +1 @@
+Contains any external documents such as PDFs
diff --git a/Report/tex/doc/LevenshteinRatio.cs b/Report/tex/doc/LevenshteinRatio.cs
new file mode 100644
index 0000000..52f9136
--- /dev/null
+++ b/Report/tex/doc/LevenshteinRatio.cs
@@ -0,0 +1,42 @@
+namespace LevenshteinRatio;
+
+public static class Levenshtein {
+ public static float Ratio(string target, string source) {
+ if (source == target) {
+ return 1;
+ }
+
+ if (string.IsNullOrEmpty(source) || string.IsNullOrEmpty(target)) {
+ return 0;
+ }
+
+ var distance = new int[source.Length + 1, target.Length + 1];
+
+ for (int i = 0; i <= source.Length; i++) {
+ distance[i, 0] = i;
+ }
+
+ for (int i = 0; i <= target.Length; i++) {
+ distance[0, i] = i;
+ }
+
+ for (int i = 1; i <= source.Length; i++) {
+ for (int j = 1; j <= target.Length; j++) {
+ int cost = target[j - 1] == source[i - 1] ? 0 : 1;
+
+ distance[i, j] =
+ Math.Min(
+ Math.Min(
+ distance[i - 1, j] + 1,
+ distance[i, j - 1] + 1
+ ),
+ distance[i - 1, j - 1] + cost
+ );
+ }
+ }
+
+ var distanceAsFloat = Convert.ToSingle(distance[source.Length, target.Length]);
+
+ return 1.0f - distanceAsFloat / Math.Max(source.Length, target.Length);
+ }
+}
diff --git a/Report/tex/doc/LevenshteinRatio.hs b/Report/tex/doc/LevenshteinRatio.hs
new file mode 100644
index 0000000..7110bbb
--- /dev/null
+++ b/Report/tex/doc/LevenshteinRatio.hs
@@ -0,0 +1,39 @@
+module Lib (levenshteinRatio) where
+
+import Data.Array
+
+levenshteinRatio :: String -> String -> Double
+levenshteinRatio source target
+ | source == target = 1.0
+ | otherwise =
+ let distance = fromIntegral (calculateDistance source target)
+ maxLength = fromIntegral (max (length source) (length target))
+ in 1.0 - distance / maxLength
+
+calculateDistance :: String -> String -> Int
+calculateDistance source target = finalDistance sourceLength targetLength
+ where
+ sourceLength = length source
+ targetLength = length target
+
+ distanceMatrix = array
+ ((0, 0), (sourceLength, targetLength))
+ [
+ ((i, j), distanceAtIndices i j) | i <- [0 .. sourceLength],
+ j <- [0 .. targetLength]
+ ]
+
+ distanceAtIndices 0 j = j
+ distanceAtIndices i 0 = i
+ distanceAtIndices i j =
+ minimum
+ [ distanceMatrix ! (i - 1, j) + 1,
+ distanceMatrix ! (i, j - 1) + 1,
+ distanceMatrix ! (i - 1, j - 1) + cost i j
+ ]
+
+ cost i j
+ | source !! (i - 1) == target !! (j - 1) = 0
+ | otherwise = 1
+
+ finalDistance i j = distanceMatrix ! (i, j)
diff --git a/Report/tex/doc/levenshteinRatio.ts b/Report/tex/doc/levenshteinRatio.ts
new file mode 100644
index 0000000..8b5425a
--- /dev/null
+++ b/Report/tex/doc/levenshteinRatio.ts
@@ -0,0 +1,30 @@
+export function levenshteinRatio(target: string, source: string): number {
+ if (source === null || target === null) return 0.0;
+ if (source === target) return 1.0;
+ if (source.length === 0 || target.length === 0) return 0.0;
+
+ const distanceMatrix = new Array(source.length + 1);
+ for (let i = 0; i < distanceMatrix.length; i++) distanceMatrix[i] = new Array(target.length + 1);
+
+ for (let i = 0; i <= source.length; distanceMatrix[i][0] = i++);
+ for (let i = 0; i <= target.length; distanceMatrix[0][i] = i++);
+
+ for (let i = 1; i <= source.length; i++) {
+ for (let j = 1; j <= target.length; j++) {
+ const cost = target.charAt(j - 1) === source.charAt(i - 1) ? 0 : 1;
+
+ distanceMatrix[i][j] =
+ Math.min(
+ Math.min(
+ distanceMatrix[i - 1][j] + 1,
+ distanceMatrix[i][j - 1] + 1
+ ),
+ distanceMatrix[i - 1][j - 1] + cost
+ );
+ }
+ }
+
+ const totalDistance = distanceMatrix[source.length][target.length] / Math.max(source.length, target.length);
+
+ return 1.0 - totalDistance;
+};
diff --git a/Report/tex/img/.gitkeep b/Report/tex/img/.gitkeep
new file mode 100644
index 0000000..af2222e
--- /dev/null
+++ b/Report/tex/img/.gitkeep
@@ -0,0 +1 @@
+Contains any images used in the sections
diff --git a/Report/tex/img/logo.png b/Report/tex/img/logo.png
new file mode 100644
index 0000000..963245e
Binary files /dev/null and b/Report/tex/img/logo.png differ
diff --git a/Report/tex/img/logo.svg b/Report/tex/img/logo.svg
new file mode 100644
index 0000000..fadedb1
--- /dev/null
+++ b/Report/tex/img/logo.svg
@@ -0,0 +1 @@
+
diff --git a/Report/tex/main.tex b/Report/tex/main.tex
new file mode 100644
index 0000000..404944f
--- /dev/null
+++ b/Report/tex/main.tex
@@ -0,0 +1,48 @@
+\documentclass[9pt]{IEEEconf}
+
+\input{packages.tex}
+\input{variables.tex}
+
+\begin{document}
+\small
+% \sffamily
+% Front page containing title, author and date
+\pagenumbering{gobble}
+\input{sec/0 frontpage.tex}
+\newpage
+
+% Set page numbering to arabic and show the table of contents, toc should not contain page number
+\pagenumbering{arabic}
+\thispagestyle{empty}
+\tableofcontents
+\newpage
+
+% Enable two column layout for the rest of the document
+\twocolumn
+
+% Dictionary containing all the terms used in the document
+\input{sec/0 dictionairy.tex}
+\newpage
+
+% Abstract of the document
+\input{sec/0 abstract.tex}
+
+% Sections of the document
+\input{sec/1 introduction.tex}
+
+\section*{Acknowledgements}
+\label{sec:acknowledgements}
+The author would like to thank the following people for their contribution to this report:
+\begin{itemize}
+ \item[] \makebox[3.2cm]{\textbf{Foppele, J.}\hfill} Supervisor
+ \item[] \makebox[3.2cm]{\textbf{Luciano, P.}\hfill} Haskell code review
+ \item[] \makebox[3.2cm]{\textbf{Ralph, D.}\hfill} TypeScript code review
+ \item[] \makebox[3.2cm]{\textbf{Siegmar , B.}\hfill} CSharp code review
+\end{itemize}
+
+\label{sec:referenties}
+\bibliography{references}
+\nocite{*}
+
+\input{sec/2 appendice.tex}
+\end{document}
diff --git a/Report/tex/packages.tex b/Report/tex/packages.tex
new file mode 100644
index 0000000..414ae97
--- /dev/null
+++ b/Report/tex/packages.tex
@@ -0,0 +1,28 @@
+%/ Use case: language and spell checking
+\usepackage[utf8]{inputenc}
+\usepackage[english]{babel}
+\usepackage{caption}
+%/ Use case: uppercase headers
+\usepackage{titlecaps}
+\usepackage{sectsty}
+%/ Use case: text formatting
+\usepackage{url}
+\usepackage[newfloat,outputdir=tmp]{minted}
+\usepackage[colorlinks=true, allcolors=teal]{hyperref}
+\usepackage{textcomp}
+\usepackage{amsmath}
+\usepackage{float}
+%/ Use case: images
+\usepackage{graphicx}
+\usepackage[export]{adjustbox}
+\usepackage[font=small,labelfont=bf]{caption}
+%/ Use case: tables
+\usepackage{booktabs}
+\usepackage[flushleft]{threeparttable}
+\usepackage{pgfplots}
+\usepackage{pgfplotstable}
+%/ Use case: paragraph indentation
+\usepackage{parskip}
+
+\usepackage{float}
+\usepackage{pdflscape}
diff --git a/Report/tex/references.bib b/Report/tex/references.bib
new file mode 100644
index 0000000..e69de29
diff --git a/Report/tex/sec/0 abstract.tex b/Report/tex/sec/0 abstract.tex
new file mode 100644
index 0000000..2bc5ad8
--- /dev/null
+++ b/Report/tex/sec/0 abstract.tex
@@ -0,0 +1,3 @@
+\begin{abstract}
+
+\end{abstract}
diff --git a/Report/tex/sec/0 dictionairy.tex b/Report/tex/sec/0 dictionairy.tex
new file mode 100644
index 0000000..0bc5ad8
--- /dev/null
+++ b/Report/tex/sec/0 dictionairy.tex
@@ -0,0 +1,15 @@
+\onecolumn
+% todo(wessel)
+\section*{Dictionairy}
+\begin{table}[ht]
+ \raggedright
+ \begin{threeparttable}
+ \begin{tabular}{p{4cm}|p{11.5cm}}
+ \toprule
+ \textbf{Term} & \textbf{Meaning} \\
+ \hline
+ \bottomrule
+ \end{tabular}
+ \end{threeparttable}
+\end{table}
+\twocolumn
diff --git a/Report/tex/sec/0 frontpage.tex b/Report/tex/sec/0 frontpage.tex
new file mode 100644
index 0000000..b62e32c
--- /dev/null
+++ b/Report/tex/sec/0 frontpage.tex
@@ -0,0 +1,10 @@
+\onecolumn
+\maketitle
+
+\begin{figure}[H]
+ \centering
+ \includegraphics[width=0.3\textwidth]{../img/logo.png}
+\end{figure}
+
+% Push the content below to the bottom of the page
+\vfill
diff --git a/Report/tex/sec/1 introduction.tex b/Report/tex/sec/1 introduction.tex
new file mode 100644
index 0000000..a26a33c
--- /dev/null
+++ b/Report/tex/sec/1 introduction.tex
@@ -0,0 +1,34 @@
+\section{Introduction}
+\label{sec:introduction}
+This report will focus on understanding functional programming
+languages and their differences compared to imperative languages.
+The implementation of the Levenshtein ratio algorithm is discribed in three
+different programming styles and compares the results on multiple fronts.
+
+The Levenshtein ratio algorithm is a commonly used
+algorithm to measure the similarity between two strings.
+It is applied in various fields such as spell checking, DNA sequencing, and plagiarism detection.
+By implementing this algorithm in different programming languages, we can analyze the impact of
+the programming paradigm on performance, code complexity, and maintainability.
+
+The following languages were chosen for this comparison, each representing a different paradigm:
+\begin{itemize}
+ \item[-] \makebox[3.2cm]{\textbf{Haskell (Functional)}\hfill} A purely functional language that
+ emphasizes immutability and recursion. Known for its concise and expressive code.
+ \item[-] \makebox[3.2cm]{\textbf{Csharp (Imperative)}\hfill} An object-oriented language mainly
+ used to develop Windows applications and games.
+ \item[-] \makebox[3.2cm]{\textbf{TypeScript (Semi)}\hfill} A language that supports both imperative
+ and functional constructs. Known for its leniant interperter.
+\end{itemize}
+
+The comparison is based on the following criteria:
+\begin{enumerate}
+ \item[I.] Speed – time complexity and memory usage.
+ \item[II.] Readability – how simple and intuitive the code is.
+ \item[III.] Maintainability – how well the code scales and is extendable.
+ \item[IV.] Complexity of implementation – how difficult it is to correctly implement the algorithm in the chosen language.
+\end{enumerate}
+
+To objectively test the implementations, identical test datasets are used. Multiple test cases are designed that increase in complexity and size, with an expected output. The correctness of the implementations is verified with asserts or unit tests.
+
+This approach provides insight into how different programming paradigms affect the practical implementation of a well-known algorithm.
diff --git a/Report/tex/sec/2 appendice.tex b/Report/tex/sec/2 appendice.tex
new file mode 100644
index 0000000..53dba7a
--- /dev/null
+++ b/Report/tex/sec/2 appendice.tex
@@ -0,0 +1,128 @@
+\onecolumn
+\begin{landscape}
+\section{Appendice}
+
+\subsection*{Benchmark Summaries}
+\begin{figure}[H]
+ \caption{Benchmark results for the TypeScript implementation using the Deno runtime.}
+ \label{code:benchmark-typescript}
+ \begin{minted}[fontsize=\footnotesize]{text}
+ CPU | AMD Ryzen 5 5600X 6-Core Processor
+ Runtime | Deno 2.0.0 (x86_64-unknown-linux-gnu)
+
+ benchmark time/iter (avg) iter/s (min … max) p75 p99 p995
+ --------------------------------------------------- ----------------------------- --------------------- --------------------------
+ levenshteinRatio - short identical strings 5.1 ns 195,400,000 ( 5.0 ns … 24.6 ns) 5.0 ns 7.5 ns 9.2 ns
+ levenshteinRatio - short different strings 144.9 ns 6,904,000 (137.0 ns … 182.7 ns) 148.7 ns 173.1 ns 182.5 ns
+ levenshteinRatio - short similar strings 323.3 ns 3,093,000 (299.4 ns … 613.6 ns) 325.8 ns 465.5 ns 613.6 ns
+ levenshteinRatio - long identical strings 5.3 ns 187,100,000 ( 5.1 ns … 145.6 ns) 5.1 ns 7.9 ns 9.0 ns
+ levenshteinRatio - long different strings 7.0 ms 142.0 ( 6.5 ms … 12.3 ms) 6.9 ms 12.3 ms 12.3 ms
+ levenshteinRatio - long partially similar strings 7.5 ms 133.6 ( 7.2 ms … 8.1 ms) 7.6 ms 8.1 ms 8.1 ms
+ \end{minted}
+\end{figure}
+
+\hfill
+
+\begin{figure}[H]
+ \caption{Benchmark results for the CSharp implementation using BenchmarkDotNet.}
+ \label{code:benchmark-csharp}
+ \begin{minted}[fontsize=\footnotesize]{text}
+ Runtime = .NET 9.0.3 (9.0.325.11113), X64 RyuJIT AVX2; GC = Concurrent Workstation
+ Mean = 3.233 ms, StdErr = 0.004 ms (0.14%), N = 14, StdDev = 0.017 ms
+ Min = 3.204 ms, Q1 = 3.221 ms, Median = 3.233 ms, Q3 = 3.246 ms, Max = 3.259 ms
+ IQR = 0.025 ms, LowerFence = 3.184 ms, UpperFence = 3.283 ms
+ ConfidenceInterval = [3.214 ms; 3.252 ms] (CI 99.9%), Margin = 0.019 ms (0.59% of Mean)
+ Skewness = -0.19, Kurtosis = 1.65, MValue = 2
+
+ BenchmarkDotNet v0.14.0, Debian GNU/Linux 12 (bookworm) (container)
+ AMD Ryzen 5 5600X, 1 CPU, 12 logical and 6 physical cores
+ .NET SDK 9.0.201
+
+ | Method | Mean | Error | StdDev |
+ |---------------------------- |-----------------:|---------------:|---------------:|
+ | ShortIdenticalStrings | 1.410 ns | 0.0510 ns | 0.0793 ns |
+ | ShortDifferentStrings | 112.147 ns | 1.4472 ns | 1.3537 ns |
+ | ShortSimilarStrings | 193.013 ns | 1.8653 ns | 1.7448 ns |
+ | LongIdenticalStrings | 1.097 ns | 0.0221 ns | 0.0196 ns |
+ | LongDifferentStrings | 3,234,542.032 ns | 34,662.1297 ns | 32,422.9776 ns |
+ | LongPartiallySimilarStrings | 3,233,473.960 ns | 18,980.6706 ns | 16,825.8701 ns |
+
+ Mean : Arithmetic mean of all measurements
+ Error : Half of 99.9% confidence interval
+ StdDev : Standard deviation of all measurements
+ 1 ns : 1 Nanosecond (0.000000001 sec)
+
+ Run time: 00:02:27 (147.1 sec), executed benchmarks: 6
+
+ Global total time: 00:03:08 (188.25 sec), executed benchmarks: 6
+ \end{minted}
+\end{figure}
+\hfill
+
+\begin{figure}[H]
+ \caption{Benchmark results for the Haskell implementation using Criterion.}
+ \label{code:benchmark-haskell}
+ \begin{minted}[fontsize=\footnotesize]{text}
+ benchmarking levenshteinRatio - short identical strings
+ time 20.15 ns (19.87 ns .. 20.38 ns)
+ 0.999 R² (0.998 R² .. 0.999 R²)
+ mean 20.15 ns (20.00 ns .. 20.36 ns)
+ std dev 604.4 ps (497.4 ps .. 753.7 ps)
+
+ benchmarking levenshteinRatio - short different strings
+ time 966.6 ns (953.2 ns .. 985.3 ns)
+ 0.996 R² (0.991 R² .. 0.999 R²)
+ mean 992.3 ns (970.7 ns .. 1.036 μs)
+ std dev 97.98 ns (50.78 ns .. 187.7 ns)
+
+ benchmarking levenshteinRatio - short similar strings
+ time 2.410 μs (2.386 μs .. 2.436 μs)
+ 0.999 R² (0.999 R² .. 1.000 R²)
+ mean 2.391 μs (2.374 μs .. 2.417 μs)
+ std dev 69.63 ns (50.30 ns .. 104.4 ns)
+
+ benchmarking levenshteinRatio - long identical strings
+ time 3.786 μs (3.765 μs .. 3.815 μs)
+ 1.000 R² (0.999 R² .. 1.000 R²)
+ mean 3.815 μs (3.795 μs .. 3.842 μs)
+ std dev 79.62 ns (63.85 ns .. 103.2 ns)
+
+ benchmarking levenshteinRatio - long different strings
+ time 1.178 s (847.8 ms .. 1.411 s)
+ 0.991 R² (0.970 R² .. 1.000 R²)
+ mean 1.174 s (1.121 s .. 1.245 s)
+ std dev 68.38 ms (32.52 ms .. 85.07 ms)
+
+ benchmarking levenshteinRatio - long partially similar strings
+ time 1.159 s (816.3 ms .. 1.381 s)
+ 0.990 R² (0.968 R² .. 1.000 R²)
+ mean 1.158 s (1.120 s .. 1.214 s)
+ std dev 53.67 ms (17.17 ms .. 70.20 ms)
+ \end{minted}
+\end{figure}
+\hfill
+
+\subsection*{Source Code}
+\begin{figure}[H]
+ \caption{TypeScript implementation of the Levenshtein distance algorithm.}
+ \label{code:typescript}
+ \inputminted[fontsize=\footnotesize]{typescript}{./doc/levenshteinRatio.ts}
+\end{figure}
+
+\hfill
+
+\begin{figure}[H]
+ \caption{C\# implementation of the Levenshtein distance algorithm.}
+ \label{code:csharp}
+ \inputminted[fontsize=\footnotesize]{csharp}{./doc/LevenshteinRatio.cs}
+\end{figure}
+
+\hfill
+
+\begin{figure}[H]
+ \caption{Haskell implementation of the Levenshtein distance algorithm.}
+ \label{code:haskell}
+ \inputminted[fontsize=\footnotesize]{haskell}{./doc/LevenshteinRatio.hs}
+\end{figure}
+
+\end{landscape}
diff --git a/Report/tex/tmp/.gitkeep b/Report/tex/tmp/.gitkeep
new file mode 100644
index 0000000..c2931ef
--- /dev/null
+++ b/Report/tex/tmp/.gitkeep
@@ -0,0 +1 @@
+Contains build files
diff --git a/Report/tex/variables.tex b/Report/tex/variables.tex
new file mode 100644
index 0000000..268fbef
--- /dev/null
+++ b/Report/tex/variables.tex
@@ -0,0 +1,26 @@
+\graphicspath{ {./img/} }
+\pgfplotsset{compat=1.18}
+
+\title{\titlecap{\scshape Comparison of the Levenshtein Ratio Algorithm in Haskell, C\# and TypeScript}}
+\author{Wessel Tip $<$contact@wessel.gg$>$ (\url{https://wessel.gg/})\\
+\\
+Minor Advanced Software Engineering \\
+NHL Stenden University of Applied Sciences \\
+Year 3, Semester 2 (Jan. 2025 - Jun. 2025)}
+
+% Empty date
+\date{\today}
+
+% Sets the description name of code blocks to "Source Code"
+\newenvironment{code}{\captionsetup{type=listing}}{}
+\SetupFloatingEnvironment{listing}{name=Source Code}
+
+\renewcommand{\theFancyVerbLine}{\sffamily
+\textcolor[rgb]{0.5,0.5,1.0}{\scriptsize
+\oldstylenums{\arabic{FancyVerbLine}}}}
+
+% Sets the bibliography style to IEEE
+\bibliographystyle{IEEEtran}
+
+% Disables the no citations error
+\nocite{*}
diff --git a/Typescript/benchmark.zip b/Typescript/benchmark.zip
new file mode 100644
index 0000000..f01a196
Binary files /dev/null and b/Typescript/benchmark.zip differ
diff --git a/Typescript/levenshteinRatio.bench.ts b/Typescript/levenshteinRatio.bench.ts
new file mode 100644
index 0000000..7f364db
--- /dev/null
+++ b/Typescript/levenshteinRatio.bench.ts
@@ -0,0 +1,29 @@
+import { levenshteinRatio } from "./levenshteinRatio.ts";
+
+const longStringA = new Array(1000).fill('a').join('');
+const longStringB = new Array(1000).fill('b').join('');
+const longStringC = new Array(500).fill('a').join('') + new Array(500).fill('b').join('');
+
+Deno.bench("levenshteinRatio - short identical strings", () => {
+ levenshteinRatio("test", "test");
+});
+
+Deno.bench("levenshteinRatio - short different strings", () => {
+ levenshteinRatio("test", "abcd");
+});
+
+Deno.bench("levenshteinRatio - short similar strings", () => {
+ levenshteinRatio("kitten", "sitting");
+});
+
+Deno.bench("levenshteinRatio - long identical strings", () => {
+ levenshteinRatio(longStringA, longStringA);
+});
+
+Deno.bench("levenshteinRatio - long different strings", () => {
+ levenshteinRatio(longStringA, longStringB);
+});
+
+Deno.bench("levenshteinRatio - long partially similar strings", () => {
+ levenshteinRatio(longStringC, longStringA);
+});
diff --git a/Typescript/levenshteinRatio.test.ts b/Typescript/levenshteinRatio.test.ts
new file mode 100644
index 0000000..e8312c1
--- /dev/null
+++ b/Typescript/levenshteinRatio.test.ts
@@ -0,0 +1,40 @@
+import { assertEquals } from "jsr:@std/assert";
+import { levenshteinRatio } from "./levenshteinRatio.ts";
+
+Deno.test("levenshteinRatio should return 1 for empty strings", () => {
+ assertEquals(levenshteinRatio("", ""), 1);
+});
+
+Deno.test("levenshteinRatio should return 0 if one string is empty", () => {
+ assertEquals(levenshteinRatio("", "test"), 0);
+ assertEquals(levenshteinRatio("test", ""), 0);
+});
+
+Deno.test("levenshteinRatio should return 0 if one string is null", () => {
+ assertEquals(levenshteinRatio("test", null!), 0);
+ assertEquals(levenshteinRatio(null!, ""), 0);
+ assertEquals(levenshteinRatio(null!, null!), 0);
+});
+
+Deno.test("levenshteinRatio should return 1 for identical strings", () => {
+ assertEquals(levenshteinRatio("test", "test"), 1);
+});
+
+Deno.test("levenshteinRatio should return 1 for long identical strings", () => {
+ const longString = new Array(10000).fill('a').join('');
+ assertEquals(levenshteinRatio(longString, longString), 1);
+});
+
+Deno.test("levenshteinRatio should return 0 for different strings", () => {
+ assertEquals(levenshteinRatio("test", "example"), 0);
+});
+
+Deno.test("levenshteinRatio should return 0 for long different strings", () => {
+ const longStringA = new Array(10000).fill('a').join('');
+ const longStringB = new Array(10000).fill('b').join('');
+ assertEquals(levenshteinRatio(longStringA, longStringB), 0);
+});
+
+Deno.test("levenshteinRatio should return a value between 0 and 1 for similar strings", () => {
+ assertEquals(levenshteinRatio("kitten", "sitting"), 0.5714285714285714);
+});
\ No newline at end of file
diff --git a/Typescript/levenshteinRatio.ts b/Typescript/levenshteinRatio.ts
new file mode 100644
index 0000000..e246858
--- /dev/null
+++ b/Typescript/levenshteinRatio.ts
@@ -0,0 +1,48 @@
+/**
+ * Compare `target` to `source` using LevenshteinRatio
+ *
+ * @param {string} target The string to compare with `source`
+ * @param {string} source The string to compare with `target`
+ * @returns {number} The Levenshtein distance between `target` and `source`
+ * @example
+ *
+ * levenshteinRatio('exampel', 'example')
+ * // => 0.7142857142857143
+ */
+export function levenshteinRatio(target: string, source: string): number {
+ // edge cases: source or target is empty, source equals target
+ if (source === null || target === null) return 0.0;
+ if (source === target) return 1.0;
+ if (source.length === 0 || target.length === 0) return 0.0;
+
+ // create matrix to store the distances between each character in
+ // the source and target strings and populate it
+ const distanceMatrix = new Array(source.length + 1);
+ for (let i = 0; i < distanceMatrix.length; i++) distanceMatrix[i] = new Array(target.length + 1);
+
+ for (let i = 0; i <= source.length; distanceMatrix[i][0] = i++);
+ for (let i = 0; i <= target.length; distanceMatrix[0][i] = i++);
+
+ // Fill the rows and columns of the distance matrix by comparing the characters in the source
+ // and target strings and calculating the cost (1 if characters are the same)
+ for (let i = 1; i <= source.length; i++) {
+ for (let j = 1; j <= target.length; j++) {
+ const cost = target.charAt(j - 1) === source.charAt(i - 1) ? 0 : 1;
+
+ distanceMatrix[i][j] =
+ Math.min(
+ Math.min(
+ distanceMatrix[i - 1][j] + 1,
+ distanceMatrix[i][j - 1] + 1
+ ),
+ distanceMatrix[i - 1][j - 1] + cost
+ );
+ }
+ }
+
+ // Calculate the ratio of similarity by dividing the distance by the maximum length
+ // of the two strings and subtracting the result from 1.0
+ const totalDistance = distanceMatrix[source.length][target.length] / Math.max(source.length, target.length);
+
+ return 1.0 - totalDistance;
+};
\ No newline at end of file
diff --git a/Typescript/profiler.sh b/Typescript/profiler.sh
new file mode 100644
index 0000000..7e1498e
--- /dev/null
+++ b/Typescript/profiler.sh
@@ -0,0 +1,5 @@
+rm deno-bench.json perf.data perf.data.txt
+
+sudo perf record -F MAX -g /home/wessel/.deno/bin/deno bench --json > deno-bench.json
+sudo chown $USER:$USER ./perf.data
+perf script -i perf.data > perf.data.txt