Merge pull request #14 from co1emi11er2/not_funcs

Not funcs

Project.toml

@@ -1,7 +1,7 @@
 name = "Handcalcs"
 uuid = "e8a07092-c156-4455-ab8e-ed8bc81edefb"
 authors = ["Cole Miller"]
-version = "0.3.3"
+version = "0.3.4"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"

docs/src/index.md

@@ -114,18 +114,26 @@ x = 0
 y = sin(x)
 z = cos(x)
 I_x, I_y = TestHandcalcFunctions.calc_Is(5, 15)
-end not_funcs = [sin cos]
+end not_funcs = [:sin :cos]
 ```
 
 In the above example `sin` and `cos` were passed over and calc_Is was not. As you can see, the calc_Is function was a function that called other functions, and the @handcalcs macro continued to step into each function to unroll all expressions. Please see below for a list of the current functions that are passed over automatically. Please submit a pull request if you would like to add more generic math functions that I have left out. 
 
-```
+```julia
 const math_syms = [
     :*, :/, :^, :+, :-, :%,
     :.*, :./, :.^, :.+, :.-, :.%,
     :<, :>, Symbol(==), :<=, :>=,
     :.<, :.>, :.==, :.<=, :.>=,
-    :sqrt, :sin, :cos, :tan]
+    :sqrt, :sin, :cos, :tan, :sum, 
+    :cumsum, :max, :min, :exp, :log,
+    :log10]
+```
+
+If you want to add functions to your specific project, you can do the following:
+
+```@example main
+set_handcalcs(not_funcs = [:foo :bar :baz])
 ```
 
 Current Limitations for `@handcalcs`

src/Handcalcs.jl

@@ -27,7 +27,10 @@ const math_syms = [
     :.*, :./, :.^, :.+, :.-, :.%,
     :<, :>, Symbol(==), :<=, :>=,
     :.<, :.>, :.==, :.<=, :.>=,
-    :sqrt, :sin, :cos, :tan]
+    :sqrt, :sin, :cos, :tan, :sum, 
+    :cumsum, :max, :min, :exp, :log,
+    :log10]
+
 const h_syms = [:cols, :spa, :h_env, :len]
 
 include("default_h_kwargs.jl")

src/handcalc_marco.jl

@@ -161,6 +161,10 @@ end
 function check_not_funcs(f, kwargs)
     not_funcs = find_not_funcs(kwargs)
     not_funcs = typeof(not_funcs) == Symbol ? [not_funcs] : not_funcs
+    defaults = get(default_h_kwargs, :not_funcs, [])
+    if defaults != []
+        push!(not_funcs, defaults...)
+    end
     return f ∉ not_funcs
 end
 

test/default_h_kwargs.jl

@@ -31,3 +31,17 @@ calc = @handcalcs begin
 end
 @test calc == expected
 reset_handcalcs()
+
+
+# use set_handcalcs for not_funcs
+# ***************************************************
+# ***************************************************
+set_handcalcs(not_funcs = [:calc_Ix])
+
+expected = L"$\begin{aligned}
+Ix &= \mathrm{calc}_{Ix}\left( 5, 15 \right) = 1406.25
+\end{aligned}$"
+
+calc = @handcalcs Ix = calc_Ix(5, 15)
+@test calc == expected
+reset_handcalcs()