diff --git a/src/lib/subroutines.jl b/src/lib/subroutines.jl index 66b4828f..1c4e9dbe 100644 --- a/src/lib/subroutines.jl +++ b/src/lib/subroutines.jl @@ -1,3 +1,9 @@ +""" + subroutines.jl + +# Description +Common low-level functions, such as for operating on matrices and vectors. +""" # ----------------------------------------------------------------------------- # COMMON LOW-LEVEL FUNCTIONS diff --git a/src/lib/symbols.jl b/src/lib/symbols.jl index 6829bd59..73700a03 100644 --- a/src/lib/symbols.jl +++ b/src/lib/symbols.jl @@ -1,3 +1,13 @@ +""" + symbols.jl + +# Description +Symbols for macro evaluation of activation, match, and learning functions. +""" + +# ----------------------------------------------------------------------------- +# FUNCTIONS +# ----------------------------------------------------------------------------- """ Low-level common function for computing the 1-norm of the element minimum of a sample and weights. @@ -152,6 +162,10 @@ function art_learn(art::ARTModule, x::RealVector, index::Integer) return eval(art.opts.update)(art, x, get_sample(art.W, index)) end +# ----------------------------------------------------------------------------- +# ENUMERATIONS +# ----------------------------------------------------------------------------- + """ Enumerates all of the update functions available in the package. """ @@ -175,4 +189,4 @@ const ACTIVATION_FUNCTIONS = [ :unnormalized_match, :choice_by_difference, :gamma_activation, -] \ No newline at end of file +] diff --git a/test/runtests.jl b/test/runtests.jl index dc704586..4aa288f4 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -1,11 +1,20 @@ """ runtests.jl +# Description The entry point to unit tests for the AdaptiveResonance.jl package. """ +# ----------------------------------------------------------------------------- +# DEPENDENCIES +# ----------------------------------------------------------------------------- + using SafeTestsets +# ----------------------------------------------------------------------------- +# SAFETESTSETS +# ----------------------------------------------------------------------------- + @safetestset "All Test Sets" begin include("test_sets.jl") end