Futhark User’s Guide

Welcome to the documentation for the Futhark compiler and language. For a basic introduction, please see the Futhark website. To get started, read the page on Installation. Once the compiler has been installed, you might want to take a look at Basic Usage. This User’s Guide contains a Language Reference, but new Futhark programmers are probably better served by reading the Futhark Book first.

Documentation for the included basis library is also available online.

The particularly interested reader may also want to peruse the publications, or the development blog.

Table of Contents

• 1. Installation
  • 1.1. Compiling from source
  • 1.2. Installing from a precompiled snapshot
  • 1.3. Installing Futhark on Windows
• 2. Basic Usage
  • 2.1. Compiling to Executable
  • 2.2. Compiling to Library
• 3. Language Reference
  • 3.1. Identifiers and Keywords
  • 3.2. Primitive Types and Values
  • 3.3. Expressions
  • 3.4. Shape Declarations
  • 3.5. Declarations
  • 3.6. Module System
  • 3.7. Referring to Other Files
  • 3.8. Literal Defaults
• 4. C Porting Guide
  • 4.1. Where This Guide Falls Short
  • 4.2. Types
  • 4.3. Operators
  • 4.4. Variable Mutation
  • 4.5. Arrays
• 5. Hacking on the Futhark Compiler
  • 5.1. Debugging Internal Type Errors
  • 5.2. Checking Generated Code
  • 5.3. Using the futhark Tool
• 6. Binary Data Format
  • 6.1. Specification

Manual Pages

• futhark
• futhark-c
• futhark-opencl
• futhark-py
• futhark-pyopencl
• futharki
• futhark-test
• futhark-bench
• futhark-doc
• futhark-dataset