build: mark API as public

[AayushSabharwal]

No description provided.

[github-actions]

Benchmark Results (Julia vlts)

Time benchmarks

	master	109a10c...	master / 109a10c...
arithmetic/2-arg mul	13 ± 0.31 μs	12.9 ± 0.29 μs	1 ± 0.033
arithmetic/addition	0.0776 ± 0.00097 ms	0.0759 ± 0.0013 ms	1.02 ± 0.022
arithmetic/division	26.7 ± 0.63 μs	26 ± 0.69 μs	1.02 ± 0.036
arithmetic/multiplication	0.0606 ± 0.0019 ms	0.0618 ± 0.0022 ms	0.981 ± 0.047
overhead/acrule/a+2	2.33 ± 0.04 μs	2.36 ± 0.049 μs	0.988 ± 0.027
overhead/acrule/a+2+b	0.07 ± 0.01 μs	0.07 ± 0.01 μs	1 ± 0.2
overhead/acrule/a+b	4.08 ± 0.17 μs	4.16 ± 0.061 μs	0.981 ± 0.044
overhead/acrule/noop:Int	0.05 ± 0.01 μs	0.05 ± 0.01 μs	1 ± 0.28
overhead/acrule/noop:Sym	0.06 ± 0 μs	0.051 ± 0.01 μs	1.18 ± 0.23
overhead/get_degrees/large_poly	0.09 ± 0 μs	0.09 ± 0.001 μs	1 ± 0.011
overhead/rule/noop:Int	0.07 ± 0.01 μs	0.06 ± 0.01 μs	1.17 ± 0.26
overhead/rule/noop:Sym	0.07 ± 0.01 μs	0.06 ± 0.01 μs	1.17 ± 0.26
overhead/rule/noop:Term	0.06 ± 0.01 μs	0.07 ± 0.01 μs	0.857 ± 0.19
overhead/ruleset/noop:Int	30 ± 0 ns	30 ± 0 ns	1 ± 0
overhead/ruleset/noop:Sym	0.31 ± 0.01 μs	0.31 ± 0.01 μs	1 ± 0.046
overhead/ruleset/noop:Term	1.2 ± 0.011 μs	1.21 ± 0.019 μs	0.993 ± 0.018
overhead/simplify/noop:Int	30 ± 0 ns	30 ± 0 ns	1 ± 0
overhead/simplify/noop:Sym	30 ± 10 ns	30 ± 10 ns	1 ± 0.47
overhead/simplify/noop:Term	28.1 ± 0.71 μs	28.6 ± 0.94 μs	0.984 ± 0.041
overhead/simplify/randterm (+, *):serial	0.227 ± 0.0011 s	0.228 ± 0.0021 s	0.995 ± 0.01
overhead/simplify/randterm (+, *):thread	0.25 ± 0.0094 s	0.258 ± 0.036 s	0.969 ± 0.14
overhead/simplify/randterm (/, *):serial	0.0853 ± 0.0019 ms	0.0845 ± 0.0021 ms	1.01 ± 0.034
overhead/simplify/randterm (/, *):thread	0.0889 ± 0.0021 ms	0.0881 ± 0.0023 ms	1.01 ± 0.035
overhead/substitute/a	0.0504 ± 0.0014 ms	0.0514 ± 0.0011 ms	0.98 ± 0.034
overhead/substitute/a,b	0.0625 ± 0.0015 ms	0.0638 ± 0.0013 ms	0.979 ± 0.031
overhead/substitute/a,b,c	0.0558 ± 0.0013 ms	0.057 ± 0.0011 ms	0.978 ± 0.029
polyform/easy_iszero	23 ± 0.48 μs	22.7 ± 0.5 μs	1.01 ± 0.031
polyform/isone	1.06 ± 0.03 ms	1.05 ± 0.03 ms	1 ± 0.041
polyform/isone:noop	0.09 ± 0.01 μs	0.09 ± 0.01 μs	1 ± 0.16
polyform/iszero	0.902 ± 0.025 ms	0.899 ± 0.025 ms	1 ± 0.039
polyform/iszero:noop	0.081 ± 0.01 μs	0.09 ± 0.01 μs	0.9 ± 0.15
polyform/simplify_fractions	1.14 ± 0.031 ms	1.15 ± 0.034 ms	0.993 ± 0.039
printing/large_poly	0.209 ± 0.0034 s	0.21 ± 0.0021 s	0.995 ± 0.019
time_to_load	1.27 ± 0.02 s	1.21 ± 0.0049 s	1.05 ± 0.017

