[fix/docs]: Update backtracking folder #916

Panquesito7 · 2020-06-26T20:16:31Z

Description of Change

Add backtracking folder to CMake build-chain
Update various files in the backtracking folder with refined code and documentation

Checklist

Added description of change
Relevant documentation/comments is changed or added
PR title follows semantic commit guidelines
Search previous suggestions before making a new one, as yours may be a duplicate.
I acknowledge that all my contributions will be made under the project's license.

Notes: Didn't split commits. If requested, I can split, but will take more time.

kvedala · 2020-06-26T20:23:28Z

Too many files and a lot of corrections will come.
If we pick one file at a time, we can do a much better job in improving the code.
Too many files will make the process extremely inefficient.

Panquesito7 · 2020-06-26T23:48:12Z

Done, only updated backtracking/graph_coloring. 🙂

kvedala · 2020-06-27T00:30:33Z

excellent. I see good update.

fix documentation in this code
you'd need to let CMake know about this folder. This requires following steps:
1. copy CMakeLists.txt (do not change to small-caps) exactly from math folder and paste it in backtracking folder
2. on line# 16, change destination folder from bin/math to bin/backtracking
3. open CMakeLists.txt in root folder, add the following line between probability and data_structures.

add_subdirectory(backtracking)

Done. Commit and push. We will ensure the compilation works well.
You can use the link: https://gitpod.io/#https://github.com/TheAlgorithms/C-Plus-Plus/pull/916 to compile the code online and even compile the documentation and view it to ensure all is well.

Panquesito7 · 2020-06-27T00:34:40Z

Done.

kvedala · 2020-06-27T00:40:19Z

now starts your bug-fixing process 😏

kvedala · 2020-06-27T00:45:48Z

As an active contributor, request to you:
use the link above and execute the program, check the output on gitpod. If the output is ok, then implement them as self-tests

lgtm-com · 2020-06-27T00:48:55Z

This pull request introduces 1 alert when merging 6db5bfa into eddda4e - view on LGTM.com

new alerts:

1 for Short global name

Panquesito7 · 2020-06-27T01:18:36Z

I didn't figured out how to compile it there.
So, I compiled it on my machine with VS 2019.

The results are:

Following are the assigned colors
1232
Following are the assigned colors
1323
Following are the assigned colors
2131
Following are the assigned colors
2313
Following are the assigned colors
3121
Following are the assigned colors
3212

Is that correct? I got a bit confused.

kvedala · 2020-06-28T02:11:47Z

The errors reported are in a different file. So, next, fix that file in this same Pull-request

Panquesito7 · 2020-06-28T18:03:07Z

Issues should be solved now, thanks! 🙂

lgtm-com · 2020-06-28T18:12:04Z

This pull request introduces 1 alert when merging 5138881 into f87bc25 - view on LGTM.com

new alerts:

1 for Short global name

kvedala · 2020-06-29T21:36:59Z

This pull request introduces 1 alert when merging 5138881 into f87bc25 - view on LGTM.com

new alerts:

1 for Short global name

please remove global variables. Pass variables as function arguments or better, organize them as private members of a class

kvedala · 2020-06-29T22:32:58Z

please avoid force-push.

backtracking/sudoku_solve.cpp

Note: This is identical to passing it as a function parameter, and may not be helpful

make the code neat and clean without global variables

kvedala · 2020-08-01T14:11:59Z

Looks much better. Now, check and fix the documentations for function parameters in kignt's tour program.

Panquesito7 · 2020-08-02T20:55:09Z

fix the documentations for function parameters

Updated. Please review the file.

kvedala · 2020-08-02T22:57:57Z

backtracking/sudoku_solve.cpp

+ *
+ * @details
+ * Sudoku (数独, sūdoku, digit-single) (/suːˈdoʊkuː/, /-ˈdɒk-/, /sə-/, originally called
+ * Number Place)[1] is a logic-based,[2][3] combinatorial[4] number-placement puzzle. 


There are many sudoku solving algorithms. Which method is this?
I think it is the brute-force method.

