Merge pull request #66 from jabelic/rls/ready-to-release-01

Rls/ready to release 01

Author: jabelic

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
       - master
       - staging
       - release
-    tags: '*'
+    tags: "*"
   pull_request:
 concurrency:
   # Skip intermediate builds: always.
@@ -20,8 +20,7 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.5'
-          # - 'nightly'
+          - "1.5"
         os:
           - ubuntu-latest
         arch:
@@ -38,4 +37,4 @@ jobs:
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v2
         with:
-          files: lcov.info
+          files: lcov.info

.gitignore

@@ -8,4 +8,4 @@ painting-board*
 *.jl.*.cov
 *.jl.cov
 *.jl.mem
-/Manifest.toml
+/Manifest.toml

README.md

@@ -1,11 +1,11 @@
 # SignedDistanceFunction.jl
 
 <!-- [![Build Status](https://app.travis-ci.com/jabelic/SignedDistanceFunction.jl.svg?branch=release)](https://app.travis-ci.com/jabelic/SignedDistanceFunction.jl) -->
+
 [![CI](https://github.com/jabelic/SignedDistanceFunction.jl/actions/workflows/ci.yml/badge.svg)](https://github.com/jabelic/SignedDistanceFunction.jl/actions/workflows/ci.yml)
 [![Coverage](https://codecov.io/gh/jabelic/SignedDistanceFunction.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/jabelic/SignedDistanceFunction.jl)
 [![Coverage](https://coveralls.io/repos/github/jabelic/SignedDistanceFunction.jl/badge.svg?branch=release)](https://coveralls.io/github/jabelic/SignedDistanceFunction.jl?branch=main)
 
-
 SignedDistanceFunction.jl is a package to compute signed distance function.
 
 Main features are:
@@ -31,10 +31,6 @@ The closed curve data must be `.csv` file. N is an `Int`, representing the numbe
 
 #### macOS
 
-`$ make initial`
-
-or
-
 `$ julia>`  
 `$ Pkg(1.5)> add PackageCompiler`  
 `$ Pkg(1.5)> add DelimitedFiles`  
@@ -47,8 +43,7 @@ or
 `$ (SignedDistanceFunction)>`  
 `$ julia> using SignedDistanceFunction`  
 `$ julia> signedDistance2D("xxxxxx.csv", N)`  
-
-
+`$ echo "Sysimage.so" >> .gitignore`
 
 ### Debug in REPL
 
@@ -70,12 +65,12 @@ return the REPL(`Delete/Backspace`)
 
 `julia> signedDistance2D("XXXXXX.csv", N)`
 
-<!-- Plots sample data: 
+<!-- Plots sample data:
 
 `julia> using CSV, DataFrames, Plots, DelimitedFiles, Luxor, BenchmarkTools`
 
 `julia> gamma = readdlm("data.csv", ',', Float64)`
 
-`julia> plot(gamma[:, 1], gamma[:, 2], st=:scatter, title="infty_shape", markersize=2, grid=false)` 
+`julia> plot(gamma[:, 1], gamma[:, 2], st=:scatter, title="infty_shape", markersize=2, grid=false)`
 
 `julia>  savefig("interface.png") -->

benchmarks/benchmarks.jl

@@ -11,6 +11,7 @@ import .Draw: parformance_graphs
 function _exe(kinds)
     _execute_times = 2
     _phi = []
+    # NOTE: N is for image size(N x N)
     init_N = 100
     increment_N = 200
     runtime = zeros(_execute_times + 1, 2)
@@ -40,38 +41,3 @@ end
 # _exe(2)
 _exe(3)
 
-#==
-Jabelic test it and get it as below.
-
-N2300:  300+200i, ARG = 10
- [300, 500, 700, 900, 1100, 1300, 1500, 1700, 1900, 2100, 2300]
- [2.727736517 1.549037993; 2.430711433 4.540753791; 
- 4.87217261 8.72733049; 6.970006918 11.296165896; 
- 10.919117877 16.429877231; 15.524662846 28.576650596; 
- 20.630861499 38.540759007; 26.182433943 51.252256581; 
- 33.966169503 64.128344396; 40.489381557 75.419365612; 
- 50.053971199 91.594363467]
-
-300+200i, ARG = 3, interface  multi-thread, single-thread
- [2.402844242 1.564786665; 2.415855251 4.372297246; 4.636160664 9.164722692; 7.243630318 11.635953353]
-signedDistance2D, 300+200i, ARG = 3, interface, multi-thread only. jordan_curve(using isinside), multi_curves(using floodfill)
- [2.126074484 13.096371426; 2.496373027 125.23088408; 5.242287246 596.261015286; 7.987274914 1743.300632586]
-
-
-1-3-500, interface, inpolygon
-[100, 300, 500]
-[1.248799153 0.530269039; 2.28104107 4.735589021; 6.293578857 11.423713058]
-32
-
-1-3-500, interface, Floodfill
-[100, 300, 500][1.291998074 0.123935482; 3.388728651 5.878153884; 69.895109677 84.980423578]
-32
-
-1-3-500, multi_curves, Floodfill
-[100, 300, 500][2.400877896 2.741995989; 38.038218511 92.339324457; 476.64809553 833.91326708]
-32
-
-1-3-500, multi_curves, Floodfill
-[100, 300, 500][0.5009443733333333 0.891537955; 12.114947880666668 28.633708910333336; 133.44351538533337 261.82990826500003]
-
- ==#

src/distance_function.jl

@@ -4,9 +4,9 @@ import DataFrames, DelimitedFiles, Luxor, BenchmarkTools
 using DataFrames, DelimitedFiles, Luxor, BenchmarkTools
 
 
-# 定義上のある点に対して全てのganma曲線上との距離を算出
+# Calculate the distance between a point on all ganma curves for a given point in the definition.
 function distanceToCurve(px::Float64, py::Float64, gem::Array) # TODO: 型
-    min_distance = 10000.0 # 初期値は大きく
+    min_distance = 10000.0 
     for i = 1:length(gem[:, 1])
         distnow = sqrt((gem[i, 1] - px)^2 + (gem[i, 2] - py)^2)
         if (distnow < min_distance)
@@ -58,8 +58,8 @@ function create_signed_distance_function(_x::Array, _y::Array, _gamma::Array)
     for indexI = 1:length(_y)
         for indexJ = 1:length(_x)
             sdist = 1.0 * distanceToCurve(_x[indexJ], _y[indexI], _gamma)
-            # ganmaが閉曲線でないと成立しない。
-            # omegaとの境界線上はErrorになる
+            # ganma must be a closed curve.
+            # Error happened when the point is on the edge of subdomain.
             if Point(_x[indexJ], _y[indexI]) in [Point(_gamma[i, 1], _gamma[i, 2]) for i = 1:length(_gamma[:, 1])]
                 sdist = 0
             elseif isinside(Point(_x[indexJ], _y[indexI]), [Point(_gamma[i, 1], _gamma[i, 2]) for i = 1:length(_gamma[:, 1])])