Skip to content

Commit a0b5d60

Browse files
committed
save README updates
1 parent 61f5bb1 commit a0b5d60

7 files changed

Lines changed: 159 additions & 47 deletions

File tree

.specstory/cli/config.toml

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# SpecStory CLI Configuration
2+
#
3+
# This is the project-level config file for SpecStory CLI.
4+
# All settings here apply to this project unless overridden by CLI flags.
5+
#
6+
# Uncomment (remove the #) the line and edit any setting below to change the default behavior.
7+
# For more information, see: https://docs.specstory.com/integrations/terminal-coding-agents/usage
8+
9+
[local_sync]
10+
# Write markdown files locally. (default: true)
11+
# enabled = false # equivalent to --only-cloud-sync
12+
13+
# Custom output directory for markdown files.
14+
# Default: ./.specstory/history (relative to the project directory)
15+
# output_dir = "~/.specstory/history" # equivalent to --output-dir "~/.specstory/history"
16+
17+
# Use local timezone for file name and content timestamps (default: false, UTC)
18+
# local_time_zone = true # equivalent to --local-time-zone
19+
20+
[cloud_sync]
21+
# Sync session data to SpecStory Cloud. (default: true, when logged in to SpecStory Cloud)
22+
# enabled = false # equivalent to --no-cloud-sync
23+
24+
[logging]
25+
# Write logs to .specstory/debug/debug.log (default: false)
26+
# log = true # equivalent to --log
27+
28+
# Debug-level output, requires console or log (default: false)
29+
# debug = true # equivalent to --debug
30+
31+
# Custom output directory for debug data.
32+
# Default: ./.specstory/debug (relative to the project directory)
33+
# debug_dir = "~/.specstory/debug" # equivalent to --debug-dir "~/.specstory/debug"
34+
35+
# Error/warn/info output to stdout (default: false)
36+
# console = true # equivalent to --console
37+
38+
# Suppress all non-error output (default: false)
39+
# silent = true # equivalent to --silent
40+
41+
[version_check]
42+
# Check for new versions of the CLI on startup.
43+
# Default: true
44+
# enabled = false # equivalent to --no-version-check
45+
46+
[analytics]
47+
# Send anonymous product usage analytics to help improve SpecStory.
48+
# Default: true
49+
# enabled = false # equivalent to --no-usage-analytics
50+
51+
[telemetry]
52+
# OTLP gRPC collector endpoint (e.g., "localhost:4317" or "http://localhost:4317")
53+
# endpoint = "localhost:4317"
54+
55+
# Override the default service name (default: "specstory-cli")
56+
# service_name = "my-service-name"
57+
58+
# Include user prompt text in telemetry spans (default: true)
59+
# prompts = false
60+
61+
[providers]
62+
# Agent execution commands by provider (used by specstory run)
63+
# Pass custom flags (e.g. claude_cmd = "claude --allow-dangerously-skip-permissions")
64+
# Use of these is equivalent to -c "custom command"
65+
66+
# Claude Code command
67+
# claude_cmd = "claude"
68+
69+
# Codex CLI command
70+
# codex_cmd = "codex"
71+
72+
# Cursor CLI command
73+
# cursor_cmd = "cursor-agent"
74+
75+
# Droid CLI command
76+
# droid_cmd = "droid"
77+
78+
# Gemini CLI command
79+
# gemini_cmd = "gemini"

.vscode/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"specstory.cloudSync.enabled": "never"
3+
}

LATEST.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# ParserNG
22

3+
Parser 1.0.3 has been released on maven-central!
4+
Maintaining the industry standard besting speeds of v1.0.x, it adds the functionality of rotational geometry.
5+
In v1.0.3, you can use the rotor function, `rot` to rotate raw points in 3D space and other functions such as curves, lines, surfaces(both plane and curved) and 3D equations of all sorts.
36

47
ParserNG 1.0.2 has been released on maven-central!
58
Version 1.0.2 retains the wild speeds of Version 1.0.1. Adds an extra widening technique of variable passing to the Turbo mode,

LOGICAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ In CLI, you can use -e/-E/--expanding switch to work with Expanding expressions.
133133
<br>
134134
Example:<br>
135135
```
136-
VALUES_PNG="1 8 5 2" java -jar target/parser-ng-0.2.2.jar -e "avg(..L{MN/2})*1.1-MN < L0 | (L1+L{MN-1})*1.3 + MN< L0" -v
136+
VALUES_PNG="1 8 5 2" java -jar target/parser-ng-1.0.3.jar -e "avg(..L{MN/2})*1.1-MN < L0 | (L1+L{MN-1})*1.3 + MN< L0" -v
137137
avg(..L{MN/2})*1.1-MN < L0 | (L1+L{MN-1})*1.3 + MN< L0
138138
Expression : avg(..L{MN/2})*1.1-MN <L0 | (L1+L{MN-1})*1.3 + MN<L0
139139
Upon : 1,8,5,2

MORE.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ParserNG
2-
<b>ParserNG</b> is a powerful open-source math tool that parses and evaluates algebraic expressions and also knows how to handle a lot of mathematical expressions. Its latest release on mavn-central (version 0.2.1) can be used to plot 2D graphs(Geometric plots and function plots) It works seamlessly on all Java platforms.<br><br>
2+
<b>ParserNG</b> is a powerful open-source math tool that parses and evaluates algebraic expressions and also knows how to handle a lot of mathematical expressions. Its latest release on mavn-central (version 1.0.31) can be used to plot 2D graphs(Geometric plots and function plots) It works seamlessly on all Java platforms.<br><br>
33

44

55

@@ -8,15 +8,15 @@
88
Click the Sponsor button to do this.
99

1010

11-
ParserNG v0.2.3 breaks the barrier in fully featured math parser frequencies!
12-
With various other optimizations, v0.2.3 comes with inner loop optimizations which uses a blazing fast, post-fix style algorithm to quickly evaluate inner brackets with less checks and less string manipulations.
11+
ParserNG v1.0.3 breaks the barrier in fully featured math parser frequencies!
12+
With various other optimizations, v1.0.3 comes with inner loop optimizations which uses a blazing fast, post-fix style algorithm to quickly evaluate inner brackets with less checks and less string manipulations.
1313
This obviously will make graphing and other iterative tasks super responsive.
1414

15-
ParserNG v0.2.4 is an extremely feature rich math tool which also doubles as (arguably) the fastest pure Java expression evaluator on the planet.
15+
ParserNG v1.0.34 is an extremely feature rich math tool which also doubles as (arguably) the fastest pure Java expression evaluator on the planet.
1616
In benchmarks, it beats com.expression.parser(Java Math Expression Parser) by almost (10x-14x) and edges out Exp4J (which is lightweight) in many benchmarks.
1717

1818

19-
ParserNG 0.2.5 features strength reduction, constant folding and execution frame(array) based args passing(in contrast to Map based) to ensure O(1) complexity in passage of args to the evaluation stage.
19+
ParserNG 1.0.35 features strength reduction, constant folding and execution frame(array) based args passing(in contrast to Map based) to ensure O(1) complexity in passage of args to the evaluation stage.
2020

2121
[Here are a few benchmarks here](./BENCHMARK_RESULTS.md)
2222

@@ -68,7 +68,7 @@ If you need to access this library via Maven Central, do:
6868
<dependency>
6969
<groupId>com.github.gbenroscience</groupId>
7070
<artifactId>parser-ng</artifactId>
71-
<version>0.2.3</version>
71+
<version>1.0.3</version>
7272
</dependency>
7373
7474

@@ -101,20 +101,20 @@ ParserNG is written completely in (pure) Java and so is as cross-platform as Jav
101101
## Using ParserNG as commandline tool
102102
You can use jar directly as commandline calculus. Unless the tool is packed to your distribution:
103103
```
104-
java -jar parser-ng-0.2.3.jar 1+1
104+
java -jar parser-ng-1.0.3.jar 1+1
105105
2.0
106106
```
107107
Or as logical parser
108108
```
109-
java -jar parser-ng-0.2.3.jar -l true and true
109+
java -jar parser-ng-1.0.3.jar -l true and true
110110
true
111-
java -jar parser-ng-0.2.3.jar -l "2 == (4-2)"
111+
java -jar parser-ng-1.0.3.jar -l "2 == (4-2)"
112112
true
113113
```
114114
You can get help by
115115
```
116-
java -jar parser-ng-0.2.3.jar -h
117-
ParserNG 0.2.3 math.Main
116+
java -jar parser-ng-1.0.3.jar -h
117+
ParserNG 1.0.3 math.Main
118118
-h/-H/--help this text; do not change for help (witout dashes), which lists functions
119119
-v/-V/--verbose output is reprinted to stderr with some inter-steps
120120
-l/-L/--logic will add logical expression wrapper around the expression
@@ -136,11 +136,11 @@ java -jar parser-ng-0.2.3.jar -h
136136
```
137137
You can get examples by verbose help:
138138
```
139-
java -jar parser-ng-0.2.3.jar -h -v
139+
java -jar parser-ng-1.0.3.jar -h -v
140140
```
141141
you can list functions:
142142
```
143-
java -jar parser-ng-0.2.3.jar help
143+
java -jar parser-ng-1.0.3.jar help
144144
List of currently known methods:
145145
acos - help not yet written. See https://github.com/gbenroscience/ParserNG
146146
...
@@ -149,7 +149,7 @@ List of functions is just tip of iceberg, see: https://github.com/gbenroscience/
149149
```
150150
you can list logical operators:
151151
```
152-
java -jar parser-ng-0.2.3.jar -l help
152+
java -jar parser-ng-1.0.3.jar -l help
153153
Comparing operators: !=, ==, >=, <=, le, ge, lt, gt, <, >
154154
Logical operators: impl, xor, imp, eq, or, and, |, &
155155
As Mathematical parts are using () as brackets, Logical parts must be grouped by [] eg.
@@ -164,40 +164,40 @@ Program can work with stdin, out and err properly. Can work with multiline input
164164
### cmdline examples
165165
Following lines describes, how stdin/arguments are processed, and how different is input/output with `-t` on/off
166166
```
167-
java -jar parser-ng-0.2.3.jar -h
167+
java -jar parser-ng-1.0.3.jar -h
168168
this help
169-
java -jar parser-ng-0.2.3.jar 1+1
169+
java -jar parser-ng-1.0.3.jar 1+1
170170
2.0
171-
java -jar parser-ng-0.2.3.jar "1+1
171+
java -jar parser-ng-1.0.3.jar "1+1
172172
+2+2"
173173
2.0
174174
4.0
175-
java -jar parser-ng-0.2.3.jar -t "1+1
175+
java -jar parser-ng-1.0.3.jar -t "1+1
176176
+2+2"
177177
6.0
178-
java -jar parser-ng-0.2.3.jar -i 1+1
178+
java -jar parser-ng-1.0.3.jar -i 1+1
179179
nothing, will expect manual output, and calculate line by line
180-
java -jar parser-ng-0.2.3.jar -i -t 1+1
180+
java -jar parser-ng-1.0.3.jar -i -t 1+1
181181
nothing, will expect manual output and calcualte it all as one expression
182-
echo 2+2 | java -jar parser-ng-0.2.3.jar 1+1
182+
echo 2+2 | java -jar parser-ng-1.0.3.jar 1+1
183183
2.0
184184
echo "1+1
185-
+2+2 | java -jar parser-ng-0.2.3.jar -i
185+
+2+2 | java -jar parser-ng-1.0.3.jar -i
186186
2.0
187187
4.0
188188
echo "1+1
189-
+2+2 | java -jar parser-ng-0.2.3.jar -i -t
189+
+2+2 | java -jar parser-ng-1.0.3.jar -i -t
190190
6.0
191-
java -cp parser-ng-0.2.3.jar parser.cmd.ParserCmd "1+1
191+
java -cp parser-ng-1.0.3.jar parser.cmd.ParserCmd "1+1
192192
will ask for manual imput en evaluate per line
193193
echo "1+1
194-
+2+2 | java -cp parser-ng-0.2.3.jar parser.cmd.ParserCmd 2>/dev/null
194+
+2+2 | java -cp parser-ng-1.0.3.jar parser.cmd.ParserCmd 2>/dev/null
195195
2.0
196196
4.0
197-
java -cp parser-ng-0.2.3.jar parser.MathExpression "1+1
197+
java -cp parser-ng-1.0.3.jar parser.MathExpression "1+1
198198
+2+2"
199199
6.0
200-
java -cp parser-ng-0.2.3.jar parser.LogicalExpression "true or false"
200+
java -cp parser-ng-1.0.3.jar parser.LogicalExpression "true or false"
201201
true
202202
203203
```
@@ -773,7 +773,7 @@ This would give:
773773

