Skip to content
/ numfu Public

Functional programming language designed for readable & expressive code, extensibility, and mathematical computing with arbitrary precision arithmetic.

License

Notifications You must be signed in to change notification settings

rphle/numfu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

PyPI - Version PyPI - License PyPI - Python Version PyPI Downloads Docs GitHub stars

NumFu Programming Language

NumFu is a pure, interpreted, functional programming language designed for readable & expressive code, extensibility, and ease of learning for beginners.

NumFu's simple syntax and semantics make it well-suited for educational applications, such as courses in functional programming and general programming introductions. At the same time, as its name suggests, NumFu is also ideal for exploring mathematical ideas and sketching algorithms, thanks to its native support for arbitrary-precision arithmetic.

Features

  • Arbitrary Precision Arithmetic - Reliable mathematical computing powered by Python's mpmath
  • First-Class Functions - Automatic currying, partial application, and function composition
  • Expressive Syntax - Infix operators, spread/rest operators, and lots of syntactic sugar
  • Tail Call Optimization for efficient recursive algorithms without stack overflow
  • Interactive Development - Friendly REPL and helpful error messages
  • Minimal Complexity - Only four core types: Number, Boolean, List, and String
  • Python Integration - Large & reliable standard library through NumFu's Python runtime
  • Extensible - NumFu is written entirely in Python with the goal of being extensible and easy to understand.

Quick Start

Installation

From PyPI

pip install numfu-lang

From Source

git clone https://github.com/rphle/numfu
cd numfu
make install

Hello NumFu!

Create hello.nfu:

import sqrt from "math"

// Mathematical computing with arbitrary precision
let golden = {depth ->
  let recur =
    {d -> if d <= 0 then 1 else 1 + 1 / recur(d - 1)}
  in recur(depth)
} in golden(10) // β‰ˆ 1.618

// Function composition & piping
let add1 = {x -> x + 1},
    double = {x -> x * 2}
in 5 |> (add1 >> double) // 12

// Partial Application
{a, b, c -> a+b+c}(_, 5, _)
// {a,c -> a+5+c}

// Assertions
sqrt(49) ---> $ == 7

// Built-in testing with assertions
let square = {x -> x * x} in
  square(7) ---> $ == 49  // βœ“ passes

Run it:

numfu hello.nfu

Interactive REPL

numfu repl
NumFu REPL. Type 'exit' or press Ctrl+D to exit.
>>> 2 + 3 * 4
14
>>> let square = {x -> x * x} in square(7)
49
>>> import max from "math"
>>> [1, 2, 3, 4, 5, 6, 7] |> filter(_, {x -> x%2 == 0}) |> max
6

πŸ“– Documentation

Note

As a language interpreted in Python, which is itself an interpreted language, NumFu is not especially fast. Therefore, it is not recommended for performance-critical applications or large-scale projects. However, NumFu has not yet been thoroughly optimized so you can expect some performance improvements in the future.

Language Overview

Functions with Automatic Partial Application

Functions are defined using {a, b, ... -> ...} syntax. They're automatically partially applied, so if you supply fewer arguments than expected, the function returns a new function that expects the remaining arguments:

let fibonacci = {n ->
    if n <= 1 then n
    else fibonacci(n - 1) + fibonacci(n - 2)
}
fibonacci(10)

Function Syntax Reconstruction

When functions (even partially applied ones) are printed or cast to strings, NumFu reconstructs readable syntax!

>>> {a, b, c -> a + b + c}(_, 5)
{a, c -> a+5+c}  // Functions print as readable syntax!

Function Composition and Piping

let add1 = {x -> x + 1},
    double = {x -> x * 2}
in 5 |> (add1 >> double); // 12

// List processing
[5, 12, 3] |> filter(_, _ > 4) |> map(_, _ * 2)
// [10, 24]

Spread/Rest Operators

Support for variable-length arguments and destructuring:

import length from "std"

{...args -> length(args)}(1, 2, 3)    // 3

{first, ...rest -> [first, ...rest]}(1, 2, 3, 4, 5)
// [1, 2, 3, 4, 5]

Module System

Export and import functions and values between modules. Supports path imports and directory modules with index.nfu:

import sqrt from "math"
import * from "io"

let greeting = "Hello, " + input("What's your name? ")

export distance = {x1, y1, x2, y2 ->
    let dx = x2 - x1, dy = y2 - y1 in
    sqrt(dx^2 + dy^2)
}

export greeting

Arbitrary Precision Arithmetic

All numbers use Python's mpmath for reliable mathematical computing without floating point errors. Precision can be configured via CLI arguments:

import pi, degrees from "math"

0.1 + 0.2 == 0.3 // true
degrees(pi / 2) == 90 // true

Precise Error Messages

Errors always point to the exact line and column with proper preview and clear messages:

[at examples/bubblesort.nfu:11:17]
[11]           else if workingarr[i] > workingArr[i + ...
                       ^^^^^^^^^^
NameError: 'workingarr' is not defined in the current scope
[at tests/functions.nfu:36:20]
[36]   let add1 = {x -> x + "lol"} in
                          ^
TypeError: Invalid argument type for operator '+': argument 2 must be Number, got String

πŸ› οΈ Development

Prerequisites

  • Python β‰₯ 3.10

Setup Development Environment

git clone https://github.com/rphle/numfu
cd numfu
make dev

The make dev command also installs Pyright and Ruff via Pip. To format code and check types, it is strongly recommended to run both ruff check --fix and pyright before committing.

Building NumFu

make build

NumFu contains built-ins written in NumFu itself (src/numfu/stdlib/builtins.nfu). make build first installs NumFu without the built-ins, then parses and serializes the file, and finally performs a full editable install. The script also builds NumFu and creates wheels.

Building Documentation

cd docusaurus && npm i && cd .. # make sure to install dependencies

make serve  # local preview
make docs   # build to 'docs-build'

Project Structure

numfu/
β”œβ”€β”€ src/numfu/
β”‚   β”œβ”€β”€ __init__.py         # Package exports
β”‚   β”œβ”€β”€ _version.py         # Version & metadata
β”‚   β”œβ”€β”€ classes.py          # Basic dataclasses
β”‚   β”œβ”€β”€ parser.py           # Lark-based parser & AST generator
β”‚   β”œβ”€β”€ interpreter.py      # Complete Interpreter
β”‚   β”œβ”€β”€ modules.py          # Import/export & module resolving
β”‚   β”œβ”€β”€ ast_types.py        # AST node definitions
β”‚   β”œβ”€β”€ builtins.py         # Built-in functions
β”‚   β”œβ”€β”€ cli.py              # Command-line interface
β”‚   β”œβ”€β”€ repl.py             # Interactive REPL
β”‚   β”œβ”€β”€ errors.py           # Error handling & display
β”‚   β”œβ”€β”€ typechecks.py       # Built-in type system
β”‚   β”œβ”€β”€ reconstruct.py      # Code reconstruction for printing
β”‚   β”œβ”€β”€ grammar/            # Lark grammar files
β”‚   └── stdlib/             # Standard library modules
β”œβ”€β”€ docs/                   # Language documentation
β”‚   β”œβ”€β”€ guide/              # User guides
β”‚   └── reference/          # Reference
β”œβ”€β”€ docusaurus/             # Docusaurus website
β”œβ”€β”€ tests/                  # Test files
β”œβ”€β”€ scripts/                # Build and utility scripts
└── pyproject.toml          # Configuration

Testing

NumFu is tested with over 300 tests covering core features, edge cases, and real-world examples β€” including most snippets from the documentation. Tests are grouped by category and include handwritten cases as well as tests generated by LLMs (mostly Claude Sonnet 4).

Every test is self-validating using assertions and fails with an error if the output isn’t exactly as expected.

To run all tests from the tests folder:

make test

Contributing

Found a bug or have an idea? Open an issue.

Want to contribute code?

  • Check existing issues and TODO.md for open tasks.
  • Run all tests before committing.
  • Please consider running ruff check and pyright to format code and check types before committing.
  • Pull requests are welcome!

License

This project is licensed under Apache License 2.0 - see the LICENSE file for details.

About

Functional programming language designed for readable & expressive code, extensibility, and mathematical computing with arbitrary precision arithmetic.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published