Infeasibility more cleaning #2231

guilpier-code · 2024-07-03T14:39:07Z

We're on the road to make infeasibility analyzer more changeable, more precisely when adding a constraint type to the list of constraints to be detected in case of infeasibity.
This PR is a step towards this purpose.
It contains some heterogeneous simplifications and renaming.
In order to ease the review, some comments were added in this PR.

…Report

…feasibility-analyzer

…tweenAngleBrackets

…e() and timeStep()

…) into type()

…fied and renamed into STSname()

…traintsByType() Check on the current constraint's name number of components is useless : it cannot be null.

…ing BC names

… parts (suspicious constraints and infeasibility causes)

…yType with his friends

guilpier-code · 2024-07-04T06:32:10Z

src/solver/infeasible-problem-analysis/constraint.cpp

 {
    boost::algorithm::split_regex(nameComponents_, name_, boost::regex("::"));
-    return nameComponents_.size();


No need to return the size : this was returned only to test if this size is zero, but it can never be zero, as constraints are filtered based on regex pattern :

const std::string constraint_name_pattern = "^AreaHydroLevel::|::hourly::|::daily::|::weekly::|" "^FictiveLoads::|^Level::|" "^HydroPower::";

This forces the constraint's name to contain "::" and something else (like AreaHydroLevel, daily, ...).

guilpier-code · 2024-07-04T06:40:16Z

src/solver/infeasible-problem-analysis/constraint.cpp

 {
-    const auto& begin = str.begin();
-    const auto& end = str.end();
+    std::vector<std::string> split_name;


Here we base the extraction of the string between angle bracket on the split algorithm, rather than the find algorithm. It makes code slightly more simple.
Error handling was a bit simplified.
In the end, function is shorter and easier to understand, I guess.

.../infeasible-problem-analysis/include/antares/solver/infeasible-problem-analysis/constraint.h

guilpier-code · 2024-07-04T06:45:17Z

src/solver/infeasible-problem-analysis/report.cpp

@@ -71,11 +72,8 @@ void InfeasibleProblemReport::sortConstraintsByType()
 {
    for (auto& c: constraints_)
    {
-        if (c.extractComponentsFromName() == 0)


As already said above, extractComponentsFromName was returning the number of components a constraint's name is composed with, but this number can never be zero.
So the if statement was removed.

guilpier-code · 2024-07-04T06:50:51Z

src/solver/infeasible-problem-analysis/report.cpp

@@ -114,14 +116,12 @@ void InfeasibleProblemReport::logSuspiciousConstraints()
    {
        Antares::logs.error() << "* Binding constraints,";
    }
-
-    Antares::logs.error() << "* Negative hurdle costs on lines with infinite capacity (rare).";


Couldn't see any use for this log line :
it's printed in all cases of infeasibility, even if here are no link involved (indeed, hurdle costs are related to links).
Besides, it can be misleading for user, forced to wonder why he's got this message.

guilpier-code · 2024-07-04T06:53:31Z

src/solver/infeasible-problem-analysis/report.cpp

 }

 void InfeasibleProblemReport::prettyPrint()
 {
-    sortConstraintsByType();


The call to sortConstraintsByType() was moved above, with another call to a sort function.
Besides, this call is not related to client function's name, which is supposed to print only.

guilpier-code · 2024-07-04T06:58:00Z

src/tests/src/solver/infeasible-problem-analysis/test-unfeasible-problem-analyzer.cpp

-  "BC::hourly::hour<36>",
-  "BC::daily::day<67>",
-  "BC::weekly::week<12>",
+  "BC-name-1::hourly::hour<36>",


Here I changed a bit the binding constraints' names.
Originally, these names started with "BC::", and it made think that BC names in mps files necessarily start with this prefix. This not the case, this prefix is the name of the BC.

guilpier-code · 2024-07-04T07:24:35Z

src/solver/infeasible-problem-analysis/report.cpp

@@ -86,6 +84,10 @@ void InfeasibleProblemReport::logSuspiciousConstraints()
    {
        Antares::logs.error() << c.prettyPrint();
    }
+}
+
+void InfeasibleProblemReport::logInfeasibilityCauses()


Here we split logs into 2 separate functions :

one that logs suspicious constraints

one that logs of infeasibility causes

a-zakir · 2024-07-08T13:17:34Z

src/solver/infeasible-problem-analysis/constraint.cpp

@@ -75,67 +61,36 @@ class StringIsNotWellFormated: public std::runtime_error
    }
 };

-std::string StringBetweenAngleBrackets(const std::string& str)
+std::string StringBetweenAngleBrackets(const std::string& constraintName)


this function is agnostic to its input and therefore the param should not be renamed;

a-zakir · 2024-07-08T13:18:28Z

src/solver/infeasible-problem-analysis/constraint.cpp

-        stream << std::string("Error the string: ") << std::quoted(str)
-               << " does not contains the left angle bracket " << std::quoted("<");
-        throw StringIsNotWellFormated(stream.str());
+        err_msg += "constraint name '" + constraintName + "' misses '<' and/or '>' bracket";


or make it a class method

a-zakir · 2024-07-08T13:21:15Z

src/solver/infeasible-problem-analysis/constraint.cpp

@@ -158,61 +113,46 @@ ConstraintType Constraint::getType() const
    {
        return ConstraintType::hydro_reservoir_level;
    }
+    if (nameComponents_.at(0) == "HydroPower")


it's works because Antares provides constraints and vars names, trimmed!

…more-cleaning

sonarqubecloud · 2024-07-09T13:57:17Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@flomnes

* Collect hydro validation errors (AntaresSimulatorTeam#2204) collect *n* hydro validation errors (10 per area ) before exiting --------- Co-authored-by: Florian Omnès <[email protected]> * Remove actions dependencies using node js 16 (AntaresSimulatorTeam#2215) > Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: notiz-dev/github-action-json-property@release. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/. --------- Co-authored-by: Florian OMNES <[email protected]> * Move TS number print (AntaresSimulatorTeam#2228) Purpose : moving the code that prints the TS numbers on disk : due to recent changes it was moved after the loop through MC years. So, we have to wait until simulation ends to know which TS numbers where drawn. So we move that code back. * Infeability analyzer : renaming (AntaresSimulatorTeam#2225) Purpose : as the title says This PR is attached to ticket [ticket ANT-1825](https://gopro-tickets.rte-france.com/browse/ANT-1825). Some improvements were made or tried by taking care of the ticket. The result is this PR. --------- Co-authored-by: Florian OMNES <[email protected]> * Always run clang-format on PR (AntaresSimulatorTeam#2230) * Add changelog for minor versions (AntaresSimulatorTeam#2229) - v8.8.6 - v8.6.8 --------- Co-authored-by: Abdoulbari Zaher <[email protected]> Co-authored-by: Jason Maréchal <[email protected]> * Infeasibility analyzer : small simplifications (AntaresSimulatorTeam#2226) Purpose : as the title says This PR is attached to ticket [ticket ANT-1825](https://gopro-tickets.rte-france.com/browse/ANT-1825). Some improvements were made or tried by taking care of the ticket. The result is this PR. --------- Co-authored-by: Florian OMNES <[email protected]> * Fix compile, add boost header in CMakelists (AntaresSimulatorTeam#2233) * STS: Withdrawal efficiency [ANT-1862] (AntaresSimulatorTeam#2223) Add a efficiencywithdrawal property to short term storage This mimics the already existing efficiency for injection * Infeasibility analyzer : HydroPower constraint (AntaresSimulatorTeam#2227) [ANT-1825] Add constraint that can possibily lead to infeasibilities. HydroPower is the constraint on the sum of generated hydro energy over the week for a given area. The provided RHS in some cases makes the problem infeasible. --------- Co-authored-by: Florian OMNES <[email protected]> * Compilation warnings (AntaresSimulatorTeam#2237) close AntaresSimulatorTeam#2236 * Version 9.2 (AntaresSimulatorTeam#2240) * Fix sonarcloud job (AntaresSimulatorTeam#2246) * Adequacy Patch regression [ANT-1845] (AntaresSimulatorTeam#2235) * 9.2 rc 1 (AntaresSimulatorTeam#2247) * Keep using node js 16 on centos CI (AntaresSimulatorTeam#2248) * Infeasibility more cleaning (AntaresSimulatorTeam#2231) We're on the road to make **infeasibility analyzer** more changeable, more precisely when adding a constraint type to the list of constraints to be detected in case of infeasibity. This PR is a step towards this purpose. It contains some heterogeneous simplifications and renaming. In order to ease the review, some comments were added in this PR. --------- Co-authored-by: Florian OMNES <[email protected]> * Document clang-format (AntaresSimulatorTeam#2243) Add version number to avoid confusion. * Link TS generation : splitting into multiple files (AntaresSimulatorTeam#2171) This PR aims at moving some code about link TS generation, from **main** program to new source files. It follows PR AntaresSimulatorTeam#2155 To be done : - [x] move headers (*.h) to the right place - [x] update this branch with its base branch (@flomnes made a change on base branch) We may also take advantage of this PR to : - [ ] Thermal TS generation : - [ ] avoid loading the **whole study** when **no** thermal TS generation is required (this is currently the case) - [ ] move implementation details about thermal TS generation from **main** program to new source files - [ ] Separate loading / extracting data from study and generate the TS --------- Co-authored-by: Florian OMNES <[email protected]> Co-authored-by: Florian OMNES <[email protected]> * Explain why MPS are named when the problem is infeasible (AntaresSimulatorTeam#2250) * Add tests in CI for version 9.2 (AntaresSimulatorTeam#2241) Co-authored-by: Florian OMNES <[email protected]> * Rename test-platform to os for windows CI (AntaresSimulatorTeam#2253) * Fix bug hydro heuristic with mingen (ANT-1825) (AntaresSimulatorTeam#2258) Removing lines that create infeasibility and that are not necessary. --------- Co-authored-by: Juliette-Gerbaux <[email protected]> Co-authored-by: Florian OMNES <[email protected]> * Remove useless fwd declaration --------- Co-authored-by: Abdoulbari Zaher <[email protected]> Co-authored-by: Florian Omnès <[email protected]> Co-authored-by: payetvin <[email protected]> Co-authored-by: guilpier-code <[email protected]> Co-authored-by: Florian OMNES <[email protected]> Co-authored-by: Jason Maréchal <[email protected]> Co-authored-by: Juliette-Gerbaux <[email protected]> Co-authored-by: Juliette-Gerbaux <[email protected]>

@flomnes

* Collect hydro validation errors (AntaresSimulatorTeam#2204) collect *n* hydro validation errors (10 per area ) before exiting --------- Co-authored-by: Florian Omnès <[email protected]> * Remove actions dependencies using node js 16 (AntaresSimulatorTeam#2215) > Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: notiz-dev/github-action-json-property@release. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/. --------- Co-authored-by: Florian OMNES <[email protected]> * Move TS number print (AntaresSimulatorTeam#2228) Purpose : moving the code that prints the TS numbers on disk : due to recent changes it was moved after the loop through MC years. So, we have to wait until simulation ends to know which TS numbers where drawn. So we move that code back. * Infeability analyzer : renaming (AntaresSimulatorTeam#2225) Purpose : as the title says This PR is attached to ticket [ticket ANT-1825](https://gopro-tickets.rte-france.com/browse/ANT-1825). Some improvements were made or tried by taking care of the ticket. The result is this PR. --------- Co-authored-by: Florian OMNES <[email protected]> * Always run clang-format on PR (AntaresSimulatorTeam#2230) * Add changelog for minor versions (AntaresSimulatorTeam#2229) - v8.8.6 - v8.6.8 --------- Co-authored-by: Abdoulbari Zaher <[email protected]> Co-authored-by: Jason Maréchal <[email protected]> * Infeasibility analyzer : small simplifications (AntaresSimulatorTeam#2226) Purpose : as the title says This PR is attached to ticket [ticket ANT-1825](https://gopro-tickets.rte-france.com/browse/ANT-1825). Some improvements were made or tried by taking care of the ticket. The result is this PR. --------- Co-authored-by: Florian OMNES <[email protected]> * Fix compile, add boost header in CMakelists (AntaresSimulatorTeam#2233) * STS: Withdrawal efficiency [ANT-1862] (AntaresSimulatorTeam#2223) Add a efficiencywithdrawal property to short term storage This mimics the already existing efficiency for injection * Infeasibility analyzer : HydroPower constraint (AntaresSimulatorTeam#2227) [ANT-1825] Add constraint that can possibily lead to infeasibilities. HydroPower is the constraint on the sum of generated hydro energy over the week for a given area. The provided RHS in some cases makes the problem infeasible. --------- Co-authored-by: Florian OMNES <[email protected]> * Compilation warnings (AntaresSimulatorTeam#2237) close AntaresSimulatorTeam#2236 * Version 9.2 (AntaresSimulatorTeam#2240) * Fix sonarcloud job (AntaresSimulatorTeam#2246) * Adequacy Patch regression [ANT-1845] (AntaresSimulatorTeam#2235) * 9.2 rc 1 (AntaresSimulatorTeam#2247) * Keep using node js 16 on centos CI (AntaresSimulatorTeam#2248) * Infeasibility more cleaning (AntaresSimulatorTeam#2231) We're on the road to make **infeasibility analyzer** more changeable, more precisely when adding a constraint type to the list of constraints to be detected in case of infeasibity. This PR is a step towards this purpose. It contains some heterogeneous simplifications and renaming. In order to ease the review, some comments were added in this PR. --------- Co-authored-by: Florian OMNES <[email protected]> * Document clang-format (AntaresSimulatorTeam#2243) Add version number to avoid confusion. * Link TS generation : splitting into multiple files (AntaresSimulatorTeam#2171) This PR aims at moving some code about link TS generation, from **main** program to new source files. It follows PR AntaresSimulatorTeam#2155 To be done : - [x] move headers (*.h) to the right place - [x] update this branch with its base branch (@flomnes made a change on base branch) We may also take advantage of this PR to : - [ ] Thermal TS generation : - [ ] avoid loading the **whole study** when **no** thermal TS generation is required (this is currently the case) - [ ] move implementation details about thermal TS generation from **main** program to new source files - [ ] Separate loading / extracting data from study and generate the TS --------- Co-authored-by: Florian OMNES <[email protected]> Co-authored-by: Florian OMNES <[email protected]> * Explain why MPS are named when the problem is infeasible (AntaresSimulatorTeam#2250) * Add tests in CI for version 9.2 (AntaresSimulatorTeam#2241) Co-authored-by: Florian OMNES <[email protected]> * Rename test-platform to os for windows CI (AntaresSimulatorTeam#2253) * Fix bug hydro heuristic with mingen (ANT-1825) (AntaresSimulatorTeam#2258) Removing lines that create infeasibility and that are not necessary. --------- Co-authored-by: Juliette-Gerbaux <[email protected]> Co-authored-by: Florian OMNES <[email protected]> * Infeasibility anaylsis : make it more changeable (AntaresSimulatorTeam#2232) Create classes for each constraint type, with a common interface. Additional tests to come. --------- Co-authored-by: Florian OMNES <[email protected]> Co-authored-by: Florian Omnès <[email protected]> * Remove manual dynamic memory usage (AntaresSimulatorTeam#2254) Replaced new[] with vectors Made RunTimeInfos static --------- Co-authored-by: Abdoulbari Zaher <[email protected]> Co-authored-by: Florian Omnès <[email protected]> Co-authored-by: payetvin <[email protected]> Co-authored-by: guilpier-code <[email protected]> Co-authored-by: Florian OMNES <[email protected]> Co-authored-by: Jason Maréchal <[email protected]> Co-authored-by: Juliette-Gerbaux <[email protected]> Co-authored-by: Juliette-Gerbaux <[email protected]>

guilpier-code and others added 5 commits July 2, 2024 17:21

Renaming infeasibility analyzer : renaming in class Constraint

0580371

Renaming infeasibility analyzer : renaming in class InfeasibleProblem…

e46bc1f

…Report

Simplifying infeasibility analyzer

eec4b4f

format

f10c53a

Merge remote-tracking branch 'github/develop' into fix/simplifying-in…

b4f47bd

…feasibility-analyzer

pull-request-size bot added the size/L label Jul 3, 2024

guilpier-code force-pushed the fix/infeasibility-more-cleaning branch from 28afee5 to 8c17df6 Compare July 3, 2024 14:52

New constraint to detect by infeasibility analyzer

644335b

guilpier-code force-pushed the fix/new-constraint-for-infeasibiliy branch from 18232c4 to 644335b Compare July 3, 2024 15:02

guilpier-code added 10 commits July 3, 2024 17:05

Infeasibility - to more changeability : simplification + renaming

b94dfc0

Infeasibility - to more changeability : simplifying function StringBe…

f408ecd

…tweenAngleBrackets

Infeasibility - to more changeability : simplifying functions areaNam…

bb55301

…e() and timeStep()

Infeasibility - to more changeability : renaming Constraint::getType(…

1d58402

…) into type()

Infeasibility - to more changeability : function STSName() ==> simpli…

666201d

…fied and renamed into STSname()

Infeasibility - to more changeability : remove unnecessary comments

499619b

Infeasibility - to more changeability : simplifying function sortCons…

25d3424

…traintsByType() Check on the current constraint's name number of components is useless : it cannot be null.

Infeasibility - to more changeability : in unit tests, change mislead…

3c040c0

…ing BC names

Infeasibility - to more changeability : split constraints logs into 2…

b3fc6f0

… parts (suspicious constraints and infeasibility causes)

Infeasibility - to more changeability : move call to sortConstraintsB…

bbdc230

…yType with his friends

guilpier-code force-pushed the fix/infeasibility-more-cleaning branch from 8c17df6 to bbdc230 Compare July 3, 2024 15:16

Infeasibility - to more changeability : run clang-format

331c1f5

guilpier-code commented Jul 4, 2024

View reviewed changes

guilpier-code requested review from flomnes, sylvlecl and JasonMarechal25 July 4, 2024 07:16

guilpier-code commented Jul 4, 2024

View reviewed changes

guilpier-code marked this pull request as ready for review July 4, 2024 08:29

Base automatically changed from fix/new-constraint-for-infeasibiliy to develop July 8, 2024 08:30

a-zakir reviewed Jul 8, 2024

View reviewed changes

Merge remote-tracking branch 'github/develop' into fix/infeasibility-…

20603f7

…more-cleaning

flomnes approved these changes Jul 9, 2024

View reviewed changes

flomnes merged commit 3fc885a into develop Jul 9, 2024
5 of 7 checks passed

flomnes deleted the fix/infeasibility-more-cleaning branch July 9, 2024 13:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Infeasibility more cleaning #2231

Infeasibility more cleaning #2231

guilpier-code commented Jul 3, 2024 •

edited

Loading

guilpier-code Jul 4, 2024

guilpier-code Jul 4, 2024

guilpier-code Jul 4, 2024

guilpier-code Jul 4, 2024

guilpier-code Jul 4, 2024 •

edited

Loading

guilpier-code Jul 4, 2024

guilpier-code Jul 4, 2024

a-zakir Jul 8, 2024

a-zakir Jul 8, 2024

a-zakir Jul 8, 2024 •

edited

Loading

sonarqubecloud bot commented Jul 9, 2024

Infeasibility more cleaning #2231

Infeasibility more cleaning #2231

Conversation

guilpier-code commented Jul 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guilpier-code Jul 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

a-zakir Jul 8, 2024 • edited Loading

Choose a reason for hiding this comment

sonarqubecloud bot commented Jul 9, 2024

Quality Gate passed

guilpier-code commented Jul 3, 2024 •

edited

Loading

guilpier-code Jul 4, 2024 •

edited

Loading

a-zakir Jul 8, 2024 •

edited

Loading