Differences

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

--- haas:spring2018:unix:projects:spf0 [2018/03/14 16:14] – [Only specifying starting value] wedge
+++ haas:spring2018:unix:projects:spf0 [2018/03/14 18:30] (current) – [Specifications] wedge
@@ Line 145: / Line 145: @@
 ====Only specifying numeric pattern====
-In the event only a pattern is provided, search through the PI data for the provided pattern, displaying each match.
+In the event only a pattern is provided, search through the PI data for the provided pattern, displaying each match to STDOUT.
 For example:
@@ Line 155: / Line 155: @@
 </cli>
+====one result per line====
+Using the **byline** option, instead of displaying results horizonally, they'll be displayed vertically (one result per line) to STDOUT.
+<cli>
+lab46:~/src/unix/spf0$ cat pi.120.out | ./pigrep '26' byline
+
+
+lab46:~/src/unix/spf0$
+</cli>
+====compute offsets from start of digits====
+The **offset** argument will, instead of displaying the numeric matches (which, aside from counting are of dubious value) will display how many digits away from the start of the PI digits the pattern resides.
+<cli>
+lab46:~/src/unix/spf0$ cat pi.120.out | ./pigrep '26' offset
+22
+lab46:~/src/unix/spf0$
+</cli>
+With an example like this, we should easily be able to verify its correctness:
+<cli>
+lab46:~/src/unix/spf0$ cat pi.120.out
+314159265358979323846264338327950288419716939937510582097494459230781640628620899862803482534211706798214808651328230664
+lab46:~/src/unix/spf0$ cat pi.120.out | cut -c7-8,22-23
+lab46:~/src/unix/spf0$
+</cli>
+====mixing options (offset, byline)====
+And we can mix options (in any order):
+<cli>
+lab46:~/src/unix/spf0$ cat pi.120.out | ./pigrep byline '26' offset
+
+
+lab46:~/src/unix/spf0$
+</cli>
+====Using atend with offset====
+The **atend** option, issued by itself, has no impact on operations:
+<cli>
+lab46:~/src/unix/spf0$ cat pi.120.out | ./pigrep atend '26'
+26
+lab46:~/src/unix/spf0$
+</cli>
+So we need to combine it with the **offset** option to make an impact:
+<cli>
+lab46:~/src/unix/spf0$ cat pi.120.out | ./pigrep atend offset '26'
+23
+lab46:~/src/unix/spf0$
+</cli>
+====dropping the leading 3====
+With the **drop3** option, we merely exclude the leading 3 of pi from our calculations. This should result in everything being "off by one" from previous outputs (with any combination of arguments):
+<cli>
+lab46:~/src/unix/spf0$ cat pi.120.out | ./pigrep atend offset '26' drop3
+22
+lab46:~/src/unix/spf0$
+</cli>
+====Using MAX to limit processing====
+Sometimes, a pattern may produce an untenable quantity of results. We may wish to restrict it, and can do so with the aid of setting the **MAX** variable.
+Take this request, which produces numerous results:
+<cli>
+lab46:~/src/unix/spf0$ cat pi.120.out | ./pigrep '2'
+2 2 2 2 2 2 2 2 2 2 2 2 2 2
+lab46:~/src/unix/spf0$
+</cli>
+We can cut that down to a smaller quantity by setting MAX accordingly (let's say, limit to 4 matches):
+<cli>
+lab46:~/src/unix/spf0$ cat pi.120.out | MAX=4 ./pigrep '2'
+2 2 2
+lab46:~/src/unix/spf0$
+</cli>
+You could also **export** MAX, mitigating the need to manually specify it for each run.
 =====Specifications=====
 Evaluation will be based on correctness of values as well as on formatting/spacing.
@@ Line 160: / Line 245: @@
 You'll notice that everything lines up and is positioned similarly:
-  * each column exists within 10 characters of on-screen real estate:
+  * groupwork! This project is specifically designed to be performed in groups.
-    * 8 characters for actual value display,
+    * I want to see groups ranging from a minimum of 2 people, to a maximum of 4 people. Any less and any more are not allowed.
-    * with one space padding either side
+      * furthermore, groups of 2 or 3 cannot have overall class ranks (rankings as of today: 03/14/2018) within 3 ranks of each other (ie ranks 8 and 9, or 8 and 10, or 8 and 11 are not valid combinations for 2-person groups).
-  * columns are separated with a '<nowiki>|</nowiki>' symbol, appended to the right edge of the column (effectively making each column 11 characters wide).
+        * ranks 1 and 2 are specifically and uniquely exempt from this restriction (ie they can be part of the same group, if they were to choose to be a group of 2). Otherwise, same rank spacing still applies.
-    * note that the rightmost column is ended with this '<nowiki>|</nowiki>'.
+        * groups of 4 cannot have rank subsets that span 3 consecutive ranks (ie ranks 6, 7, 8, and 11)
-  * there is a heading/header at the top of the output table, and it uses a '**+**' to "connect" the horizontal and vertical lines being drawn
+    * EVERY group member needs to be identified in your scripts (in a comment listing everyone).
-    * The dashes and vertical bars set up an ASCII art-like table pattern that helps make the data more readable.
+    * EVERY group member needs to be familiar with the end products
-  * The values are right justified with each column
+    * EVERY group member needs to submit a copy of the scripts (they should all be identical- I will check)
-    * justification is essential. Everything should line up on its respective right margin.
+      * in the event you feel other group members have not lived up to their obligations, you may alter your scripts accordingly (be it not giving them the final product, or enhancing functionality to bring it in compliance, or leaving comments indicating who wasn't pulling their own weight).
-  * base headings are right justified, with a 2 spaces being allocated for reference of the base:
+    * EVERY group member needs to do an approximately equal portion of the work. Slackers should be called out (I'll be keeping an eye out as well) and they will lose credit.
-    * you'll see "base 2" vs. "base16"; your script needs to accommodate this.
+    * This project is designed to be done DURING class time. It may offer up some useful insights into other projects (that you're doing on your own).
-  * You are to literally print out no more than 2 consecutive spaces at a time in your output statements. If you need more, use one of the formatting tools to generate spaces for you (**printf(1)** may be able to help you with this).
+  * You need to check your arguments to ensure they are present and valid.
-  * You need to check your arguments to ensure they are present and valid. Some examples:
+    * all mentioned arguments implementing their indicated functionality (atend, byline, drop3, offset, help)
-    * starting value is a valid (whole) number
+      * help takes priority over other options
-      * if less than 0, or greater than 255, needs to be capped to whichever extreme it exceeds
+      * atend has no appreciable impact unless offset is also specified
-        * if -4, cap to 0
-        * if 300, cap to 255
-    * ending value is a valid (whole) number
-      * if less than 0, or greater than 255, needs to be capped to whichever extreme it exceeds
-        * if -8, cap to 0
-        * if 420, cap to 255
     * any invalid arguments (nonsensical value in place of starting value, invalid base specification, etc.) should be silently dropped/ignored.
-  * default starting value is 0, default ending value is 15. If nothing else is validly provided, these are the values the script should run with.
-  * if starting and ending values are the same, the script will display just one line of number output (in addition to the header).
   * if lacking any bases to display, silently exit
-  * your script needs to commence with a proper **shabang** to bash; your script needs to end with an "**exit 0**" at the very end
+  * your script needs to commence with a proper **shabang** to run using bash; your script needs to end with an "**exit 0**" at the very end
   * comments and indentation are required and necessary
     * comments should explain how or why you are doing something
-    * indentation should be consistent throughout the script
+    * indentation should be consistent throughout the script (no mixing of different indentation units; no mixing of tabs and spaces)
     * indentation is to be no less than 3 on-screen spaces (I recommend tabstops of 4).
-  * continuing with our shell scripting, your script will need to employ in a core/central way:
+  * continuing with our shell scripting, your scripts will need to employ in a core/central way (note that both scripts may not each need all of these, but across both scripts, you should make sure that each of these concepts is utilized):
     * variables
+    * command-line argument parsing and usage
+    * command-line pipelines
     * command expansions
     * regular expressions
-    * if statements
+    * conditional/selection structures
     * loops
-    * at least 1 function (use **function** keyword to identify)
   * your logic needs to:
     * flow (one thing leads into the next, as best as possible)
     * make sense within the given context
-    * avoid redundancy (make a function instead of maintaining multiple copies of code)
+    * avoid redundancy
-    * be understood by you (no grabbing snippets that seem to "work" from the internet)
+    * be understood by you, and everyone in your group (no grabbing snippets that seem to "work" from the internet)
       * if you gain inspiration from some external resource, please cite it
       * comments are a great way of demonstrating understanding (if you explain the why and how effectively, and it isn't in violation of other aspects, I'll know you are in control of things)
@@ Line 218: / Line 296: @@
   * utilizing creativity
   * being able to control solution via consistent, clear, and organized presentation
+  * approximately equal involvement and impact of all group members on the brainstorming and development of the finished scripts.
-Basically: I want your solution to be the result of an honest, genuine brainstorming process where you have (on your own) figured out a path to solving the problem, you have dabbled and experimented and figured things out, and you can command the concepts and tools with a fluency enabling you to pull off such a feat. Your solution should demonstrate the real learning that took place and experience gained.
+Basically: I want your solution to be the result of an honest, genuine brainstorming process where you have figured out a path to solving the problem, you have dabbled and experimented and figured things out, and you can command the concepts and tools with a fluency enabling you to pull off such a feat. Your solution should demonstrate the real learning that took place and experience gained.
 Cutting corners, avoiding work, skimping on functionality, cheating through getting others to do work for you or finding pre-packaged "answers" on the internet violates the spirit of the project, for they betray your ability to pull off the task on your own.
@@ Line 230: / Line 309: @@
 This can be in the form of comments in your script, or even a separate file submitted at time of submission (if a file, be sure to make mention of it in your script so I can be sure to look for it).
-=====Verification=====
-To assist you in verifying output compliance, I have generated a set of sample script outputs and placed them in the public directory for this project.
-There you will find a file by the name of **outputlist**, which contains a list of filenames (output0 - outputF) and the **pwn0.sh** script command-line used to generate the output found in those files.
-Using these files, you can check the functionality of your script in a number of operating conditions, to verify that it is indeed working as it should be. While this isn't likely to cover the full spectrum of possibilities, it should offer up some assistance in helping you broaden your view of troubleshooting scenarios.
 =====Submission=====
-By successfully performing this project, you should have a fully functioning script by the name of **pwn0.sh**, which is all you need to submit for project completion (no steps file, as your "steps" file IS the script you wrote).
+By successfully performing this project, you should have a fully functioning set of scripts by the names **pigen** and **pigrep**, which are all you need to submit for project completion (no steps file, as your "steps" file ARE the scripts you wrote).
 To submit this project to me using the **submit** tool, run the following command at your lab46 prompt:
 <cli>
-$ submit unix pwn0 pwn0.sh
+$ submit unix spf0 pigen pigrep
-Submitting unix project "pwn0":
+Submitting unix project "spf0":
-    -> pwn0.sh(OK)
+    -> pigen(OK)
+    -> pigrep(OK)
 SUCCESSFULLY SUBMITTED
 </cli>
-You should get some sort of confirmation indicating successful submission  if all went according to plan. If not, check for typos and or locational mismatches.
+You should get some sort of confirmation indicating successful submission if all went according to plan. If not, check for typos and or locational mismatches.
 I'll be looking for the following:
 <code>
-:pwn0:final tally of results (78/78)
+:spf0:final tally of results (26/26)
-*:pwn0:pwn0.sh on help displays informative usage and exits [4/4]
+*:spf0:scripts effectively utilize variables in operations [2/2]
-*:pwn0:pwn0.sh effectively utilizes variables in operations [4/4]
+*:spf0:scripts effectively utilize command-line arguments [2/2]
-*:pwn0:pwn0.sh effectively utilizes command expansions [4/4]
+*:spf0:scripts effectively utilize command expansions [2/2]
-*:pwn0:pwn0.sh effectively utilizes regular expressions [4/4]
+*:spf0:scripts effectively utilize regular expressions [2/2]
-*:pwn0:pwn0.sh effectively utilizes selection statements [4/4]
+*:spf0:scripts effectively utilize selection structures [2/2]
-*:pwn0:pwn0.sh effectively utilizes looping structures [4/4]
+*:spf0:scripts effectively utilize looping structures [2/2]
-*:pwn0:pwn0.sh effectively utilizes functions in script [4/4]
+*:spf0:scripts are proper bash scripts with shabang and exit [2/2]
-*:pwn0:pwn0.sh is a proper bash script with shabang and exit [4/4]
+*:spf0:pigrep displays values in proper orientation [2/2]
-*:pwn0:pwn0.sh parses command-line arguments as appropriate [4/4]
+*:spf0:pigrep accurately displays values as requested [2/2]
-*:pwn0:pwn0.sh accurately displays values in proper alignment [4/4]
+*:spf0:scripts properly manage input violations [2/2]
-*:pwn0:pwn0.sh accurately displays values in requested bases [4/4]
+*:spf0:pigen operates according to specifications [2/2]
-*:pwn0:pwn0.sh accurately displays values in specified range [4/4]
+*:spf0:pigrep operates according to specifications [2/2]
-*:pwn0:pwn0.sh range logic flexibly works forward and reverse [4/4]
+*:spf0:script logic is organized and easy to read [2/2]
-*:pwn0:pwn0.sh iterates as appropriate in given scenarios [4/4]
-*:pwn0:pwn0.sh includes additional bases as requested [4/4]
-*:pwn0:pwn0.sh omits specified bases as requested [4/4]
-*:pwn0:pwn0.sh properly manages input violations [4/4]
-*:pwn0:pwn0.sh operates according to specifications [5/5]
-*:pwn0:pwn0.sh logic is organized and easy to read [5/5]
 </code>
@@ Line 281: / Line 349: @@
   * 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 not done in a valid group will be subject to a 25% overall deduction

Lab46 Wiki

User Tools

Site Tools

Differences

Page Tools