Skip to content

Commit

Permalink
Merge branch 'tikz-figure-export' of https://github.com/d-monnet/Benc…
Browse files Browse the repository at this point in the history
…hmarkProfiles.jl into tikz-figure-export
  • Loading branch information
d-monnet committed Oct 30, 2023
2 parents f4cf755 + 2ef164c commit 54f8213
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions src/performance_profiles.jl
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ end
"""
function performance_profile_data_mat(T;kwargs...)
Retruns `performance_profile_data` output (vectors) as matrices. Matrices are padded with NaN if necessary.
Returns `performance_profile_data` output (vectors) as matrices. Matrices are padded with NaN if necessary.
"""
function performance_profile_data_mat(T::Matrix{Float64};kwargs...)
x_data, y_data, max_ratio = performance_profile_data(T;kwargs...)
Expand All @@ -187,7 +187,7 @@ Export a performance profile plot data as .csv file. Profiles data are padded wi
## Keyword Arguments
* `solver_names :: Vector{S}` : names of the solvers.
- `solver_names :: Vector{S}` : names of the solvers.
- `header::Vector{String}`: Contains .csv file column names. Note that `header` value does not change columns order in .csv exported files (see Output).
Other keyword arguments are passed to `performance_profile_data`.
Expand Down
8 changes: 4 additions & 4 deletions src/tikz_export.jl
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ Export tikz figure of the performance profiles given by `T` in `filename`.
* `grid::Bool=true` : display grid if true.
* `colours::Vector{String} = []` : colours of the plots, should have as many elements as the number of columns of `T`.
* `linestyles::Vector{String} = []` : line style (dashed, dotted, ...) of the plots, should have as many elements as the number of columns of `T`.
* `linewidth::AbstractFloat = 1.0` : line with of the plots.
* `xlabel::String = ""` : x axis label. If empty, uses the one returns by `performance_profile_axis_labels`.
* `ylabel::String = ""` : x axis label. If empty, uses the one returns by `performance_profile_axis_labels`.
* `linewidth::AbstractFloat = 1.0` : line width of the plots.
* `xlabel::String = ""` : x-axis label. If empty, uses the one returned by `performance_profile_axis_labels`.
* `ylabel::String = ""` : y-axis label. If empty, uses the one returned by `performance_profile_axis_labels`.
* `axis_tick_length::AbstractFloat = 0.2` : axis graduation tick length.
* `lgd_pos::Vector = [xlim+0.5,ylim]`, : legend box top left corner coordinates, by default legend is on the left had side of the figure.
* `lgd_plot_length::AbstractFloat = 0.7` : legend curve plot length.
* `lgd_v_offset::AbstractFloat = 0.7` : vertical space between two legend items.
* `lgd_plot_offset::AbstractFloat = 0.1` : space between legend box left side and curve plot.
* `lgd_box_length::AbstractFloat = 3.` : legend box horizontal length.
* `label_val::Vector = [0.2,0.25,0.5,1]` : possible graduation labels along axes are multiples of label_val elements times 10^n (n is automatically selected).
Other keyword arguments are passed `performance_profile_data`.
Other keyword arguments are passed to `performance_profile_data`.
"""
function export_performance_profile_tikz(
Expand Down

0 comments on commit 54f8213

Please sign in to comment.