Skip to content

Added member types to *Change struct docstrings #386

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
merged 1 commit into from
Jun 13, 2018
Merged

Added member types to *Change struct docstrings #386

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions src/functions.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ An abstract supertype for structs which specify partial modifications to functio
abstract type AbstractFunctionModification end

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

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

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