Merge branch 'master' into implement-stacks-queues-rust

Author: PeanutbutterWarrior

.devcontainer/devcontainer.json

@@ -3,7 +3,7 @@
 {
 	"name": "Ubuntu",
 	"build": {
-		"dockerfile": "Dockerfile",
+		"dockerfile": "../Dockerfile",
 		// Update 'VARIANT' to pick an Ubuntu version: focal, bionic
 		"args": { "VARIANT": "focal" }
 	},

.github/workflows/publish_container.yml

@@ -0,0 +1,17 @@
+name: Publish Docker
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Publish to Registry
+      uses: elgohr/Publish-Docker-Github-Action@master
+      with:
+        name: algorithm-archivists/aaa-langs
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+        registry: ghcr.io

.gitignore

@@ -524,3 +524,7 @@ vscode/
 
 # SCons build directory
 build/
+
+# Cargo artifacts
+Cargo.lock
+target/

.nojekyll

@@ -6,7 +6,7 @@ FROM mcr.microsoft.com/vscode/devcontainers/base:0-${VARIANT}
 
 # [Optional] Uncomment this section to install additional OS packages.
 RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
-    && apt-get -y install --no-install-recommends build-essential software-properties-common xz-utils g++ sbcl julia python3 python3-pip python3-dev ghc openjdk-11-jdk rustc libssl-dev gfortran libxml2-dev libyaml-dev libgmp-dev libz-dev libncurses5 gnuplot nodejs npm lua5.3 ocaml php ruby-full gnu-smalltalk scratch libfftw3-dev
+    && apt-get -y install --no-install-recommends build-essential software-properties-common xz-utils g++ sbcl julia python3 python3-pip python3-dev ghc openjdk-11-jdk libssl-dev gfortran libxml2-dev libyaml-dev libgmp-dev libz-dev libncurses5 gnuplot nodejs npm lua5.3 ocaml php ruby-full gnu-smalltalk scratch libfftw3-dev cmake
 
 # Setup Crystal
 RUN echo 'deb http://download.opensuse.org/repositories/devel:/languages:/crystal/xUbuntu_20.04/ /' | sudo tee /etc/apt/sources.list.d/devel:languages:crystal.list
@@ -40,17 +40,16 @@ ENV PATH=$PATH:~/dlang/dmd-$DLANG_VERSION/linux/bin64/
 RUN sudo sh -c 'wget -c https://dl.google.com/go/go1.14.2.linux-amd64.tar.gz -O - | sudo tar -xz -C /usr/local'
 ENV PATH=$PATH:/usr/local/go/bin
 
-# Setup Kotlin (doesnt unzip right maybe?)
-RUN sudo sh -c 'wget -c https://github.com/JetBrains/kotlin/releases/download/v1.5.30/kotlin-compiler-1.5.30.zip -O /usr/local/kotlinc.zip'
-RUN unzip /usr/local/kotlinc.zip
-ENV PATH=$PATH:/usr/local/kotlinc/bin
+# Setup Kotlin
+RUN mkdir -p ~/kotlin && wget -c https://github.com/JetBrains/kotlin/releases/download/v1.5.30/kotlin-compiler-1.5.30.zip -O ~/kotlin/kotlinc.zip && cd ~/kotlin && unzip kotlinc.zip
+ENV PATH=$PATH:~/kotlin/kotlinc/bin
 
 # Setup lolcode
-## Use: https://github.com/justinmeza/lci
+RUN git clone https://github.com/justinmeza/lci.git ~/lolcode && cd ~/lolcode && mkdir build && cd build && cmake .. && make -B
+ENV PATH=$PATH:~/lolcode/build
 
 # Setup Piet
-## Use: https://github.com/boothby/repiet
-
+RUN pip install repiet
 
 # Setup Matlab
 # ?????? This is a licensed language???
@@ -73,6 +72,9 @@ RUN sudo add-apt-repository 'deb https://cloud.r-project.org/bin/linux/ubuntu fo
 RUN sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys D9D33FCD84D82C17288BA03B3C9A6980F827E01E
 RUN sudo add-apt-repository 'deb http://ppa.launchpad.net/plt/racket/ubuntu focal main'
 
+# Setup Rust
+RUN curl https://sh.rustup.rs -sSf | sh -s -- -y
+
 # Setup Scratch
 ## using 1.x right now.... in future checkout snap or adobe air?
 
@@ -86,7 +88,8 @@ ENV PATH=$PATH:~/swift/usr/bin
 RUN export DEBIAN_FRONTEND=noninteractive && apt-get -y install --no-install-recommends vim
 
 # Setup whitespace
-## ?
+RUN mkdir -p ~/whitespace && git clone https://github.com/wspace/whitespace-haskell ~/whitespace && cd ~/whitespace && make -B
+ENV PATH=$PATH:~/whitespace
 
 # Setup Elm
 RUN mkdir -p ~/elm && curl -L -o ~/elm/elm.gz https://github.com/elm/compiler/releases/download/0.19.1/binary-for-linux-64-bit.gz && \
@@ -102,6 +105,7 @@ ENV PATH=$PATH:~/vlang/v
 RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
     && apt-get -y install --no-install-recommends crystal dart nim powershell scala dotnet-sdk-5.0 r-base racket
 
+
 RUN pip install wheel matplotlib numpy coconut scons
 
 RUN sudo sh -c 'npm install -g typescript'

.devcontainer/Dockerfile renamed to Dockerfile

@@ -5,16 +5,66 @@ This provides Builder objects for each of the language implementations in the AA
 
 Currently, the aim is to provide a way to compile or copy the implementation files to the build directory, as well as to provide ways to run them and capture their output.
 
-To run the compilation for all implmeentations in one language, e.g. Rust, run the command `scons build/c`, and the resulting executables will be available in the `cuild/c` directory, each in their respective algorithm directory, containing the executable."""
+To run the compilation for all implementations in one language, e.g. C, run the command `scons build/c`, and the resulting executables will be available in the `build/c` directory, each in their respective algorithm directory, containing the executable."""
 
 from pathlib import Path
+import os
 
-env = Environment()
+rust_cargo_builder = Builder(action=['cargo build --bins --manifest-path $MANIFEST',
+                                     Move('$TARGET$PROGSUFFIX', '$SOURCE_DIR/target/debug/main$PROGSUFFIX')])
+
+rust_rustc_builder = Builder(action='rustc $SOURCE -o $TARGET$PROGSUFFIX')
+
+go_builder = Builder(action='go build -o $TARGET$PROGSUFFIX $SOURCE')
+
+env = Environment(ENV=os.environ,
+                  BUILDERS={'rustc': rust_rustc_builder,
+                            'cargo': rust_cargo_builder,
+                            'Go': go_builder},
+                  tools=['gcc', 'gnulink', 'g++', 'gas', 'gfortran'])
+
+env['CCFLAGS'] = ''
+env['CXXFLAGS'] = '-std=c++17'
+env['ASFLAGS'] = '--64'
 
 # Add other languages here when you want to add language targets
-languages = ['c']
+# Put 'name_of_language_directory' : 'file_extension'
+languages = {
+    'c': 'c',
+    'cpp': 'cpp',
+    'asm-x64': 's',
+    'rust': 'rs',
+    'go': 'go',
+    'fortran': 'f90',
+}
 
 env.C = env.Program
+env.CPlusPlus = env.Program
+env.X64 = env.Program
+env.Fortran = env.Program
+
+Export('env')
+
+sconscripts = []
+files_to_compile = {language: [] for language in languages}
+
+for chapter_dir in Path.cwd().joinpath('contents').iterdir():
+    if (code_dir := (chapter_dir / 'code')).exists():
+        for path in code_dir.iterdir():
+            if path.stem in languages:
+                # Check for overriding sconscript
+                if (sconscript_path := path / 'SConscript').exists():
+                    sconscripts.append(sconscript_path)
+                    SConscript(sconscript_path, exports='env')
+                else:
+                    files_to_compile[path.stem].extend(path.glob(f'*.{languages[path.stem]}'))
 
-SConscript('SConscript', exports='env languages')
+sconscript_dir_path = Path('sconscripts')
+for language, files in files_to_compile.items():
+    if files:
+        if (sconscript_path := sconscript_dir_path / f"{language}_SConscript").exists():
+            SConscript(sconscript_path, exports = {'files_to_compile': files,
+                                                   'language': language})
+        else:
+            print(f'{language} file found at {files[0]}, but no sconscript file is present ')
 

SConscript

@@ -63,19 +63,24 @@ void test_approximation_count(size_t n_trials, size_t n_items, double a,
     }
     double avg = sum / n_trials;
 
-    assert(fabs((avg - n_items) / n_items) < threshold);
+    if (fabs((avg - n_items) / n_items) < threshold){
+        printf("passed\n");
+    }
+    else{
+        printf("failed\n");
+    }
 }
 
 int main()
 {
     srand(time(NULL));
 
-    printf("Counting Tests, 100 trials\n");
-    printf("testing 1000, a = 30, 10%% error\n");
+    printf("[#]\nCounting Tests, 100 trials\n");
+    printf("[#]\ntesting 1,000, a = 30, 10%% error\n");
     test_approximation_count(100, 1000, 30, 0.1);
-    printf("testing 12345, a = 10, 10%% error\n");
+    printf("[#]\ntesting 12,345, a = 10, 10%% error\n");
     test_approximation_count(100, 12345, 10, 0.1);
-    printf("testing 222222, a = 0.5, 20%% error\n");
+    printf("[#]\ntesting 222,222, a = 0.5, 20%% error\n");
     test_approximation_count(100, 222222, 0.5, 0.2);
 
     return 0;

SConstruct

@@ -55,17 +55,17 @@ auto test_approximate_count(
   for (auto i = 0; i < n_trials; ++i)
     sum += approximate_count(n_items, a);
   const auto avg = sum / n_trials;
-  return std::abs((avg - n_items) / n_items) < threshold ? "pass" : "fail";
+  return std::abs((avg - n_items) / n_items) < threshold ? "passed" : "failed";
 }
 
 int main() {
-  std::cout << "Counting Tests, 100 trials\n";
+  std::cout << "[#]\nCounting Tests, 100 trials\n";
 
-  std::cout << "testing 1,000, a = 30, 10% error "
+  std::cout << "[#]\ntesting 1,000, a = 30, 10% error \n"
             << test_approximate_count(100, 1000, 30, 0.1) << "\n";
-  std::cout << "testing 12,345, a = 10, 10% error "
+  std::cout << "[#]\ntesting 12,345, a = 10, 10% error \n"
             << test_approximate_count(100, 12345, 10, 0.1) << "\n";
   // Note : with a lower a, we need more trials, so a higher % error here.
-  std::cout << "testing 222,222, a = 0.5, 20% error "
+  std::cout << "[#]\ntesting 222,222, a = 0.5, 20% error \n"
             << test_approximate_count(100, 222222, 0.5, 0.2) << "\n";
 }

contents/approximate_counting/code/c/approximate_counting.c

@@ -47,15 +47,21 @@ function test_approximate_count(n_trials, n_items, a, threshold)
 
     avg = sum(samples)/n_trials
 
-    @test (abs((avg - n_items) / n_items) < threshold)
+    if (abs((avg - n_items) / n_items) < threshold)
+        println("passed")
+    else
+        println("failed")
+    end
 end
 
-@testset "Counting Tests, 100 trials" begin
-    println("testing 1,000, a = 30, 10% error")
-        test_approximate_count(100, 1000, 30, 0.1)
-    println("testing 12,345, a = 10, 10% error")
-        test_approximate_count(100, 12345, 10, 0.1)
-    # Note: with a lower a, we need more trials, so a higher % error here.
-    println("testing 222,222, a = 0.5, 20% error")
-        test_approximate_count(100, 222222, 0.5, 0.2)
-end
+println("[#]\nCounting Tests, 100 trials")
+
+println("[#]\ntesting 1,000, a = 30, 10% error")
+test_approximate_count(100, 1000, 30, 0.1)
+
+println("[#]\ntesting 12,345, a = 10, 10% error")
+test_approximate_count(100, 12345, 10, 0.1)
+
+# Note: with a lower a, we need more trials, so a higher % error here.
+println("[#]\ntesting 222,222, a = 0.5, 20% error")
+test_approximate_count(100, 222222, 0.5, 0.2)

contents/approximate_counting/code/cpp/approximate_counting.cpp

@@ -40,10 +40,13 @@ def test_approximate_count(n_trials, n_items, a, threshold):
 
     if abs((avg - n_items)/n_items) < threshold:
         print("passed")
+    else:
+        print("failed")
 
-print("testing 1,000, a = 30, 10% error")
+print("[#]\nCounting Tests, 100 trials")
+print("[#]\ntesting 1,000, a = 30, 10% error")
 test_approximate_count(100, 1000, 30, 0.1)
-print("testing 12,345, a = 10, 10% error")
+print("[#]\ntesting 12,345, a = 10, 10% error")
 test_approximate_count(100, 12345, 10, 0.1)
-print("testing 222,222, a = 0.5, 20% error")
+print("[#]\ntesting 222,222, a = 0.5, 20% error")
 test_approximate_count(100, 222222, 0.5, 0.2)

contents/approximate_counting/code/julia/approximate_counting.jl

@@ -24,7 +24,7 @@ In this chapter, I hope to provide a slightly more satisfying answer by introduc
 
 | Hutchinson Operator | Attractor |
 | ------------------- | --------- |
-| $$\begin{align} f_1(P) &= \begin{bmatrix} 0 &0 \\ 0 &0.16 \end{bmatrix}P + \begin{bmatrix} 0 \\ 0 \end{bmatrix} \\ f_2(P) &= \begin{bmatrix} 0.85 &0.04 \\ -0.04 &0.85 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix} \\ f_3(P) &= \begin{bmatrix} 0.2 &-0.26 \\ 0.23 &022 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix} \\ f_4(P) &= \begin{bmatrix} -0.15 &0.28 \\ 0.26 &0.24 \end{bmatrix}P + \begin{bmatrix} 0 \\ 0.44 \end{bmatrix} \end{align}$$ | <img class="center" src="res/full_fern.png" alt="Barnsley Chaos Game"  style="width:100%"> |
+| $$\begin{align} f_1(P) &= \begin{bmatrix} 0 &0 \\ 0 &0.16 \end{bmatrix}P + \begin{bmatrix} 0 \\ 0 \end{bmatrix} \\ f_2(P) &= \begin{bmatrix} 0.85 &0.04 \\ -0.04 &0.85 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix} \\ f_3(P) &= \begin{bmatrix} 0.2 &-0.26 \\ 0.23 &0.22 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix} \\ f_4(P) &= \begin{bmatrix} -0.15 &0.28 \\ 0.26 &0.24 \end{bmatrix}P + \begin{bmatrix} 0 \\ 0.44 \end{bmatrix} \end{align}$$ | <img class="center" src="res/full_fern.png" alt="Barnsley Chaos Game"  style="width:100%"> |
 
 At first glance, this set of functions looks like an incomprehensible mess of magic numbers to create a specific result, and in a sense, that is precisely correct.
 That said, we will go through each function and explain how it works, while also providing a simple chaos game implementation in code.
