feat: added a new algorithm to find whether two line segment intersec… #796

meSajied · 2020-05-26T13:19:04Z

…t or not

Description of Change

Checklist

Added description of change
Added file name matches File name guidelines
Added tests and example, test must pass
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.
Sort by alphabetical order
I acknowledge that all my contributions will be made under the project's license.

Notes:

…t or not

ayaankhan98 · 2020-05-26T17:47:56Z

geometry/line_segment_intersection.cpp

@@ -0,0 +1,63 @@
+#include <bits/stdc++.h>


don't use <bits/stdc++.h>

ayaankhan98 · 2020-05-26T17:48:45Z

geometry/line_segment_intersection.cpp

+#include <bits/stdc++.h>
+using namespace std;
+
+class Point{


you can use a struct if all the members are public

ayaankhan98

cpplint_modified_files is failling

geometry/line_segment_intersection.cpp:2:  Do not use namespace using-directives.  Use using-declarations instead.  [build/namespaces] [5]
geometry/line_segment_intersection.cpp:5:  public: should be indented +1 space inside class Point  [whitespace/indent] [3]
geometry/line_segment_intersection.cpp:10:  public: should be indented +1 space inside class SegmentIntersection  [whitespace/indent] [3]
geometry/line_segment_intersection.cpp:11:  Lines should be <= 80 characters long  [whitespace/line_length] [2]
geometry/line_segment_intersection.cpp:11:  Missing space before {  [whitespace/braces] [5]
geometry/line_segment_intersection.cpp:13:  Lines should be <= 80 characters long  [whitespace/line_length] [2]
geometry/line_segment_intersection.cpp:17:  Line ends in whitespace.  Consider deleting these extra spaces.  [whitespace/end_of_line] [4]
geometry/line_segment_intersection.cpp:17:  Lines should be <= 80 characters long  [whitespace/line_length] [2]
geometry/line_segment_intersection.cpp:18:  Lines should be <= 80 characters long  [whitespace/line_length] [2]
geometry/line_segment_intersection.cpp:20:  Line ends in whitespace.  Consider deleting these extra spaces.  [whitespace/end_of_line] [4]
geometry/line_segment_intersection.cpp:21:  Lines should be <= 80 characters long  [whitespace/line_length] [2]
geometry/line_segment_intersection.cpp:23:  Line ends in whitespace.  Consider deleting these extra spaces.  [whitespace/end_of_line] [4]
geometry/line_segment_intersection.cpp:24:  Lines should be <= 80 characters long  [whitespace/line_length] [2]
geometry/line_segment_intersection.cpp:26:  Line ends in whitespace.  Consider deleting these extra spaces.  [whitespace/end_of_line] [4]
geometry/line_segment_intersection.cpp:27:  Lines should be <= 80 characters long  [whitespace/line_length] [2]
geometry/line_segment_intersection.cpp:29:  Line ends in whitespace.  Consider deleting these extra spaces.  [whitespace/end_of_line] [4]
geometry/line_segment_intersection.cpp:30:  Lines should be <= 80 characters long  [whitespace/line_length] [2]
geometry/line_segment_intersection.cpp:32:  Line ends in whitespace.  Consider deleting these extra spaces.  [whitespace/end_of_line] [4]
geometry/line_segment_intersection.cpp:37:  Lines should be <= 80 characters long  [whitespace/line_length] [2]
geometry/line_segment_intersection.cpp:37:  Missing space before {  [whitespace/braces] [5]
geometry/line_segment_intersection.cpp:38:  Line ends in whitespace.  Consider deleting these extra spaces.  [whitespace/end_of_line] [4]
geometry/line_segment_intersection.cpp:38:  Lines should be <= 80 characters long  [whitespace/line_length] [2]
geometry/line_segment_intersection.cpp:39:  Lines should be <= 80 characters long  [whitespace/line_length] [2]
geometry/line_segment_intersection.cpp:42:  Lines should be <= 80 characters long  [whitespace/line_length] [2]
geometry/line_segment_intersection.cpp:43:  Line ends in whitespace.  Consider deleting these extra spaces.  [whitespace/end_of_line] [4]

kvedala

repository is meant for educational purposes and hence, the codes submitted must be educative i.e., others should be able to read and learn from them. This would require the code to be documented as much as possible.
please ensure that you have performed the sanity checks mentioned in the pull request template. one of them is to READ the CONTRIBUTIONS.md file. Therein is a mention that the files should conform to cpplint and all the help for the same is also mentioned.
Please review the protocols and make the necessary corrections.

kvedala · 2020-05-26T23:54:01Z

geometry/line_segment_intersection.cpp

@@ -0,0 +1,63 @@
+#include <bits/stdc++.h>
+using namespace std;


fails cpplint. must be removed.

kvedala · 2020-05-26T23:55:03Z

geometry/line_segment_intersection.cpp

+    int x, y;
+};
+
+class SegmentIntersection{


document your code.

ayaankhan98

this all looks good but do one more thing add a breif documentation for each function, it will help the reader to understand the code in better way

kvedala · 2020-05-28T13:19:36Z

Please see the file search/binary_search.h for example of documentation.

kvedala · 2020-05-29T12:35:47Z

This looks much better, thank you.
Now, can you structure it in the doxygen-format as shown in search/binary_search.h and described here. This will help the system to automatically build documentation like this: https://kvedala.github.io/C-Plus-Plus without manual intervention.

kvedala · 2020-05-29T13:54:16Z

Excellent. Now, the beginning of the file should contain a comment block like so:

/**
 * \file
 * \brief -- Brief one line comment here
 * \description -- optional multiline large description here
 */

kvedala · 2020-05-29T13:56:16Z

also, the comment blocks should go just above the function declaration

kvedala · 2020-05-29T13:56:58Z

geometry/line_segment_intersection.cpp

+    int x, y;
+};
+
+struct SegmentIntersection {


this struct is undocumented

kvedala · 2020-05-29T13:58:39Z

geometry/line_segment_intersection.cpp

@@ -0,0 +1,88 @@
+#include <iostream>
+
+struct Point {


struct is undocumented.
you can add a brief comment like so: others/smallest_circle

kvedala · 2020-05-29T13:59:40Z

geometry/line_segment_intersection.cpp

+struct SegmentIntersection {
+    inline bool intersect(Point first_point, Point second_point,
+                                    Point third_point, Point forth_point) {
+       /**


comment blocks should go above the function name i.e. for example, the comment block between lines 10-14 should be just above line 8.

kvedala · 2020-05-29T14:00:06Z

geometry/line_segment_intersection.cpp

+
+    inline int direction(Point first_point, Point second_point,
+                                                    Point third_point) {
+       /**


same - comment block from lines 46-54 should be at line 44.

kvedala · 2020-05-29T14:00:26Z

geometry/line_segment_intersection.cpp

+    }
+};
+
+int main() {


document the main function. a simple one-liner is good

kvedala

there should be a one line gap between end of a previous code and start of a new comment/code. But the cpplint does not seem to give any errors regarding that. So, I approve as well.

Good work, @meSajied Thank you

meSajied · 2020-05-30T08:44:02Z

Can you merge this pull request now @kvedala??

ayaankhan98 · 2020-05-30T10:08:40Z

geometry/line_segment_intersection.cpp

+            return false;
+    }
+};
+/*


Suggested change

/*

/**

ayaankhan98 · 2020-05-30T10:09:01Z

geometry/line_segment_intersection.cpp

+ * or not.
+ */
+#include <iostream>
+/*


Suggested change

/*

/**

ayaankhan98

everything else looks good

meSajied · 2020-05-30T14:56:26Z

I think everything is good now.... @ayaankhan98

ayaankhan98

yes looks fine

kvedala · 2020-05-31T13:53:41Z

Reason why we need a robust CI - build fails on windows due to missing #include <algorothm> for the functions std::max and std::min

meSajied · 2020-06-01T15:24:51Z

But now pull request is merged... @kvedala

kvedala · 2020-06-01T15:32:43Z

you can recreate a pull request with corrections. If you make a pull request - here, it will compile and check your code automatically

but I have already fixed your code there. Thats how I found out. Otherwise, it is impossible for one man to compile and check each every one of 100+ programs

feat: added a new algorithm to find whether two line segment intersec…

41df377

…t or not

ayaankhan98 reviewed May 26, 2020

View reviewed changes

geometry/line_segment_intersection.cpp Outdated

@@ -0,0 +1,63 @@

#include <bits/stdc++.h>

Copy link

Member

ayaankhan98 May 26, 2020

Choose a reason for hiding this comment

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

don't use <bits/stdc++.h>

ayaankhan98 reviewed May 26, 2020

View reviewed changes

ayaankhan98 added the automated tests are failing Do not merge until tests pass label May 26, 2020

kvedala requested changes May 26, 2020

View reviewed changes

deadshotsb added the awaiting modification Do not merge until modifications are made label May 27, 2020

fix: cpplint issues

f1cd848

meSajied requested a review from ayaankhan98 May 27, 2020 13:28

ayaankhan98 approved these changes May 27, 2020

View reviewed changes

meSajied added 2 commits May 28, 2020 17:34

added documentation.....

56ea92e

added documentation....

56ded89

added documentation...

1ecd631

added doxygen format....

e66c5a8

kvedala reviewed May 29, 2020

View reviewed changes

geometry/line_segment_intersection.cpp

int x, y;

};

struct SegmentIntersection {

Copy link

Collaborator

kvedala May 29, 2020

Choose a reason for hiding this comment

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

this struct is undocumented

kvedala reviewed May 29, 2020

View reviewed changes

geometry/line_segment_intersection.cpp

}

};

int main() {

Copy link

Collaborator

kvedala May 29, 2020

Choose a reason for hiding this comment

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

document the main function. a simple one-liner is good

meSajied added 3 commits May 29, 2020 20:23

fix: comment blocks...

84531fb

fix: cpplint issue

6f3923d

fix: cpplint issues...

3e15e82

kvedala approved these changes May 29, 2020

View reviewed changes

meSajied added 2 commits May 29, 2020 21:35

fix: comment spaces...

165a30c

fix: additional spaces...

8243864

ayaankhan98 removed automated tests are failing Do not merge until tests pass awaiting modification Do not merge until modifications are made labels May 30, 2020

ayaankhan98 reviewed May 30, 2020

View reviewed changes

geometry/line_segment_intersection.cpp Outdated

return false;

}

};

/*

Copy link

Member

ayaankhan98 May 30, 2020

Choose a reason for hiding this comment

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

Suggested change

/*

/**

ayaankhan98 reviewed May 30, 2020

View reviewed changes

geometry/line_segment_intersection.cpp Outdated

* or not.

*/

#include <iostream>

/*

Copy link

Member

ayaankhan98 May 30, 2020

Choose a reason for hiding this comment

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

Suggested change

/*

/**

ayaankhan98 reviewed May 30, 2020

View reviewed changes

fix: documentation issue

1540a6c

ayaankhan98 approved these changes May 30, 2020

View reviewed changes

ayaankhan98 merged commit 0eedbb3 into TheAlgorithms:master May 30, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: added a new algorithm to find whether two line segment intersec… #796

feat: added a new algorithm to find whether two line segment intersec… #796

meSajied commented May 26, 2020 •

edited

Loading

ayaankhan98 May 26, 2020

ayaankhan98 May 26, 2020

ayaankhan98 left a comment •

edited

Loading

kvedala left a comment

kvedala May 26, 2020

kvedala May 26, 2020

ayaankhan98 left a comment •

edited

Loading

kvedala commented May 28, 2020 •

edited

Loading

kvedala commented May 29, 2020

kvedala commented May 29, 2020

kvedala commented May 29, 2020

kvedala May 29, 2020

kvedala May 29, 2020

kvedala May 29, 2020

kvedala May 29, 2020

kvedala May 29, 2020

kvedala left a comment

meSajied commented May 30, 2020 •

edited by cclauss

Loading

ayaankhan98 May 30, 2020

ayaankhan98 May 30, 2020

ayaankhan98 left a comment

meSajied commented May 30, 2020 •

edited

Loading

ayaankhan98 left a comment

kvedala commented May 31, 2020

meSajied commented Jun 1, 2020

kvedala commented Jun 1, 2020 •

edited

Loading

		@@ -0,0 +1,63 @@
		#include <bits/stdc++.h>
		using namespace std;

feat: added a new algorithm to find whether two line segment intersec… #796

feat: added a new algorithm to find whether two line segment intersec… #796

Conversation

meSajied commented May 26, 2020 • edited Loading

Description of Change

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ayaankhan98 left a comment • edited Loading

Choose a reason for hiding this comment

kvedala left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ayaankhan98 left a comment • edited Loading

Choose a reason for hiding this comment

kvedala commented May 28, 2020 • edited Loading

kvedala commented May 29, 2020

kvedala commented May 29, 2020

kvedala commented May 29, 2020

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

kvedala left a comment

Choose a reason for hiding this comment

meSajied commented May 30, 2020 • edited by cclauss Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ayaankhan98 left a comment

Choose a reason for hiding this comment

meSajied commented May 30, 2020 • edited Loading

ayaankhan98 left a comment

Choose a reason for hiding this comment

kvedala commented May 31, 2020

meSajied commented Jun 1, 2020

kvedala commented Jun 1, 2020 • edited Loading

meSajied commented May 26, 2020 •

edited

Loading

ayaankhan98 left a comment •

edited

Loading

ayaankhan98 left a comment •

edited

Loading

kvedala commented May 28, 2020 •

edited

Loading

meSajied commented May 30, 2020 •

edited by cclauss

Loading

meSajied commented May 30, 2020 •

edited

Loading

kvedala commented Jun 1, 2020 •

edited

Loading