drytuna/cs373-collatz

Solving Sphere 3n+1 Problem

cs373-collatz's Issues

Documentation

Use pydoc to document the interfaces.
The above documentation only needs to be generated for Collatz.py. Comment each function meaningfully. Use comments only if you need to explain the why of a particular implementation. Choose a coding convention and be consistent. Use good variable names. Write readable code with good indentation, blank lines, and blank spaces.

Smarter Cache

Come up with a smarter way of using the cache

New boundaries of the cache

Shorten the number of cycle calculations by working with the new cache range

Index Range

the python range function does not look at the last number

Acceptance Tests

The grader's GitHub account will have a public Git repository for unit tests and acceptance tests.
Write acceptance tests before your write the code. When you encounter a bug, write an acceptance test that fails, fix the bug, and confirm that the acceptance test passes. Write an auxiliary program to randomly generate acceptance tests. Create at least 1000 acceptance tests. Tests corner cases and failure cases. Push and pull the acceptance tests to and from the grader's repository. Prepend - to the file names at GitHub (i.e. foo-RunCollatz.in and foo-RunCollatz.out). Reach consensus on the acceptance tests.

Unorganized codes

Split up functions and have each perform a specific task.

Issue Tracker

The GitHub repository comes with an issue tracker.
Create an issue for each of the requirements in this table. Create an issue for each bug or feature, both open and closed. Categorize, prioritize, and describe each issue adequately. Create at least 10 more issues in addition to the requirements in this table.

GitHub

Create a student GitHub account

Submission

Perform the submission below.
Collatz.zip
turnin --submit hychyc07 cs373pj1 Collatz.zip

README.txt
Collatz.log
Collatz.py
html/*
RunCollatz.in
RunCollatz.out
RunCollatz.py
SphereCollatz.py
TestCollatz.py.out
TestCollatz.py

New Cache doesn't pass Unit Tests

need to check ranges when i < num_cache < j is not TRUE

Slow

It's taking almost an hour to run 1000 lines of inputs

Unit Tests

The grader's GitHub account will have a public Git repository for unit tests and acceptance tests.
Write unit tests before you write the code. When you encounter a bug, write a unit test that fails, fix the bug, and confirm that the unit test passes. Write at least 3 unit tests for each function. Tests corner cases and failure cases. Name tests logically. Push and pull the unit tests to and from the grader's repository. Prepend - to the file names at GitHub (i.e. foo-TestCollatz.py and foo-TestCollatz.py.out). Reach consensus on the unit tests.

Implementation

Use assert to check pre-conditions, post-conditions, argument validity, return-value validity, and invariants. Worry about this last, but your program should run as fast as possible and use as little memory as possible.

Sphere

Create a Sphere account

Update Sphere Solution for V2

run time error occurred when submitting for V2

Flipped i and j

Does not work with Sphere when i > j

Sphere Submit

Sphere requires a single file to be submitted.
Combine Collatz.py and RunCollatz.py.
This is the file that the grader will submit to Sphere to determine a zero vs. non-zero grade.

Unit Test corner case

Not computing the right answer for 1 to 999999

Git Repository

Set up a private Git repository at GitHub, named cs373-collatz.
Invite the grader to your repository. Commit at least 5 times. Commit once for each bug or feature. If you cannot describe your changes in a sentence, you are not committing often enough. Write meaningful commit messages and identify the corresponding issue in the issue tracker (below). Create a log of the commits. Push frequently. It is your responsibility to protect your code from the rest of the students in the class. If your code gets out, you are as guilty as the recipient of academic dishonesty.

Lazy Cache

implement a lazy cache to work along side with the eager one