Merge pull request #390 from SciML/lincomp_revision

Lincomp revision

src/lincomp.jl

@@ -14,7 +14,7 @@
 #------------------------------------------------------------------------------
 
 """
-    linear_compartment_model(graph, inputs, outputs, leaks)
+    linear_compartment_model(graph; inputs = [], outputs = [], leaks = [])
 
 Input: defines a linear compartment model with nodes numbered from 1 to `n` by
 - `graph` - and array of integer arrays representing the adjacency lists of the graph
@@ -23,14 +23,25 @@ Input: defines a linear compartment model with nodes numbered from 1 to `n` by
 - `leaks` - array of sink nodes
 
 Output:
-- the corresponding ODE system in the notation of https://doi.org/10.1007/s11538-015-0098-0
+- the corresponding ODE system in a standard notation  (as, e.g., in [this paper](https://doi.org/10.1007/s11538-015-0098-0))
+
+Example: Consider a bidirected cycle with four nodes. Its adjacency list can be written as follows:
+```
+[ [2, 4], [1, 3], [2, 4], [1, 3] ]
+```
+In the list above, the `i`-th element is a list of vertices to which there exists an edge
+from the vertex `i`. Now we can create a linear compartment model over this graph with
+the output at vertex 1, input at vertex 2, and leaks at vertices 3 and 4 as follows:
+```jldoctest
+julia> ode = linear_compartment_model([[2, 4], [1, 3], [2, 4], [1, 3]], outputs = [1], inputs = [2], leaks = [2, 3])
+x1' = -x1*a_2_1 - x1*a_4_1 + x2*a_1_2 + x4*a_1_4
+x3' = x2*a_3_2 - x3*a_2_3 - x3*a_4_3 - x3*a_0_3 + x4*a_3_4
+x2' = x1*a_2_1 - x2*a_1_2 - x2*a_3_2 - x2*a_0_2 + x3*a_2_3 + u2
+x4' = x1*a_4_1 + x3*a_4_3 - x4*a_1_4 - x4*a_3_4
+y1 = x1
+```
 """
-function linear_compartment_model(
-    graph::Vector{Vector{Int}},
-    inputs::Vector{Int},
-    outputs::Vector{Int},
-    leaks::Vector{Int},
-)
+function linear_compartment_model(graph; inputs = [], outputs = [], leaks = [])
     n = length(graph)
     x_vars_names = ["x$i" for i in 1:n]
     y_vars_names = ["y$i" for i in outputs]

test/linear_compartment.jl

@@ -152,9 +152,9 @@
     for case in test_cases
         ode = linear_compartment_model(
             case[:graph],
-            case[:inputs],
-            case[:outputs],
-            case[:leaks],
+            inputs = case[:inputs],
+            outputs = case[:outputs],
+            leaks = case[:leaks],
         )
         bring = ode.poly_ring
         correct = Dict{QQMPolyRingElem, Symbol}()