diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index a8ce53c..38186d3 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-31T16:39:58","documenter_version":"1.4.1"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-07T15:25:23","documenter_version":"1.4.1"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index 9ea023b..f2b08d2 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · DynOptInterface.jl
GitHub
+Home · DynOptInterface.jl
GitHub
diff --git a/dev/objects.inv b/dev/objects.inv index 9b52a43..edd5944 100644 Binary files a/dev/objects.inv and b/dev/objects.inv differ diff --git a/dev/reference/abstractions/index.html b/dev/reference/abstractions/index.html index f6984c8..8cbce0f 100644 --- a/dev/reference/abstractions/index.html +++ b/dev/reference/abstractions/index.html @@ -1,2 +1,2 @@ -Abstractions · DynOptInterface.jl
GitHub

Abstractions

The following are sub-types of AbstractDynamicFunction:

+Abstractions · DynOptInterface.jl
GitHub

Abstractions

Functions

DynOptInterface.AbstractBoundaryFunction — Type
AbstractBoundaryFunction <: AbstractDynamicFunction

Abstract supertype for functions evaluated at domain boundaries. That is, expressions that may contain $y(t^0)$, $y(t^f)$, $t^0$, or $t^f$.

source

Attributes

diff --git a/dev/reference/algebraic_functions/index.html b/dev/reference/algebraic_functions/index.html index ef941cc..4ec92fd 100644 --- a/dev/reference/algebraic_functions/index.html +++ b/dev/reference/algebraic_functions/index.html @@ -1,2 +1,2 @@ -Algebraic Functions · DynOptInterface.jl
GitHub
+Algebraic Functions · DynOptInterface.jl
GitHub

Algebraic Functions

Types

diff --git a/dev/reference/boundary_functions/index.html b/dev/reference/boundary_functions/index.html index 09fc830..76b002f 100644 --- a/dev/reference/boundary_functions/index.html +++ b/dev/reference/boundary_functions/index.html @@ -1,2 +1,2 @@ -Boundary Functions · DynOptInterface.jl
GitHub

Boundary Functions

DynOptInterface.Initial — Type
Initial{AF<:AbstractAlgebraicFunction} <: AbstractBoundaryFunction

\[a(y(t_i^0), t_i^0, x)\]

Represents the evaluation of an AbstractAlgebraicFunction at the initial point of its domain. Common cases are:

  • $t_i^0$ Initial{DomainIndex}
  • $y_j(t_i^0)$ Initial{DynamicVariableIndex}
source
DynOptInterface.Final — Type
Final{AF<:AbstractAlgebraicFunction} <: AbstractBoundaryFunction

\[a(y(t_i^f), t_i^f, x)\]

Represents the evaluation of an AbstractAlgebraicFunction at the final point of its domain. Common cases are:

  • $t_i^f$ Final{DomainIndex}
  • $y_j(t_i^f)$ Final{DynamicVariableIndex}
source
+Boundary Functions · DynOptInterface.jl
GitHub

Boundary Functions

DynOptInterface.Initial — Type
Initial{AF<:AbstractAlgebraicFunction} <: AbstractBoundaryFunction

\[a(y(t_i^0), t_i^0, x)\]

Represents the evaluation of an AbstractAlgebraicFunction at the initial point of its domain. Common cases are:

  • $t_i^0$ Initial{DomainIndex}
  • $y_j(t_i^0)$ Initial{DynamicVariableIndex}
source
DynOptInterface.Final — Type
Final{AF<:AbstractAlgebraicFunction} <: AbstractBoundaryFunction

\[a(y(t_i^f), t_i^f, x)\]

Represents the evaluation of an AbstractAlgebraicFunction at the final point of its domain. Common cases are:

  • $t_i^f$ Final{DomainIndex}
  • $y_j(t_i^f)$ Final{DynamicVariableIndex}
source
diff --git a/dev/reference/differential_functions/index.html b/dev/reference/differential_functions/index.html index 26b63f7..deeccb5 100644 --- a/dev/reference/differential_functions/index.html +++ b/dev/reference/differential_functions/index.html @@ -1,2 +1,2 @@ -Differential Functions · DynOptInterface.jl
GitHub

Differential Functions

+Differential Functions · DynOptInterface.jl
GitHub

Differential Functions

diff --git a/dev/reference/domains/index.html b/dev/reference/domains/index.html index f00cd27..2c2deb2 100644 --- a/dev/reference/domains/index.html +++ b/dev/reference/domains/index.html @@ -1,2 +1,2 @@ -Domains · DynOptInterface.jl
GitHub

Domains

+Domains · DynOptInterface.jl
GitHub

Domains

Type

DynOptInterface.DomainIndex — Type
DomainIndex <: AbstractAlgebraicFunction

\[t_i \in [t_i^0, t_i^f]\]

A type-safe wrapper for Int64 for use in referencing domains.

source

Attributes

DynOptInterface.DomainInitialPrimalStart — Type
DomainInitialPrimalStart <: AbstractDomainAttribute

A domain attribute for setting a starting value for $t_i^0$, which may help warm-start the optimizer. It is either a number or a nothing (unset).

source
DynOptInterface.DomainFinalPrimalStart — Type
DomainFinalPrimalStart <: AbstractDomainAttribute

A domain attribute for setting a starting value for $t_i^f$, which may help warm-start the optimizer. It is either a number or a nothing (unset).

source

Functions

Errors

diff --git a/dev/reference/dynamic_variables/index.html b/dev/reference/dynamic_variables/index.html index 826e75d..a218ece 100644 --- a/dev/reference/dynamic_variables/index.html +++ b/dev/reference/dynamic_variables/index.html @@ -1,2 +1,2 @@ -Dynamic Variables · DynOptInterface.jl
GitHub

Dynamic Variables

+Dynamic Variables · DynOptInterface.jl
GitHub

Dynamic Variables

Type

Attributes

DynOptInterface.DynamicVariablePrimalStart — Type
DynamicVariablePrimalStart <: AbstractDynamicVariableAttribute

A dynamic variable attribute for setting a starting function for $y_j(t_i)$, which may help warm-start the optimizer. It is either a nothing (unset) or a single-argument function of T<:Real.

source

Functions

Errors

diff --git a/dev/reference/integral_functions/index.html b/dev/reference/integral_functions/index.html index c2e9ad9..bc89bcd 100644 --- a/dev/reference/integral_functions/index.html +++ b/dev/reference/integral_functions/index.html @@ -1,2 +1,2 @@ -Integral Functions · DynOptInterface.jl
GitHub

Integral Functions

+Integral Functions · DynOptInterface.jl
GitHub

Integral Functions

diff --git a/dev/search_index.js b/dev/search_index.js index 60d9001..b98fd76 100644 --- a/dev/search_index.js +++ b/dev/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"reference/dynamic_variables/","page":"Dynamic Variables","title":"Dynamic Variables","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/dynamic_variables/#Dynamic-Variables","page":"Dynamic Variables","title":"Dynamic Variables","text":"","category":"section"},{"location":"reference/dynamic_variables/","page":"Dynamic Variables","title":"Dynamic Variables","text":"DynamicVariableIndex\nsupports_dynamic_variable\nUnsupportedDynamicVariable\nAddDynamicVariableNotAllowed\nadd_dynamic_variable","category":"page"},{"location":"reference/dynamic_variables/#DynOptInterface.DynamicVariableIndex","page":"Dynamic Variables","title":"DynOptInterface.DynamicVariableIndex","text":"DynamicVariableIndex <: AbstractDynamicFunction\n\nt_i mapsto y_j(t_i)\n\nA type-safe wrapper for Int64 for use in referencing dynamic variables.\n\n\n\n\n\n","category":"type"},{"location":"reference/dynamic_variables/#DynOptInterface.supports_dynamic_variable","page":"Dynamic Variables","title":"DynOptInterface.supports_dynamic_variable","text":"supports_dynamic_variable(model::MOI.ModelLike)\n\nReturn a Bool indicating whether model supports dynamic variables.\n\n\n\n\n\n","category":"function"},{"location":"reference/dynamic_variables/#DynOptInterface.UnsupportedDynamicVariable","page":"Dynamic Variables","title":"DynOptInterface.UnsupportedDynamicVariable","text":"UnsupportedDynamicVariable <: MOI.UnsupportedError\n\nAn error indicating that dynamic variables are not supported by the model, that is, that supports_dynamic_variable returns false.\n\n\n\n\n\n","category":"type"},{"location":"reference/dynamic_variables/#DynOptInterface.AddDynamicVariableNotAllowed","page":"Dynamic Variables","title":"DynOptInterface.AddDynamicVariableNotAllowed","text":"AddDynamicVariableNotAllowed <: MOI.NotAllowedError\n\nAn error indicating that dynamic variables cannot be added to the model in its current state.\n\n\n\n\n\n","category":"type"},{"location":"reference/dynamic_variables/#DynOptInterface.add_dynamic_variable","page":"Dynamic Variables","title":"DynOptInterface.add_dynamic_variable","text":"add_dynamic_variable(model::MOI.ModelLike)\n\nAdd a dynamic variable to model, returning a DynamicVariableIndex. An AddDynamicVariableNotAllowed is thrown if a dynamic variable cannot be added to model in its current state.\n\n\n\n\n\n","category":"function"},{"location":"reference/algebraic_functions/","page":"Algebraic Functions","title":"Algebraic Functions","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/algebraic_functions/#Algebraic-Functions","page":"Algebraic Functions","title":"Algebraic Functions","text":"","category":"section"},{"location":"reference/algebraic_functions/","page":"Algebraic Functions","title":"Algebraic Functions","text":"NonlinearAlgebraicFunction","category":"page"},{"location":"reference/algebraic_functions/#DynOptInterface.NonlinearAlgebraicFunction","page":"Algebraic Functions","title":"DynOptInterface.NonlinearAlgebraicFunction","text":"NonlinearAlgebraicFunction <: AbstractAlgebraicFunction\n\nt_i mapsto a(y(t_i) t_i x)\n\nSimilar to MathOptInterface.ScalarNonlinearFunction, \n\nEach node in args can be one of the following:\n\nA constant value of type T<:Real\nA MathOptInterface.VariableIndex\nA DomainIndex\nA DynamicVariableIndex\nAnother NonlinearAlgebraicFunction\n\n\n\n\n\n","category":"type"},{"location":"reference/integral_functions/","page":"Integral Functions","title":"Integral Functions","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/integral_functions/#Integral-Functions","page":"Integral Functions","title":"Integral Functions","text":"","category":"section"},{"location":"reference/integral_functions/","page":"Integral Functions","title":"Integral Functions","text":"IntegralFunction\nBolzaFunction","category":"page"},{"location":"reference/integral_functions/#DynOptInterface.IntegralFunction","page":"Integral Functions","title":"DynOptInterface.IntegralFunction","text":"IntegralFunction{AF<:AbstractAlgebraicFunction} <: AbstractDynamicFunction\n\nint_t_i^o^t_i^f a(y(t_i) t_i x) mathrmdt_i\n\nRepresents the integral of an AbstractAlgebraicFunction over its domain.\n\n\n\n\n\n","category":"type"},{"location":"reference/integral_functions/#DynOptInterface.BolzaFunction","page":"Integral Functions","title":"DynOptInterface.BolzaFunction","text":"BolzaFunction{BF<:AbstractBoundaryFunction, AF<:AbstractAlgebraicFunction} <: AbstractDynamicFunction\n\nb(y_0 y_f t_0 t_f x) + int_t_i^o^t_i^f a(y(t_i) t_i x) mathrmdt_i\n\nRepresents the sum of an AbstractBoundaryFunction with the integral of an AbstractAlgebraicFunction. The functions must have the same DomainIndex.\n\n\n\n\n\n","category":"type"},{"location":"reference/differential_functions/","page":"Differential Functions","title":"Differential Functions","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/differential_functions/#Differential-Functions","page":"Differential Functions","title":"Differential Functions","text":"","category":"section"},{"location":"reference/differential_functions/","page":"Differential Functions","title":"Differential Functions","text":"DynamicVariableDerivative\nExplicitDifferentialFunction\nNonlinearDifferentialFunction","category":"page"},{"location":"reference/differential_functions/#DynOptInterface.DynamicVariableDerivative","page":"Differential Functions","title":"DynOptInterface.DynamicVariableDerivative","text":"DynamicVariableDerivative <: AbstractDifferentialFunction\n\nt_i mapsto doty_j(t_i)\n\nA derivative\n\n\n\n\n\n","category":"type"},{"location":"reference/differential_functions/#DynOptInterface.ExplicitDifferentialFunction","page":"Differential Functions","title":"DynOptInterface.ExplicitDifferentialFunction","text":"ExplicitDifferentialFunction{AF<:AbstractAlgebraicFunction} <: AbstractDifferentialFunction\n\nt_i mapsto doty(t_i) - a(y(t_i) t_i x)\n\n\n\n\n\n","category":"type"},{"location":"reference/differential_functions/#DynOptInterface.NonlinearDifferentialFunction","page":"Differential Functions","title":"DynOptInterface.NonlinearDifferentialFunction","text":"NonlinearDifferentialFunction <: AbstractDifferentialFunction\n\nt_i mapsto r(doty(t_i) y(t_i) t_i x)\n\nSimilar to MOI.ScalarNonlinearFunction, \n\nEach node in args can be one of the following:\n\nA constant value of type T<:Real\nAn MOI.VariableIndex\nA DomainIndex\nA DynamicVariableIndex\nA DynamicVariableDerivative\nAnother NonlinearDifferentialFunction\n\n\n\n\n\n","category":"type"},{"location":"reference/domains/","page":"Domains","title":"Domains","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/domains/#Domains","page":"Domains","title":"Domains","text":"","category":"section"},{"location":"reference/domains/","page":"Domains","title":"Domains","text":"DomainIndex\nsupports_domain\nUnsupportedDomain\nAddDomainNotAllowed\nadd_domain","category":"page"},{"location":"reference/domains/#DynOptInterface.DomainIndex","page":"Domains","title":"DynOptInterface.DomainIndex","text":"DomainIndex <: AbstractAlgebraicFunction\n\nt_i\n\nA type-safe wrapper for Int64 for use in referencing domains.\n\n\n\n\n\n","category":"type"},{"location":"reference/domains/#DynOptInterface.supports_domain","page":"Domains","title":"DynOptInterface.supports_domain","text":"supports_domain(model::MOI.ModelLike)\n\nReturn a Bool indicating whether model supports domains.\n\n\n\n\n\n","category":"function"},{"location":"reference/domains/#DynOptInterface.UnsupportedDomain","page":"Domains","title":"DynOptInterface.UnsupportedDomain","text":"UnsupportedDomain <: MOI.UnsupportedError\n\nAn error indicating that domains are not supported by the model, that is, that supports_domain returns false.\n\n\n\n\n\n","category":"type"},{"location":"reference/domains/#DynOptInterface.AddDomainNotAllowed","page":"Domains","title":"DynOptInterface.AddDomainNotAllowed","text":"AddDomainNotAllowed <: MOI.NotAllowedError\n\nAn error indicating that domains cannot be added to the model in its current state.\n\n\n\n\n\n","category":"type"},{"location":"reference/domains/#DynOptInterface.add_domain","page":"Domains","title":"DynOptInterface.add_domain","text":"add_domain(model::MOI.ModelLike)\n\nAdd a domain to model, returning a DomainIndex. An AddDomainNotAllowed is thrown if a domain cannot be added to the model in its current state.\n\n\n\n\n\n","category":"function"},{"location":"","page":"Home","title":"Home","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"#DynOptInterface","page":"Home","title":"DynOptInterface","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Documentation for DynOptInterface.","category":"page"},{"location":"reference/abstractions/","page":"Abstractions","title":"Abstractions","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/abstractions/#Abstractions","page":"Abstractions","title":"Abstractions","text":"","category":"section"},{"location":"reference/abstractions/","page":"Abstractions","title":"Abstractions","text":"The following are sub-types of AbstractDynamicFunction:","category":"page"},{"location":"reference/abstractions/","page":"Abstractions","title":"Abstractions","text":"AbstractAlgebraicFunction\nt_i DomainIndex\nt_i mapsto y_j(t_i) DynamicVariableIndex\nt_i mapsto a(y(t_i) t_i x) NonlinearAlgebraicFunction\nAbstractDifferentialFunction\nt_i mapsto doty_j(t_i) DynamicVariableDerivative\nt_i mapsto doty_j(t_i) - a(y(t_i) t_i x) ExplicitDifferentialFunction\nt_i mapsto r(doty(t_i) y(t_i) t_i x) NonlinearDifferentialFunction\nAbstractBoundaryFunction\na(y(t_i^0) t_i^0 x) Initial\na(y(t_i^f) t_i^f x) Final\nb(y(t^0) y(t^f) t^0 t^f x) NonlinearBoundaryFunction\nint_t_i^0^t_i^f a(y(t_i) t_i x) mathrmdt_i IntegralFunction\nb(y(t_i^0) y(t_i^f) t_i^0 t_i^f x) + int_t_i^0^t_i^f a(y(t_i) t_i x) mathrmdt_i BolzaFunction","category":"page"},{"location":"reference/abstractions/","page":"Abstractions","title":"Abstractions","text":"AbstractDynamicFunction\nAbstractAlgebraicFunction\nAbstractDifferentialFunction\nAbstractBoundaryFunction","category":"page"},{"location":"reference/abstractions/#DynOptInterface.AbstractDynamicFunction","page":"Abstractions","title":"DynOptInterface.AbstractDynamicFunction","text":"AbstractDynamicFunction <: MOI.AbstractScalarFunction\n\nAbstract supertype for dynamic functions.\n\n\n\n\n\n","category":"type"},{"location":"reference/abstractions/#DynOptInterface.AbstractAlgebraicFunction","page":"Abstractions","title":"DynOptInterface.AbstractAlgebraicFunction","text":"AbstractAlgebraicFunction <: AbstractDynamicFunction\n\nAbstract supertype for algebraic functions.\n\n\n\n\n\n","category":"type"},{"location":"reference/abstractions/#DynOptInterface.AbstractDifferentialFunction","page":"Abstractions","title":"DynOptInterface.AbstractDifferentialFunction","text":"AbstractDifferentialFunction <: AbstractDynamicFunction\n\nAbstract supertype for differential functions.\n\n\n\n\n\n","category":"type"},{"location":"reference/abstractions/#DynOptInterface.AbstractBoundaryFunction","page":"Abstractions","title":"DynOptInterface.AbstractBoundaryFunction","text":"AbstractBoundaryFunction <: AbstractDynamicFunction\n\nAbstract supertype for dynamic functions evaluated at the domain boundaries.\n\n\n\n\n\n","category":"type"},{"location":"reference/boundary_functions/","page":"Boundary Functions","title":"Boundary Functions","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/boundary_functions/#Boundary-Functions","page":"Boundary Functions","title":"Boundary Functions","text":"","category":"section"},{"location":"reference/boundary_functions/","page":"Boundary Functions","title":"Boundary Functions","text":"Initial\nFinal\nNonlinearBoundaryFunction","category":"page"},{"location":"reference/boundary_functions/#DynOptInterface.Initial","page":"Boundary Functions","title":"DynOptInterface.Initial","text":"Initial{AF<:AbstractAlgebraicFunction} <: AbstractBoundaryFunction\n\na(y(t_i^0) t_i^0 x)\n\nRepresents the evaluation of an AbstractAlgebraicFunction at the initial point of its domain. Common cases are:\n\nt_i^0 Initial{DomainIndex}\ny_j(t_i^0) Initial{DynamicVariableIndex}\n\n\n\n\n\n","category":"type"},{"location":"reference/boundary_functions/#DynOptInterface.Final","page":"Boundary Functions","title":"DynOptInterface.Final","text":"Final{AF<:AbstractAlgebraicFunction} <: AbstractBoundaryFunction\n\na(y(t_i^f) t_i^f x)\n\nRepresents the evaluation of an AbstractAlgebraicFunction at the final point of its domain. Common cases are:\n\nt_i^f Final{DomainIndex}\ny_j(t_i^f) Final{DynamicVariableIndex}\n\n\n\n\n\n","category":"type"},{"location":"reference/boundary_functions/#DynOptInterface.NonlinearBoundaryFunction","page":"Boundary Functions","title":"DynOptInterface.NonlinearBoundaryFunction","text":"NonlinearBoundaryFunction <: AbstractBoundaryFunction\n\nb(y(t^0) y(t^f) t^0 t^f x)\n\nSimilar to MathOptInterface.ScalarNonlinearFunction, \n\nEach node in args can be one of the following:\n\nA constant value of type T<:Real\nA MathOptInterface.VariableIndex\nAn Initial{DomainIndex}\nA Final{DomainIndex}\nAn Initial{DynamicVariableIndex}\nA Final{DynamicVariableIndex}\nAnother NonlinearBoundaryFunction\n\n\n\n\n\n","category":"type"}] +[{"location":"reference/dynamic_variables/","page":"Dynamic Variables","title":"Dynamic Variables","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/dynamic_variables/#Dynamic-Variables","page":"Dynamic Variables","title":"Dynamic Variables","text":"","category":"section"},{"location":"reference/dynamic_variables/#Type","page":"Dynamic Variables","title":"Type","text":"","category":"section"},{"location":"reference/dynamic_variables/","page":"Dynamic Variables","title":"Dynamic Variables","text":"DynamicVariableIndex","category":"page"},{"location":"reference/dynamic_variables/#DynOptInterface.DynamicVariableIndex","page":"Dynamic Variables","title":"DynOptInterface.DynamicVariableIndex","text":"DynamicVariableIndex <: AbstractDynamicFunction\n\nt_i mapsto y_j(t_i)\n\nA type-safe wrapper for Int64 for use in referencing dynamic variables.\n\n\n\n\n\n","category":"type"},{"location":"reference/dynamic_variables/#Attributes","page":"Dynamic Variables","title":"Attributes","text":"","category":"section"},{"location":"reference/dynamic_variables/","page":"Dynamic Variables","title":"Dynamic Variables","text":"DynamicVariableName\nDynamicVariablePrimalStart\nDynamicVariablePrimal","category":"page"},{"location":"reference/dynamic_variables/#DynOptInterface.DynamicVariableName","page":"Dynamic Variables","title":"DynOptInterface.DynamicVariableName","text":"DynamicVariableName <: AbstractDomainAttribute\n\nA dynamic variable attribute for a String identifying a DynamicVariableIndex. If not set, it has a default value of \"\".\n\n\n\n\n\n","category":"type"},{"location":"reference/dynamic_variables/#DynOptInterface.DynamicVariablePrimalStart","page":"Dynamic Variables","title":"DynOptInterface.DynamicVariablePrimalStart","text":"DynamicVariablePrimalStart <: AbstractDynamicVariableAttribute\n\nA dynamic variable attribute for setting a starting function for y_j(t_i), which may help warm-start the optimizer. It is either a nothing (unset) or a single-argument function of T<:Real.\n\n\n\n\n\n","category":"type"},{"location":"reference/dynamic_variables/#DynOptInterface.DynamicVariablePrimal","page":"Dynamic Variables","title":"DynOptInterface.DynamicVariablePrimal","text":"DynamicVariablePrimal <: AbstractDynamicVariableAttribute\n\nA dynamic variable attribute for setting or getting y_j(t_i). It should be a single-argument function of T<:Real. It should have the same behaviour as the MathOptInterface.VariablePrimal attribute.\n\n\n\n\n\n","category":"type"},{"location":"reference/dynamic_variables/#Functions","page":"Dynamic Variables","title":"Functions","text":"","category":"section"},{"location":"reference/dynamic_variables/","page":"Dynamic Variables","title":"Dynamic Variables","text":"supports_dynamic_variable\nadd_dynamic_variable","category":"page"},{"location":"reference/dynamic_variables/#DynOptInterface.supports_dynamic_variable","page":"Dynamic Variables","title":"DynOptInterface.supports_dynamic_variable","text":"supports_dynamic_variable(model::MOI.ModelLike)\n\nReturn a Bool indicating whether model supports dynamic variables.\n\n\n\n\n\n","category":"function"},{"location":"reference/dynamic_variables/#DynOptInterface.add_dynamic_variable","page":"Dynamic Variables","title":"DynOptInterface.add_dynamic_variable","text":"add_dynamic_variable(model::MOI.ModelLike)\n\nAdd a dynamic variable to model, returning a DynamicVariableIndex. An AddDynamicVariableNotAllowed is thrown if a dynamic variable cannot be added to model in its current state.\n\n\n\n\n\n","category":"function"},{"location":"reference/dynamic_variables/#Errors","page":"Dynamic Variables","title":"Errors","text":"","category":"section"},{"location":"reference/dynamic_variables/","page":"Dynamic Variables","title":"Dynamic Variables","text":"UnsupportedDynamicVariable\nAddDynamicVariableNotAllowed","category":"page"},{"location":"reference/dynamic_variables/#DynOptInterface.UnsupportedDynamicVariable","page":"Dynamic Variables","title":"DynOptInterface.UnsupportedDynamicVariable","text":"UnsupportedDynamicVariable <: MOI.UnsupportedError\n\nAn error indicating that dynamic variables are not supported by the model, that is, that supports_dynamic_variable returns false.\n\n\n\n\n\n","category":"type"},{"location":"reference/dynamic_variables/#DynOptInterface.AddDynamicVariableNotAllowed","page":"Dynamic Variables","title":"DynOptInterface.AddDynamicVariableNotAllowed","text":"AddDynamicVariableNotAllowed <: MOI.NotAllowedError\n\nAn error indicating that dynamic variables cannot be added to the model in its current state.\n\n\n\n\n\n","category":"type"},{"location":"reference/algebraic_functions/","page":"Algebraic Functions","title":"Algebraic Functions","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/algebraic_functions/#Algebraic-Functions","page":"Algebraic Functions","title":"Algebraic Functions","text":"","category":"section"},{"location":"reference/algebraic_functions/#Types","page":"Algebraic Functions","title":"Types","text":"","category":"section"},{"location":"reference/algebraic_functions/","page":"Algebraic Functions","title":"Algebraic Functions","text":"LinearAlgebraicTerm\nLinearAlgebraicFunction\nSquaredAlgebraicTerm\nSquaredAlgebraicFunction\nNonlinearAlgebraicFunction","category":"page"},{"location":"reference/algebraic_functions/#DynOptInterface.LinearAlgebraicTerm","page":"Algebraic Functions","title":"DynOptInterface.LinearAlgebraicTerm","text":"LinearAlgebraicTerm{T}\n\nt_i mapsto c_j y_j(t_i)\n\n\n\n\n\n","category":"type"},{"location":"reference/algebraic_functions/#DynOptInterface.LinearAlgebraicFunction","page":"Algebraic Functions","title":"DynOptInterface.LinearAlgebraicFunction","text":"LinearAlgebraicFunction{T} <: AbstractAlgebraicFunction\n\nt_i mapsto c^top y(t_i)\n\n\n\n\n\n","category":"type"},{"location":"reference/algebraic_functions/#DynOptInterface.SquaredAlgebraicTerm","page":"Algebraic Functions","title":"DynOptInterface.SquaredAlgebraicTerm","text":"SquaredAlgebraicTerm{T}\n\nt_i mapsto y_j(t_i) c_jk y_k(t_i)\n\n\n\n\n\n","category":"type"},{"location":"reference/algebraic_functions/#DynOptInterface.SquaredAlgebraicFunction","page":"Algebraic Functions","title":"DynOptInterface.SquaredAlgebraicFunction","text":"SquaredAlgebraicFunction{T}\n\nt_i mapsto y(t_i)^top C y(t_i)\n\n\n\n\n\n","category":"type"},{"location":"reference/algebraic_functions/#DynOptInterface.NonlinearAlgebraicFunction","page":"Algebraic Functions","title":"DynOptInterface.NonlinearAlgebraicFunction","text":"NonlinearAlgebraicFunction <: AbstractAlgebraicFunction\n\nt_i mapsto f_a(y(t_i) t_i x)\n\nSimilar to MathOptInterface.ScalarNonlinearFunction, \n\nEach node in args can be one of the following:\n\nA constant value of type T<:Real\nA MathOptInterface.VariableIndex\nA DomainIndex\nA DynamicVariableIndex\nAnother NonlinearAlgebraicFunction\n\n\n\n\n\n","category":"type"},{"location":"reference/integral_functions/","page":"Integral Functions","title":"Integral Functions","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/integral_functions/#Integral-Functions","page":"Integral Functions","title":"Integral Functions","text":"","category":"section"},{"location":"reference/integral_functions/","page":"Integral Functions","title":"Integral Functions","text":"IntegralFunction\nBolzaFunction","category":"page"},{"location":"reference/integral_functions/#DynOptInterface.IntegralFunction","page":"Integral Functions","title":"DynOptInterface.IntegralFunction","text":"IntegralFunction{AF<:AbstractAlgebraicFunction} <: AbstractDynamicFunction\n\nint_t_i^o^t_i^f a(y(t_i) t_i x) mathrmdt_i\n\nRepresents the integral of an AbstractAlgebraicFunction over its domain.\n\n\n\n\n\n","category":"type"},{"location":"reference/integral_functions/#DynOptInterface.BolzaFunction","page":"Integral Functions","title":"DynOptInterface.BolzaFunction","text":"BolzaFunction{BF<:AbstractBoundaryFunction, AF<:AbstractAlgebraicFunction} <: AbstractDynamicFunction\n\nb(y_0 y_f t_0 t_f x) + int_t_i^o^t_i^f a(y(t_i) t_i x) mathrmdt_i\n\nRepresents the sum of an AbstractBoundaryFunction with the integral of an AbstractAlgebraicFunction. The functions must have the same DomainIndex.\n\n\n\n\n\n","category":"type"},{"location":"reference/differential_functions/","page":"Differential Functions","title":"Differential Functions","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/differential_functions/#Differential-Functions","page":"Differential Functions","title":"Differential Functions","text":"","category":"section"},{"location":"reference/differential_functions/","page":"Differential Functions","title":"Differential Functions","text":"DynamicVariableDerivative\nExplicitDifferentialFunction\nNonlinearDifferentialFunction","category":"page"},{"location":"reference/differential_functions/#DynOptInterface.DynamicVariableDerivative","page":"Differential Functions","title":"DynOptInterface.DynamicVariableDerivative","text":"DynamicVariableDerivative <: AbstractDifferentialFunction\n\nt_i mapsto doty_j(t_i)\n\nA derivative\n\n\n\n\n\n","category":"type"},{"location":"reference/differential_functions/#DynOptInterface.ExplicitDifferentialFunction","page":"Differential Functions","title":"DynOptInterface.ExplicitDifferentialFunction","text":"ExplicitDifferentialFunction{AF<:AbstractAlgebraicFunction} <: AbstractDifferentialFunction\n\nt_i mapsto doty(t_i) - a(y(t_i) t_i x)\n\n\n\n\n\n","category":"type"},{"location":"reference/differential_functions/#DynOptInterface.NonlinearDifferentialFunction","page":"Differential Functions","title":"DynOptInterface.NonlinearDifferentialFunction","text":"NonlinearDifferentialFunction <: AbstractDifferentialFunction\n\nt_i mapsto f_d(doty(t_i) y(t_i) t_i x)\n\nSimilar to MOI.ScalarNonlinearFunction, \n\nEach node in args can be one of the following:\n\nA constant value of type T<:Real\nAn MOI.VariableIndex\nA DomainIndex\nA DynamicVariableIndex\nA DynamicVariableDerivative\nAnother NonlinearDifferentialFunction\n\n\n\n\n\n","category":"type"},{"location":"reference/domains/","page":"Domains","title":"Domains","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/domains/#Domains","page":"Domains","title":"Domains","text":"","category":"section"},{"location":"reference/domains/#Type","page":"Domains","title":"Type","text":"","category":"section"},{"location":"reference/domains/","page":"Domains","title":"Domains","text":"DomainIndex","category":"page"},{"location":"reference/domains/#DynOptInterface.DomainIndex","page":"Domains","title":"DynOptInterface.DomainIndex","text":"DomainIndex <: AbstractAlgebraicFunction\n\nt_i in t_i^0 t_i^f\n\nA type-safe wrapper for Int64 for use in referencing domains.\n\n\n\n\n\n","category":"type"},{"location":"reference/domains/#Attributes","page":"Domains","title":"Attributes","text":"","category":"section"},{"location":"reference/domains/","page":"Domains","title":"Domains","text":"DomainName\nDomainInitialPrimalStart\nDomainFinalPrimalStart\nDomainInitialPrimal\nDomainFinalPrimal","category":"page"},{"location":"reference/domains/#DynOptInterface.DomainName","page":"Domains","title":"DynOptInterface.DomainName","text":"DomainName <: AbstractDomainAttribute\n\nA domain attribute for a String identifying a DomainIndex. If not set, it has a default value of \"\".\n\n\n\n\n\n","category":"type"},{"location":"reference/domains/#DynOptInterface.DomainInitialPrimalStart","page":"Domains","title":"DynOptInterface.DomainInitialPrimalStart","text":"DomainInitialPrimalStart <: AbstractDomainAttribute\n\nA domain attribute for setting a starting value for t_i^0, which may help warm-start the optimizer. It is either a number or a nothing (unset).\n\n\n\n\n\n","category":"type"},{"location":"reference/domains/#DynOptInterface.DomainFinalPrimalStart","page":"Domains","title":"DynOptInterface.DomainFinalPrimalStart","text":"DomainFinalPrimalStart <: AbstractDomainAttribute\n\nA domain attribute for setting a starting value for t_i^f, which may help warm-start the optimizer. It is either a number or a nothing (unset).\n\n\n\n\n\n","category":"type"},{"location":"reference/domains/#DynOptInterface.DomainInitialPrimal","page":"Domains","title":"DynOptInterface.DomainInitialPrimal","text":"DomainInitialPrimal <: AbstractDomainAttribute\n\nA domain attribute for setting or getting t_i^0. It should have the same behaviour as the MathOptInterface.VariablePrimal attribute.\n\n\n\n\n\n","category":"type"},{"location":"reference/domains/#DynOptInterface.DomainFinalPrimal","page":"Domains","title":"DynOptInterface.DomainFinalPrimal","text":"DomainFinalPrimal <: AbstractDomainAttribute\n\nA domain attribute for setting or getting t_i^f. It should have the same behaviour as the MathOptInterface.VariablePrimal attribute.\n\n\n\n\n\n","category":"type"},{"location":"reference/domains/#Functions","page":"Domains","title":"Functions","text":"","category":"section"},{"location":"reference/domains/","page":"Domains","title":"Domains","text":"supports_domain\nadd_domain","category":"page"},{"location":"reference/domains/#DynOptInterface.supports_domain","page":"Domains","title":"DynOptInterface.supports_domain","text":"supports_domain(model::MOI.ModelLike)\n\nReturn a Bool indicating whether model supports domains.\n\n\n\n\n\n","category":"function"},{"location":"reference/domains/#DynOptInterface.add_domain","page":"Domains","title":"DynOptInterface.add_domain","text":"add_domain(model::MOI.ModelLike)\n\nAdd a domain to model, returning a DomainIndex. An AddDomainNotAllowed is thrown if a domain cannot be added to the model in its current state.\n\n\n\n\n\n","category":"function"},{"location":"reference/domains/#Errors","page":"Domains","title":"Errors","text":"","category":"section"},{"location":"reference/domains/","page":"Domains","title":"Domains","text":"UnsupportedDomain\nAddDomainNotAllowed","category":"page"},{"location":"reference/domains/#DynOptInterface.UnsupportedDomain","page":"Domains","title":"DynOptInterface.UnsupportedDomain","text":"UnsupportedDomain <: MOI.UnsupportedError\n\nAn error indicating that domains are not supported by the model, that is, that supports_domain returns false.\n\n\n\n\n\n","category":"type"},{"location":"reference/domains/#DynOptInterface.AddDomainNotAllowed","page":"Domains","title":"DynOptInterface.AddDomainNotAllowed","text":"AddDomainNotAllowed <: MOI.NotAllowedError\n\nAn error indicating that domains cannot be added to the model in its current state.\n\n\n\n\n\n","category":"type"},{"location":"","page":"Home","title":"Home","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"#DynOptInterface","page":"Home","title":"DynOptInterface","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Documentation for DynOptInterface.","category":"page"},{"location":"reference/abstractions/","page":"Abstractions","title":"Abstractions","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/abstractions/#Abstractions","page":"Abstractions","title":"Abstractions","text":"","category":"section"},{"location":"reference/abstractions/#Functions","page":"Abstractions","title":"Functions","text":"","category":"section"},{"location":"reference/abstractions/","page":"Abstractions","title":"Abstractions","text":"AbstractDynamicFunction\nAbstractAlgebraicFunction\nAbstractDifferentialFunction\nAbstractBoundaryFunction","category":"page"},{"location":"reference/abstractions/#DynOptInterface.AbstractDynamicFunction","page":"Abstractions","title":"DynOptInterface.AbstractDynamicFunction","text":"AbstractDynamicFunction <: MOI.AbstractScalarFunction\n\nAbstract supertype for dynamic functions.\n\n\n\n\n\n","category":"type"},{"location":"reference/abstractions/#DynOptInterface.AbstractAlgebraicFunction","page":"Abstractions","title":"DynOptInterface.AbstractAlgebraicFunction","text":"AbstractAlgebraicFunction <: AbstractDynamicFunction\n\nAbstract supertype for algebraic functions. That is, expressions that may contain y(t) or t, but not doty(t).\n\n\n\n\n\n","category":"type"},{"location":"reference/abstractions/#DynOptInterface.AbstractDifferentialFunction","page":"Abstractions","title":"DynOptInterface.AbstractDifferentialFunction","text":"AbstractDifferentialFunction <: AbstractDynamicFunction\n\nAbstract supertype for differential functions. That is, expressions that may contain doty(t), y(t), or t.\n\n\n\n\n\n","category":"type"},{"location":"reference/abstractions/#DynOptInterface.AbstractBoundaryFunction","page":"Abstractions","title":"DynOptInterface.AbstractBoundaryFunction","text":"AbstractBoundaryFunction <: AbstractDynamicFunction\n\nAbstract supertype for functions evaluated at domain boundaries. That is, expressions that may contain y(t^0), y(t^f), t^0, or t^f.\n\n\n\n\n\n","category":"type"},{"location":"reference/abstractions/#Attributes","page":"Abstractions","title":"Attributes","text":"","category":"section"},{"location":"reference/abstractions/","page":"Abstractions","title":"Abstractions","text":"AbstractDomainAttribute\nAbstractDynamicVariableAttribute","category":"page"},{"location":"reference/abstractions/#DynOptInterface.AbstractDomainAttribute","page":"Abstractions","title":"DynOptInterface.AbstractDomainAttribute","text":"AbstractDomainAttribute\n\nAbstract supertype for attribute objects that can be used to set or get attributes (properties) of domains in the model.\n\n\n\n\n\n","category":"type"},{"location":"reference/abstractions/#DynOptInterface.AbstractDynamicVariableAttribute","page":"Abstractions","title":"DynOptInterface.AbstractDynamicVariableAttribute","text":"AbstractDynamicVariableAttribute\n\nAbstract supertype for attributs objects that can be used to set or get attributes (properties) of dynamic variables in the model.\n\n\n\n\n\n","category":"type"},{"location":"reference/boundary_functions/","page":"Boundary Functions","title":"Boundary Functions","text":"CurrentModule = DynOptInterface","category":"page"},{"location":"reference/boundary_functions/#Boundary-Functions","page":"Boundary Functions","title":"Boundary Functions","text":"","category":"section"},{"location":"reference/boundary_functions/","page":"Boundary Functions","title":"Boundary Functions","text":"Initial\nFinal\nNonlinearBoundaryFunction","category":"page"},{"location":"reference/boundary_functions/#DynOptInterface.Initial","page":"Boundary Functions","title":"DynOptInterface.Initial","text":"Initial{AF<:AbstractAlgebraicFunction} <: AbstractBoundaryFunction\n\na(y(t_i^0) t_i^0 x)\n\nRepresents the evaluation of an AbstractAlgebraicFunction at the initial point of its domain. Common cases are:\n\nt_i^0 Initial{DomainIndex}\ny_j(t_i^0) Initial{DynamicVariableIndex}\n\n\n\n\n\n","category":"type"},{"location":"reference/boundary_functions/#DynOptInterface.Final","page":"Boundary Functions","title":"DynOptInterface.Final","text":"Final{AF<:AbstractAlgebraicFunction} <: AbstractBoundaryFunction\n\na(y(t_i^f) t_i^f x)\n\nRepresents the evaluation of an AbstractAlgebraicFunction at the final point of its domain. Common cases are:\n\nt_i^f Final{DomainIndex}\ny_j(t_i^f) Final{DynamicVariableIndex}\n\n\n\n\n\n","category":"type"},{"location":"reference/boundary_functions/#DynOptInterface.NonlinearBoundaryFunction","page":"Boundary Functions","title":"DynOptInterface.NonlinearBoundaryFunction","text":"NonlinearBoundaryFunction <: AbstractBoundaryFunction\n\nf_b(y(t^0) y(t^f) t^0 t^f x)\n\nSimilar to MathOptInterface.ScalarNonlinearFunction, \n\nEach node in args can be one of the following:\n\nA constant value of type T<:Real\nA MathOptInterface.VariableIndex\nAn Initial{DomainIndex}\nA Final{DomainIndex}\nAn Initial{DynamicVariableIndex}\nA Final{DynamicVariableIndex}\nAnother NonlinearBoundaryFunction\n\n\n\n\n\n","category":"type"}] }