Skip to content

Commit

Permalink
adding prime factors example
Browse files Browse the repository at this point in the history
Signed-off-by: vsoch <vsochat@stanford.edu>
  • Loading branch information
vsoch committed Sep 8, 2020
1 parent 6f2459d commit 58b8b60
Show file tree
Hide file tree
Showing 5 changed files with 181 additions and 0 deletions.
8 changes: 8 additions & 0 deletions rust/prime-factors/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Generated by Cargo
# will have compiled files and executables
/target/
**/*.rs.bk

# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
# More information here http://doc.crates.io/guide.html#cargotoml-vs-cargolock
Cargo.lock
6 changes: 6 additions & 0 deletions rust/prime-factors/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[package]
edition = "2018"
name = "prime_factors"
version = "1.1.0"

[dependencies]
110 changes: 110 additions & 0 deletions rust/prime-factors/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# Prime Factors

Compute the prime factors of a given natural number.

A prime number is only evenly divisible by itself and 1.

Note that 1 is not a prime number.

## Example

What are the prime factors of 60?

- Our first divisor is 2. 2 goes into 60, leaving 30.
- 2 goes into 30, leaving 15.
- 2 doesn't go cleanly into 15. So let's move on to our next divisor, 3.
- 3 goes cleanly into 15, leaving 5.
- 3 does not go cleanly into 5. The next possible factor is 4.
- 4 does not go cleanly into 5. The next possible factor is 5.
- 5 does go cleanly into 5.
- We're left only with 1, so now, we're done.

Our successful divisors in that computation represent the list of prime
factors of 60: 2, 2, 3, and 5.

You can check this yourself:

- 2 * 2 * 3 * 5
- = 4 * 15
- = 60
- Success!

## Rust Installation

Refer to the [exercism help page][help-page] for Rust installation and learning
resources.

## Writing the Code

Execute the tests with:

```bash
$ cargo test
```

All but the first test have been ignored. After you get the first test to
pass, open the tests source file which is located in the `tests` directory
and remove the `#[ignore]` flag from the next test and get the tests to pass
again. Each separate test is a function with `#[test]` flag above it.
Continue, until you pass every test.

If you wish to run all ignored tests without editing the tests source file, use:

```bash
$ cargo test -- --ignored
```

To run a specific test, for example `some_test`, you can use:

```bash
$ cargo test some_test
```

If the specific test is ignored use:

```bash
$ cargo test some_test -- --ignored
```

To learn more about Rust tests refer to the [online test documentation][rust-tests]

Make sure to read the [Modules][modules] chapter if you
haven't already, it will help you with organizing your files.

## Further improvements

After you have solved the exercise, please consider using the additional utilities, described in the [installation guide](https://exercism.io/tracks/rust/installation), to further refine your final solution.

To format your solution, inside the solution directory use

```bash
cargo fmt
```

To see, if your solution contains some common ineffective use cases, inside the solution directory use

```bash
cargo clippy --all-targets
```

## Submitting the solution

Generally you should submit all files in which you implemented your solution (`src/lib.rs` in most cases). If you are using any external crates, please consider submitting the `Cargo.toml` file. This will make the review process faster and clearer.

## Feedback, Issues, Pull Requests

The [exercism/rust](https://github.com/exercism/rust) repository on GitHub is the home for all of the Rust exercises. If you have feedback about an exercise, or want to help implement new exercises, head over there and create an issue. Members of the rust track team are happy to help!

If you want to know more about Exercism, take a look at the [contribution guide](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md).

[help-page]: https://exercism.io/tracks/rust/learning
[modules]: https://doc.rust-lang.org/book/ch07-02-defining-modules-to-control-scope-and-privacy.html
[cargo]: https://doc.rust-lang.org/book/ch14-00-more-about-cargo.html
[rust-tests]: https://doc.rust-lang.org/book/ch11-02-running-tests.html

## Source

The Prime Factors Kata by Uncle Bob [http://butunclebob.com/ArticleS.UncleBob.ThePrimeFactorsKata](http://butunclebob.com/ArticleS.UncleBob.ThePrimeFactorsKata)

## Submitting Incomplete Solutions
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
21 changes: 21 additions & 0 deletions rust/prime-factors/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
pub fn factors(n: u64) -> Vec<u64> {
let mut current = n;

// start testing with 2
let mut factor = 2;

// keep a vector list of results
let mut results = vec![];

// keep going until we hit 1
while current > 1 {
// if divides cleanly, divide it
if current % factor == 0 {
current /= factor;
results.push(factor);
} else {
factor += 1;
}
}
results
}
36 changes: 36 additions & 0 deletions rust/prime-factors/tests/prime-factors.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
use prime_factors::factors;

#[test]
fn test_no_factors() {
assert_eq!(factors(1), vec![]);
}

#[test]
fn test_prime_number() {
assert_eq!(factors(2), vec![2]);
}

#[test]
fn test_square_of_a_prime() {
assert_eq!(factors(9), vec![3, 3]);
}

#[test]
fn test_cube_of_a_prime() {
assert_eq!(factors(8), vec![2, 2, 2]);
}

#[test]
fn test_product_of_primes_and_non_primes() {
assert_eq!(factors(12), vec![2, 2, 3]);
}

#[test]
fn test_product_of_primes() {
assert_eq!(factors(901_255), vec![5, 17, 23, 461]);
}

#[test]
fn test_factors_include_large_prime() {
assert_eq!(factors(93_819_012_551), vec![11, 9539, 894_119]);
}

0 comments on commit 58b8b60

Please sign in to comment.