Skip to content

add docstring to function in copy.jl #1246

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
Mar 2, 2021
Merged

add docstring to function in copy.jl #1246

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31b8725
add docstring to function in copy.jl
joaquimg Feb 19, 2021
148b4fb
Update copy.jl
joaquimg Feb 21, 2021
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
10 changes: 10 additions & 0 deletions src/Utilities/copy.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,16 @@ function IndexMap(n = 0)
)
end

"""
index_map_for_variable_indices(variables)

This function does not add variables to the IndexMap.
It simply initializes the IndexMap with a proper data struture.
If the variable indices are contiguous and start from 1, then
an optimized data structure with pre allocated memory is initialized.
Otherwise the data structure will start empty and will try to
keep using performant structure for as long as possible.
"""
function index_map_for_variable_indices(variables)
n = length(variables)
if all(i -> variables[i] == MOI.VariableIndex(i), 1:n)
Expand Down