Memory benchmarks

	master	109a10c...	master / 109a10c...
arithmetic/2-arg mul	0.076 k allocs: 2.62 kB	0.075 k allocs: 2.59 kB	1.01
arithmetic/addition	0.438 k allocs: 16 kB	0.438 k allocs: 16 kB	1
arithmetic/division	0.14 k allocs: 5.38 kB	0.138 k allocs: 5.31 kB	1.01
arithmetic/multiplication	0.354 k allocs: 11.6 kB	0.354 k allocs: 11.6 kB	1
overhead/acrule/a+2	0.034 k allocs: 1.25 kB	0.033 k allocs: 1.23 kB	1.01
overhead/acrule/a+2+b	0 allocs: 0 B	0 allocs: 0 B
overhead/acrule/a+b	0.047 k allocs: 1.8 kB	0.045 k allocs: 1.77 kB	1.02
overhead/acrule/noop:Int	0 allocs: 0 B	0 allocs: 0 B
overhead/acrule/noop:Sym	0 allocs: 0 B	0 allocs: 0 B
overhead/get_degrees/large_poly	2 allocs: 32 B	2 allocs: 32 B	1
overhead/rule/noop:Int	2 allocs: 0.0625 kB	2 allocs: 0.0625 kB	1
overhead/rule/noop:Sym	2 allocs: 0.0625 kB	2 allocs: 0.0625 kB	1
overhead/rule/noop:Term	2 allocs: 0.0625 kB	2 allocs: 0.0625 kB	1
overhead/ruleset/noop:Int	0 allocs: 0 B	0 allocs: 0 B
overhead/ruleset/noop:Sym	3 allocs: 0.109 kB	3 allocs: 0.109 kB	1
overhead/ruleset/noop:Term	12 allocs: 0.391 kB	12 allocs: 0.391 kB	1
overhead/simplify/noop:Int	0 allocs: 0 B	0 allocs: 0 B
overhead/simplify/noop:Sym	0 allocs: 0 B	0 allocs: 0 B
overhead/simplify/noop:Term	0.298 k allocs: 11.6 kB	0.282 k allocs: 11.4 kB	1.02
overhead/simplify/randterm (+, *):serial	2.3 M allocs: 0.0882 GB	2.21 M allocs: 0.0869 GB	1.01
overhead/simplify/randterm (+, *):thread	2.35 M allocs: 0.246 GB	2.26 M allocs: 0.245 GB	1.01
overhead/simplify/randterm (/, *):serial	0.844 k allocs: 30.4 kB	0.781 k allocs: 29.4 kB	1.03
overhead/simplify/randterm (/, *):thread	0.879 k allocs: 31.5 kB	0.816 k allocs: 30.5 kB	1.03
overhead/substitute/a	0.272 k allocs: 9.83 kB	0.272 k allocs: 9.83 kB	1
overhead/substitute/a,b	0.34 k allocs: 12.2 kB	0.34 k allocs: 12.2 kB	1
overhead/substitute/a,b,c	0.301 k allocs: 10.4 kB	0.301 k allocs: 10.4 kB	1
polyform/easy_iszero	0.13 k allocs: 4.44 kB	0.124 k allocs: 4.34 kB	1.02
polyform/isone	8.3 k allocs: 0.565 MB	7.96 k allocs: 0.559 MB	1.01
polyform/isone:noop	1 allocs: 16 B	1 allocs: 16 B	1
polyform/iszero	6.83 k allocs: 0.465 MB	6.68 k allocs: 0.463 MB	1.01
polyform/iszero:noop	1 allocs: 16 B	1 allocs: 16 B	1
polyform/simplify_fractions	8.77 k allocs: 0.587 MB	8.6 k allocs: 0.584 MB	1.01
printing/large_poly	1.86 M allocs: 0.082 GB	1.86 M allocs: 0.082 GB	1
time_to_load	0.153 k allocs: 14.5 kB	0.153 k allocs: 14.5 kB	1

[github-actions]

Benchmark Results (Julia v1)

Time benchmarks

	master	109a10c...	master / 109a10c...
arithmetic/2-arg mul	10.4 ± 0.27 μs	10.1 ± 0.25 μs	1.04 ± 0.037
arithmetic/addition	0.0678 ± 0.00079 ms	0.0669 ± 0.00088 ms	1.01 ± 0.018
arithmetic/division	24 ± 0.56 μs	24.1 ± 0.58 μs	0.997 ± 0.033
arithmetic/multiplication	0.0532 ± 0.002 ms	0.0529 ± 0.0027 ms	1.01 ± 0.064
overhead/acrule/a+2	2.15 ± 0.05 μs	2.16 ± 0.05 μs	0.995 ± 0.033
overhead/acrule/a+2+b	0.08 ± 0 μs	0.08 ± 0 μs	1 ± 0
overhead/acrule/a+b	3.7 ± 0.09 μs	3.8 ± 0.08 μs	0.974 ± 0.031
overhead/acrule/noop:Int	30 ± 0 ns	30 ± 0 ns	1 ± 0
overhead/acrule/noop:Sym	0.07 ± 0.01 μs	0.061 ± 0.01 μs	1.15 ± 0.25
overhead/get_degrees/large_poly	0.08 ± 0.01 μs	0.08 ± 0.01 μs	1 ± 0.18
overhead/rule/noop:Int	0.061 ± 0.01 μs	0.06 ± 0.01 μs	1.02 ± 0.24
overhead/rule/noop:Sym	0.07 ± 0 μs	0.07 ± 0 μs	1 ± 0
overhead/rule/noop:Term	0.07 ± 0 μs	0.07 ± 0 μs	1 ± 0
overhead/ruleset/noop:Int	30 ± 0 ns	30 ± 0 ns	1 ± 0
overhead/ruleset/noop:Sym	0.311 ± 0.011 μs	0.311 ± 0.011 μs	1 ± 0.05
overhead/ruleset/noop:Term	1.21 ± 0.03 μs	1.18 ± 0.04 μs	1.03 ± 0.043
overhead/simplify/noop:Int	30 ± 0 ns	30 ± 0 ns	1 ± 0
overhead/simplify/noop:Sym	0.05 ± 0.02 μs	30 ± 10 ns	1.67 ± 0.87
overhead/simplify/noop:Term	26 ± 0.56 μs	26.3 ± 0.59 μs	0.99 ± 0.031
overhead/simplify/randterm (+, *):serial	0.193 ± 0.027 s	0.2 ± 0.029 s	0.964 ± 0.2
overhead/simplify/randterm (+, *):thread	0.225 ± 0.021 s	0.233 ± 0.016 s	0.967 ± 0.11
overhead/simplify/randterm (/, *):serial	0.0853 ± 0.003 ms	0.0858 ± 0.004 ms	0.994 ± 0.058
overhead/simplify/randterm (/, *):thread	0.0953 ± 0.0096 ms	0.0941 ± 0.0091 ms	1.01 ± 0.14
overhead/substitute/a	0.0401 ± 0.00092 ms	0.0425 ± 0.001 ms	0.944 ± 0.031
overhead/substitute/a,b	0.0516 ± 0.0013 ms	0.0533 ± 0.0012 ms	0.97 ± 0.033
overhead/substitute/a,b,c	0.0477 ± 0.0011 ms	0.0505 ± 0.0012 ms	0.944 ± 0.032
polyform/easy_iszero	19 ± 0.37 μs	18.6 ± 0.44 μs	1.02 ± 0.031
polyform/isone	0.903 ± 0.017 ms	0.909 ± 0.019 ms	0.994 ± 0.028
polyform/isone:noop	0.081 ± 0.01 μs	0.09 ± 0.01 μs	0.9 ± 0.15
polyform/iszero	0.783 ± 0.015 ms	0.783 ± 0.017 ms	1 ± 0.029
polyform/iszero:noop	0.09 ± 0.01 μs	0.081 ± 0.01 μs	1.11 ± 0.18
polyform/simplify_fractions	0.979 ± 0.031 ms	0.98 ± 0.029 ms	0.999 ± 0.044
printing/large_poly	0.196 ± 0.015 s	0.192 ± 0.015 s	1.02 ± 0.11
time_to_load	1.34 ± 0.018 s	1.35 ± 0.028 s	0.993 ± 0.025

