Skip to content

Commit 179028f

Browse files
committed
docs: update documentation for Cortex Compute Engine compatibility
- Update operators.md with Cortex format and all 15 categories - Add new operator fields documentation (signature, associative, etc.) - Update operator tables with Cortex naming conventions - Add Cortex Compute Engine compatibility to README and index - Highlight 382 operators across 15 categories
1 parent 93564e6 commit 179028f

3 files changed

Lines changed: 225 additions & 93 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ A Julia package for parsing, manipulating, and generating mathematical expressio
99

1010
MathJSON is a JSON-based format for representing mathematical expressions, providing interoperability with web-based mathematical tools like [MathLive](https://cortexjs.io/mathlive/) and the [Cortex Compute Engine](https://cortexjs.io/compute-engine/).
1111

12+
## Features
13+
14+
- **Parse MathJSON**: Convert MathJSON strings to Julia expression trees
15+
- **Generate MathJSON**: Serialize Julia expressions to MathJSON format
16+
- **Validation**: Verify expressions conform to the MathJSON specification
17+
- **Symbolics.jl Integration**: Bidirectional conversion with Symbolics.jl expressions
18+
- **Cortex Compute Engine Compatible**: Full support for all 382 operators from the official MathJSON standard library
19+
1220
## Installation
1321

1422
```julia
@@ -49,6 +57,19 @@ symbolic = to_symbolics(expr)
4957
mathjson = from_symbolics(x + 1)
5058
```
5159

60+
## Operator Registry
61+
62+
MathJSON.jl includes an extensive operator registry based on the [Cortex Compute Engine](https://cortexjs.io/compute-engine/) standard library:
63+
64+
- **382 operators** across 15 categories
65+
- **Arithmetic**: Add, Subtract, Multiply, Divide, Power, Sqrt, Abs, Exp, Log, ...
66+
- **Trigonometry**: Sin, Cos, Tan, Arcsin, Arccos, Arctan, Sinh, Cosh, ...
67+
- **Calculus**: D (derivative), Integrate, Limit, Sum, Product, ...
68+
- **Linear Algebra**: Determinant, Transpose, Inverse, Eigenvalues, ...
69+
- **Logic**: And, Or, Not, Xor, Implies, Equivalent, ...
70+
- **Statistics**: Mean, Median, Variance, StandardDeviation, ...
71+
- **And more**: Collections, Combinatorics, Number Theory, Polynomials, ...
72+
5273
## Documentation
5374

5475
For full documentation, see the [documentation site](https://s-celles.github.io/MathJSON.jl/).

docs/src/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ MathJSON is a JSON-based format for representing mathematical expressions, provi
1010
- **Generate MathJSON**: Serialize Julia expressions to MathJSON format
1111
- **Validation**: Verify expressions conform to the MathJSON specification
1212
- **Symbolics.jl Integration**: Bidirectional conversion with Symbolics.jl expressions
13+
- **Cortex Compute Engine Compatible**: Full support for all 382 operators from the official MathJSON standard library
1314

1415
## Installation
1516

@@ -50,6 +51,21 @@ symbolic = to_symbolics(expr)
5051
mathjson = from_symbolics(x + 1)
5152
```
5253

54+
## Operator Registry
55+
56+
MathJSON.jl includes an extensive operator registry based on the [Cortex Compute Engine](https://cortexjs.io/compute-engine/) standard library:
57+
58+
- **382 operators** across 15 categories
59+
- **Arithmetic**: Add, Subtract, Multiply, Divide, Power, Sqrt, Abs, Exp, Log, ...
60+
- **Trigonometry**: Sin, Cos, Tan, Arcsin, Arccos, Arctan, Sinh, Cosh, ...
61+
- **Calculus**: D (derivative), Integrate, Limit, Sum, Product, ...
62+
- **Linear Algebra**: Determinant, Transpose, Inverse, Eigenvalues, ...
63+
- **Logic**: And, Or, Not, Xor, Implies, Equivalent, ...
64+
- **Statistics**: Mean, Median, Variance, StandardDeviation, ...
65+
- **And more**: Collections, Combinatorics, Number Theory, Polynomials, ...
66+
67+
See the [Operator Registry](operators.md) page for complete documentation.
68+
5369
## API
5470

5571
See the [API Reference](api.md) page for complete documentation of all exported functions and types.

0 commit comments

Comments
 (0)