@@ -54,7 +54,7 @@ Now let's hop into disecting the Barnsley fern by seeing how each transform affe
 | -------- | --------- |
 | $$f_1(P) = \begin{bmatrix} 0 &0 \\ 0 &0.16 \end{bmatrix}P + \begin{bmatrix} 0 \\ 0 \end{bmatrix}$$ <p> This operation moves every point to a single line. | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/affine_rnd_0.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
 | $$f_2(P) = \begin{bmatrix} 0.85 &0.04 \\ -0.04 &0.85 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix}$$ <p> This operation moves every point up and to the right. | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/affine_rnd_1.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
-| $$f_3(P) = \begin{bmatrix} 0.2 &-0.26 \\ 0.23 &022 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix}$$ <p> This operation rotates every point to the left. | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/affine_rnd_2.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
+| $$f_3(P) = \begin{bmatrix} 0.2 &-0.26 \\ 0.23 &0.22 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix}$$ <p> This operation rotates every point to the left. | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/affine_rnd_2.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
 | $$f_4(P) = \begin{bmatrix} -0.15 &0.28 \\ 0.26 &0.24 \end{bmatrix}P + \begin{bmatrix} 0 \\ 0.44 \end{bmatrix}$$ <p> This operation flips every point and rotates to the right.| <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/affine_rnd_3.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
 
 At this stage, it *might* be clear what is going on, but it's not exactly obvious.
