feat: add is_parameter_timeseries trait

Author: AayushSabharwal

docs/src/api.md

@@ -34,6 +34,19 @@ observed
 
 ## Value provider interface
 
+### State indexing
+
+```@docs
+Timeseries
+NotTimeseries
+is_timeseries
+state_values
+set_state!
+current_time
+getu
+setu
+```
+
 ### Parameter indexing
 
 ```@docs
@@ -52,25 +65,12 @@ simulation (such as by callbacks), it must implement the following methods to en
 correct functioning of [`getu`](@ref) and [`getp`](@ref).
 
 ```@docs
+is_parameter_timeseries
 parameter_timeseries
 parameter_values_at_time
 parameter_values_at_state_time
 ```
 
-
-### State indexing
-
-```@docs
-Timeseries
-NotTimeseries
-is_timeseries
-state_values
-set_state!
-current_time
-getu
-setu
-```
-
 ### Batched Queries and Updates
 
 ```@docs

docs/src/terminology.md

@@ -56,6 +56,12 @@ In code samples, a value provider is typically denoted with the name `valp`.
     providers. This allows for several syntactic improvements. The [`symbolic_container`](@ref)
     function is useful in defining such objects.
 
-!!! note "Timeseries objects"
-    The documentation uses "Timeseries objects" to refer to value providers which implement
-    the [`Timeseries`](@ref) variant of the [`is_timeseries`](@ref) trait.
+### Timeseries objects
+
+Timeseries objects are value providers which implement the [`Timeseries`](@ref) variant of
+the [`is_timeseries`](@ref) trait.
+
+### Parameter timeseries objects
+
+Parameter timeseries objects are timeseries objects which implement the
+[`Timeseries`](@ref) variant of the [`is_parameter_timeseries`](@ref) trait.

src/SymbolicIndexingInterface.jl

@@ -8,7 +8,7 @@ using Accessors: @reset
 RuntimeGeneratedFunctions.init(@__MODULE__)
 
 export ScalarSymbolic, ArraySymbolic, NotSymbolic, symbolic_type, hasname, getname,
-       Timeseries, NotTimeseries, is_timeseries
+       Timeseries, NotTimeseries, is_timeseries, is_parameter_timeseries
 include("trait.jl")
 
 export is_variable, variable_index, variable_symbols, is_parameter, parameter_index,

src/trait.jl

@@ -129,7 +129,7 @@ data. It may still be time-dependent. For example, an `ODEProblem` only stores
 the initial state of a system, so it is `NotTimeseries`, but still time-dependent.
 This is the default trait variant for all types.
 
-See also: [`Timeseries`](@ref), [`is_timeseries`](@ref)
+See also: [`Timeseries`](@ref), [`is_timeseries`](@ref).
 """
 struct NotTimeseries <: IsTimeseriesTrait end
 
@@ -138,10 +138,27 @@ struct NotTimeseries <: IsTimeseriesTrait end
     is_timeseries(::Type)
 
 Get the timeseries trait of a type. Defaults to [`NotTimeseries`](@ref) for all types.
+A type for which `is_timeseries(T) == Timeseries()` may also have a parameter timeseries.
+This is determined by the [`is_parameter_timeseries`](@ref) trait.
 
-See also: [`Timeseries`](@ref), [`NotTimeseries`](@ref)
+See also: [`Timeseries`](@ref), [`NotTimeseries`](@ref), [`is_parameter_timeseries`](@ref).
 """
 function is_timeseries end
 
 is_timeseries(x) = is_timeseries(typeof(x))
 is_timeseries(::Type) = NotTimeseries()
+
+"""
+    is_parameter_timeseries(x) = is_parameter_timeseries(typeof(x))
+    is_parameter_timeseries(::Type)
+
+Get the parameter timeseries trait of a type. Defaults to [`NotTimeseries`](@ref) for all
+types. A type for which `is_parameter_timeseries(T) == Timeseries()` must also have
+`is_timeseries(T) == Timeseries()`.
+
+See also: [`Timeseries`](@ref), [`NotTimeseries`](@ref), [`is_timeseries`](@ref).
+"""
+function is_parameter_timeseries end
+
+is_parameter_timeseries(x) = is_parameter_timeseries(typeof(x))
+is_parameter_timeseries(::Type) = NotTimeseries()