Skip to content

Commit 87cb28d

Browse files
authored
Merge pull request #1111 from vyudu/docstring-fix
fix docstrings
2 parents 4012412 + af16c69 commit 87cb28d

File tree

1 file changed

+0
-8
lines changed

1 file changed

+0
-8
lines changed

src/network_analysis.jl

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -743,7 +743,6 @@ end
743743
Constructively compute whether a kinetic system (a reaction network with a set of rate constants) will admit detailed-balanced equilibrium
744744
solutions, using the Wegscheider conditions, [Feinberg, 1989](https://www.sciencedirect.com/science/article/pii/0009250989851243). A detailed-balanced solution is one for which the rate of every forward reaction exactly equals its reverse reaction. Accepts a dictionary, vector, or tuple of variable-to-value mappings, e.g. [k1 => 1.0, k2 => 2.0,...].
745745
"""
746-
747746
function isdetailedbalanced(rs::ReactionSystem, parametermap::Dict; abstol=0, reltol=1e-9)
748747
if length(parametermap) != numparams(rs)
749748
error("Incorrect number of parameters specified.")
@@ -825,7 +824,6 @@ Constructively compute whether a network will have complex-balanced equilibrium
825824
solutions, following the method in van der Schaft et al., [2015](https://link.springer.com/article/10.1007/s10910-015-0498-2#Sec3).
826825
Accepts a dictionary, vector, or tuple of variable-to-value mappings, e.g. [k1 => 1.0, k2 => 2.0,...].
827826
"""
828-
829827
function iscomplexbalanced(rs::ReactionSystem, parametermap::Dict)
830828
if length(parametermap) != numparams(rs)
831829
error("Incorrect number of parameters specified.")
@@ -902,7 +900,6 @@ end
902900
constant of the reaction between complex i and complex j. Accepts a dictionary, vector, or tuple
903901
of variable-to-value mappings, e.g. [k1 => 1.0, k2 => 2.0,...].
904902
"""
905-
906903
function ratematrix(rs::ReactionSystem, rates::Vector{Float64})
907904
complexes, D = reactioncomplexes(rs)
908905
n = length(complexes)
@@ -997,7 +994,6 @@ end
997994
Returns the matrix of a basis of cycles (or flux vectors), or a basis for reaction fluxes for which the system is at steady state.
998995
These correspond to right eigenvectors of the stoichiometric matrix. Equivalent to [`fluxmodebasis`](@ref).
999996
"""
1000-
1001997
function cycles(rs::ReactionSystem)
1002998
nps = get_networkproperties(rs)
1003999
nsm = netstoichmat(rs)
@@ -1032,7 +1028,6 @@ end
10321028
10331029
See documentation for [`cycles`](@ref).
10341030
"""
1035-
10361031
function fluxvectors(rs::ReactionSystem)
10371032
cycles(rs)
10381033
end
@@ -1044,7 +1039,6 @@ end
10441039
10451040
Check if a reaction network obeys the conditions of the deficiency one theorem, which ensures that there is only one equilibrium for every positive stoichiometric compatibility class.
10461041
"""
1047-
10481042
function satisfiesdeficiencyone(rn::ReactionSystem)
10491043
all(r -> ismassaction(r, rn), reactions(rn)) ||
10501044
error("The deficiency one theorem is only valid for reaction networks that are mass action.")
@@ -1067,7 +1061,6 @@ end
10671061
10681062
Check if a reaction network obeys the conditions of the deficiency zero theorem, which ensures that there is only one equilibrium for every positive stoichiometric compatibility class, this equilibrium is asymptotically stable, and this equilibrium is complex balanced.
10691063
"""
1070-
10711064
function satisfiesdeficiencyzero(rn::ReactionSystem)
10721065
all(r -> ismassaction(r, rn), reactions(rn)) ||
10731066
error("The deficiency zero theorem is only valid for reaction networks that are mass action.")
@@ -1082,7 +1075,6 @@ end
10821075
10831076
Note: This function currently only works for networks of deficiency one, and is not currently guaranteed to return *all* the concentration-robust species in the network. Any species returned by the function will be robust, but this may not include all of them. Use with caution. Support for higher deficiency networks and necessary conditions for robustness will be coming in the future.
10841077
"""
1085-
10861078
function robustspecies(rn::ReactionSystem)
10871079
complexes, D = reactioncomplexes(rn)
10881080
nps = get_networkproperties(rn)

0 commit comments

Comments
 (0)