@@ -71,7 +71,7 @@ The easiest way to make sense of this is to show the operations on the Barnsley
 | -------- | --------- |
 | $$f_1(P) = \begin{bmatrix} 0 &0 \\ 0 &0.16 \end{bmatrix}P + \begin{bmatrix} 0 \\ 0 \end{bmatrix}$$ | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/affine_fern_0.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
 | $$f_2(P) = \begin{bmatrix} 0.85 &0.04 \\ -0.04 &0.85 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix}$$ | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/affine_fern_1.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
-| $$f_3(P) = \begin{bmatrix} 0.2 &-0.26 \\ 0.23 &022 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix}$$ | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/affine_fern_2.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
+| $$f_3(P) = \begin{bmatrix} 0.2 &-0.26 \\ 0.23 &0.22 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix}$$ | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/affine_fern_2.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
 | $$f_4(P) = \begin{bmatrix} -0.15 &0.28 \\ 0.26 &0.24 \end{bmatrix}P + \begin{bmatrix} 0 \\ 0.44 \end{bmatrix}$$ | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/affine_fern_3.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
 
 Here, the self-similar nature of the fern becomes apparent.
@@ -86,7 +86,7 @@ To account for this, each function is also given a probability of being chosen:
 | -------- | ----------- |
 | $$f_1(P) = \begin{bmatrix} 0 &0 \\ 0 &0.16 \end{bmatrix}P + \begin{bmatrix} 0 \\ 0 \end{bmatrix}$$ | 0.01 |
 | $$f_2(P) = \begin{bmatrix} 0.85 &0.04 \\ -0.04 &0.85 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix}$$ | 0.85 |
-| $$f_3(P) = \begin{bmatrix} 0.2 &-0.26 \\ 0.23 &022 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix}$$ | 0.07 |
+| $$f_3(P) = \begin{bmatrix} 0.2 &-0.26 \\ 0.23 &0.22 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix}$$ | 0.07 |
 | $$f_4(P) = \begin{bmatrix} -0.15 &0.28 \\ 0.26 &0.24 \end{bmatrix}P + \begin{bmatrix} 0 \\ 0.44 \end{bmatrix}$$ | 0.07 |
 
 ## Playing around a bit...
@@ -98,7 +98,7 @@ Here are a few examples of ferns that can be generated by modifying constituent
 | -------- | --------- |
 | $$f_1(P) = \begin{bmatrix} \tau &0 \\ 0 &0.16 \end{bmatrix}P + \begin{bmatrix} 0 \\ 0 \end{bmatrix}$$ <p> where $$-0.5 < \tau < 0.5 $$ <p> Turning stems to leaves | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/fern_twiddle_0.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
 | $$f_2(P) = \begin{bmatrix} 0.85 & \tau \\ -0.04 &0.85 \end{bmatrix}P + \begin{bmatrix} 0 \\ 1.6 \end{bmatrix}$$ <p> where $$ -0.01 < \tau < 0.09 $$ <p> Changing fern tilt | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/fern_twiddle_1.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
