Skip to content

[Utilities] implement Aqua.jl recommendation for functions.jl #1738

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 2 commits into from
Feb 10, 2022
Merged

[Utilities] implement Aqua.jl recommendation for functions.jl #1738

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f01bdf5
[Utilities] implement Aqua.jl recommendation for functions.jl
odow Feb 9, 2022
d156038
Update functions.jl
odow Feb 9, 2022
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
77 changes: 37 additions & 40 deletions src/Utilities/functions.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1732,8 +1732,23 @@ function operate(
return operate!(op, T, copy(f), g)
end

# To avoid type piracy, we add at least one `ScalarLike` outside of the `...`.
function Base.:+(arg::ScalarLike{T}, args::ScalarLike{T}...) where {T}
_eltype(args::Tuple) = _eltype(first(args), Base.tail(args))
_eltype(::Tuple{}) = nothing
_eltype(::MOI.Utilities.TypedScalarLike{T}, tail) where {T} = T
_eltype(::MOI.VariableIndex, tail) = _eltype(tail)
_eltype(::MOI.Utilities.TypedVectorLike{T}, tail) where {T} = T
_eltype(::MOI.VectorOfVariables, tail) = _eltype(tail)

function Base.:+(arg::ScalarLike, args::ScalarLike...)
T = _eltype(arg, args)
if T === nothing
error(
"Unable to add VariableIndex together because no coefficient type " *
"is specified. Instead of `x + y`, convert one of the terms to a " *
"`ScalarAffineFunction` first by left-multiplying by `one(T)` where " *
"`T` is the coefficient type For example: `1.0 * x + y`.",
)
end
return operate(+, T, arg, args...)
end

Expand All @@ -1757,7 +1772,16 @@ function Base.:+(f::MOI.VariableIndex, α::Number)
return operate(+, typeof(α), f, α)
end

function Base.:-(arg::ScalarLike{T}, args::ScalarLike{T}...) where {T}
function Base.:-(arg::ScalarLike, args::ScalarLike...)
T = _eltype(arg, args)
if T === nothing
error(
"Unable to subtract VariableIndex together because no coefficient " *
"type is specified. Instead of `x - y`, convert one of the terms to a " *
"`ScalarAffineFunction` first by left-multiplying by `one(T)` where " *
"`T` is the coefficient type For example: `1.0 * x - y`.",
)
end
return operate(-, T, arg, args...)
end

Expand All @@ -1777,37 +1801,6 @@ function Base.:-(α::Number, f::MOI.VariableIndex)
return operate(-, typeof(α), α, f)
end

function Base.:+(::MOI.VariableIndex, ::MOI.VariableIndex...)
return error(
"Unable to add VariableIndex together because no coefficient type " *
"is specified. Instead of `x + y`, convert one of the terms to a " *
"`ScalarAffineFunction` first by left-multiplying by `one(T)` where " *
"`T` is the coefficient type For example: `1.0 * x + y`.",
)
end

function Base.:-(::MOI.VariableIndex, ::MOI.VariableIndex...)
return error(
"Unable to subtract VariableIndex together because no coefficient " *
"type is specified. Instead of `x - y`, convert one of the terms to a " *
"`ScalarAffineFunction` first by left-multiplying by `one(T)` where " *
"`T` is the coefficient type For example: `1.0 * x - y`.",
)
end

function Base.:*(
::MOI.VariableIndex,
::MOI.VariableIndex,
::MOI.VariableIndex...,
)
return error(
"Unable to multiply VariableIndex together because no coefficient " *
"type is specified. Instead of `x * y`, convert one of the terms to a " *
"`ScalarAffineFunction` first by left-multiplying by `one(T)` where " *
"`T` is the coefficient type For example: `1.0 * x * y`.",
)
end

# Vector +/-
###############################################################################

Expand Down Expand Up @@ -2417,12 +2410,16 @@ end

Base.:*(f::MOI.AbstractFunction) = f

# To avoid type piracy, we add at least one `ScalarLike` outside of the `...`.
function Base.:*(
f::ScalarLike{T},
g::ScalarLike{T},
args::ScalarLike{T}...,
) where {T}
function Base.:*(f::ScalarLike, g::ScalarLike, args::ScalarLike...)
T = _eltype(f, (g, args...))
if T === nothing
error(
"Unable to multiply VariableIndex together because no coefficient " *
"type is specified. Instead of `x * y`, convert one of the terms to a " *
"`ScalarAffineFunction` first by left-multiplying by `one(T)` where " *
"`T` is the coefficient type For example: `1.0 * x * y`.",
)
end
return operate(*, T, f, g, args...)
end

Expand Down