diff --git a/previews/PR12/api/index.html b/previews/PR12/api/index.html index 97282ccb..5e19be0a 100644 --- a/previews/PR12/api/index.html +++ b/previews/PR12/api/index.html @@ -3,4 +3,4 @@ function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-90474609-3', {'page_path': location.pathname + location.search + location.hash}); -
Edit on GitHub

Interface Functions

SymbolicIndexingInterface.observed — Function
observed(sys, sym)

Return the observed function of the given sym in sys. The returned function should accept a timeseries if sys has an independent variable, and return the observed values for the given sym.

source
+
Edit on GitHub

Interface Functions

Missing docstring.

Missing docstring for isvariable. Check Documenter's build log for details.

Missing docstring.

Missing docstring for variableindex. Check Documenter's build log for details.

Missing docstring.

Missing docstring for isparameter. Check Documenter's build log for details.

Missing docstring.

Missing docstring for parameterindex. Check Documenter's build log for details.

Missing docstring.

Missing docstring for isindependent_variable. Check Documenter's build log for details.

Missing docstring.

Missing docstring for isobserved. Check Documenter's build log for details.

SymbolicIndexingInterface.observed — Function
observed(sys, sym, [symbolic_states])

Return the observed function of the given sym in sys. The returned function should have the signature (u, p) -> [values...] where u and p is the current state and parameter vector. If istimedependent(sys) == true, the function should accept the current time t as its third parameter. If has_static_variable(sys) == false then observed must accept a third parameter symbolic_states indicating the order of symbolic variables in u.

See also: is_time_dependent, has_static_variable

source
Missing docstring.

Missing docstring for istimedependent. Check Documenter's build log for details.

diff --git a/previews/PR12/index.html b/previews/PR12/index.html index 31e5109b..c9363bfb 100644 --- a/previews/PR12/index.html +++ b/previews/PR12/index.html @@ -48,4 +48,4 @@ [4ec0a83e] Unicode Info Packages marked with ⌅ have new versions available but compatibility constraints restrict them from upgrading. To see why use `status --outdated -m`You can also download the manifest file and the -project file. +project file. diff --git a/previews/PR12/search/index.html b/previews/PR12/search/index.html index 672d1e25..a676103a 100644 --- a/previews/PR12/search/index.html +++ b/previews/PR12/search/index.html @@ -3,4 +3,4 @@ function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-90474609-3', {'page_path': location.pathname + location.search + location.hash}); -

