From 8c074a4ba811738ceb51fb0c637203299082913e Mon Sep 17 00:00:00 2001 From: Ryan Boldi Date: Thu, 3 Mar 2022 21:29:42 -0500 Subject: [PATCH] update documentation to include simplification --- doc/intro.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/doc/intro.md b/doc/intro.md index 2a2a4ec..0e67dcf 100644 --- a/doc/intro.md +++ b/doc/intro.md @@ -1,3 +1,32 @@ -# Introduction to propeller +# Introduction to Propeller TODO: write [great documentation](http://jacobian.org/writing/what-to-write/) + + + + +# Simplification + +To use Propeller's auto-simplification system, simply include the following four command line arguments when running a problem: + +```clojure +:simplification? true +``` +Toggle auto-simplification +```clojure +:simplification-k 4 +``` +This is the upper bound for elements deleted from the plushy every step. Every step, a number in $[1, k]$ of elements is deleted from the plushy representation of the solution. +```clojure +:simplification-steps 1000 +``` +Number of simplification steps to perform +```clojure +:simplification-verbose? true +``` +whether or not to output simplification info into the output of the evolutionary run. +The output with verbose adds the following lines to the output: +```clojure +{:start-plushy-length 42, :k 4} +{:final-plushy-length 13, :final-plushy (:in1 :in1 :integer_quot :in1 :in1 :exec_dup :in1 :integer_mult close :exec_dup :integer_add 1 :integer_add)} +``` \ No newline at end of file