feat: added a program to check a number is perfect square or not #1412

AmanDeep-21 · 2020-10-29T19:17:29Z

Description of Change

Created a program to check a number is a perfect square or not

Checklist

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:

Marinovsky · 2020-10-29T20:54:57Z

This can be done easier by checking only whether the number modulo four equals zero or one. Indeed, this is a theorem from Number Theory that says that every perfect square has the form 4k+1 or 4k and k is an integer.

Panquesito7

Please enable GitHub Actions in your repository of this fork in this link: https://github.com/AmanDeep-21/C-Plus-Plus/actions

math/check_perfect_square.cpp

AmanDeep-21 · 2020-10-30T10:17:40Z

This can be done easier by checking only whether the number modulo four equals zero or one. Indeed, this is a theorem from Number Theory that says that every perfect square has the form 4k+1 or 4k and k is an integer.

I agree that perfect squares are of the form 4k or 4k+1 where k belongs to non-negative integers, but it does not guarantee that if a number is of the form 4k or 4k+1, then its definitely a perfect square, for instance, 13,17,21,24,28,29,32,33 all these numbers follow either 4k or 4k+1 case, but none of them is a perfect square.

Marinovsky · 2020-10-30T14:36:23Z

This can be done easier by checking only whether the number modulo four equals zero or one. Indeed, this is a theorem from Number Theory that says that every perfect square has the form 4k+1 or 4k and k is an integer.

I agree that perfect squares are of the form 4k or 4k+1 where k belongs to non-negative integers, but it does not guarantee that if a number is of the form 4k or 4k+1, then its definitely a perfect square, for instance, 13,17,21,24,28,29,32,33 all these numbers follow either 4k or 4k+1 case, but none of them is a perfect square.

Yeah, It's true, sorry for that.

math/check_perfect_square.cpp

AmanDeep-21 · 2020-10-31T05:06:54Z

This can be done easier by checking only whether the number modulo four equals zero or one. Indeed, this is a theorem from Number Theory that says that every perfect square has the form 4k+1 or 4k and k is an integer.

I agree that perfect squares are of the form 4k or 4k+1 where k belongs to non-negative integers, but it does not guarantee that if a number is of the form 4k or 4k+1, then its definitely a perfect square, for instance, 13,17,21,24,28,29,32,33 all these numbers follow either 4k or 4k+1 case, but none of them is a perfect square.

Yeah, It's true, sorry for that.

No issues

Panquesito7

Please enable GitHub Actions in your repository of this fork in this link: https://github.com/AmanDeep-21/C-Plus-Plus/actions

Panquesito7 · 2020-11-01T21:44:04Z

math/check_perfect_square.cpp

+#include <cassert>          // for assert
+#include <iostream>         // for io operations


Suggested change

#include <cassert> // for assert

#include <iostream> // for io operations

#include <cassert> /// for assert

#include <iostream> /// for io operations

Panquesito7 · 2020-11-01T21:46:29Z

math/check_perfect_square.cpp

@@ -0,0 +1,117 @@
+/**
+ * @file
+ * @brief This program aims at checking that the given number is perfect square or not


Suggested change

* @brief This program aims at checking that the given number is perfect square or not

* @brief This program aims at checking that the given number is [perfect square](https://leetcode.com/problems/perfect-squares/) or not

Panquesito7 · 2020-11-01T21:46:50Z

math/check_perfect_square.cpp

+#include <cassert>          // for assert
+#include <iostream>         // for io operations
+
+/**


Suggested change

/**

/**

* @namespace math

* @brief Mathematical algorithms

*/

namespace math {

/**

* @namespace check_perfect_square

* @brief Functions for [Perfect Square](https://leetcode.com/problems/perfect-squares/) implementation

*/

namespace check_perfect_square {

/**

Panquesito7 · 2020-11-01T21:48:32Z

math/check_perfect_square.cpp

+
+    int64_t value = get_integral_square_root(num);
+    return value * value == num;
+}


Suggested change

}

}

} // namespace check_perfect_square

} // namespace math

Panquesito7 · 2020-11-01T21:48:47Z

math/check_perfect_square.cpp

+ * @returns void
+ */
+static void test1(){
+    int64_t test_case_1 = check_perfect_square(-4);


Suggested change

int64_t test_case_1 = check_perfect_square(-4);

int64_t test_case_1 = math::check_perfect_square::check_perfect_square(-4);

Panquesito7 · 2020-11-01T21:48:51Z

math/check_perfect_square.cpp

+ * @returns void
+ */
+static void test2(){
+    int64_t test_case_2 = check_perfect_square(1);


Suggested change

int64_t test_case_2 = check_perfect_square(1);

int64_t test_case_2 = math::check_perfect_square::check_perfect_square(1);

Panquesito7 · 2020-11-01T21:48:55Z

math/check_perfect_square.cpp

+ * @returns void
+ */
+static void test3(){
+    int64_t test_case_3 = check_perfect_square(2);


Suggested change

int64_t test_case_3 = check_perfect_square(2);

int64_t test_case_3 = math::check_perfect_square::check_perfect_square(2);

Panquesito7 · 2020-11-01T21:48:59Z

math/check_perfect_square.cpp

+ * @returns void
+ */
+static void test4(){
+    int64_t test_case_4 = check_perfect_square(4);


Suggested change

int64_t test_case_4 = check_perfect_square(4);

int64_t test_case_4 = math::check_perfect_square::check_perfect_square(4);

Panquesito7 · 2020-11-01T21:49:02Z

math/check_perfect_square.cpp

+ * @returns void
+ */
+static void test5(){
+    int64_t test_case_5 = check_perfect_square(8);


Suggested change

int64_t test_case_5 = check_perfect_square(8);

int64_t test_case_5 = math::check_perfect_square::check_perfect_square(8);

Panquesito7 · 2020-11-01T21:49:18Z

math/check_perfect_square.cpp

+ * @returns 0 on exit
+ */
+int main() {
+    test();


Suggested change

test();

test(); // execute the tests

stale · 2021-07-08T08:42:21Z

This pull request has been automatically marked as abandoned because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale · 2021-07-21T16:42:43Z

Please ping one of the maintainers once you commit the changes requested or make improvements on the code. If this is not the case and you need some help, feel free to ask for help in our Gitter channel. Thank you for your contributions!

added a program to check a number is perfect square or not

0dd1363

Panquesito7 added the enhancement New feature or request label Oct 29, 2020

Panquesito7 requested changes Oct 29, 2020

View reviewed changes

Panquesito7 added the requested changes changes have been requested label Oct 29, 2020

added requested changes

44f833c

AmanDeep-21 requested a review from Panquesito7 October 30, 2020 10:20

Panquesito7 changed the title ~~added a program to check a number is perfect square or not~~ feat: added a program to check a number is perfect square or not Oct 30, 2020

Panquesito7 reviewed Oct 30, 2020

View reviewed changes

math/check_perfect_square.cpp Outdated Show resolved Hide resolved

changed int to int64_t

5bb877d

AmanDeep-21 requested a review from Panquesito7 October 31, 2020 05:16

Panquesito7 requested changes Nov 1, 2020

View reviewed changes

stale bot added the stale Author has not responded to the comments for over 2 weeks label Jul 8, 2021

stale bot closed this Jul 21, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: added a program to check a number is perfect square or not #1412

feat: added a program to check a number is perfect square or not #1412

AmanDeep-21 commented Oct 29, 2020 •

edited by gitpod-io bot

Loading

Marinovsky commented Oct 29, 2020

Panquesito7 left a comment

AmanDeep-21 commented Oct 30, 2020

Marinovsky commented Oct 30, 2020

AmanDeep-21 commented Oct 31, 2020

Panquesito7 left a comment

Panquesito7 Nov 1, 2020

Panquesito7 Nov 1, 2020

Panquesito7 Nov 1, 2020

Panquesito7 Nov 1, 2020

Panquesito7 Nov 1, 2020

Panquesito7 Nov 1, 2020

Panquesito7 Nov 1, 2020

Panquesito7 Nov 1, 2020

Panquesito7 Nov 1, 2020

Panquesito7 Nov 1, 2020

stale bot commented Jul 8, 2021

stale bot commented Jul 21, 2021

		#include <cassert> // for assert
		#include <iostream> // for io operations

	* @brief This program aims at checking that the given number is perfect square or not
	* @brief This program aims at checking that the given number is [perfect square](https://leetcode.com/problems/perfect-squares/) or not

-/**
+/**
+ * @namespace math
+ * @brief Mathematical algorithms
+ */
+namespace math {
+/**
+ * @namespace check_perfect_square
+ * @brief Functions for [Perfect Square](https://leetcode.com/problems/perfect-squares/) implementation
+ */
+namespace check_perfect_square {
+/**

-}
+}
+}  // namespace check_perfect_square
+}  // namespace math

	int64_t test_case_1 = check_perfect_square(-4);
	int64_t test_case_1 = math::check_perfect_square::check_perfect_square(-4);

	int64_t test_case_2 = check_perfect_square(1);
	int64_t test_case_2 = math::check_perfect_square::check_perfect_square(1);

	int64_t test_case_3 = check_perfect_square(2);
	int64_t test_case_3 = math::check_perfect_square::check_perfect_square(2);

	int64_t test_case_4 = check_perfect_square(4);
	int64_t test_case_4 = math::check_perfect_square::check_perfect_square(4);

	int64_t test_case_5 = check_perfect_square(8);
	int64_t test_case_5 = math::check_perfect_square::check_perfect_square(8);

feat: added a program to check a number is perfect square or not #1412

feat: added a program to check a number is perfect square or not #1412

Conversation

AmanDeep-21 commented Oct 29, 2020 • edited by gitpod-io bot Loading

Description of Change

Checklist

Marinovsky commented Oct 29, 2020

Panquesito7 left a comment

Choose a reason for hiding this comment

AmanDeep-21 commented Oct 30, 2020

Marinovsky commented Oct 30, 2020

AmanDeep-21 commented Oct 31, 2020

Panquesito7 left a 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stale bot commented Jul 8, 2021

stale bot commented Jul 21, 2021

AmanDeep-21 commented Oct 29, 2020 •

edited by gitpod-io bot

Loading