Update doc

Author: Azzaare

src/layers/comparison.jl

@@ -35,7 +35,7 @@ end
 Compute an euclidean norm with domain size `dom_size` of a scalar.
 """
 function co_euclidean(x; dom_size, params...)
-    return co_euclidean_val(x; val = 0.0, dom_size)
+    return co_euclidean_val(x; val=0.0, dom_size)
 end
 
 """
@@ -48,16 +48,21 @@ co_abs_diff_var_vars(x; nvars, params...) = abs(x - nvars)
     co_var_minus_vars(x; nvars)
 Return the difference `x - nvars` if positive, `0.0` otherwise, where `nvars` denotes the numbers of variables.
 """
-co_var_minus_vars(x; nvars, params...) = co_var_minus_val(x; val = nvars)
+co_var_minus_vars(x; nvars, params...) = co_var_minus_val(x; val=nvars)
 
 """
     co_vars_minus_var(x; nvars)
 Return the difference `nvars - x` if positive, `0.0` otherwise, where `nvars` denotes the numbers of variables.
 """
-co_vars_minus_var(x; nvars, params...) = co_val_minus_var(x; val = nvars)
+co_vars_minus_var(x; nvars, params...) = co_val_minus_var(x; val=nvars)
 
 
 # Parametric layers
+"""
+    make_comparisons(param::Symbol)
+
+Generate the comparison functions for the given parameter.
+"""
 make_comparisons(param::Symbol) = make_comparisons(Val(param))
 
 function make_comparisons(::Val{:none})
@@ -84,7 +89,7 @@ end
     comparison_layer(param = false)
 Generate the layer of transformations functions of the ICN. Iff `param` value is set, also includes all the parametric comparison with that value. The operations are mutually exclusive, that is only one will be selected.
 """
-function comparison_layer(parameters = Vector{Symbol}())
+function comparison_layer(parameters=Vector{Symbol}())
     comparisons = make_comparisons(:none)
 
     for p in parameters
@@ -118,7 +123,7 @@ end
 
     for (f, results) in funcs_param
         for (key, vals) in enumerate(data)
-            @test f(vals.first; val = vals.second[1]) == results[key]
+            @test f(vals.first; val=vals.second[1]) == results[key]
         end
     end
 
@@ -130,15 +135,15 @@ end
 
     for (f, results) in funcs_vars
         for (key, vals) in enumerate(data)
-            @test f(vals.first, nvars = vals.second[2]) == results[key]
+            @test f(vals.first, nvars=vals.second[2]) == results[key]
         end
     end
 
     funcs_val_dom = [CN.co_euclidean_val => [1.4, 2.0]]
 
     for (f, results) in funcs_val_dom
         for (key, vals) in enumerate(data)
-            @test f(vals.first, val = vals.second[1], dom_size = vals.second[2]) ≈
+            @test f(vals.first, val=vals.second[1], dom_size=vals.second[2]) ≈
                   results[key]
         end
     end
@@ -147,7 +152,7 @@ end
 
     for (f, results) in funcs_dom
         for (key, vals) in enumerate(data)
-            @test f(vals.first, dom_size = vals.second[2]) ≈ results[key]
+            @test f(vals.first, dom_size=vals.second[2]) ≈ results[key]
         end
     end
 

src/utils.jl

@@ -57,7 +57,7 @@ end
     as_bitvector(n::Int, max_n::Int = n)
 Convert an Int to a BitVector of minimal size (relatively to `max_n`).
 """
-function as_bitvector(n::Int, max_n::Int = n)
+function as_bitvector(n::Int, max_n::Int=n)
     nm1 = n - 1
     v = falses(ceil(Int, log2(max_n)))
     i = 0
@@ -86,7 +86,7 @@ end
     reduce_symbols(symbols, sep)
 Produce a formatted string that separates the symbols by `sep`. Used internally for `show_composition`.
 """
-function reduce_symbols(symbols, sep, parenthesis = true; prefix = "")
+function reduce_symbols(symbols, sep, parenthesis=true; prefix="")
     str = reduce((x, y) -> "$y$sep$x", map(s -> "$prefix$s", symbols))
     return parenthesis ? "[$str]" : str
 end
@@ -96,6 +96,8 @@ end
 
 Application of an operation from the transformation layer. Used to generate more efficient code for all compositions.
 """
+function tr_in end
+
 @unroll function tr_in(tr, X, x; params...)
     @unroll for i = 1:length(tr)
         tr[i](x, @view(X[:, i]); params...)