The wikipedia copy paste is unnecessary here - and is called plagiarism if not cited properly.

Good point; what kind of description shall we add here?

kvedala · 2020-08-02T23:00:48Z

fix the documentations for function parameters

Updated. Please review the file.

Please check the other files for similar issues.

kvedala

review my comment above: [fix/docs]: Update backtracking folder #916 (comment)
some of the function documentations in sudoku solver are still stubs.

Panquesito7 · 2020-08-03T03:05:22Z

backtracking/sudoku_solve.cpp

+ * @param mat matrix where numbers are saved
+ * @param i current index in rows
+ * @param j current index in columns
+ * @param no number to be added in matrix


I think this is the only thing that is missing good documentation.

* @param no number to be added in matrix

Is there anything else that needs to be changed/fixed?

Panquesito7 · 2020-08-04T17:27:13Z

@kvedala all seems to be fine to me (except the review comment above).
What if we merge this, and continue working on it in another PR?

backtracking/sudoku_solve.cpp

File taken and modified from https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/backtracking/minimax.cpp. I improved that algorithm previously (see TheAlgorithms/C-Plus-Plus#916).

[fix/docs]: Update backtracking/graph_coloring.cpp

ea66bc1

Panquesito7 force-pushed the backtracking_updates branch from aea386e to ea66bc1 Compare June 26, 2020 23:47

Panquesito7 changed the title ~~[fix/docs]: Update the backtracking folder~~ [fix/docs]: Update backtracking/graph_coloring.cpp Jun 26, 2020

Panquesito7 added 2 commits June 26, 2020 19:33

Add CMakeLists.txt in backtracking folder

b3b4538

Add backtracking to CMakeLists.txt

3ae5043

fix: Fix build issues

3c4625f

docs: Various documentation fixes

6db5bfa

fix: minimax.cpp issues

94f62b2

fix: sudoku_solve.cpp fixes

8ffbbb3

Panquesito7 force-pushed the backtracking_updates branch from 5138881 to 8ffbbb3 Compare June 29, 2020 22:30

formatting source-code for 8ffbbb3

fb93557

kvedala reviewed Jun 29, 2020

View reviewed changes

backtracking/sudoku_solve.cpp Outdated Show resolved Hide resolved

kvedala changed the title ~~[fix/docs]: Update backtracking/graph_coloring.cpp~~ [fix/docs]: Update backtracking folder Jun 29, 2020

kvedala and others added 4 commits June 29, 2020 19:05

make he code neat and clean without global variables

5a030a4

fix 2 stars in comment

11ac67c

fix MSVC errors by forcing template parameter in function calls

2787dea

Note: This is identical to passing it as a function parameter, and may not be helpful

Merge pull request #11 from kvedala/kvedala

69e1c3e

make the code neat and clean without global variables

docs: Documentation improvements (knight_tour.cpp)

51ad4f0

Panquesito7 removed the automated tests are failing Do not merge until tests pass label Aug 2, 2020

kvedala reviewed Aug 2, 2020

View reviewed changes

Panquesito7 added 3 commits August 2, 2020 18:07

docs: Documentation improvements (sudoku_solve.cpp)

1581fdf

docs: Documentation improvements (minimax.cpp)

974d1f7

docs: More documentation improvements (minimax.cpp)

0de86c6

Panquesito7 requested a review from kvedala August 3, 2020 00:13

kvedala requested changes Aug 3, 2020

View reviewed changes

docs: Documentation improvements (sudoku_solve.cpp)

bf3e0e4

Panquesito7 force-pushed the backtracking_updates branch from 168e7cf to bf3e0e4 Compare August 3, 2020 02:21

Panquesito7 commented Aug 3, 2020

View reviewed changes

Panquesito7 added the Improvement improvement in previously written codes label Aug 3, 2020

kvedala mentioned this pull request Aug 3, 2020

fhlasek/fixgraph: refactor of graph/ to follow the linter style #986

Merged

6 tasks

Panquesito7 requested a review from kvedala August 7, 2020 00:21

kvedala reviewed Aug 7, 2020

View reviewed changes

backtracking/sudoku_solve.cpp Outdated Show resolved Hide resolved

fix: sudoku_solve.cpp improvements

81e43da

Panquesito7 requested a review from kvedala August 7, 2020 18:11

kvedala merged commit 25b39a3 into TheAlgorithms:master Aug 7, 2020

Panquesito7 added the approved Approved; waiting for merge label Aug 7, 2020

Panquesito7 deleted the backtracking_updates branch August 7, 2020 19:04

Panquesito7 mentioned this pull request Aug 9, 2020

[fix/docs]: Improve backtracking/n_queens.cpp #1000

Merged

5 tasks

tinouduart33 mentioned this pull request Jan 31, 2021

feat: Get a trace of all of the allocations, using a doubly linked list and wrappers for malloc/calloc and free. TheAlgorithms/C#782

Merged

Panquesito7 mentioned this pull request Mar 12, 2021

feat: Add Backtracking Minimax implementation in C++ OpenGenus/cosmos#6062

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[fix/docs]: Update backtracking folder #916

[fix/docs]: Update backtracking folder #916

Panquesito7 commented Jun 26, 2020 •

edited by gitpod-io bot

Loading

kvedala commented Jun 26, 2020 •

edited

Loading

Panquesito7 commented Jun 26, 2020 •

edited

Loading

kvedala commented Jun 27, 2020 •

edited

Loading

Panquesito7 commented Jun 27, 2020

kvedala commented Jun 27, 2020 •

edited

Loading

kvedala commented Jun 27, 2020

lgtm-com bot commented Jun 27, 2020

Panquesito7 commented Jun 27, 2020

kvedala commented Jun 28, 2020

Panquesito7 commented Jun 28, 2020

lgtm-com bot commented Jun 28, 2020

kvedala commented Jun 29, 2020

kvedala commented Jun 29, 2020

kvedala commented Aug 1, 2020

Panquesito7 commented Aug 2, 2020

kvedala Aug 2, 2020 •

edited

Loading

Panquesito7 Aug 3, 2020

kvedala commented Aug 2, 2020

kvedala left a comment

Panquesito7 Aug 3, 2020 •

edited

Loading

Panquesito7 commented Aug 4, 2020

[fix/docs]: Update backtracking folder #916

[fix/docs]: Update backtracking folder #916

Conversation

Panquesito7 commented Jun 26, 2020 • edited by gitpod-io bot Loading

Description of Change

Checklist

kvedala commented Jun 26, 2020 • edited Loading

Panquesito7 commented Jun 26, 2020 • edited Loading

kvedala commented Jun 27, 2020 • edited Loading

Panquesito7 commented Jun 27, 2020

kvedala commented Jun 27, 2020 • edited Loading

kvedala commented Jun 27, 2020

lgtm-com bot commented Jun 27, 2020

Panquesito7 commented Jun 27, 2020

kvedala commented Jun 28, 2020

Panquesito7 commented Jun 28, 2020

lgtm-com bot commented Jun 28, 2020

kvedala commented Jun 29, 2020

kvedala commented Jun 29, 2020

kvedala commented Aug 1, 2020

Panquesito7 commented Aug 2, 2020

kvedala Aug 2, 2020 • edited Loading

Choose a reason for hiding this comment

Panquesito7 Aug 3, 2020

Choose a reason for hiding this comment

kvedala commented Aug 2, 2020

kvedala left a comment

Choose a reason for hiding this comment

Panquesito7 Aug 3, 2020 • edited Loading

Choose a reason for hiding this comment

Panquesito7 commented Aug 4, 2020

Panquesito7 commented Jun 26, 2020 •

edited by gitpod-io bot

Loading

kvedala commented Jun 26, 2020 •

edited

Loading

Panquesito7 commented Jun 26, 2020 •

edited

Loading

kvedala commented Jun 27, 2020 •

edited

Loading

kvedala commented Jun 27, 2020 •

edited

Loading

kvedala Aug 2, 2020 •

edited

Loading

Panquesito7 Aug 3, 2020 •

edited

Loading