From 3de7aff459b495a514c9dc52d9d019175ff40872 Mon Sep 17 00:00:00 2001 From: Ivan Pribec Date: Tue, 15 Feb 2022 21:42:47 +0100 Subject: [PATCH 1/8] Test Mermaid diagram --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index d53c87b..e365fd2 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,27 @@ This version is a modernization of the original Fortran 77 code. This is a work Further updates are planned... +### Decision tree + +Decision tree for systems of nonlinear equations + +```mermaid +flowchart TB + start(Is the Jacobian matrix available?) + middle1(Is flexibility required?) + middle2(Is flexibility required?) + start --- Yes ---> middle1 + start --- No ---> middle2 + b1(HYBRJ) + b2(HYBRJ1) + b3(HYBRD) + b4(HYBRD1) + middle1 --- Yes ---> b1 + middle1 --- No ---> b2 + middle2 --- Yes ---> b3 + middle2 --- No ---> b3 +``` + ### Documentation * The API documentation for the latest default branch can be found [here](https://fortran-lang.github.io/minpack/). This is generated by processing the source files with [FORD](https://github.com/Fortran-FOSS-Programmers/ford). From eaab6dbf758783086bbc89aef845b1e72f9472b5 Mon Sep 17 00:00:00 2001 From: Ivan Pribec Date: Tue, 15 Feb 2022 21:46:31 +0100 Subject: [PATCH 2/8] Fix attempt --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index e365fd2..618ce74 100644 --- a/README.md +++ b/README.md @@ -28,19 +28,19 @@ Decision tree for systems of nonlinear equations ```mermaid flowchart TB - start(Is the Jacobian matrix available?) - middle1(Is flexibility required?) - middle2(Is flexibility required?) - start --- Yes ---> middle1 - start --- No ---> middle2 - b1(HYBRJ) - b2(HYBRJ1) - b3(HYBRD) - b4(HYBRD1) - middle1 --- Yes ---> b1 - middle1 --- No ---> b2 - middle2 --- Yes ---> b3 - middle2 --- No ---> b3 + start[Is the Jacobian matrix available?] + middle1[Is flexibility required?] + middle2[Is flexibility required?] + start--Yes-->middle1 + start--No-->middle2 + b1[HYBRJ] + b2[HYBRJ1] + b3[HYBRD] + b4[HYBRD1] + middle1---Yes--->b1 + middle1---No--->b2 + middle2---Yes--->b3 + middle2---No--->b3 ``` ### Documentation From 19510c69ed16084d519ae43c8b4b4dc58ab8cb8d Mon Sep 17 00:00:00 2001 From: Ivan Pribec Date: Tue, 15 Feb 2022 21:48:13 +0100 Subject: [PATCH 3/8] Fix mistake --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 618ce74..a7b6f02 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ flowchart TB middle1---Yes--->b1 middle1---No--->b2 middle2---Yes--->b3 - middle2---No--->b3 + middle2---No--->b4 ``` ### Documentation From f2401d67108f023bf318385f180e7105bf46c3be Mon Sep 17 00:00:00 2001 From: Ivan Pribec Date: Tue, 15 Feb 2022 21:50:30 +0100 Subject: [PATCH 4/8] Make shorter --- README.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a7b6f02..ffc60e4 100644 --- a/README.md +++ b/README.md @@ -29,18 +29,12 @@ Decision tree for systems of nonlinear equations ```mermaid flowchart TB start[Is the Jacobian matrix available?] - middle1[Is flexibility required?] - middle2[Is flexibility required?] - start--Yes-->middle1 - start--No-->middle2 - b1[HYBRJ] - b2[HYBRJ1] - b3[HYBRD] - b4[HYBRD1] - middle1---Yes--->b1 - middle1---No--->b2 - middle2---Yes--->b3 - middle2---No--->b4 + start--Yes-->middle1[Is flexibility required?] + start--No-->middle2[Is flexibility required?] + middle1--Yes-->b1[HYBRJ] + middle1--No-->b2[HYBRJ1] + middle2--Yes-->b3[HYBRD] + middle2--No-->b4[HYBRD1] ``` ### Documentation From be4c9946c0bf1be3ad59a9d54b1f6da9507fe36b Mon Sep 17 00:00:00 2001 From: Ivan Pribec Date: Tue, 15 Feb 2022 22:00:45 +0100 Subject: [PATCH 5/8] Add least squares flowchart --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index ffc60e4..ec1fcc5 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,23 @@ flowchart TB middle2--No-->b4[HYBRD1] ``` +Decision tree for nonlinear least squares porblems + +```mermaid +flowchart TB + start[Is the Jacobian matrix available?] + start--Yes-->m1[Is storage limited?] + start--No-->m2[Is flexibility required?] + m1--Yes-->ml1[Is flexibility required?] + m1--No-->ml2[Is flexibility required?] + ml1--Yes-->b1[LMSTR] + ml1--No-->b2[LMSTR1] + ml2--Yes-->b3[LMDER] + ml2--No-->b4[LMDER1] + m2--Yes-->mr1[LMDIF] + m2--No-->mr2[LMDIF1] +``` + ### Documentation * The API documentation for the latest default branch can be found [here](https://fortran-lang.github.io/minpack/). This is generated by processing the source files with [FORD](https://github.com/Fortran-FOSS-Programmers/ford). From 5a8a4e39982b4441555ce8b3572b1435d20efccb Mon Sep 17 00:00:00 2001 From: Ivan Pribec Date: Tue, 15 Feb 2022 22:02:05 +0100 Subject: [PATCH 6/8] Fix typo --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ec1fcc5..564f380 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,9 @@ This version is a modernization of the original Fortran 77 code. This is a work Further updates are planned... -### Decision tree +### Decision trees -Decision tree for systems of nonlinear equations +#### Decision tree for systems of nonlinear equations ```mermaid flowchart TB @@ -37,7 +37,7 @@ flowchart TB middle2--No-->b4[HYBRD1] ``` -Decision tree for nonlinear least squares porblems +#### Decision tree for nonlinear least squares problems ```mermaid flowchart TB From b9426b7d5e524857034ceb94c6432382b570fffc Mon Sep 17 00:00:00 2001 From: Ivan Pribec Date: Tue, 15 Feb 2022 22:05:11 +0100 Subject: [PATCH 7/8] Make names lowercase --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 564f380..2471c6d 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,10 @@ flowchart TB start[Is the Jacobian matrix available?] start--Yes-->middle1[Is flexibility required?] start--No-->middle2[Is flexibility required?] - middle1--Yes-->b1[HYBRJ] - middle1--No-->b2[HYBRJ1] - middle2--Yes-->b3[HYBRD] - middle2--No-->b4[HYBRD1] + middle1--Yes-->b1[hybrj] + middle1--No-->b2[hybrj1] + middle2--Yes-->b3[hybrd] + middle2--No-->b4[hybrd1] ``` #### Decision tree for nonlinear least squares problems @@ -46,12 +46,12 @@ flowchart TB start--No-->m2[Is flexibility required?] m1--Yes-->ml1[Is flexibility required?] m1--No-->ml2[Is flexibility required?] - ml1--Yes-->b1[LMSTR] - ml1--No-->b2[LMSTR1] - ml2--Yes-->b3[LMDER] - ml2--No-->b4[LMDER1] - m2--Yes-->mr1[LMDIF] - m2--No-->mr2[LMDIF1] + ml1--Yes-->b1[lmstr] + ml1--No-->b2[lmstr1] + ml2--Yes-->b3[lmder] + ml2--No-->b4[lmder1] + m2--Yes-->mr1[lmdif] + m2--No-->mr2[lmdif1] ``` ### Documentation From f3ed848001ac38cc21a32682e756ac71f03c52fa Mon Sep 17 00:00:00 2001 From: Sebastian Ehlert <28669218+awvwgk@users.noreply.github.com> Date: Sun, 20 Feb 2022 16:40:17 +0100 Subject: [PATCH 8/8] Add links to diagrams --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2471c6d..5d10e5a 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,10 @@ flowchart TB start[Is the Jacobian matrix available?] start--Yes-->middle1[Is flexibility required?] start--No-->middle2[Is flexibility required?] - middle1--Yes-->b1[hybrj] - middle1--No-->b2[hybrj1] - middle2--Yes-->b3[hybrd] - middle2--No-->b4[hybrd1] + middle1--Yes-->b1[hybrj] + middle1--No-->b2[hybrj1] + middle2--Yes-->b3[hybrd] + middle2--No-->b4[hybrd1] ``` #### Decision tree for nonlinear least squares problems @@ -46,12 +46,12 @@ flowchart TB start--No-->m2[Is flexibility required?] m1--Yes-->ml1[Is flexibility required?] m1--No-->ml2[Is flexibility required?] - ml1--Yes-->b1[lmstr] - ml1--No-->b2[lmstr1] - ml2--Yes-->b3[lmder] - ml2--No-->b4[lmder1] - m2--Yes-->mr1[lmdif] - m2--No-->mr2[lmdif1] + ml1--Yes-->b1[lmstr] + ml1--No-->b2[lmstr1] + ml2--Yes-->b3[lmder] + ml2--No-->b4[lmder1] + m2--Yes-->mr1[lmdif] + m2--No-->mr2[lmdif1] ``` ### Documentation