-| $$f_3(P) = \begin{bmatrix} 0.2 &-0.26 \\ 0.23 &022 \end{bmatrix}P + \begin{bmatrix} \tau \\ 1.6 \end{bmatrix}$$ <p> where $$-0.5 < \tau < 0.5$$ <p> Plucking left leaves | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/fern_twiddle_2.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
+| $$f_3(P) = \begin{bmatrix} 0.2 &-0.26 \\ 0.23 &0.22 \end{bmatrix}P + \begin{bmatrix} \tau \\ 1.6 \end{bmatrix}$$ <p> where $$-0.5 < \tau < 0.5$$ <p> Plucking left leaves | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/fern_twiddle_2.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
 | $$f_4(P) = \begin{bmatrix} -0.15 &0.28 \\ 0.26 &0.24 \end{bmatrix}P + \begin{bmatrix} \tau \\ 0.44 \end{bmatrix}$$ <p> where $$-0.5 < \tau < 0.5$$ <p> Plucking right leaves | <div style="text-align:center"> <video style="width:100%" controls loop> <source src="res/fern_twiddle_3.mp4" type="video/mp4"> Your browser does not support the video tag. </video> </div> |
 
 As an important note: the idea of modifying a resulting image by twiddling the knobs of an affine transform is the heart of many interesting methods, including fractal image compression where a low resolution version of an image is stored along with a reconstructing function set to generate high-quality images on-the-fly {{ "fractal-compression" | cite }}{{ "saupe1994review" | cite }}.
@@ -135,6 +135,8 @@ The biggest differences between the two code implementations is that the Barnsle
 [import, lang:"java"](code/java/Barnsley.java)
 {% sample lang="coco" %}
 [import, lang:"coconut"](code/coconut/barnsley.coco)
+{% sample lang="hs" %}
+[import, lang:"haskell"](code/haskell/Barnsley.hs)
 {% endmethod %}
 
 ### Bibliography