Skip to content

Update documentation links #406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pulsipher merged 2 commits into from
Dec 16, 2025
Merged

Update documentation links #406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1736e65
Change subheadings in variable.md + adjust InfiniteInterpolations fun…
wenwen0231 Dec 11, 2025
079a388
Fix example output for InfiniteMathOptAI
wenwen0231 Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/develop/extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,7 +734,7 @@ Our extension is done and now `RandomGenerativeInfo` can be incorporated by a
`GenerativeDerivativeMethod` we create or an `AbstractMeasureData` object of our
choice like `FunctionalDiscreteMeasureData`.

## [Transformation Backends] (@id extend_backends)
## [Transformation Backends](@id extend_backends)
`InfiniteOpt` provides a convenient interface and abstraction for modeling
infinite-dimensional optimization problems. By default, `InfiniteModel`s are
reformulated into a solvable `JuMP.Model` via `TranscriptionOpt.TranscriptionBackend`
Expand Down
2 changes: 1 addition & 1 deletion docs/src/guide/objective.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ One key idea is that the objective must evaluate to a finite expression which me
it must only explicitly contain finite variables and point variables. Infinite
expressions must be summarized by a measure (e.g., taking the expectation of a random variable).

## [Basic Usage] (@id obj_basic)
## [Basic Usage](@id obj_basic)
Principally, the objective function is specified via
[`@objective`](https://jump.dev/JuMP.jl/v1/api/JuMP/#JuMP.@objective)
as is done in `JuMP`. For example, let's define the stochastic objective to
Expand Down
2 changes: 1 addition & 1 deletion docs/src/guide/parameter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ via the basic constructor for [`DependentParameters`](@ref) and then invoking
[`add_parameters`](@ref). Note that this should be done with caution since most
error checking will be omitted in this case.

## [Macro Definition] (@id param_macro)
## [Macro Definition](@id param_macro)
### One-Dimensional Parameters
One user-friendly way of defining infinite parameters is by macro
[`@infinite_parameter`](@ref). The macro executes the same process as the
Expand Down
2 changes: 1 addition & 1 deletion docs/src/manual/extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ respective [guide](@ref ext_docs) for more information.
## InfiniteInterpolations
Enabled via `import InfiniteOpt, Interpolations`.
```@docs
JuMP.value(::Union{GeneralVariableRef,JuMP.GenericAffExpr{Float64, GeneralVariableRef},JuMP.GenericQuadExpr{Float64, GeneralVariableRef},JuMP.GenericNonlinearExpr{GeneralVariableRef},InfOptConstraintRef}, ::Interpolations.InterpolationType)
JuMP.value(::GeneralVariableRef, ::Interpolations.InterpolationType)
```

## InfiniteMathOptAI
Expand Down
20 changes: 10 additions & 10 deletions docs/src/manual/variable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Note that the principle way for defining variables is by using
[`JuMP.@variable`](https://jump.dev/JuMP.jl/v1/api/JuMP/#JuMP.@variable)
which originates from `JuMP.jl`.

### Infinite
### Infinite Variables
```@docs
InfOptVariableType
Infinite
Expand All @@ -22,7 +22,7 @@ InfiniteVariableRef
InfiniteOpt.Collections.VectorTuple
```

### Semi-Infinite
### Semi-Infinite Variables
```@docs
SemiInfinite
JuMP.build_variable(::Function, ::JuMP.VariableInfo, ::SemiInfinite)
Expand All @@ -34,7 +34,7 @@ SemiInfiniteVariableIndex
SemiInfiniteVariableRef
```

### Point
### Point Variables
```@docs
Point
JuMP.build_variable(::Function, ::JuMP.VariableInfo, ::Point)
Expand All @@ -44,7 +44,7 @@ PointVariableIndex
PointVariableRef
```

### Finite
### Finite Variables
Note that finite variables simply correspond to using
[`JuMP.ScalarVariable`](https://jump.dev/JuMP.jl/v1/api/JuMP/#JuMP.ScalarVariable)
which originates from `JuMP.jl` as well. In other words, these are defined via
Expand Down Expand Up @@ -82,7 +82,7 @@ used_by_measure(::DecisionVariableRef)
used_by_objective(::DecisionVariableRef)
```

### Infinite
### Infinite Variables
```@docs
parameter_refs(::InfiniteVariableRef)
parameter_list(::InfiniteVariableRef)
Expand All @@ -95,7 +95,7 @@ parameter_group_int_indices(::InfiniteVariableRef)
core_object(::InfiniteVariableRef)
```

### Semi-Infinite
### Semi-Infinite Variables
```@docs
infinite_variable_ref(::SemiInfiniteVariableRef)
parameter_refs(::SemiInfiniteVariableRef)
Expand All @@ -108,15 +108,15 @@ parameter_group_int_indices(::SemiInfiniteVariableRef)
core_object(::SemiInfiniteVariableRef)
```

### Point
### Point Variables
```@docs
infinite_variable_ref(::PointVariableRef)
parameter_values(::PointVariableRef)
raw_parameter_values(::PointVariableRef)
core_object(::PointVariableRef)
```

### Finite
### Finite Variables
```@docs
core_object(::FiniteVariableRef)
```
Expand All @@ -141,12 +141,12 @@ JuMP.set_start_values(::InfiniteModel)
JuMP.delete(::InfiniteModel, ::DecisionVariableRef)
```

### Infinite
### Infinite Variables
```@docs
constant_over_collocation(::InfiniteVariableRef, ::GeneralVariableRef)
```

### Semi-Infinite
### Semi-Infinite Variables
```@docs
JuMP.set_name(::SemiInfiniteVariableRef,::String)
```
Loading