Merge pull request #5 from SciML/default-to-false

Default `is_*_sym` to false, update docstrings

Author: AayushSabharwal

docs/make.jl

@@ -5,18 +5,14 @@ cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
 
 include("pages.jl")
 
-makedocs(
-    sitename="SymbolicIndexingInterface.jl",
-    authors="Chris Rackauckas",
-    modules=[SymbolicIndexingInterface],
-    clean=true,doctest=false,
-    format = Documenter.HTML(analytics = "UA-90474609-3",
-                             assets = ["assets/favicon.ico"],
-                             canonical="https://docs.sciml.ai/SymbolicIndexingInterface/stable/"),
-    pages=pages
-)
+makedocs(sitename = "SymbolicIndexingInterface.jl",
+         authors = "Chris Rackauckas",
+         modules = [SymbolicIndexingInterface],
+         clean = true, doctest = false,
+         format = Documenter.HTML(analytics = "UA-90474609-3",
+                                  assets = ["assets/favicon.ico"],
+                                  canonical = "https://docs.sciml.ai/SymbolicIndexingInterface/stable/"),
+         pages = pages)
 
-deploydocs(
-   repo = "github.com/SciML/SymbolicIndexingInterface.jl.git";
-   push_preview = true
-)
+deploydocs(repo = "github.com/SciML/SymbolicIndexingInterface.jl.git";
+           push_preview = true)

docs/pages.jl

@@ -1,6 +1,6 @@
 # Put in a separate page so it can be used by SciMLDocs.jl
 
-pages=[
+pages = [
     "Home" => "index.md",
     "API" => "api.md",
-]
+]

src/interface.jl

@@ -8,7 +8,8 @@ function independent_variables end
 """
 $(TYPEDSIGNATURES)
 
-Check if the given sym is an independent variable in the given system.
+Check if the given sym is an independent variable in the given system. Defaults
+to `false` if not implemented for the given system/container type.
 """
 function is_indep_sym end
 
@@ -29,7 +30,8 @@ function state_sym_to_index end
 """
 $(TYPEDSIGNATURES)
 
-Check if the given sym is a state variable in the given system.
+Check if the given sym is a state variable in the given system. Defaults
+to `false` if not implemented for the given system/container type.
 """
 function is_state_sym end
 
@@ -50,6 +52,7 @@ function param_sym_to_index end
 """
 $(TYPEDSIGNATURES)
 
-Check if the given sym is a parameter variable in the given system.
+Check if the given sym is a parameter variable in the given system. Defaults
+to `false` if not implemented for the given system/container type.
 """
-function is_param_sym end
+function is_param_sym end

src/symbolcache.jl

@@ -1,27 +1,29 @@
-struct SymbolCache{S,T,U}
+struct SymbolCache{S, T, U}
     syms::S
     indepsym::T
     paramsyms::U
 end
 
-
 independent_variables(sc::SymbolCache) = sc.indepsym
-independent_variables(::SymbolCache{S,Nothing}) where {S} = []
+independent_variables(::SymbolCache{S, Nothing}) where {S} = []
+is_indep_sum(::Any, _) = false
 is_indep_sym(sc::SymbolCache, sym) = any(isequal(sym), sc.indepsym)
-is_indep_sym(::SymbolCache{S,Nothing}, _) where {S} = false
+is_indep_sym(::SymbolCache{S, Nothing}, _) where {S} = false
 states(sc::SymbolCache) = sc.syms
 states(::SymbolCache{Nothing}) = []
 state_sym_to_index(sc::SymbolCache, sym) = findfirst(isequal(sym), sc.syms)
 state_sym_to_index(::SymbolCache{Nothing}, _) = nothing
+is_state_sym(::Any, _) = false
 is_state_sym(sc::SymbolCache, sym) = !isnothing(state_sym_to_index(sc, sym))
 parameters(sc::SymbolCache) = sc.paramsyms
-parameters(::SymbolCache{S,T,Nothing}) where {S,T} = []
+parameters(::SymbolCache{S, T, Nothing}) where {S, T} = []
 param_sym_to_index(sc::SymbolCache, sym) = findfirst(isequal(sym), sc.paramsyms)
-param_sym_to_index(::SymbolCache{S,T,Nothing}, _) where {S,T} = nothing
+param_sym_to_index(::SymbolCache{S, T, Nothing}, _) where {S, T} = nothing
+is_param_sym(::Any, _) = false
 is_param_sym(sc::SymbolCache, sym) = !isnothing(param_sym_to_index(sc, sym))
-  
-Base.copy(VA::SymbolCache) = typeof(VA)(
-    (VA.syms===nothing) ? nothing : copy(VA.syms),
-    (VA.indepsym===nothing) ? nothing : copy(VA.indepsym),
-    (VA.paramsyms===nothing) ? nothing : copy(VA.paramsyms),
-)
+
+function Base.copy(VA::SymbolCache)
+    typeof(VA)((VA.syms === nothing) ? nothing : copy(VA.syms),
+               (VA.indepsym === nothing) ? nothing : copy(VA.indepsym),
+               (VA.paramsyms === nothing) ? nothing : copy(VA.paramsyms))
+end

test/runtests.jl

@@ -1,6 +1,4 @@
 using SymbolicIndexingInterface
 using Test
 
-@time begin
-    @time @testset begin include("symbolcache.jl") end
-end
+@time begin @time @testset begin include("symbolcache.jl") end end