fill_A_S_M!(): add !, specify argtypes

to match julia naming convention

Author: Alexey Stukalov

src/additional_functions/parameters.jl

@@ -1,4 +1,13 @@
-function fill_A_S_M(A, S, M, A_indices, S_indices, M_indices, parameters)
+# fill A, S, and M matrices with the parameter values according to the parameters map
+function fill_A_S_M!(
+    A::AbstractMatrix,
+    S::AbstractMatrix,
+    M::Union{AbstractVector, Nothing},
+    A_indices::AbstractArrayParamsMap,
+    S_indices::AbstractArrayParamsMap,
+    M_indices::Union{AbstractArrayParamsMap, Nothing},
+    parameters::AbstractVector,
+)
     @inbounds for (iA, iS, par) in zip(A_indices, S_indices, parameters)
         for index_A in iA
             A[index_A] = par
@@ -88,12 +97,18 @@ function get_matrix_derivative(M_indices, parameters, n_long)
     return ∇M
 end
 
-function fill_matrix(M, M_indices, parameters)
+# fill M with parameters
+function fill_matrix!(
+    M::AbstractMatrix,
+    M_indices::AbstractArrayParamsMap,
+    parameters::AbstractVector,
+)
     for (iM, par) in zip(M_indices, parameters)
         for index_M in iM
             M[index_M] = par
         end
     end
+    return M
 end
 
 function get_partition(A_indices, S_indices)

src/imply/RAM/generic.jl

@@ -222,7 +222,7 @@ gradient!(imply::RAM, par, model::AbstractSemSingle) =
 
 # objective and gradient
 function objective!(imply::RAM, parameters, model, has_meanstructure::Val{T}) where {T}
-    fill_A_S_M(
+    fill_A_S_M!(
         imply.A,
         imply.S,
         imply.M,
@@ -250,7 +250,7 @@ function gradient!(
     model::AbstractSemSingle,
     has_meanstructure::Val{T},
 ) where {T}
-    fill_A_S_M(
+    fill_A_S_M!(
         imply.A,
         imply.S,
         imply.M,
@@ -346,7 +346,7 @@ function check_acyclic(A_pre, n_par, A_indices)
     A_rand = copy(A_pre)
     randpar = rand(n_par)
 
-    fill_matrix(A_rand, A_indices, randpar)
+    fill_matrix!(A_rand, A_indices, randpar)
 
     # check if the model is acyclic
     acyclic = isone(det(I - A_rand))

src/imply/RAM/symbolic.jl

@@ -112,7 +112,7 @@ function RAMSymbolic(;
     F[CartesianIndex.(1:n_var, ram_matrices.F_ind)] .= 1.0
 
     set_RAMConstants!(A, S, M, ram_matrices.constants)
-    fill_A_S_M(A, S, M, ram_matrices.A_ind, ram_matrices.S_ind, ram_matrices.M_ind, par)
+    fill_A_S_M!(A, S, M, ram_matrices.A_ind, ram_matrices.S_ind, ram_matrices.M_ind, par)
 
     A, S, F = sparse(A), sparse(S), sparse(F)