Memory benchmarks

	master	109a10c...	master / 109a10c...
arithmetic/2-arg mul	0.053 k allocs: 1.7 kB	0.053 k allocs: 1.7 kB	1
arithmetic/addition	0.3 k allocs: 10.3 kB	0.3 k allocs: 10.3 kB	1
arithmetic/division	0.129 k allocs: 4.69 kB	0.129 k allocs: 4.69 kB	1
arithmetic/multiplication	0.25 k allocs: 6.44 kB	0.25 k allocs: 6.44 kB	1
overhead/acrule/a+2	0.033 k allocs: 1.11 kB	0.033 k allocs: 1.11 kB	1
overhead/acrule/a+2+b	0 allocs: 0 B	0 allocs: 0 B
overhead/acrule/a+b	0.044 k allocs: 1.52 kB	0.044 k allocs: 1.52 kB	1
overhead/acrule/noop:Int	0 allocs: 0 B	0 allocs: 0 B
overhead/acrule/noop:Sym	0 allocs: 0 B	0 allocs: 0 B
overhead/get_degrees/large_poly	2 allocs: 32 B	2 allocs: 32 B	1
overhead/rule/noop:Int	2 allocs: 0.0625 kB	2 allocs: 0.0625 kB	1
overhead/rule/noop:Sym	2 allocs: 0.0625 kB	2 allocs: 0.0625 kB	1
overhead/rule/noop:Term	2 allocs: 0.0625 kB	2 allocs: 0.0625 kB	1
overhead/ruleset/noop:Int	0 allocs: 0 B	0 allocs: 0 B
overhead/ruleset/noop:Sym	3 allocs: 0.109 kB	3 allocs: 0.109 kB	1
overhead/ruleset/noop:Term	12 allocs: 0.391 kB	12 allocs: 0.391 kB	1
overhead/simplify/noop:Int	0 allocs: 0 B	0 allocs: 0 B
overhead/simplify/noop:Sym	0 allocs: 0 B	0 allocs: 0 B
overhead/simplify/noop:Term	0.276 k allocs: 9.89 kB	0.276 k allocs: 9.89 kB	1
overhead/simplify/randterm (+, *):serial	2.09 M allocs: 0.0743 GB	2.09 M allocs: 0.0743 GB	1
overhead/simplify/randterm (+, *):thread	2.25 M allocs: 0.236 GB	2.25 M allocs: 0.236 GB	1
overhead/simplify/randterm (/, *):serial	0.776 k allocs: 28.1 kB	0.776 k allocs: 28.1 kB	1
overhead/simplify/randterm (/, *):thread	0.911 k allocs: 0.0324 MB	0.911 k allocs: 0.0324 MB	1
overhead/substitute/a	0.204 k allocs: 6.77 kB	0.204 k allocs: 6.77 kB	1
overhead/substitute/a,b	0.268 k allocs: 8.86 kB	0.268 k allocs: 8.86 kB	1
overhead/substitute/a,b,c	0.268 k allocs: 8.67 kB	0.268 k allocs: 8.67 kB	1
polyform/easy_iszero	0.088 k allocs: 2.83 kB	0.088 k allocs: 2.83 kB	1
polyform/isone	10.9 k allocs: 0.576 MB	10.9 k allocs: 0.576 MB	1
polyform/isone:noop	1 allocs: 16 B	1 allocs: 16 B	1
polyform/iszero	8.97 k allocs: 0.476 MB	8.97 k allocs: 0.476 MB	1
polyform/iszero:noop	1 allocs: 16 B	1 allocs: 16 B	1
polyform/simplify_fractions	11.4 k allocs: 0.593 MB	11.4 k allocs: 0.593 MB	1
printing/large_poly	2.15 M allocs: 0.079 GB	2.15 M allocs: 0.079 GB	1
time_to_load	0.145 k allocs: 11 kB	0.145 k allocs: 11 kB	1