All new changes

Author: TobiasWrigstad

assignments/assignment1.org

@@ -160,7 +160,7 @@ defined more than once.].
  * defines. Doxygens tags are words preceeded by either a backslash @\
  * or by an at symbol @@.
  *
- * @see http://wrigstad.com/ioopm19/assignments/assignment1.html
+ * @see http://wrigstad.com/ioopm/assignments/assignment1.html
  */
 
 /// @brief Create a new hash table
@@ -4147,3 +4147,67 @@ presentations, or add your name to the help list.
 # Explain the key hotkeys
 # TODO: add fixmee to course emacs package
 # first insert listing could use an animation that shows how the interation works
+
+* Addendum 2020-10-05: Documentation of Assignments
+
+When we talk about documentation in the assignments, we are referring
+to three different kinds of documentation:
+
+1. Documentation in the header files -- as exemplified in the assignment text.
+2. Documentation in the .c files as code comments
+3. External documentation in the README.md file
+
+
+** Documentation in the header files
+
+Sometimes you make changes to how a function works, or you make
+assumptions that need to be communicated to the user. These things
+should be reflected in the documentation in the header files. For
+example, if you do not allow NULL as a value in your hash table,
+then this needs to be documented in the header file in the insert
+function for example. The target audience for these comments are
+the users of your functions, plus future maintainers of you code
+that need to understand what the functions are supposed to do.
+
+Design decision necessary to understand how to use the stuff
+you've built should go here -- like how error handling is done,
+etc. and whether the hashtable owns its data or not. 
+
+
+** Documentation in the ~.c~ files as code comments
+
+Sometimes you need to comment on things, for example you put
+=TODO=:s, =FIXME=:s or other explanations about why a particular
+design choice etc. These things are also part of the
+documentation, but the target audience is a future you, or someone
+else who might be tasked with maintaining or extending this code
+in the future.
+
+(Note that in Java, there are no separate header files meaning the
+header file documentation will be interleaved with the
+implementation code, or if you use an Java =Interface= to factor
+this out.)
+
+
+** Documentation in the =README.md= file
+
+The =README.md= should in the very least contain information about
+how to compile the code, run the tests, and run the program(s).
+Sometimes some major thing has changed because some design
+decision you took, and this needs to be reflected here. If you
+make a deal with a teacher about some shortcut, it too goes here. 
+
+The target audience for this information is the teachers of this
+course.
+
+Also quickly outline design decisions you took. This can be a very
+brief bullet list as long as it is clear, e.g.: 
+
+- Errors are handled by ...
+- The hash table does not take ownership of the data of its keys and values
+- ...
+
+This bullet list overlaps a little with the information in the
+header files, but this version is more terse, and the target
+audience is another.
+

assignments/assignment2.org

@@ -7,6 +7,29 @@
 *Hard deadline*: End of Week 44
 #+end_important
 
+#+begin_note
+This assignments builds on the previous one. 
+When you form a new pair, one of you will bring
+their old assignment 1 code with them to the new pair. 
+
+There are several reasons for this all rooted in how
+useful and insightful it is to live with code you've
+written yourself for a "long while", and respectively,
+how insightful it is to see someone else's implementation
+of the same specification. 
+
+It usually forces you to reflect on readability, what is good
+naming, what is "obvious" or intuitive, etc. Plus you'll get to
+experience that you get better, when you look at code you wrote
+"ages ago" and immediately can see improvements or better ways to
+do it.
+
+Thus, one of you will be the expert on the implementation of the
+library that you can use to do most of the heavy lifting in this
+assignment. The other will ask questions and poke at differences
+with the hashtable code he or she knows from before. 
+#+end_note
+
 * Simple Webstore Backend
 In Assignment 2, we are going to put the data structures we
 implemented in Assignment 1 to use as we build a small program
@@ -357,10 +380,10 @@ This assignment reuses components from earlier in the course:
 
 You are doing Assigment 2 in a team of two people. As a starting
 point of this work, you need to pick components 1--3 above from 3
-*discrete* sources from within the same group. For example, let
-Alice, Bob and Cecil be members of the same group, and Alice and
-Bob work together on Assignment 2. In the start of their work, 
-Alice and Bob compile the following: 
+*discrete* sources from within the same group. For example, let's
+say Alice and Bob works together on Assignment 2. On assignment 1,
+Bob worked with Cecil. In the start of their work, Alice and Bob
+compile the following:
 
 1. Hash table comes from Alice's Assignment 1
 2. Linked list comes from Cecil's Assignment 1

