Merge branch 'master' into fixes

Author: vpuri3

Project.toml

@@ -1,7 +1,7 @@
 name = "SciMLOperators"
 uuid = "c0aeaf25-5076-4817-a8d5-81caf7dfa961"
 authors = ["Vedant Puri <[email protected]>"]
-version = "0.2.5"
+version = "0.2.6"
 
 [deps]
 ArrayInterface = "4fba245c-0d91-5ea0-9b3e-6abc04ee57a9"

src/SciMLOperators.jl

@@ -20,6 +20,20 @@ import SparseArrays: sparse, issparse
 
 """
 $(TYPEDEF)
+
+## Interface
+
+An `L::AbstractSciMLOperator` can be called like a function. This behaves
+like multiplication by the linear operator represented by the
+`AbstractSciMLOperator`. Possible signatures are
+
+- `L(du, u, p, t)` for in-place operator evaluation
+- `du = L(u, p, t)` for out-of-place operator evaluation
+
+If the operator is not a constant, update it with `(u, p, t)`.
+A mutating form, i.e. `update_coefficients!(L, u, p, t)` that changes the
+internal coefficients, and an out-of-place form
+`L_new = update_coefficients(L, u, p, t)`.
 """
 abstract type AbstractSciMLOperator{T} end
 

src/interface.jl

@@ -3,18 +3,6 @@
 # Operator interface
 ###
 
-"""
-Function call and multiplication:
-    - L(du, u, p, t) for in-place operator evaluation,
-    - du = L(u, p, t) for out-of-place operator evaluation
-
-If the operator is not a constant, update it with (u,p,t). A mutating form, i.e.
-update_coefficients!(A,u,p,t) that changes the internal coefficients, and a
-out-of-place form B = update_coefficients(A,u,p,t).
-
-"""
-function (::AbstractSciMLOperator) end
-
 DEFAULT_UPDATE_FUNC(A,u,p,t) = A
 
 update_coefficients(L,u,p,t) = L
@@ -42,7 +30,7 @@ function iscached(L::AbstractSciMLOperator)
     has_cache = hasfield(typeof(L), :cache) # TODO - confirm this is static
     isset = has_cache ? !isnothing(L.cache) : true
 
-    return isset & all(iscached, getops(L)) 
+    return isset & all(iscached, getops(L))
 end
 
 iscached(L) = true