Bugfix for optimal objective value

[ewu63]

Purpose

Previously, sol.fStar is taken to be the optimal objective value, but sol.objectives[obj_name].value is the objective value of the last queried point, which is not guaranteed to match. This is now fixed, even though this is ambiguous and undocumented.

Note that the constraint values are still the last queried values, since the constraint value at the optimum is not returned by the optimizer and we do not want to query the constraints just to get this value. So they are left as the last value.

Expected time until merged

1 week

Type of change

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (non-backwards-compatible fix or feature)
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no API changes)
• Documentation update
• Maintenance update
• Other (please describe)

Testing

I added a test

Checklist

• I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
• I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
• I have run unit and regression tests which pass locally with my changes
• I have added new tests that prove my fix is effective or that my feature works
• I have added necessary documentation

[codecov]

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (f56e159) 73.38% compared to head (3355ba0) 61.65%.

Files	Patch %	Lines
pyoptsparse/pyOpt_solution.py	71.42%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##             main     #364       +/-   ##
===========================================
- Coverage   73.38%   61.65%   -11.74%     
===========================================
  Files          22       22               
  Lines        3307     3312        +5     
===========================================
- Hits         2427     2042      -385     
- Misses        880     1270      +390     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[lamkina]

This looks good to me.

[sseraj]

Looks good, just one minor comment

[sseraj]

Is this line necessary?

[ewu63]

bump @lamkina