reform 0.1.0

A symbolic manipulation toolkit which aims to handle expressions with billions of terms, taking up terabytes of diskspace.
Documentation 
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

===
API
===

Certain features of reFORM can be used inside other programs
and programming languages using its API.
We expose a `Python API`_ and a `C API`_.

Python API
##########

To compile the reFORM Python 3 library, compile with the ``python_api`` feature:

.. code-block:: bash

	cargo build --release --features=python_api

This will produce a ``libreform.so`` (Linux), ``libreform.dylib`` (Mac OS),
or ``libreform.dll`` (Windows) in ``target/release``. Rename this file to ``reform.so``, place it in the same folder as your Python script, and simply import it.

.. note:: 
	On Mac OS, it could be that the code does not compile. A fix is to remove ``features = ["extension-module"]`` from ``Cargo.toml``, which will mean
	that the Python 3 version that the library supports, is fixed.

An example Python program:

.. code-block:: python

	import reform

	vi = reform.VarInfo()
	a = reform.Expression("x+y^2", vi)
	b = reform.Expression("z", vi)
	c = a * b

	print("c: ", c, ", c expanded: ", c.expand())

	d = c.expand().id("x", "1+w", vi)
	print("Substituted x->1+w: ", d)

An example Python program showing the polynomial API:

.. code-block:: python

	import reform

	vi = reform.VarInfo();
	a = reform.Polynomial("1+x*y+5", vi)
	b = reform.Polynomial("x^2+2*x*y+y", vi)
	g = a + b

	ag = a * g
	bg = b * g

	rat = reform.RationalPolynomial(ag, bg)
	print('ag/bg:', rat)
	print('gcd:', ag.gcd(bg))


C API
########

To compile the reFORM C library, compile with the ``c_api`` feature:

.. code-block:: bash

	cargo build --release --features=c_api

Then, compile your C code as follows:

.. code-block:: bash

	gcc --std=c11 -o gcd gcd.c -L target/release/ -lreform

To run the C code, add the library to the path:

.. code-block:: bash

	LD_LIBRARY_PATH=target/release/

An example C program:

.. code-block:: c

	#include <stdio.h>
	#include <stdint.h>

	typedef struct polynomial Polynomial;
	typedef struct varinfo VarInfo;

	extern VarInfo * polynomial_varinfo();
	extern void polynomial_varinfo_free(VarInfo *);

	extern Polynomial * polynomial_new(const char *expr, VarInfo*);
	extern void polynomial_free(Polynomial *);
	extern Polynomial * polynomial_clone(Polynomial *);
	extern char * polynomial_to_string(Polynomial *);
	extern void polynomial_string_free(char *);
	extern Polynomial * polynomial_add(const Polynomial *, const Polynomial *);
	extern Polynomial * polynomial_mul(const Polynomial *, const Polynomial *);
	extern Polynomial * polynomial_sub(const Polynomial *, const Polynomial *);
	extern Polynomial * polynomial_div(const Polynomial *, const Polynomial *);
	extern Polynomial * polynomial_neg(const Polynomial *);
	extern Polynomial * polynomial_gcd(const Polynomial *, const Polynomial *);

	extern RationalPolynomial * rationalpolynomial_new(const Polynomial *, const Polynomial *);
	extern void rationalpolynomial_free(RationalPolynomial *);
	extern Polynomial * rationalpolynomial_clone(Polynomial *);
	extern char * rationalpolynomial_to_string(RationalPolynomial *);
	extern Polynomial * rationalpolynomial_neg(const RationalPolynomial *);
	extern RationalPolynomial * rationalpolynomial_add(const RationalPolynomial *, const RationalPolynomial *);
	extern RationalPolynomial * rationalpolynomial_mul(const RationalPolynomial *, const RationalPolynomial *);
	extern RationalPolynomial * rationalpolynomial_div(const RationalPolynomial *, const RationalPolynomial *);
	extern RationalPolynomial * rationalpolynomial_sub(const RationalPolynomial *, const RationalPolynomial *);


	int main(void) {
		VarInfo *vi = polynomial_varinfo();
		Polynomial *a = polynomial_new("1+x*y+5", vi);
		Polynomial *b = polynomial_new("x^2+2*x*y+y", vi);
		Polynomial *g = polynomial_add(a, b);

		Polynomial *ag = polynomial_mul(a, g);
		Polynomial *bg = polynomial_mul(b, g);

		Polynomial *gcd = polynomial_gcd(ag, bg);

		char *str = polynomial_to_string(gcd);
		printf("gcd: %s\n", str);

		RationalPolynomial *rat = rationalpolynomial_new(ag, bg); // g wil be removed
		char *s = rationalpolynomial_to_string(mrat);
		printf("ag/bg: %s\n", s);

		polynomial_string_free(s);
		polynomial_string_free(str);
		rationalpolynomial_free(rat);
		rationalpolynomial_free(mrat);
		polynomial_free(a);
		polynomial_free(b);
		polynomial_free(g);
		polynomial_free(ag);
		polynomial_free(bg);
		polynomial_free(gcd);
		polynomial_varinfo_free(vi);
	}