cloud9.org

@@ -15,6 +15,7 @@ last name was Batman before changing to Chalpin, try =saba1234=
 instead.
 #+end_important
 
+
 * Setup: using ssh (only once)
 
 Ssh -- Secure SHell -- is a wonderful program that allows you to
@@ -132,9 +133,6 @@ guess. You need to confer with each other.
 [[./images/cloud9-invite4.png]]
 
 
-
-
-#+include: "./footer.org"
 * Changing your backend server 
 
 If you for some reason have trouble logging in to your chosen
@@ -160,6 +158,51 @@ If instructed to change servers, we will give you new suitable
 host names.
 
 
+* Installing Necessary Tools in your New Cloud9 
+
+#+begin_important
+Starting 2020-09-16, we provide a second Cloud9 instance which is
+backed on separate servers. With this setup, every student has a
+dedicated computational resource which should be less sensitive to
+the actions of others. Hopefully this solves the problems that
+some of you have been experiencing.
+#+end_important
+
+In the AWS management console where you normally go to start your 
+Cloud9 IDE, there will be a second Cloud9 instance whose name ends
+in *-aws*. 
+
+*The first time* you start this *-aws* server up, you will need to
+go to the terminal in Cloud9 and run the following *two* commands to
+install the course's tools:
+
+** Command 1: Make space
+To make space, you should run the following command to uninstall unnecesary programs:
+#+begin_src bash
+sudo yum remove -y docker mysql55 perl mercurial-python27 ruby20-libs perl-Encode php56 php56-common aws-apitools-elb golang subversion php-pear
+#+end_src
+
+** Command 2: Install tools
+To install the tools needed for the course, run the following command:
+#+begin_src bash
+sudo yum install -y zsh htop valgrind clang6.0-tools-extra.x86_64 lldb.x86_64 doxygen-latex.x86_64 CUnit.x86_64 CUnit-devel.x86_64 http://downloads.sourceforge.net/ltp/lcov-1.14-1.noarch.rpm
+#+end_src
+
+We will update this page with instructions for installing Java
+1.8. Right now, Java 1.7 is installed which is even older than
+Java 1.8. If you have problems with Java 1.7 (there is no reason
+to expect you would), before these instructions are issued, please
+use the first Cloud9 IDE running on the IT department ThinLinc
+servers (e.g. =atterbom.it.uu.se= etc.) for the time being.
+
+*Note that you will need to re-invite people to your new instance.*
+
+#+begin_important
+*Under no circumstances* may you change settings for your instance,
+such as changing how many minutes before the instance is suspended
+until next activity. Failure to comply with these rules will lead to
+permanent suspension of your Cloud9 account. 
+#+end_important
 
 #+include: "./footer.org"
 

code-exam.org

@@ -25,16 +25,22 @@ on-campus, just like described below.*
 
 * What is a Coding Exam?
 
+#+begin_important
+The code exam in 2020 will be held physically on campus, according to schedule. 
+If the pressure on spaces for the coding exam is too high, then we will switch
+to a new schedule with 3 slots in the day instead of the normal 2. 
+#+end_important
+
 A coding exam is an individual exam that runs in the normal
 computer halls. You have to pass *two* coding exams on this
 course, one imperative and one object-oriented in the programming
 languages that the course uses.
 
-#+begin_note
-It is not yet clear in 2020 how the code exams will run. This will 
-ultimately depend on the number of students on the course, the
-available computer halls, etc. We will now in September 2020.
-#+end_note
+# #+begin_note
+# It is not yet clear in 2020 how the code exams will run. This will 
+# ultimately depend on the number of students on the course, the
+# available computer halls, etc. We will now in September 2020.
+# #+end_note
 
 Coding exams are given multiple times during the course (e.g., 4
 times in 2018) and each exam has two programming tasks -- one
@@ -90,22 +96,25 @@ kodprovet har hårda tidsgränser.
 Below are some recent coding exams.
 
 |       Date | Files     | Instructions and/or Postmortem | Note   |