774774
#### ParserNG and eigenvalues
775775

776-
Version 0.2.3 of ParserNG allows you to quickly compute the eigenvalues of a Matrix.
776+
Version 1.0.3 of ParserNG allows you to quickly compute the eigenvalues of a Matrix.
777777

778778
Do:
779779
```Java
@@ -782,7 +782,7 @@ Do:
782782
```
783783
#### ParsrNG and eigenvectors
784784

785-
As of ParserNG 0.2.3 also, eigenvector computations have been added, do:
785+
As of ParserNG 1.0.3 also, eigenvector computations have been added, do:
786786
Do:
787787
```Java
788788
MathExpression expression = new MathExpression("eigvec(@(5,5)(12,1,4,2,9,3,1,8,-5,6,13,9,7,3,5,7,3,5,4,9,13,2,4,8,6))");

PERFORMANCE_TUNING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This section is designed to help you squeeze every last nanosecond out of **ParserNG 1.0.2**. Because the engine utilizes a JIT-native architecture via `MethodHandle` trees, its performance characteristics differ significantly from traditional interpreted parsers.
1+
This section is designed to help you squeeze every last nanosecond out of **ParserNG 1.0.3**. Because the engine utilizes a JIT-native architecture via `MethodHandle` trees, its performance characteristics differ significantly from traditional interpreted parsers.
22

33
---
44

@@ -17,7 +17,7 @@ ParserNG offers two primary execution paths. Choosing the right one depends on y
1717
---
1818

1919
### 2. The Power of Constant Folding
20-
Version 1.0.2 introduces aggressive **Constant Folding**. This optimization happens during the compilation phase, where the parser identifies sub-expressions that result in a constant value and "pre-calculates" them.
20+
Version 1.0.3 introduces aggressive **Constant Folding**. This optimization happens during the compilation phase, where the parser identifies sub-expressions that result in a constant value and "pre-calculates" them.
2121

2222
* **Static Expression:** `sin(3.14159 / 2) + x`
2323
* **Folded Expression:** `1.0 + x`
@@ -72,7 +72,7 @@ for (int i = 0; i < 1_000_000; i++) {
7272
---
7373

7474
### 6. JDK Version Matters
75-
ParserNG 1.0.2 is optimized for **modern JDKs (17, 21, and 24)**. Improvements in the `java.lang.invoke` package in later versions directly translate to faster "Turbo" execution. If you are running on JDK 8 or 11, you may see slightly higher latencies due to less efficient `MethodHandle` inlining.
75+
ParserNG 1.0.3 is optimized for **modern JDKs (17, 21, and 24)**. Improvements in the `java.lang.invoke` package in later versions directly translate to faster "Turbo" execution. If you are running on JDK 8 or 11, you may see slightly higher latencies due to less efficient `MethodHandle` inlining.
7676

7777
---
7878

README.md

Lines changed: 41 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ParserNG 🧮⚡
22

3-
**ParserNG 1.0.2** is a **blazing-fast**, nigh zero allocation(memory wise), **pure Java**, **zero-native-dependencies** math expression parser and evaluator.
3+
**ParserNG 1.0.3** is a **blazing-fast**, nigh zero allocation(memory wise), **pure Java**, **zero-native-dependencies** math expression parser and evaluator.
44

55
It **beats Janino, exp4J, and com.expression.parser on evaluation speed** across every kind of expression — from simple algebra to heavy trig, matrices, and calculus.
66
The normal mode routinely does about **3-10 million evaluations per second** while the new Turbo mode easily peaks at about **10 million to 90 million evaluations per second**.
@@ -12,11 +12,11 @@ Perfect for scientific computing, simulations, real-time systems, education tool
1212
[![Maven Central](https://img.shields.io/maven-central/v/com.github.gbenroscience/parser-ng.svg?label=Maven%20Central)](https://central.sonatype.com/artifact/com.github.gbenroscience/parser-ng)
1313
[![License](https://img.shields.io/github/license/gbenroscience/ParserNG?color=blue)](https://github.com/gbenroscience/ParserNG/blob/master/LICENSE)
1414
![Java](https://img.shields.io/badge/Java-8%2B-orange)
15-
![Latest Version](https://img.shields.io/badge/version-1.0.2-success)
15+
![Latest Version](https://img.shields.io/badge/version-1.0.3-success)
1616

17-
> **1.0.2** introduces **Turbo Scalar** and **Turbo Matrix** compiled paths + massive speed improvements via strength reduction, constant folding, and O(1) frame-based argument passing.
17+
> **1.0.3** introduces **Turbo Scalar** and **Turbo Matrix** compiled paths + massive speed improvements via strength reduction, constant folding, and O(1) frame-based argument passing.
1818
19-
## ✨ Highlights (v1.0.2)
19+
## ✨ Highlights (v1.0.3)
2020

2121
- **Speed champion** — beats Janino in most benchmarks, and exp4J, com.expression.parser and Parsii in every benchmark (see [BENCHMARK_RESULTS.md](BENCHMARK_RESULTS.md))
2222
- **Turbo Mode** — compile once, evaluate millions of times per second (Scalar + Matrix paths)
@@ -36,14 +36,14 @@ Perfect for scientific computing, simulations, real-time systems, education tool
3636
<dependency>
3737
<groupId>com.github.gbenroscience</groupId>
3838
<artifactId>parser-ng</artifactId>
39-
<version>1.0.2</version>
39+
<version>1.0.3</version>
4040
</dependency>
4141
```
4242

