Skip to content

README.md

Latest commit

 

History

History
107 lines (76 loc) · 4.4 KB

README.md

File metadata and controls

107 lines (76 loc) · 4.4 KB

FaustML

FaustML is a first order simply typed ML, with OCaml-compatible concrete syntax. The project contains a polytime check and interpretor for those programs.

Using a data-tiering algorithm, we guarantee that the program will execute in PTIME if the execution make use of full memoization + full sharing of subterm.

This algorithm is inspired by

M. Avanzini and U. Dal Lago. On sharing, memoization, and polynomial time. Inf. Comput., 261:3–22, 2018.

Build

to build the project use dune build the depedencies are OCamlgraph and UnionFind

Usage

usage: ./faustml - [itsenap] prog.ml
  - condence version of the other options
  -a enable all (equiv to - tsien)
  -p enable polytime check (equiv to - tsi)
  -t enable type check
  -s enable syntax check
  -i enable tier check
  -e enable standar execution
  -n enable naive execution
  -help  Display this list of options
  --help  Display this list of options

if one of the option: n/e/a is enable, the program will listen to user input, then parse it as a program input for the function called "main" in the program. The common usages are:

  • ./faustml -a prog.ml < input.ml to check everything and execute
  • ./faustml -p prog.ml to check everything without executing
  • ./faustml -e prog.ml < input.ml to execute without checking anything

the input should have the form a list of values [v1;..;vn] with n the number of arguments of the first function of the program if there is only 1 input, a simple value without bracket also works i.e: [v] or v

/!\careful! the program for the moment require the linearity of variable inside function. If there is multiple times the same variable most of the project will not work

Graphs

we can translate the constraints graph to a pdf using dot: dot -Tpdf graphs/constraints.dot > graphs/constraints.pdf

or the small bash program will do the above line automatically: ./graph constraints

Tiering (-i)

As it is still in developpement, multiple version of the tiering are accessible, There is a choice to be made before compilation, in the file bin/faust.ml, between:

  • Tier.tier_prog very strict version of the tiering
  • Tierformal.tier_prog allow duplication and downward coercion but also duplicate computations (instead of storing each graph)

The first one follow the strict inference rules of tiering with no duplication of function. The second one take a bit of freedom because it evaluate function in a "depedency order" to avoid multiple computation of tiering The last one follow an algorithm closer to the inference rules of tiering with the "coercion" rule added. It is (a priori) equivalent to the second one but less "clever"

Syntax (-s)

when using the -s flag, we check that syntax restrictions are satisfy. Those restrict what is allowed in recursive calls:

for f(x,y,z) a recursive call must be of the form f(x1,p1(y),p2(z)) with x1 a sub-term (strict) of x and p1/p2 cons-free function or f(x1,y1,z1) with x1 a sub-term (strict) with y1 a sub-term (large) of y and z1 (large) a sub-term of z/ or a mix of the two

the following example are not allowed:

let f(x,y,z) = ... f(x1,S(y),z)  (*S is not a cons-free operation*)
let g(x,y,z) = ... g(x1,z,y) (*we can't change the order*)
let h(y,x) = ... h(y,x1) (*the first argument must be the recursive one*)

the following example are allowed

let f(x,y,z) = ... f(x1,pred(y),z) (*pred is a cons-free operation *)
let g(x,y,z) = ...g(x1,y,z) (*we can also let the not-recursive argument unchanged*)
let h(y,x) = ...h(y1,x1)   (*here y is considered recursive argument, and x a secondary one*)

Execution (-n/-e)

the naive execution (-n) is the usual call-by-value evaluation of the program.

the execution (-e) uses memoization of function calls and sharing of sub-term. But the result value is unfold at the end for printing purposes. This execution is garantee polytime without the unfolding at the end. Meaning that we are able to compute, in polynomial time, a representation of the result in a DAG which is stored in a heap

To get this representation you can use the (-verbose -e) flag which show the heap evolution during the execution

Tests

The test/ folder contains

  • test/neg/ for the negative tests. Thoses are programs that don't pass one of the restriction for good reasons (like nbleaves of exp) or for bad reasons (like insert sort)
  • test/pos/ for positive tests. Programs that pass all the restrictions