-| 2017-10-26 | [[http://wrigstad.com/ioopm/agoster.zip][available]] | [[http://wrigstad.com/ioopm/2017/kodprov-okt-17.html][available]]                      |        |
-| 2017-12-08 | [[http://wrigstad.com/ioopm/entrekod.zip][available]] | [[http://wrigstad.com/ioopm/2017/kodprov-dec-08.html][available]]                      | Only C |
-| 2017-12-18 | [[http://wrigstad.com/ioopm/sorsele-fm.zip][available]] | [[http://wrigstad.com/ioopm/2017/kodprov-dec-18.html][available]]                      |        |
+| 2017-10-26 | [[http://wrigstad.com/ioopm/agoster.zip][available]] | [[http://wrigstad.com/ioopm17/2017/kodprov-okt-17.html][available]]                      |        |
+| 2017-12-08 | [[http://wrigstad.com/ioopm/entrekod.zip][available]] | [[http://wrigstad.com/ioopm17/2017/kodprov-dec-08.html][available]]                      | Only C |
+| 2017-12-18 | [[http://wrigstad.com/ioopm/sorsele-fm.zip][available]] | [[http://wrigstad.com/ioopm17/2017/kodprov-dec-18.html][available]]                      |        |
 | 2018-04-02 | [[http://wrigstad.com/ioopm/bridget.zip][available]] |                                |        |
 | 2018-08-30 | [[http://wrigstad.com/ioopm/mandel.zip][available]] | [[./exams/2018-08-30.org][available]]                      |        |
 | 2018-10-24 | [[http://wrigstad.com/ioopm/byzantin.zip][available]] | [[./exams/2018-10-24.org][available]]                      |        |
 | 2018-12-11 | [[http://wrigstad.com/ioopm/equinox.zip][available]] | [[./exams/2018-12-11.org][available]]                      |        |
 | 2018-12-19 | [[http://wrigstad.com/ioopm/patata.zip][available]] | [[./exams/2018-12-19.org][available]]                      |        |
 | 2019-01-14 | [[http://wrigstad.com/ioopm/bergamott.zip][available]] | [[./exams/2019-01-14.org][available]]                      |        |
 
-In 2016, I was asked on Piazza to record a screencast that
-demonstrated what doing a code exam could be like. This was a
-great idea, but the question was asked the night before the 
-exam, and hence [[http://user.it.uu.se/~writo649/java.mp4][this recording]] is a little rough (to the point
-of being a bit wrong in the end, but it serves the purpose to
-show what writing a code exam can be like). 
+** Screencast Example of Solving a Coding Exam
+Here is a screencast recording from 2020-10-12 that solves the
+exam from 2019-01-14. *Because I could not get Studium to scale my recording to anything legible, you most likely want to look at the 1:1 resolution [[http://user.it.uu.se/~writo649/kodprov-190114.mp4][here]].*
+
+#+begin_center
+#+BEGIN_EXPORT html
+<iframe width="560px" height="320px" allowfullscreen="true" src="https://uppsala.instructuremedia.com/embed/a447b015-895a-4363-9bd0-c8bd94e77164" frameborder="0"></iframe>
+#+END_EXPORT
+#+end_center
 
 * Frequently Asked Questions
 

exams/2019-01-14.org

@@ -8,7 +8,7 @@
 1. =cd= (detta tar dig till din hemkatalog)
 2. =mkdir kodprov190114=
 3. =cd kodprov190114=
-4. =curl http://wrigstad.com/ioopm/bergamott.zip=
+4. =curl --output k.zip http://wrigstad.com/ioopm/bergamott.zip=
 5. =unzip k.zip=
 
 Nu har du fått ett antal filer och kataloger:

index.org

@@ -1,4 +1,3 @@
-
 #+title: Imperative & Object-Oriented Programming Methodology
 #+include: "./setup.org"
 
@@ -103,14 +102,14 @@ given live and recorded for posterity. Recorded lectures appear [[./lectures.org
 | 1/9   | Grundläggande datatyper, deklaration, uttryck och satser. Funktioner. Enkel I/O. Enkel  stränghantering.                  | [[aua:1][A1]] ([[aua:13][F13]], [[aua:15][G15]])                 |  [[file:misc/lecture1.pdf][2020 slides]]   |
 | 4/9   | Poster och unioner. Typnamnsdefinitioner. Funktionspekare. Separatkompilering och headerfiler.                            | [[aua:3][A3]], [[aua:9][D9]], [[aua:15][G15]], [[aua:16][G16]], ([[aua:22][I22]]), [[aua:30][K30]]. |  [[file:misc/lecture2.pdf][2020 slides]]   |
 | 7/9   | Dynamisk minnesallokering. Pekare.                                                                                        | [[aua:10][E10]], [[aua:20][H20]], [[aua:26][J26]], [[aua:27][J27]], [[aua:38][M38]]       |  [[file:misc/lecture3.pdf][2020 slides]]   |
-| 10/9  | Introduktion till resten av kursen. Skillnad mellan funktionell och imperativ programmering. SIMPLE. Det agila upplägget. | [[aua:7][C7]]                            |   [[file:misc/w1-2.pdf][Old slides]]   |
-| 14/9  | Stack och heap, länkade strukturer, pekare 1/2.                                                                           | [[aua:10][E10]], [[aua:20][H20]], [[aua:26][J26]], [[aua:36][M36]]            |   [[file:misc/w3.pdf][Old slides]]   |
-| 17/9  | Stack och heap, länkade strukturer, pekare 2/2.                                                                           | [[aua:27][J27]], [[aua:37][M37]], [[aua:39][M39]]                 |      -''-      |
-| 21/9  | Introduction to testing with CUnit                                                                                        | [[aua:18][G18]], [[aua:49][Q49]], [[aua:50][Q50]]                 |   [[file:misc/w4.pdf][Old slides]]   |
-| 24/9  | Automatisering (Make, scripting) och optimering.                                                                          | [[aua:55][T55]], [[aua:57][U57]], [[aua:58][V58]], [[aua:45][P45]]            |      -''-      |
-| 28/9  | Design & metodologi. Hur strukturerar man? Top-down, bottom-up. Lagertänkande.                                            | [[aua:41][N41]]                           |   [[file:misc/w5.pdf][Old slides]]   |
-| 1/10  | Modularisering, separatkompilering, coupling & cohesion.                                                                  | TBA                           |      -''-      |
-| 5/10  | Defensiv programmering. Läsbar kod.                                                                                       | [[aua:22][I22]], [[aua:45][P45]]                      |   [[file:misc/w6.pdf][Old slides]]   |
+| 10/9  | Introduktion till resten av kursen. Skillnad mellan funktionell och imperativ programmering. SIMPLE. Det agila upplägget. | [[aua:7][C7]]                            |  [[file:misc/lecture4.pdf][2020 slides]]   |
+| 14/9  | Stack och heap, länkade strukturer, pekare 1/2.                                                                           | [[aua:10][E10]], [[aua:20][H20]], [[aua:26][J26]], [[aua:36][M36]]            |  [[file:misc/lecture5.pdf][2020 slides]]   |
+| 17/9  | Stack och heap, länkade strukturer, pekare 2/2.                                                                           | [[aua:27][J27]], [[aua:37][M37]], [[aua:39][M39]]                 |  [[file:misc/lecture6.pdf][2020 slides]]   |
+| 21/9  | Introduction to testing with CUnit                                                                                        | [[aua:18][G18]], [[aua:49][Q49]], [[aua:50][Q50]]                 |  [[file:misc/lecture7.pdf][2020 slides]]   |
+| 24/9  | Design & metodologi. Hur strukturerar man? Top-down, bottom-up. Lagertänkande.                                            | [[aua:41][N41]]                           |  [[file:misc/lecture8.pdf][2020 slides]]   |
+| 28/9  | Automatisering (Make, scripting) och optimering.                                                                          | [[aua:55][T55]], [[aua:57][U57]], [[aua:58][V58]], [[aua:45][P45]]            |  [[file:misc/lecture9.pdf][2020 slides]]   |
+| 1/10  | Modularisering, separatkompilering, coupling & cohesion.                                                                  | TBA                           |  [[file:misc/lecture10.pdf][2020 slides]]   |
+| 5/10  | Defensiv programmering. Läsbar kod.                                                                                       | [[aua:22][I22]], [[aua:45][P45]]                      |  [[file:misc/lecture11.pdf][2020 slides]]   |
 | 8/10  | Preprocessorn. Bitmanipulering.                                                                                           | [[aua:42][O42]], [[aua:43][O43]], [[aua:44][O44]]                 |      -''-      |
 | 12/10 | /Backup/ (Terminalen)                                                                                                     | [[aua:58][V58]]                           |      Demo      |
 | 15/10 | Prepping for code exam                                                                                                    |                               |      N/A       |