4343
Also available on **Maven Central**:
44-
https://central.sonatype.com/artifact/com.github.gbenroscience/parser-ng/1.0.2
44+
https://central.sonatype.com/artifact/com.github.gbenroscience/parser-ng/1.0.3
4545

46-
## ⚡ Turbo Mode — The 1.0.2 Game Changer
46+
## ⚡ Turbo Mode — The 1.0.3 Game Changer
4747

4848
```java
4949
import com.github.gbenroscience.parser.MathExpression;
@@ -128,13 +128,40 @@ MathExpression expr = new MathExpression("""
128128
System.out.println("Determinant = " + expr.solve());
129129
```
130130

131+
132+
### 6. ROTOR
133+
You may use the rot function to rotate functions, surfaces(plane or curved), lines and even raw points in 3D space.
134+
135+
To rotate any of these, you need the orbital center, the coordinates of the direction vector(a,b,c) and the angle of rotation.
136+
137+
The example below shows two ways to use the ParserNG library to rotate the point `p` and `q` about the orbital center (1,0,1)
138+
with the directio vector,(1,1,0). The angle of rotation is pi radians.
139+
140+
```Java
141+
String expression = "p=@(1,3)(4,2,5);q=@(1,3)(12,3,-1);rot(p,q, pi, @(1,3)(1,0,1),@(1,3)(1,1,0))";
142+
MathExpression interpreted = new MathExpression(expression);
143+
144+
MathExpression.EvalResult ev = interpreted.solveGeneric();
145+
System.out.printf("Expression: %s%n", expression);
146+
System.out.println("interpreted: " + ev);
147+
148+
// Compile to turbo
149+
FastCompositeExpression compiled = new ScalarTurboEvaluator(interpreted, true).compile();
150+
// Warm up turbo JIT
151+
double[] vars = new double[0];
152+
MathExpression.EvalResult evr = compiled.apply(vars);
153+
System.out.println("turbo: " + evr);
154+
```
155+
156+
157+
131158
## ⌨️ Command-line tool (REPL)
132159

