Skip to content

Repository files navigation

Fixen Logo

Fixen: The Fixed-Point Generator

Fixed-Point-Oriented Programming for Haskell

Documentation . Report Bug · Request Feature

Haskell Contributors Forks Stargazers Issues MIT License

Table of Contents
  1. About
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About

The Fixen language is a Domain-Specific Language for expressing work-queue algorithms ergonomically. Work-queue algorithms are used to solve problems involving cycles and other types of self-reference, e.g., graphs, static analysis, automata minimization, type checking and distributed computing.

To write work-queue algorithms in Fixen, simply declare relations and rules. For instance, to write an algorithm for finding shortest paths to vertices in a graph, declare the following:

rel Edge: Vertex, Vertex, Dist
rel DistTo: Vertex, Dist

rule addDist: DistTo a d, Edge a b e |- DistTo b (d + e)

Then run the Fixen compiler on these declarations to generate Haskell source code that implements the work-queue algorithm that computes shortest paths. The generated source code is a Haskell module that can be imported and used by application code.

A detailed tutorial on how to write programs with Fixen is found in the documentation.

This library and executable has been tested on GHC version 9.12.2.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  • GHC v9.12.2-9.14.1 (base v4.21.0.0-v4.22.0.0)
  • Cabal v3.16.0.0
  • HLS v2.14.0.0
  • git

Installing and Building

  • Clone this repository
    git clone https://github.com/plilab/fixen.git
    cd fixen/
  • Building
    cabal build
  • Documentation
    cabal haddock

You're all set!

(back to top)

Roadmap

  • Complete the parser
  • Complete the symbol solver
  • Generate rule forests IR
  • DB layout inference
  • Generate Haskell source
  • Benchmarks

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Top contributors:

contrib.rocks image

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

{-# LANGUAGE OverloadedStrings #-}
module ContactInfo where

import Data.Text (Text)
import Data.Text qualified as T

dom :: Text
dom = T.concat [ "@", "fixen-lang", ".", T.reverse "gro"]

email :: Text
email = T.append "collaborations" dom

People

Michael D. Adams (Principal Investigator) - https://michaeldadams.org

Foo Yong Qi (Maintainer) - https://yongqi.foo/

Brian Cheong (Developer) - https://comp.nus.edu.sg/~bskch

Project Link: https://github.com/plilab/fixen

The Programming Languages Innovation Lab @ NUS: https://github.com/plilab

(back to top)

About

A fixed-point-oriented programming language for Haskell

Topics

Resources

Stars

20 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages