summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 5ad71830dcf4905a58b04e0c01dda70132eaf0b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
Ixion is a general purpose formula parser, interpreter, formula cell dependency
tracker and spreadsheet document model backend all in one package.

## Overview
The goal of this project is to create a library for calculating the
results of formula expressions stored in multiple formula cells.  The cells
can be referenced by each other, and Ixion resolves their dependencies
automatically upon calculation.  The caller can run the calculation routine
either in a single-threaded mode, or a multi-threaded mode. Ixion also supports
re-calculations where the contents of one or more cells have been modified
since the last calculation, and a partial calculation of only the affected
cells need to be calculated.

## Portability
This library is written with portability in mind; platform specific calls
are avoided as much as possible.  It makes use of modern C++ features and the
[boost library](http://boost.org) to achieve portability.

## Performance
Achieving good performance is one of the goals of this project.  As much
care is taken as humanly possible, to attain reasonable performance.

## Threaded calculation
Ixion can perform threaded calculation using arbitrary number of threads,
for both full and partial calculation modes.

## Supported features
* Each calculation session is defined in a plain text file, which is parsed
  and interpreted by the Ixion parser.
* Fully threaded calculation.
* Name resolution using A1- and R1C1-style references.
* Support 2D cell references and named expressions.
* Support range references.
* Support table references.
* 3D cell and range references.
* Dependency tracking during both full calculation and partial re-calculation.
* Inline strings.
* Inline arrays.
* Volatile functions. The framework for volatile functions is implemented. We
  just need to implement more functions.
* C++ API.
* Python API.
* Matrix support via grouped formulas.

## Features known to be missing
* More built-in functions.
* Custom functions defined in the caller program.
* External references.
* Implicit intersection.

## Documentation

* [Official API documentation](https://ixion.readthedocs.io/en/latest/) for general users of the library.

## Installation

Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for build and
installation instructions.


## Download source packages

Please refer to the [Releases](https://gitlab.com/ixion/ixion/-/releases) page.
The source packages for the older versions are found [here](OLD-DOWNLOADS.md).