Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Job sequencing algorithm explanation & implementation added. #2797

Open
wants to merge 21 commits into
base: master
Choose a base branch
from

Conversation

Maahmoudezzat
Copy link

Description of Change

Checklist

A well-formatted and organized Job sequencing algorithm explanation & implementation added applying a greedy approach using the priority_queue data structure.

  • Added description of change
  • Added file name matches File name guidelines
  • Added tests and example, test must pass
  • Added documentation so that the program is self-explanatory and educational - Doxygen guidelines
  • 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:

Copy link
Collaborator

@realstealthninja realstealthninja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for contributing. This has a very nicely written header.
Please do read the contributing.md file and fix the documentation issues with the functions, headers. Please also add tests n a separate function

greedy_algorithms/job_sequencing_algorithm.cpp Outdated Show resolved Hide resolved
greedy_algorithms/job_sequencing_algorithm.cpp Outdated Show resolved Hide resolved
greedy_algorithms/job_sequencing_algorithm.cpp Outdated Show resolved Hide resolved
greedy_algorithms/job_sequencing_algorithm.cpp Outdated Show resolved Hide resolved
@realstealthninja realstealthninja added awaiting modification Do not merge until modifications are made Proper Documentation Required requested to write the documentation properly labels Oct 9, 2024
@Maahmoudezzat
Copy link
Author

Thanks for the review.
I have do the following:

  • A proper documentation for functions and headers as mentioned in the guide.
  • Added tests in the main.

greedy_algorithms/job_sequencing_algorithm.cpp Outdated Show resolved Hide resolved
greedy_algorithms/job_sequencing_algorithm.cpp Outdated Show resolved Hide resolved
greedy_algorithms/job_sequencing_algorithm.cpp Outdated Show resolved Hide resolved
greedy_algorithms/job_sequencing_algorithm.cpp Outdated Show resolved Hide resolved
.vscode/settings.json Outdated Show resolved Hide resolved
greedy_algorithms/job_sequencing_algorithm.cpp Outdated Show resolved Hide resolved
greedy_algorithms/job_sequencing_algorithm.cpp Outdated Show resolved Hide resolved
@Maahmoudezzat
Copy link
Author

@realstealthninja Hey, I'm waiting for your reveiw.

@@ -85,7 +85,6 @@
"xstring": "cpp",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove changes to this file

*
* @param arr array fo Jobs
* @param n number of the jobs in the array
* @returns vector of 'char' including the IDs of jobs
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

template parameter N should be documented

 @ tparam N <describe N> 

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting modification Do not merge until modifications are made Proper Documentation Required requested to write the documentation properly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants