Lab46 Wiki

User Tools

Site Tools

You are here: start » notes » discrete » fall2021 » projects » pnf1
notes:discrete:fall2021:projects:pnf1

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
notes:discrete:fall2021:projects:pnf1 [2021/08/31 21:25] – stepping-suggestion aholmes9notes:discrete:fall2021:projects:pnf1 [2021/09/09 03:59] (current) – [Prime Detection Algorithm] mbrill1
Line 4: Line 4:
 </WRAP> </WRAP>
  
-======PROJECT: PRIME NUMBER FUN intro (PNF0)======+======PROJECT: PRIME NUMBER FUN moar (PNF1)======
  
 =====Objective===== =====Objective=====
 +
 Using the TIC-80 fantasy console simulator on your pi, implement a program that visually displays a range of values (lower and upper bounds adjustable by the user) that colorfully displays whether each value is a **prime** or **composite** value. Using the TIC-80 fantasy console simulator on your pi, implement a program that visually displays a range of values (lower and upper bounds adjustable by the user) that colorfully displays whether each value is a **prime** or **composite** value.
  
Line 37: Line 38:
   * ask copious, clarifying questions (so you can better add content)   * ask copious, clarifying questions (so you can better add content)
   * craft a coherent and organized document, with information located under pertinent headings   * craft a coherent and organized document, with information located under pertinent headings
-  * explain the fundamentals of the process, conceptual background, algorithmic approach, and you can even suggest particulars related to TIC-80 (certain functions that might prove useful- individual, unrelated snippets to do things like capturing time, or displaying text, etc.)+  * explain the fundamentals of the process, conceptual background, algorithmic approach, and you can even suggest particulars related to TIC-80 (certain functions that might prove useful- individual, unrelated snippets to do things like capturing time or displaying text, etc.)
   * to get full credit, each individual that submits must perform no fewer than 4 changes to this document (as viewable from the wiki revision system). Failure to do so will result in documentation penalties being applied.   * to get full credit, each individual that submits must perform no fewer than 4 changes to this document (as viewable from the wiki revision system). Failure to do so will result in documentation penalties being applied.
  
Line 69: Line 70:
  
 An effective way of going about this project is to allow the prime detection algorithm to "step" once every frame. That is, by allowing the TIC() function to call the calculation of the number currently being assessed, greater functionality is easier to implement. For example, animations can be played simultaneously as the calculation occurs since the entire TIC() function is able to run without needing to wait for some checkPrime() or similar process to finish. Additionally, the various optimizations can be more consistently implemented from a user perspective since they will not affect the framerate nearly as drastically as if the entire algorithm was called during a single frame. An effective way of going about this project is to allow the prime detection algorithm to "step" once every frame. That is, by allowing the TIC() function to call the calculation of the number currently being assessed, greater functionality is easier to implement. For example, animations can be played simultaneously as the calculation occurs since the entire TIC() function is able to run without needing to wait for some checkPrime() or similar process to finish. Additionally, the various optimizations can be more consistently implemented from a user perspective since they will not affect the framerate nearly as drastically as if the entire algorithm was called during a single frame.
 +
 ====Prime Detection Algorithm==== ====Prime Detection Algorithm====
 +
 +Before we can jump into how to //program// our prime number detection algorithm, we must understand the basic rules of prime numbers.
 +
 +Prime Numbers Must Be:
 +  * In the set of natural/counting numbers.
 +  * Greater than the number 1.
 +  * Factorable by only two natural/counting numbers: itself and 1.
 +
 +With your knowledge of programming and the rules of prime numbers, you should be able to make a detection algorithm now!  There are different computational methods for figuring out the primality of a number, we will take a look at one of the simplest ones first (more may be added in the future to this page).
 +
 +===Trial-By-Division Algorithm===
 +
 +One of the most basic methods of checking the primality of a number, this method relies on dividing a given number by the numbers in a set range. This is to see if any numbers in that range divide the given number cleanly; //no remainders exist in the mathematical output//. Clean division is a sign of a **composite** number.
 +
 +Let's assume we have an integer, //n//, in order to see if //n// is a prime number we should first determine our lower and upper bounds for the division test(s):
 +  * Lower bound: 2
 +  * Upper bound: <m>sqrt{n}</m>
 +     * If taking unoptimized route, upper bound can just be //n - 1//.
 +
 +Both of these bounds may be confusing, let me explain...
 +
 +For our lower bound, we most definitely want to start on the lowest number possible. Since we know that the potential factors for our integer, //n//, must be natural/counting numbers that means the lowest we could try to start at is 0. Is there an issue with this? Yes. Perhaps we can start at 1? No.
 +
 +Hopefully, you understand why starting at 0 for **division tests** would not be such a good idea. Starting at 1 would be superfluous; everything is divisible by 1. At this point, having our lower bound set to 2 ensures no issues and is the lowest we can go for our lower bound.
 +
 +For our upper bound, we want to prioritize testing to what we //absolutely// must test. Testing all values until //n// would be highly inefficient. One important rule to remember is that one of the two factors generated from //n// will be less than or equal to the square root of //n//. Knowing this rule, testing numbers after the square root of //n// is pointless.
 +
 +We must consider other options, optimizations, to implement. As our objective states, there are some more optimizations besides the ones written here. It is up to you to implement that given what has been written here.
 +
 +Now that you understand the general process of this algorithm, and what its lower and upper bounds should be, you can finally get into writing this algorithm. Here are a few concluding questions:
 +  * How can we test if a number divides cleanly by //n//?
 +     * Hint: remainder "%"
 +  * How can we implement a square root in our code for the upper bound?
 +  * How do we deal with testing the numbers 0 and 1?
  
 ==Optional Functionality== ==Optional Functionality==
 +
 This can be relatively simply and familiarly implemented (at a high level) in the way that the **chmod** accepts permission codes. By assigning each optional optimization to a number (in binary terms, starting with 1, 2, 4, 8, 16, ...) and passing the set of selected optimizations as the sum of those selected numbers, the algorithm can handle, in a way of limited individual variables, optional functions. At runtime, these can be checked from greatest to least: if the options argument is a number greater than the number corresponding to the biggest number, perform that operation, and subtract that value from the argument, then move on to the next-biggest, and so on, until the final option.\\ This can be relatively simply and familiarly implemented (at a high level) in the way that the **chmod** accepts permission codes. By assigning each optional optimization to a number (in binary terms, starting with 1, 2, 4, 8, 16, ...) and passing the set of selected optimizations as the sum of those selected numbers, the algorithm can handle, in a way of limited individual variables, optional functions. At runtime, these can be checked from greatest to least: if the options argument is a number greater than the number corresponding to the biggest number, perform that operation, and subtract that value from the argument, then move on to the next-biggest, and so on, until the final option.\\
 In the case of Break, Odds, and Square Root methodology, break can be 1, odds can be 2, and sqrt can be 4. If the input is then sqrt and odds, for example, and argument input would be 6. If nothing is selected, argument input would be 0, causing the brute force method. In the case of Break, Odds, and Square Root methodology, break can be 1, odds can be 2, and sqrt can be 4. If the input is then sqrt and odds, for example, and argument input would be 6. If nothing is selected, argument input would be 0, causing the brute force method.
 +
 +==If Statements==
 +
 +An if statement can be used to accept two conditions instead of just one. In Lua, this is accomplished with `and.` As an example, `if a==2 and b==3 then` only performs an action if a=2 and b=3. This is useful for having multiple menus and deciding which sub-menu to display. It can also be used in conjunction with Optional Functionality.
 +
 +
 +====Break On Composite Algorithm====
 +
 +The idea of the "break on composite algorithm", is very similar to the brute force algorithm. It still incorporates the trial by division idea. Lets say you are checking to see if a number is prime or composite using the trial by division algorithm. That means you are dividing said number by every number between 2 and said number. If it so happens that you come across a number that divides into your number with no remainder, then you would want your program to instantly see that your number is composite. Then move on to the next number in the range of numbers provided by the user.
 ====Display==== ====Display====
  
 =====References===== =====References=====
 +
 +https://github.com/nesbox/TIC-80/wiki
 +
 +https://github.com/nesbox/TIC-80/wiki/Cheatsheet
 +
 +https://www.lua.org/manual/5.3/
 +
 +=====Submission=====
 +
 +I'll be looking for the following:
 +
 +<code>
 +78:pnf1:final tally of results (78/78)
 +*:pnf1:no errors, program runs in TIC-80 [13/13]
 +*:pnf1:user can specify lower and upper bounds at runtime [13/13]
 +*:pnf1:algorithm selection is implemented and functional [13/13]
 +*:pnf1:specified algorithms are implemented and functional [13/13]
 +*:pnf1:timing information is displayed [13/13]
 +*:pnf1:project page contributions as per project specifications [13/13]
 +</code>
 +
 +Additionally:
 +  * Solutions not abiding by **SPIRIT** of project will be subject to a 25% overall deduction
 +  * Solutions not utilizing descriptive why and how **COMMENTS** will be subject to a 25% overall deduction
 +  * Solutions not utilizing **INDENTATION** to promote scope and clarity will be subject to a 25% overall deduction
 +  * Solutions lacking **ORGANIZATION** and are not easy to read (within 90 char width) are subject to a 25% overall deduction
notes/discrete/fall2021/projects/pnf1.1630445152.txt.gz · Last modified: 2021/08/31 21:25 by aholmes9

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki