Repository navigation
Description
What it is. Print expressions as straight-line HLSL or GLSL: one assignment per output, each repeated subexpression computed once into a local, sincos for a sin/cos pair in HLSL.
Entity r = "sqrt(x^2 + y^2)";
MathS.Shaders.Hlsl(new Dictionary<string, Entity> { ["g.x"] = r.Differentiate("x"), ["g.y"] = r.Differentiate("y") }.ToList(),
new Dictionary<Entity.Variable, string> { ["x"] = "p.x", ["y"] = "p.y" }).Code;
// float am0 = (0.5 * rsqrt(((p.x * p.x) + (p.y * p.y))));
// g.x = (am0 * (2.0 * p.x));
// g.y = (am0 * (2.0 * p.y));Why. Exact gradients and Hessians of signed distance fields, and closed forms of physical laws, derived on the CPU and run on the GPU. Measured in practice: an exact SDF normal replaced a 4-sample finite difference at 1509 → 466 instructions, and a second one ran 1.23× faster while being exact where the finite difference was 30° off at creases. #552 (Unity) is the same audience.
Contract.
- Computes the real-valued reading that
Compile<double, …>computes. The tests hold it to that: the same printer writes C# against helpers named as HLSL's intrinsics, Roslyn compiles that text, and it is compared withCompile<double, double, double>at 200 points per case (28 cases). - One difference to agree on: if A compiled division by zero over double has no value #2288 lands,
Compile<double>answers NaN for a division by zero, wherex / 0.0on a GPU is ±inf. The printer writes/as is; guarding every division would cost a branch per quotient. The proposal is to document the difference rather than pay for it. - Declines, naming the node, what has no faithful form: complex constants, non-identifier names,
Providedf(a shader cannot say "no value here";Differentiateattaches one to tanh's exponential form, so the caller unwraps it where the condition cannot fail), piecewise without a final always-true case,Roundf(tie rules differ), factorial, sets. - Adds no referenced assembly:
KernelDependenciesTestcaught a first draft that usedRegex. - Integer powers multiplied out to the 4th; higher as
pow(abs(x), n)with the sign restored for oddn, becausepowof a negative base is undefined in both languages. modprinted floored, asModfis (fmodtruncates).- Nothing is simplified.
Packaging. No clause fires (pure managed, string output) → kernel, beside IntoLinq. Arguably (C) "consumes rather than composes"; the SymPy exporter is the precedent for an output format in the kernel.
Implementation, for judging the design against working code. Branch feat/shader-source, one commit on master 87a0eff: Functions/Compilation/IntoSource/*, Convenience/MathS.Shaders.cs, Tests/UnitTests/Convenience/ShadersTest.cs, +17 lines of PublicApi.txt. UnitTests 18332 passed / 13 skipped, FSharpWrapperUnitTests 134 passed. The pull request will follow Accepted.
Worked use, together with dimensional analysis (#2292). A water wave from ω² = g k tanh(k h): the emitted HLSL matches the library to 4e-16 in double, and to 3e-5 of the amplitude in fp32 out to k h = 300.
Milestone: 2.7.0 (additive).
Metadata
Metadata
Assignees
Labels
Type
Projects
- StatusShow more project fieldsTodo
Activity
Rafael-SOWNet commentedon Oct 31, 2026
#2288 has landed (e238512). Compiled over
double, a zero divisor and zero raised to a power that is not positive now have no value (NaN), so the difference described under Contract is now real, and a little wider than the division stated there:Compile<double>since #2288a / bwithb = 0NaNa / b: ±inf under IEEE 754x^(-n),x^(-1/2)atx = 0NaN1.0 / (x * x),rsqrt(x): ±infx^0atx = 0NaN1.0Wherever the compiled function has a value, the two still agree:
feat/shader-sourcerebased onto master 17cd9da passesShadersTest, which compares the printed code withCompile<double, …>at 200 points for each of 28 cases.The proposal stands: print
/andpowas they are rather than guard every quotient. The branch's documentation already says that whereCompile<double>has no value the shader's isNaNor unspecified; the pull request will name these cases in it, so that ±inf at a zero divisor is documented, not discovered.Happypig375 commentedon Nov 1, 2026
Hypothetically can speed up compiled functions too. Precise contract, behaviour, settings TBD
Shader source in the catalogue: hlsl and glsl