Skip to content

Triangular number #896

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

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

Conversation

WinterPancake
Copy link

Pull Request Template

Description

A triangular number is a figurate number that counts objects arranged in an equilateral triangle. The standard formula for finding these can result in integer overflow due to the multiplication, so I added a OR binary operation to be able to find larger integers.
https://en.wikipedia.org/wiki/Triangular_number

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

Checklist:

  • I ran bellow commands using the latest version of rust nightly.
  • I ran cargo clippy --all -- -D warnings just before my last commit and fixed any issue that was found.
  • I ran cargo fmt just before my last commit.
  • I ran cargo test just before my last commit and all tests passed.
  • I added my algorithm to the corresponding mod.rs file within its own folder, and in any parent folder(s).
  • I added my algorithm to DIRECTORY.md with the correct link.
  • I checked COUNTRIBUTING.md and my code follows its guidelines.

Please make sure that if there is a test that takes too long to run ( > 300ms), you #[ignore] that or
try to optimize your code or make the test easier to run. We have this rule because we have hundreds of
tests to run; If each one of them took 300ms, we would have to wait for a long time.

@codecov-commenter
Copy link

codecov-commenter commented Jul 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.52%. Comparing base (99e33d1) to head (29403ed).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #896      +/-   ##
==========================================
+ Coverage   95.32%   95.52%   +0.20%     
==========================================
  Files         319      320       +1     
  Lines       20807    23021    +2214     
==========================================
+ Hits        19834    21991    +2157     
- Misses        973     1030      +57     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment on lines +1 to +2
// Triangular Numbers: Function to the Nth Triangular Number
// Wikipedia Reference : https://en.wikipedia.org/wiki/Triangular_number
Copy link
Member

Choose a reason for hiding this comment

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

Please explain what this module provides.

// Triangular Numbers: Function to the Nth Triangular Number
// Wikipedia Reference : https://en.wikipedia.org/wiki/Triangular_number
use num_bigint::BigUint;
pub fn triangular_number(n: u64) -> BigUint {
Copy link
Member

Choose a reason for hiding this comment

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

BigUint seems to be an overkill here.

Comment on lines 5 to 6
let m: BigUint = ((n | 1) * ((n + 1) / 2)).into();
m
Copy link
Member

Choose a reason for hiding this comment

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

Why not:

Suggested change
let m: BigUint = ((n | 1) * ((n + 1) / 2)).into();
m
((n | 1) * ((n + 1) / 2)).into()

Comment on lines 26 to 28
input_5: (6, BigUint::from(21u32)),
input_9: (10, BigUint::from(55u32)),
input_10: (100, BigUint::from(5050u32)),
Copy link
Member

Choose a reason for hiding this comment

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

What is the logic behind the names of the test cases?

Please add a text case with odd input and the first ones like:

        input_0: (0, BigUint::from(0u32)),
        input_1: (1, BigUint::from(1u32)),

…or being overkill. Removed the use and returning of the variable m. Renamed the names of the test cases to something more logical.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants