add precompile statements - SnoopPrecompile (#10)

Author: t-bltg

.JuliaFormatter

@@ -1,5 +1,6 @@
 annotate_untyped_fields_with_any = false
 short_to_long_function_def = false
+long_to_short_function_def = true
 whitespace_ops_in_indices = true
 remove_extra_newlines = true
 whitespace_in_kwargs = true

.github/workflows/CI.yml

@@ -30,24 +30,15 @@ jobs:
             version: '1'
             arch: x64
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v3
+      - uses: julia-actions/setup-julia@latest
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: actions/cache@v2
-        env:
-          cache-name: cache-artifacts
-        with:
-          path: ~/.julia/artifacts
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-test-${{ env.cache-name }}-
-            ${{ runner.os }}-test-
-            ${{ runner.os }}-
-      - uses: julia-actions/julia-buildpkg@v1
-      - uses: julia-actions/julia-runtest@v1
-      - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v1
+      - uses: julia-actions/cache@v1
+      - uses: julia-actions/julia-buildpkg@latest
+      - uses: julia-actions/julia-runtest@latest
+      - uses: julia-actions/julia-processcoverage@latest
+      - uses: codecov/codecov-action@v3
         with:
           file: lcov.info

Project.toml

@@ -3,17 +3,19 @@ uuid = "299715c1-40a9-479a-aaf9-4a633d36f717"
 version = "0.1.3"
 
 [deps]
+SnoopPrecompile = "66db9d55-30c0-4569-8b51-7e840670fc0c"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 
+[compat]
+StaticArrays = "0.12, 1"
+SnoopPrecompile = "1"
+julia = "1.6"
+
 [extras]
 BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 Meshes = "eacbb407-ea5a-433e-ab97-5258b1ca43fa"
 PlyIO = "42171d58-473b-503a-8d5f-782019eb09ec"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
-[compat]
-StaticArrays = "0.12, 1"
-julia = "1"
-
 [targets]
 test = ["BenchmarkTools", "Meshes", "PlyIO", "Test"]

src/MarchingCubes.jl

@@ -19,9 +19,11 @@ Adapted to `Julia` by T Bltg (github.com/t-bltg).
 
 module MarchingCubes
 
-import Base: RefValue
+using SnoopPrecompile
 using StaticArrays
 
+import Base: RefValue
+
 export MC, march, march_legacy
 
 include("lut.jl")
@@ -690,4 +692,10 @@ end
 
 include("example.jl")
 
+@precompile_setup begin
+    @precompile_all_calls begin
+        march(MarchingCubes.scenario(4, 4, 4; F = Float64, I = Int))
+    end
+end
+
 end

src/example.jl

@@ -1,5 +1,4 @@
-scenario(nx = 60, ny = 60, nz = 60; case = :torus2) = begin
-    F = Float32
+scenario(nx = 60, ny = 60, nz = 60; F = Float32, I = Int32, case = :torus2) = begin
     vol = zeros(F, nx, ny, nz)
 
     sx, sy, sz = size(vol) ./ F(16)
@@ -10,46 +9,37 @@ scenario(nx = 60, ny = 60, nz = 60; case = :torus2) = begin
     r = F(1.85)
     R = F(4)
 
-    cushin(x, y, z) =
-        z^2 * x^2 - z^4 - 2z * x^2 + 2z^3 + x^2 - z^2 - (x^2 - z)^2 - y^4 - 2x^2 * y^2 -
-        y^2 * z^2 +
-        2y^2 * z +
-        y^2
-
-    torus2(x, y, z) =
-        ((x^2 + y^2 + z^2 + R^2 - r^2)^2 - 4R^2 * (x^2 + y^2)) *
-        ((x^2 + (y + R)^2 + z^2 + R^2 - r^2)^2 - 4R^2 * ((y + R)^2 + z^2))
-
-    sphere(x, y, z) = (
-        ((x - 2)^2 + (y - 2)^2 + (z - 2)^2 - 1) *
-        ((x + 2)^2 + (y - 2)^2 + (z - 2)^2 - 1) *
-        ((x - 2)^2 + (y + 2)^2 + (z - 2)^2 - 1)
-    )
-
-    plane(x, y, z) = x + y + z - 3
-
-    cassini(x, y, z) =
-        (x^2 + y^2 + z^2 + F(0.45)^2)^2 - 16 * F(0.45)^2 * (x^2 + z^2) - F(0.5)^2
-
-    blooby(x, y, z) = x^4 - 5x^2 + y^4 - 5y^2 + z^4 - 5z^2 + F(11.8)
-
-    hyperboloid(x, y, z) = x^2 + y^2 - z^2 - 1
-
-    callback = (;
-        cushin = cushin,
-        torus2 = torus2,
-        sphere = sphere,
-        plane = plane,
-        cassini = cassini,
-        blooby = blooby,
-        hyperboloid = hyperboloid,
-    )[case]
+    callback = if case ≡ :cushin
+        (x, y, z) ->
+            z^2 * x^2 - z^4 - 2z * x^2 + 2z^3 + x^2 - z^2 - (x^2 - z)^2 - y^4 - 2x^2 * y^2 - y^2 * z^2 +
+            2y^2 * z +
+            y^2
+    elseif case ≡ :torus2
+        (x, y, z) ->
+            ((x^2 + y^2 + z^2 + R^2 - r^2)^2 - 4R^2 * (x^2 + y^2)) *
+            ((x^2 + (y + R)^2 + z^2 + R^2 - r^2)^2 - 4R^2 * ((y + R)^2 + z^2))
+    elseif case ≡ :sphere
+        (x, y, z) -> (
+            ((x - 2)^2 + (y - 2)^2 + (z - 2)^2 - 1) *
+            ((x + 2)^2 + (y - 2)^2 + (z - 2)^2 - 1) *
+            ((x - 2)^2 + (y + 2)^2 + (z - 2)^2 - 1)
+        )
+    elseif case ≡ :plane
+        (x, y, z) -> x + y + z - 3
+    elseif case ≡ :cassini
+        (x, y, z) ->
+            (x^2 + y^2 + z^2 + F(0.45)^2)^2 - 16 * F(0.45)^2 * (x^2 + z^2) - F(0.5)^2
+    elseif case ≡ :blooby
+        (x, y, z) -> x^4 - 5x^2 + y^4 - 5y^2 + z^4 - 5z^2 + F(11.8)
+    elseif case ≡ :hyperboloid
+        (x, y, z) -> x^2 + y^2 - z^2 - 1
+    end
 
     for k ∈ 1:nz, j ∈ 1:ny, i ∈ 1:nx
         vol[i, j, k] = callback((i - 1) / sx - tx, (j - 1) / sy - ty, (k - 1) / sz - tz)
     end
 
-    MC(vol, Int32)
+    MC(vol, I)
 end
 
 output(PlyIO::Module, m::MC, fn::AbstractString = "test.ply") = begin

test/runtests.jl

@@ -62,6 +62,30 @@ end
     @test length(mc.triangles) == 24_118
 end
 
+@testset "cushin" begin
+    mc = MarchingCubes.scenario(case = :cushin)
+    bytes = @allocated march(mc)
+    @test bytes == 0
+    @test length(mc.vertices) == 302
+    @test length(mc.triangles) == 600
+end
+
+@testset "cassini" begin
+    mc = MarchingCubes.scenario(case = :cassini)
+    bytes = @allocated march(mc)
+    @test bytes == 0
+    @test length(mc.vertices) == 554
+    @test length(mc.triangles) == 1_104
+end
+
+@testset "blooby" begin
+    mc = MarchingCubes.scenario(case = :blooby)
+    bytes = @allocated march(mc)
+    @test bytes == 0
+    @test length(mc.vertices) == 2_168
+    @test length(mc.triangles) == 4_352
+end
+
 @testset "isovalue" begin
     dat = Float32[(x - 3)^2 + (y - 3)^2 + (z - 3)^2 for x ∈ 1:5, y ∈ 1:5, z ∈ 1:5]