Max issues default (#20)

* Change max issues default

* format

* add missing test

Author: joaquimg

src/ModelAnalyzer.jl

@@ -25,7 +25,7 @@ See [`summarize`](@ref), [`list_of_issues`](@ref), and
 function analyze end
 
 """
-    summarize([io::IO,] AbstractData; verbose = true, max_issues = typemax(Int), kwargs...)
+    summarize([io::IO,] AbstractData; verbose = true, max_issues = 10, kwargs...)
 
 Print a summary of the analysis results contained in `AbstractData` to the
 specified IO stream. If no IO stream is provided, it defaults to `stdout`.
@@ -80,16 +80,26 @@ function summarize(io::IO, issue::AbstractIssue; verbose = true)
     end
 end
 
+const DEFAULT_MAX_ISSUES = 10
+
 function summarize(
     io::IO,
     issues::Vector{T};
     verbose = true,
-    max_issues = typemax(Int),
+    max_issues = DEFAULT_MAX_ISSUES,
 ) where {T<:AbstractIssue}
     summarize(io, T, verbose = verbose)
     print(io, "\n## Number of issues\n\n")
     print(io, "Found ", length(issues), " issues")
     print(io, "\n\n## List of issues\n\n")
+    if length(issues) > max_issues
+        print(
+            io,
+            "Showing first ",
+            max_issues,
+            " issues ($(length(issues) - max_issues) issues ommitted)\n\n",
+        )
+    end
     for issue in first(issues, max_issues)
         print(io, " * ")
         summarize(io, issue, verbose = verbose)

src/feasibility.jl

@@ -685,7 +685,7 @@ function ModelAnalyzer.summarize(
     io::IO,
     data::Data;
     verbose = true,
-    max_issues = typemax(Int),
+    max_issues = ModelAnalyzer.DEFAULT_MAX_ISSUES,
     configurations = true,
 )
     print(io, "## Feasibility Analysis\n\n")

src/infeasibility.jl

@@ -677,7 +677,7 @@ function ModelAnalyzer.summarize(
     io::IO,
     data::Data;
     verbose = true,
-    max_issues = typemax(Int),
+    max_issues = ModelAnalyzer.DEFAULT_MAX_ISSUES,
 )
     print(io, "## Infeasibility Analysis\n\n")
 

src/numerical.jl

@@ -2042,7 +2042,7 @@ function ModelAnalyzer.summarize(
     io::IO,
     data::Data;
     verbose = true,
-    max_issues = typemax(Int),
+    max_issues = ModelAnalyzer.DEFAULT_MAX_ISSUES,
     configurations = true,
     dimensions = true,
     ranges = true,

test/numerical.jl

@@ -1002,6 +1002,27 @@ function test_qp_range()
     return
 end
 
+function test_more_than_max_issues()
+    model = Model()
+    @variable(model, xg[1:20] <= 2e9)
+    data = ModelAnalyzer.analyze(ModelAnalyzer.Numerical.Analyzer(), model)
+    list = ModelAnalyzer.list_of_issue_types(data)
+    @test length(list) >= 1
+    ret = ModelAnalyzer.list_of_issues(
+        data,
+        ModelAnalyzer.Numerical.LargeBoundCoefficient,
+    )
+    @test length(ret) == 20
+
+    buf = IOBuffer()
+    ModelAnalyzer.summarize(buf, data)
+    str = String(take!(buf))
+    @test occursin("Showing first ", str)
+    @test occursin(" issues ommitted)\n\n", str)
+
+    return
+end
+
 end  # module
 
 TestNumerical.runtests()