add free_u and free_p functions

Author: hexaeder

docs/src/API.md

@@ -121,28 +121,35 @@ get_metadata(::NetworkDynamics.ComponentModel, ::Symbol, ::Symbol)
 has_metadata(::NetworkDynamics.ComponentModel, ::Symbol, ::Symbol)
 set_metadata!(::NetworkDynamics.ComponentModel, ::Symbol, ::Symbol, ::Any)
 delete_metadata!(::NetworkDynamics.ComponentModel, ::Symbol, ::Symbol)
+strip_metadata!
 has_default
 get_default
 set_default!
 delete_default!
+strip_defaults!
 has_guess
 get_guess
 set_guess!
 delete_guess!
+strip_guesses!
 has_init
 get_init
 set_init!
 delete_init!
+strip_inits!
 has_bounds
 get_bounds
 set_bounds!
 delete_bounds!
+strip_bounds!
 set_defaults!
 set_interface_defaults!
 get_defaults_dict
 get_guesses_dict
 get_bounds_dict
 get_inits_dict
+free_u
+free_p
 ```
 
 ### Metadata and Inspection Utils

src/NetworkDynamics.jl

@@ -101,6 +101,7 @@ export has_initformula, get_initformulas, set_initformula!, add_initformula!, de
 export has_position, get_position, set_position!
 export has_marker, get_marker, set_marker!
 export get_defaults_dict, get_guesses_dict, get_bounds_dict, get_inits_dict
+export free_p, free_u
 include("metadata.jl")
 
 export isfixpoint, is_linear_stable, jacobian_eigenvals

src/metadata.jl

@@ -1082,3 +1082,39 @@ end
 
 function describe_vertices end
 function describe_edges end
+
+"""
+    free_p(cf::ComponentModel)
+    free_p(nw::Network)
+
+Returns the "free" parameters (parameters without default values) for the given system.
+
+# Returns
+- Vector of parameter symbols that do not have default values set
+
+See also: [`free_u`](@ref), [`has_default`](@ref), [`set_default!`](@ref)
+"""
+function free_p(cf::NetworkDynamics.ComponentModel)
+    return filter(p -> !NetworkDynamics.has_default(cf, p), NetworkDynamics.psym(cf))
+end
+function free_p(nw::Network)
+    setdiff(NetworkDynamics.SII.parameter_symbols(nw), keys(NetworkDynamics.SII.default_values(nw)))
+end
+
+"""
+    free_u(nw::Network)
+    free_u(cf::ComponentModel)
+
+Returns the "free" variables/states (variables without default values) for the given system.
+
+# Returns
+- Vector of variable/state symbols that do not have default values set
+
+See also: [`free_p`](@ref), [`has_default`](@ref), [`set_default!`](@ref)
+"""
+function free_u(nw::Network)
+    setdiff(NetworkDynamics.SII.variable_symbols(nw), keys(NetworkDynamics.SII.default_values(nw)))
+end
+function free_u(cf::NetworkDynamics.ComponentModel)
+    return filter(u -> !NetworkDynamics.has_default(cf, u), NetworkDynamics.sym(cf))
+end