Loading search...

    +

    Loading search...

      diff --git a/previews/PR12/search_index.js b/previews/PR12/search_index.js index 725befe1..4ea5d542 100644 --- a/previews/PR12/search_index.js +++ b/previews/PR12/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"api/#Interface-Functions","page":"API","title":"Interface Functions","text":"","category":"section"},{"location":"api/","page":"API","title":"API","text":"isvariable\nvariableindex\nisparameter\nparameterindex\nisindependent_variable\nisobserved\nobserved\nistimedependent\nconstant_structure","category":"page"},{"location":"api/#SymbolicIndexingInterface.isvariable","page":"API","title":"SymbolicIndexingInterface.isvariable","text":"isvariable(sys, sym)\n\nCheck whether the given sym is a variable in sys.\n\n\n\n\n\n","category":"function"},{"location":"api/#SymbolicIndexingInterface.variableindex","page":"API","title":"SymbolicIndexingInterface.variableindex","text":"variableindex(sys, sym)\n\nReturn the index of the given variable sym in sys, or nothing otherwise.\n\n\n\n\n\n","category":"function"},{"location":"api/#SymbolicIndexingInterface.isparameter","page":"API","title":"SymbolicIndexingInterface.isparameter","text":"isparameter(sys, sym)\n\nCheck whether the given sym is a parameter in sys.\n\n\n\n\n\n","category":"function"},{"location":"api/#SymbolicIndexingInterface.parameterindex","page":"API","title":"SymbolicIndexingInterface.parameterindex","text":"parameterindex(sys, sym)\n\nReturn the index of the given parameter sym in sys, or nothing otherwise.\n\n\n\n\n\n","category":"function"},{"location":"api/#SymbolicIndexingInterface.isindependent_variable","page":"API","title":"SymbolicIndexingInterface.isindependent_variable","text":"isindependent_variable(sys, sym)\n\nCheck whether the given sym is an independent variable in sys.\n\n\n\n\n\n","category":"function"},{"location":"api/#SymbolicIndexingInterface.isobserved","page":"API","title":"SymbolicIndexingInterface.isobserved","text":"isobserved(sys, sym)\n\nCheck whether the given sym is an observed value in sys.\n\n\n\n\n\n","category":"function"},{"location":"api/#SymbolicIndexingInterface.observed","page":"API","title":"SymbolicIndexingInterface.observed","text":"observed(sys, sym)\n\nReturn the observed function of the given sym in sys. The returned function should accept a timeseries if sys has an independent variable, and return the observed values for the given sym.\n\n\n\n\n\n","category":"function"},{"location":"api/#SymbolicIndexingInterface.istimedependent","page":"API","title":"SymbolicIndexingInterface.istimedependent","text":"istimedependent(sys)\n\nCheck if sys has time as (one of) its independent variables.\n\n\n\n\n\n","category":"function"},{"location":"api/#SymbolicIndexingInterface.constant_structure","page":"API","title":"SymbolicIndexingInterface.constant_structure","text":"constant_structure(sys)\n\nCheck if sys has a constant structure. Constant structure systems do not change the number of variables or parameters over time.\n\n\n\n\n\n","category":"function"},{"location":"#SymbolicIndexingInterface.jl:-Arrays-of-Arrays-and-Even-Deeper","page":"Home","title":"SymbolicIndexingInterface.jl: Arrays of Arrays and Even Deeper","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"SymbolicIndexingInterface.jl is a set of interface functions for handling containers of symbolic variables.","category":"page"},{"location":"#Installation","page":"Home","title":"Installation","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"To install SymbolicIndexingInterface.jl, use the Julia package manager:","category":"page"},{"location":"","page":"Home","title":"Home","text":"using Pkg\nPkg.add(\"SymbolicIndexingInterface\")","category":"page"},{"location":"#Contributing","page":"Home","title":"Contributing","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Please refer to the SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages for guidance on PRs, issues, and other matters relating to contributing to SciML.\nThere are a few community forums:\nthe #diffeq-bridged channel in the Julia Slack\nJuliaDiffEq on Gitter\non the Julia Discourse forums\nsee also SciML Community page","category":"page"},{"location":"#Reproducibility","page":"Home","title":"Reproducibility","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"
      The documentation of this SciML package was built using these direct dependencies,","category":"page"},{"location":"","page":"Home","title":"Home","text":"using Pkg # hide\nPkg.status() # hide","category":"page"},{"location":"","page":"Home","title":"Home","text":"
      ","category":"page"},{"location":"","page":"Home","title":"Home","text":"
      and using this machine and Julia version.","category":"page"},{"location":"","page":"Home","title":"Home","text":"using InteractiveUtils # hide\nversioninfo() # hide","category":"page"},{"location":"","page":"Home","title":"Home","text":"
      ","category":"page"},{"location":"","page":"Home","title":"Home","text":"
      A more complete overview of all dependencies and their versions is also provided.","category":"page"},{"location":"","page":"Home","title":"Home","text":"using Pkg # hide\nPkg.status(;mode = PKGMODE_MANIFEST) # hide","category":"page"},{"location":"","page":"Home","title":"Home","text":"
      ","category":"page"},{"location":"","page":"Home","title":"Home","text":"You can also download the \nmanifest file and the\nproject file.","category":"page"}] +[{"location":"api/#Interface-Functions","page":"API","title":"Interface Functions","text":"","category":"section"},{"location":"api/","page":"API","title":"API","text":"isvariable\nvariableindex\nisparameter\nparameterindex\nisindependent_variable\nisobserved\nobserved\nistimedependent\nconstant_structure","category":"page"},{"location":"api/#SymbolicIndexingInterface.observed","page":"API","title":"SymbolicIndexingInterface.observed","text":"observed(sys, sym, [symbolic_states])\n\nReturn the observed function of the given sym in sys. The returned function should have the signature (u, p) -> [values...] where u and p is the current state and parameter vector. If istimedependent(sys) == true, the function should accept the current time t as its third parameter. If has_static_variable(sys) == false then observed must accept a third parameter symbolic_states indicating the order of symbolic variables in u.\n\nSee also: is_time_dependent, has_static_variable\n\n\n\n\n\n","category":"function"},{"location":"api/#SymbolicIndexingInterface.constant_structure","page":"API","title":"SymbolicIndexingInterface.constant_structure","text":"constant_structure(sys)\n\nCheck if sys has a constant structure. Constant structure systems do not change the number of variables or parameters over time.\n\n\n\n\n\n","category":"function"},{"location":"#SymbolicIndexingInterface.jl:-Arrays-of-Arrays-and-Even-Deeper","page":"Home","title":"SymbolicIndexingInterface.jl: Arrays of Arrays and Even Deeper","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"SymbolicIndexingInterface.jl is a set of interface functions for handling containers of symbolic variables.","category":"page"},{"location":"#Installation","page":"Home","title":"Installation","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"To install SymbolicIndexingInterface.jl, use the Julia package manager:","category":"page"},{"location":"","page":"Home","title":"Home","text":"using Pkg\nPkg.add(\"SymbolicIndexingInterface\")","category":"page"},{"location":"#Contributing","page":"Home","title":"Contributing","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Please refer to the SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages for guidance on PRs, issues, and other matters relating to contributing to SciML.\nThere are a few community forums:\nthe #diffeq-bridged channel in the Julia Slack\nJuliaDiffEq on Gitter\non the Julia Discourse forums\nsee also SciML Community page","category":"page"},{"location":"#Reproducibility","page":"Home","title":"Reproducibility","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"
      The documentation of this SciML package was built using these direct dependencies,","category":"page"},{"location":"","page":"Home","title":"Home","text":"using Pkg # hide\nPkg.status() # hide","category":"page"},{"location":"","page":"Home","title":"Home","text":"
      ","category":"page"},{"location":"","page":"Home","title":"Home","text":"
      and using this machine and Julia version.","category":"page"},{"location":"","page":"Home","title":"Home","text":"using InteractiveUtils # hide\nversioninfo() # hide","category":"page"},{"location":"","page":"Home","title":"Home","text":"
      ","category":"page"},{"location":"","page":"Home","title":"Home","text":"
      A more complete overview of all dependencies and their versions is also provided.","category":"page"},{"location":"","page":"Home","title":"Home","text":"using Pkg # hide\nPkg.status(;mode = PKGMODE_MANIFEST) # hide","category":"page"},{"location":"","page":"Home","title":"Home","text":"
      ","category":"page"},{"location":"","page":"Home","title":"Home","text":"You can also download the \nmanifest file and the\nproject file.","category":"page"}] }