Skip to content

[Utilities] refactor is_maybe_real to is_complex #2475

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.

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
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 src/Bridges/Constraint/bridges/functionize.jl
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ function MOI.supports_constraint(
::Type{G},
::Type{<:MOI.AbstractSet},
) where {T,F,G<:MOI.AbstractFunction}
return MOI.Utilities.is_maybe_real(G) && isfinite(conversion_cost(F, G))
return !MOI.Utilities.is_complex(G) && isfinite(conversion_cost(F, G))
end

function concrete_bridge_type(
Expand Down
2 changes: 1 addition & 1 deletion src/Bridges/Constraint/bridges/norm_one.jl
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ function MOI.supports_constraint(
::Type{F},
::Type{MOI.NormOneCone},
) where {T,F<:MOI.AbstractVectorFunction}
return MOI.Utilities.is_maybe_real(F)
return !MOI.Utilities.is_complex(F)
end

function MOI.Bridges.added_constrained_variable_types(::Type{<:NormOneBridge})
Expand Down
2 changes: 1 addition & 1 deletion src/Bridges/Constraint/bridges/vectorize.jl
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ function MOI.supports_constraint(
::Type{F},
::Type{<:MOI.Utilities.ScalarLinearSet{T}},
) where {T,F<:MOI.AbstractScalarFunction}
return MOI.Utilities.is_maybe_real(F)
return !MOI.Utilities.is_complex(F)
end

function MOI.Bridges.added_constrained_variable_types(::Type{<:VectorizeBridge})
Expand Down
4 changes: 2 additions & 2 deletions src/Bridges/Constraint/set_map.jl
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ function MOI.supports_constraint(
::Type{F},
::Type{S1},
) where {T,S1<:MOI.AbstractScalarSet,F<:MOI.AbstractScalarFunction}
return MOI.Utilities.is_maybe_real(F)
return !MOI.Utilities.is_complex(F)
end

function MOI.supports_constraint(
::Type{<:MultiSetMapBridge{T,S1}},
::Type{F},
::Type{S1},
) where {T,S1<:MOI.AbstractVectorSet,F<:MOI.AbstractVectorFunction}
return MOI.Utilities.is_maybe_real(F)
return !MOI.Utilities.is_complex(F)
end

function MOI.Bridges.added_constrained_variable_types(
Expand Down
30 changes: 15 additions & 15 deletions src/Utilities/functions.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2494,13 +2494,13 @@ function constant_vector(
end

"""
is_maybe_real(::Type{<:MOI.AbstractFunction})
is_complex(::Type{<:MOI.AbstractFunction})

Return `true` if the function type may return `<:Real` values. It returns false
for Complex-valued functions.
Return `true` if the function type may return `<:Complex` values. It returns
`false` for real-valued functions.

This function defaults to returning a false positive (`true`). If your new
function explicitly returns complex values, opt-out by defining a new method.
This function defaults to returning a false negatives (`false`). If your new
function explicitly returns complex values, opt-in by defining a new method.

This function is mostly intended for use in the `MOI.Bridges` submodule to
identify when bridges are not applicable (because the function is
Expand All @@ -2511,18 +2511,18 @@ complex-valued).
```jldoctest
julia> import MathOptInterface as MOI

julia> MOI.Utilities.is_maybe_real(MOI.VariableIndex)
true

julia> MOI.Utilities.is_maybe_real(MOI.ScalarAffineFunction{Complex{Int}})
julia> MOI.Utilities.is_complex(MOI.VariableIndex)
false

julia> MOI.Utilities.is_maybe_real(MOI.ScalarNonlinearFunction)
julia> MOI.Utilities.is_complex(MOI.ScalarAffineFunction{Complex{Int}})
true

julia> MOI.Utilities.is_complex(MOI.ScalarNonlinearFunction)
false
```
"""
is_maybe_real(::Type{<:MOI.AbstractFunction}) = true
is_maybe_real(::Type{<:MOI.ScalarAffineFunction{<:Complex}}) = false
is_maybe_real(::Type{<:MOI.VectorAffineFunction{<:Complex}}) = false
is_maybe_real(::Type{<:MOI.ScalarQuadraticFunction{<:Complex}}) = false
is_maybe_real(::Type{<:MOI.VectorQuadraticFunction{<:Complex}}) = false
is_complex(::Type{<:MOI.AbstractFunction}) = false
is_complex(::Type{<:MOI.ScalarAffineFunction{<:Complex}}) = true
is_complex(::Type{<:MOI.VectorAffineFunction{<:Complex}}) = true
is_complex(::Type{<:MOI.ScalarQuadraticFunction{<:Complex}}) = true
is_complex(::Type{<:MOI.VectorQuadraticFunction{<:Complex}}) = true