Skip to content

Commit b921fed

Browse files
committed
Fix docstring
1 parent 3128628 commit b921fed

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/network_analysis.jl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -192,21 +192,21 @@ function complexstoichmat(::Type{Matrix{Int}}, rn::ReactionSystem, rcs)
192192
Z
193193
end
194194

195-
"""
195+
@doc raw"""
196196
laplacianmat(rn::ReactionSystem, pmap=Dict(); sparse=false)
197197
198-
Return the negative of the graph Laplacian of the reaction network. The ODE system of a chemical reaction network can be factorized as ``\frac{dx}{dt} = Y A_k Φ(x)``, where Y is the [`complexstoichmat`](@ref) and A_k is the negative of the graph Laplacian, and Φ is the [`massactionvector`](@ref). A_k is an n-by-n matrix, where n is the number of complexes, where ``A_{ij} = k_{ij}`` if a reaction exists between the two complexes and 0 otherwise.
198+
Return the negative of the graph Laplacian of the reaction network. The ODE system of a chemical reaction network can be factorized as ``\frac{dx}{dt} = Y A_k Φ(x)``, where ``Y`` is the [`complexstoichmat`](@ref) and ``A_k`` is the negative of the graph Laplacian, and ``Φ`` is the [`massactionvector`](@ref). ``A_k`` is an n-by-n matrix, where n is the number of complexes, where ``A_{ij} = k_{ij}`` if a reaction exists between the two complexes and 0 otherwise.
199199
Returns a symbolic matrix by default, but will return a numerical matrix if parameter values are specified via pmap.
200200
"""
201201
function laplacianmat(rn::ReactionSystem, pmap = Dict(); sparse = false)
202202
D = incidencemat(rn; sparse); K = fluxmat(rn, pmap; sparse)
203203
D*K
204204
end
205205

206-
"""
206+
@doc raw"""
207207
fluxmat(rn::ReactionSystem, pmap = Dict(); sparse=false)
208208
209-
Return an r×c matrix K such that, if complex j is the substrate complex of reaction i, then K_{ij} = k, the rate constant for this reaction. Mostly a helper function for the network Laplacian, [`networklaplacianmat`](@ref). Has the useful property that ``\frac{dx}{dt} = S*K*Φ(x)``, where S is the [`netstoichmat`](@ref) or net stoichiometry matrix and Φ(x) is the [`massactionvector`](@ref).
209+
Return an r×c matrix ``K`` such that, if complex ``j`` is the substrate complex of reaction ``i``, then ``K_{ij} = k``, the rate constant for this reaction. Mostly a helper function for the network Laplacian, [`laplacianmat`](@ref). Has the useful property that ``\frac{dx}{dt} = S*K*Φ(x)``, where S is the [`netstoichmat`](@ref) or net stoichiometry matrix and ``Φ(x)`` is the [`massactionvector`](@ref).
210210
Returns a symbolic matrix by default, but will return a numerical matrix if rate constants are specified as a `Tuple`, `Vector`, or `Dict` of symbol-value pairs via `pmap`.
211211
"""
212212
function fluxmat(rn::ReactionSystem, pmap::Dict = Dict(); sparse=false)
@@ -270,7 +270,7 @@ end
270270
"""
271271
massactionvector(rn::ReactionSystem, scmap = Dict(); combinatoric_ratelaws = true)
272272
273-
Return the vector whose entries correspond to the "mass action products" of each complex. For example, given the complex A + B, the corresponding entry of the vector would be A*B, and for the complex 2X + Y, the corresponding entry would be X^2*Y. The ODE system of a chemical reaction network can be factorized as ``\frac{dx}{dt} = Y A_k Φ(x)``, where Y is the [`complexstoichmat`](@ref) and A_k is the negative of the [`networklaplacian`](@ref). This utility returns Φ(x).
273+
Return the vector whose entries correspond to the "mass action products" of each complex. For example, given the complex A + B, the corresponding entry of the vector would be ``A*B``, and for the complex 2X + Y, the corresponding entry would be ``X^2*Y``. The ODE system of a chemical reaction network can be factorized as ``\frac{dx}{dt} = Y A_k Φ(x)``, where ``Y`` is the [`complexstoichmat`](@ref) and ``A_k`` is the negative of the [`laplacianmat`](@ref). This utility returns ``Φ(x)``.
274274
Returns a symbolic vector by default, but will return a numerical vector if species concentrations are specified as a tuple, vector, or dictionary via scmap.
275275
If the `combinatoric_ratelaws` option is set, will include prefactors for that (see [introduction to Catalyst's rate laws](@ref introduction_to_catalyst_ratelaws).
276276
"""

0 commit comments

Comments
 (0)