Skip to content

Commit 0735fd7

Browse files
committed
fix laplacianmat docstring
1 parent 68fcd94 commit 0735fd7

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

src/network_analysis.jl

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -195,12 +195,11 @@ end
195195
@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.
199-
Returns a symbolic matrix by default, but will return a numerical matrix if parameter values are specified via pmap.
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.
200199
201200
Returns a symbolic matrix by default, but will return a numerical matrix if parameter values are specified via pmap.
202201
203-
**Warning**: Unlike other Catalyst functions, the `laplacianmat` function will return a `Matrix{Num}` in the symbolic case. This is to allow easier computation of the matrix decomposition of the ODEs, and to ensure that multiplying the sparse form of the matrix will work.
202+
**Warning**: Unlike other Catalyst functions, the `laplacianmat` function will return a `Matrix{Num}` in the symbolic case. This is to allow easier computation of the matrix decomposition of the ODEs, and to ensure that multiplying the sparse form of the matrix will work.
204203
"""
205204
function laplacianmat(rn::ReactionSystem, pmap::Dict = Dict(); sparse = false)
206205
D = incidencemat(rn; sparse)

0 commit comments

Comments
 (0)