From a07f5ba17b77c96d6fbbc7bf762ed7766073de3e Mon Sep 17 00:00:00 2001 From: Ashley Bao Date: Fri, 20 Jan 2023 15:21:08 -0500 Subject: [PATCH] udpate docs --- docs/index.html | 6 +++--- docs/propeller.push.instructions.html | 5 ++--- docs/propeller.push.state.html | 2 +- src/propeller/push/instructions.cljc | 3 ++- src/propeller/push/state.cljc | 1 + 5 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/index.html b/docs/index.html index 8ff9ea1..23126c4 100644 --- a/docs/index.html +++ b/docs/index.html @@ -25,8 +25,8 @@

Public variables and functions:

propeller.problems.software.smallest

SMALLEST PROBLEM from C. Le Goues et al., "The ManyBugs and IntroClass Benchmarks

Public variables and functions:

propeller.problems.string-classification

String Classification:

Public variables and functions:

propeller.problems.valiant

Possibly impossible to solve with genetic programming. Stems from the work of Leslie Valiant and involves determining the parity of an unknown subsequence of a larger sequence of bits.

-

Public variables and functions:

propeller.push.instructions

FIXME: write docs

-

Public variables and functions:

propeller.push.instructions.bool

BOOLEAN Instructions, created with propeller.push.instructions/def-instruction

+

Public variables and functions:

propeller.push.instructions

Push Instructions

+

Public variables and functions:

propeller.push.instructions.bool

BOOLEAN Instructions, created with propeller.push.instructions/def-instruction

Public variables and functions:

    propeller.push.instructions.character

    CHAR Instructions, created with propeller.push.instructions/def-instruction

    Public variables and functions:

      propeller.push.instructions.code

      CODE Instructions, created with propeller.push.instructions/def-instruction

      Public variables and functions:

        propeller.push.instructions.input-output

        INPUT and OUTPUT Instructions

        @@ -36,7 +36,7 @@

        Public variables and functions:

          propeller.push.instructions.vector

          VECTOR instructions for all vector element subtypes: BOOLEAN, FLOAT, INTEGER, and STRING.

          Public variables and functions:

          propeller.push.interpreter

          Interprets Push programs.

          Public variables and functions:

          propeller.push.limits

          Values used by the Push instructions to keep the stack sizes within reasonable limits and values used by the Push instructions to keep computed values within reasonable size limits.

          -

          Public variables and functions:

          propeller.push.state

          FIXME: write docs

          +

          Public variables and functions:

          propeller.push.state

          Push states

          Public variables and functions:

          propeller.selection

          Propeller includes many kinds of genetic operators to select parents within the population such as tournament selection, lexicase selection, and epsilon lexicase selection.

          Public variables and functions:

          propeller.simplification

          To use Propeller’s auto-simplification system, simply include the following four command line arguments when running a problem:

          Public variables and functions:

          propeller.tools.calculus

          Functions for calculus operations

          diff --git a/docs/propeller.push.instructions.html b/docs/propeller.push.instructions.html index b53b3ab..8704feb 100644 --- a/docs/propeller.push.instructions.html +++ b/docs/propeller.push.instructions.html @@ -1,8 +1,7 @@ -propeller.push.instructions documentation

          Project

          Topics

          Namespaces

          Public Vars

          propeller.push.instructions

          FIXME: write docs

          -

          cls->type

          FIXME: write docs

          -

          def-instruction

          (def-instruction instruction function)

          Defines a Push instruction as a keyword-function pair, and adds it to the instruction table

          +propeller.push.instructions documentation

          Project

          Topics

          Namespaces

          Public Vars

          propeller.push.instructions

          Push Instructions

          +

          def-instruction

          (def-instruction instruction function)

          Defines a Push instruction as a keyword-function pair, and adds it to the instruction table

          generate-instructions

          (generate-instructions stacks functions)

          Given a sequence of stacks, e.g. :float :integer, and a sequence of suffix function strings, e.g. _add, _mult, _eq, automates the generation of all possible combination instructions, which here would be :float_add, :float_mult, :float_eq, :integer_add, :integer_mult, and :integer_eq, also transferring and updating the generic function’s stack-type metadata. For some vector instructions, the placeholder :elem will be replaced with the stack of the corresponding element type (e.g. for :vector_integer, with :integer)

          get-literal-type

          (get-literal-type data)

          If a piece of data is a literal, return its corresponding stack name e.g. :integer. Otherwise, return nil.

          get-stack-instructions

          (get-stack-instructions stacks)

          Given a set of stacks, returns all instructions that operate on those stacks only. Won’t include random instructions unless :random is in the set as well

          diff --git a/docs/propeller.push.state.html b/docs/propeller.push.state.html index a361a5d..357f641 100644 --- a/docs/propeller.push.state.html +++ b/docs/propeller.push.state.html @@ -1,6 +1,6 @@ -propeller.push.state documentation

          Project

          Topics

          Namespaces

          Public Vars

          propeller.push.state

          FIXME: write docs

          +propeller.push.state documentation

          Project

          Topics

          Namespaces

          Public Vars

          propeller.push.state

          Push states

          empty-stack?

          (empty-stack? state stack)

          Returns true if the stack is empty

          example-state

          FIXME: write docs

          get-args-from-stacks

          (get-args-from-stacks state stacks)

          Takes a state and a collection of stacks to take args from. If there are enough args on each of the desired stacks, returns a map with keys {:state :args}, where :state is the new state and :args is a list of args popped from the stacks. If there aren’t enough args on the stacks, returns :not-enough-args without popping anything

          diff --git a/src/propeller/push/instructions.cljc b/src/propeller/push/instructions.cljc index 7a66236..4f65c3c 100644 --- a/src/propeller/push/instructions.cljc +++ b/src/propeller/push/instructions.cljc @@ -1,4 +1,5 @@ (ns propeller.push.instructions + "Push Instructions" (:require [clojure.set] [propeller.push.state :as state] [propeller.utils :as u] @@ -45,7 +46,7 @@ can be either constant literals or functions that take and return a Push state" #?(:clj - (def cls->type + (def ^{:no-doc true} cls->type {Boolean :boolean Short :integer Integer :integer diff --git a/src/propeller/push/state.cljc b/src/propeller/push/state.cljc index 8a9bbac..f99d03d 100755 --- a/src/propeller/push/state.cljc +++ b/src/propeller/push/state.cljc @@ -1,4 +1,5 @@ (ns propeller.push.state + "Push states" (:require [propeller.push.limits :as l] #?(:cljs [goog.string :as gstring])))