133160
```bash
134-
java -jar parser-ng-1.0.2.jar "sin(x) + cos(x)"
135-
java -jar parser-ng-1.0.2.jar "eigvalues(R=@(5,5)(...))"
136-
java -jar parser-ng-1.0.2.jar help
137-
java -jar parser-ng-1.0.2.jar -i # interactive mode
161+
java -jar parser-ng-1.0.3.jar "sin(x) + cos(x)"
162+
java -jar parser-ng-1.0.3.jar "eigvalues(R=@(5,5)(...))"
163+
java -jar parser-ng-1.0.3.jar help
164+
java -jar parser-ng-1.0.3.jar -i # interactive mode
138165
```
139166

140167
## 📊 Supported Features at a Glance
@@ -155,8 +182,8 @@ Full list: run `help` or `new MathExpression("help").solve()`.
155182

156183
- [BENCHMARK_RESULTS.md](BENCHMARK_RESULTS.md) — full speed comparisons
157184
- [GRAPHING.md](GRAPHING.md) — plotting on Swing / JavaFX / Android
158-
- [LATEST.md](LATEST.md) — what’s new in 1.0.2
159-
- Javadoc: https://javadoc.io/doc/com.github.gbenroscience/parser-ng/1.0.2
185+
- [LATEST.md](LATEST.md) — what’s new in 1.0.3
186+
- Javadoc: https://javadoc.io/doc/com.github.gbenroscience/parser-ng/1.0.3
160187

161188
## ❤️ Support the Project
162189

@@ -173,7 +200,7 @@ ParserNG is built with love in my free time. If it helps you:
173200

174201
---
175202

176-
**ParserNG 1.0.2** — faster than the competition, stronger on matrices, and now with real Turbo Scalar + Turbo Matrix compiled power.
203+
**ParserNG 1.0.3** — faster than the competition, stronger on matrices, and now with real Turbo Scalar + Turbo Matrix compiled power.
177204

178205
Happy parsing! 🚀
179206
**GBENRO JIBOYE** (@gbenroscience)

0 commit comments

Comments
 (0)