Skip to content

Commit ef32b86

Browse files
BenChungmlubin
authored andcommitted
Added member types to *Change struct docstrings (#386)
1 parent 13489d8 commit ef32b86

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/functions.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ An abstract supertype for structs which specify partial modifications to functio
205205
abstract type AbstractFunctionModification end
206206

207207
"""
208-
ScalarConstantChange{T}(new_constant)
208+
ScalarConstantChange{T}(new_constant::T)
209209
210210
A struct used to request a change in the constant term of a scalar-valued function.
211211
Applicable to `ScalarAffineFunction` and `ScalarQuadraticFunction`.
@@ -215,7 +215,7 @@ struct ScalarConstantChange{T} <: AbstractFunctionModification
215215
end
216216

217217
"""
218-
VectorConstantChange{T}(new_constant)
218+
VectorConstantChange{T}(new_constant::Vector{T})
219219
220220
A struct used to request a change in the constant vector of a vector-valued function.
221221
Applicable to `VectorAffineFunction` and `VectorQuadraticFunction`.
@@ -225,7 +225,7 @@ struct VectorConstantChange{T} <: AbstractFunctionModification
225225
end
226226

227227
"""
228-
ScalarCoefficientChange{T}(variable, new_coefficient)
228+
ScalarCoefficientChange{T}(variable::VariableIndex, new_coefficient::T)
229229
230230
A struct used to request a change in the linear coefficient of a single variable
231231
in a scalar-valued function.
@@ -241,7 +241,7 @@ end
241241
# allocates, and it is desirable to provide a zero-allocation option for working with
242242
# MultiRowChanges. See https://github.com/JuliaOpt/MathOptInterface.jl/pull/343.
243243
"""
244-
MultirowChange{T}(variable, new_coefficients)
244+
MultirowChange{T}(variable::VariableIndex, new_coefficients::Vector{Tuple{Int64, T}})
245245
246246
A struct used to request a change in the linear coefficients of a single
247247
variable in a vector-valued function. New coefficients are specified by

0 commit comments

Comments
 (0)