README.md 8.37 KB
Newer Older
Praetorius, Simon's avatar
Praetorius, Simon committed
1
# Scientific Programming with C++
Praetorius, Simon's avatar
Praetorius, Simon committed
2
3
4
5
6
7

*Summary of the lecture*

*general information about the structure of lecture and tutorial*


Praetorius, Simon's avatar
Praetorius, Simon committed
8
In this module SCPROG the exercises and projects will be submitted online into a version
Praetorius, Simon's avatar
Praetorius, Simon committed
9
control system [Git](https://git-scm.com/) hosted at the MatNat [GitLab](https://gitlab.mn.tu-dresden.de)
Praetorius, Simon's avatar
Praetorius, Simon committed
10
platform, which is a web-based Git repository manager similar to [GitHub](https://github.com)
Praetorius, Simon's avatar
Praetorius, Simon committed
11
12
and [Bitbucket](https://bitbucket.org).

Praetorius, Simon's avatar
Praetorius, Simon committed
13
14
Handing in solutions to exercises and projects digitally on such a platform is a
good way of learning and training collaborative coding, which is commonplace in
Praetorius, Simon's avatar
Praetorius, Simon committed
15
16
Scientific Computing research groups.

Praetorius, Simon's avatar
Praetorius, Simon committed
17
Additionally to the learning effect, you can collect points for submitted exercises
Praetorius, Simon's avatar
Praetorius, Simon committed
18
that may eventually lead to an improvement in you final exam by at most a grade 0.3. To
Praetorius, Simon's avatar
Praetorius, Simon committed
19
reach this bonus, you have to gain 66% of the possible exercise points (max. = 100).
Praetorius, Simon's avatar
Praetorius, Simon committed
20

Praetorius, Simon's avatar
Praetorius, Simon committed
21
In order to allow fast correction and evaluation of submitted solutions, we require
Praetorius, Simon's avatar
Praetorius, Simon committed
22
a predefined structure of the repositories and coding styles to be followed. Not
Praetorius, Simon's avatar
Praetorius, Simon committed
23
following these rules for repositories may result in your solution not being reviewed.
Praetorius, Simon's avatar
Praetorius, Simon committed
24
25
26
27
28
29
You will then have to reformat it and submit again. Not following the style guidelines
may result in point deduction, with the amount of points depending on the impact your
style could have on actual collaborative projects.

# Your Repository on GitLab
## Account
Praetorius, Simon's avatar
Praetorius, Simon committed
30
In the first tutorial we will create an account on the local GitLab platform,
Praetorius, Simon's avatar
Praetorius, Simon committed
31
32
using the ZIH-Login (s...-number) for the account user name associated to your TU-Dresden
email address. This ensures that you will get credit for your submissions.
Praetorius, Simon's avatar
Praetorius, Simon committed
33
34

## Project Name
35
Please form groups of up to two members and exchange contact details so you can find
Praetorius, Simon's avatar
Praetorius, Simon committed
36
each other on GitLab. One of you should create a *private* (!) project, and invite the rest
37
38
of the group. The name of your project is `scprog-Name1Name2`, where `Name1`
is the last name of the first student, `Name2` that of the second student. These
Praetorius, Simon's avatar
Praetorius, Simon committed
39
40
41
42
43
44
45
46
47
48
names should be sorted alphabetically. If your lineup changes for any reason during the
course of the semester, please create a new project that reflects this and inform your
tutors.

## Directory Structure
Your repository should consist of two levels of directories, one for the exercise sheets and
one for the individual exercises. This results in a tree structure like this:

```
sheet1
Praetorius, Simon's avatar
Praetorius, Simon committed
49
50
51
52
53
54
55
56
57
 +-- exercise1
 |    +-- main.cc
 |    +-- solution.txt
 |    \-- <header and source files>
 |
 +-- exercise2
 |    \-- <files as above>
 |
 \-- (...)
Praetorius, Simon's avatar
Praetorius, Simon committed
58

Praetorius, Simon's avatar
Praetorius, Simon committed
59
sheet2
Praetorius, Simon's avatar
Praetorius, Simon committed
60
61
62
 +-- exercise1
 +-- exercise2
 \-- (...)
Praetorius, Simon's avatar
Praetorius, Simon committed
63

Praetorius, Simon's avatar
Praetorius, Simon committed
64
(...)
Praetorius, Simon's avatar
Praetorius, Simon committed
65
66
67
68
69
70
```

You are free to name and structure your C++ files in any way you like, but there
should always be a file named `main.cc` that is a sample application of your implemented
classes. Often the content is given in the exercise, if it isn’t you are free to choose
sensible test cases yourselves. Make sure that this file `main.cc` can be compiled with
Praetorius, Simon's avatar
Praetorius, Simon committed
71
the command given in the lecture, or alternatively provide a [MakeFile](http://www.c-howto.de/tutorial/makefiles/)
Praetorius, Simon's avatar
Praetorius, Simon committed
72
or [CMakeLists.txt](https://cmake.org/cmake/help/latest/) that builds the exercise.
Praetorius, Simon's avatar
Praetorius, Simon committed
73
74
75

The file `solution.txt` is meant for the output of your `main.cc` and for answering
questions that appear in the exercises. If an exercise is of theoretical nature and doesn’t
Praetorius, Simon's avatar
Praetorius, Simon committed
76
77
78
include actual coding, this is the only file you have to submit. Optionally you can
submit a [Markdown](https://docs.gitlab.com/ee/user/markdown.html) file `solution.md`
instead. This allows basic formatting of the text.
Praetorius, Simon's avatar
Praetorius, Simon committed
79
80

## Access to the Repository
81
82
Please give your tutor @spraetor write access (at least Reporter status) to your project so that
your submissions can be graded.
Praetorius, Simon's avatar
Praetorius, Simon committed
83

Praetorius, Simon's avatar
Praetorius, Simon committed
84
# Submission of Exercises
Praetorius, Simon's avatar
Praetorius, Simon committed
85
86
87
88
On each exercise sheet some exercises are marked for submission with in sum 10 possible exercise points.
You have approximately two weeks for each of these exercises, where the final date is written
next to the exercise. In order to get your solutions reviewed, it has to be committed to your
GitLab repository following the procedure:
Praetorius, Simon's avatar
Praetorius, Simon committed
89
90
91
92

1. For each exercise sheet create a new branch called `sheetX` where `X` is the number of
   the sheet.
2. Create the new directory following the directory structure as above
Praetorius, Simon's avatar
Praetorius, Simon committed
93
3. Commit your solutions to the branch
Praetorius, Simon's avatar
Praetorius, Simon committed
94
95
4. Create a merge request to your master branch

Praetorius, Simon's avatar
Praetorius, Simon committed
96
After final review of your submission (and maybe inclusion of your corrections)
Praetorius, Simon's avatar
Praetorius, Simon committed
97
98
you get a comment in the MergeRequest section of GitLab and a :thumbsup:. This allows you to merge
your branch into your `master` branch.
Praetorius, Simon's avatar
Praetorius, Simon committed
99

Praetorius, Simon's avatar
Praetorius, Simon committed
100

Praetorius, Simon's avatar
Praetorius, Simon committed
101
102
103
104
105
106
107
108
109
110
111
# Style Guidelines
All programs you submit should follow basic programming rules like the following:

- **Formatting**
  - Put each instruction on a separate line (two lines if it is very large)
  - Use spaces to separate variable names, functions and operators
  - Indent your lines to visually mark different lines belonging to different scopes
- **Variable names**
  - The name should reflect the purpose of the variable
  - Variable names start with a lowercase letter, types with an uppercase letter
  - The rest of the name format for identifiers is up to you
Praetorius, Simon's avatar
Praetorius, Simon committed
112
  - Simple counting integers and similar variables are exceptions
Praetorius, Simon's avatar
Praetorius, Simon committed
113
114
115
116
- **Comments**
  - Comments allow others to understand your intentions
  - Tutors can only give you points if they understand what you were trying to do
  - *Guideline:* one comment per class, per function, per algorithm subtask, per tricky or "exotic" source line
Praetorius, Simon's avatar
Praetorius, Simon committed
117
  - Don't comment to much either, this may visually drown the actual code or diverge from what is actually coded (!)
Praetorius, Simon's avatar
Praetorius, Simon committed
118
119
120
121
  - Leave out trivial comments ("This is the constructor")
- **Language constructs**
  - You may use any construct you want, even if it has not yet been introduced in the lecture
  - Avoid constructs that have been superseded by better alternatives in the lecture
Praetorius, Simon's avatar
Praetorius, Simon committed
122
  - Declare variables and references as `const` where it is possible
Praetorius, Simon's avatar
Praetorius, Simon committed
123
  - Separate interface and implementation by correctly using public and private
Praetorius, Simon's avatar
Praetorius, Simon committed
124
  - Use smart pointers instead of raw pointers once the lecture has introduced them
Praetorius, Simon's avatar
Praetorius, Simon committed
125

Praetorius, Simon's avatar
Praetorius, Simon committed
126
Optionally, see [Google C++ Style Guide](http://google.github.io/styleguide/cppguide.html) for
Praetorius, Simon's avatar
Praetorius, Simon committed
127
128
more rules and guidelines on the coding style. Also, see the
[C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md)
Praetorius, Simon's avatar
Praetorius, Simon committed
129
130
131
132
133
for a comprehensive list of best practice programming rules for C++.

# More reading
Online references and literature useful for completing the exercises are listed below:

Praetorius, Simon's avatar
Praetorius, Simon committed
134
135
136
137
- **Online-References:**
  - [cppreference.com](http://en.cppreference.com), [BLAS](http://www.netlib.org/blas),
    [LAPACK](http://www.netlib.org/lapack/), [DUNE](https://www.dune-project.org/doxygen/),
    [Git](https://git-scm.com/docs), [Boost](https://www.boost.org/doc/libs/1_71_0/),
Praetorius, Simon's avatar
Praetorius, Simon committed
138
    [CMake](https://cmake.org/cmake/help/latest/)
Praetorius, Simon's avatar
Praetorius, Simon committed
139
- **Cheat-sheets:**
Praetorius, Simon's avatar
Praetorius, Simon committed
140
  - [Divhints](https://devhints.io/), [Git](https://github.github.com/training-kit/downloads/github-git-cheat-sheet.pdf),
Praetorius, Simon's avatar
Praetorius, Simon committed
141
    [Linux Command Line](https://appletree.or.kr/quick_reference_cards/Unix-Linux/Linux%20Command%20Line%20Cheat%20Sheet.pdf)
Praetorius, Simon's avatar
Praetorius, Simon committed
142
- **Tutorials:**
Praetorius, Simon's avatar
Praetorius, Simon committed
143
  - [MTL4](http://old.simunova.com/docs/mtl4/html/tutorial.html), [Git](https://git-scm.com/book/en/v2)
Praetorius, Simon's avatar
Praetorius, Simon committed
144
- **Compiler:**
Praetorius, Simon's avatar
Praetorius, Simon committed
145
  - [GCC](https://gcc.gnu.org/), [Clang](http://clang.llvm.org/), [Intel Icc](https://software.intel.com/en-us/c-compilers)
Praetorius, Simon's avatar
Praetorius, Simon committed
146
147
- **Books:**
  - Discovering Modern C++: An Intensive Course for Scientists, Engineers, and Programmers, Peter Gottschling, 2015:
Praetorius, Simon's avatar
Praetorius, Simon committed
148
    [slub](http://katalogbeta.slub-dresden.de/id/0017278767/#detail), [online](http://proquest.tech.safaribooksonline.de/9780134383682)
Praetorius, Simon's avatar
Praetorius, Simon committed
149
  - *References:* Die C++ Programmiersprache (Bjarne Stroustrup),
Praetorius, Simon's avatar
Praetorius, Simon committed
150
151
    C++ Kurz & Gut (Kyle Loudon, Rainer Grimm): [slub](http://katalogbeta.slub-dresden.de/id/0012713756/#detail)
  - *Beginners:* C++ Primer (Stanley Lippman, Josee Lajoie, Barbara E. Moo): [online](http://proquest.tech.safaribooksonline.de/9780133053043)
Praetorius, Simon's avatar
Praetorius, Simon committed
152
  - *Intermediate level:* Effective Modern C++ (Scott Meyers): [slub](http://katalogbeta.slub-dresden.de/id/0013617247/#detail), [online](http://proquest.tech.safaribooksonline.de/9781491908419),
Praetorius, Simon's avatar
Praetorius, Simon committed
153
    C++ Templates: The Complete Guide (David Vandevoorde, Nicolai M. Josuttis): [online](http://proquest.tech.safaribooksonline.de/0201734842)
Praetorius, Simon's avatar
Praetorius, Simon committed
154
  - *Experts:* Modern C++ Design (Andrei Alexandrescu): [online](http://proquest.tech.safaribooksonline.de/0201704315),
Praetorius, Simon's avatar
Praetorius, Simon committed
155
    C++ Template Metaprogramming (David Abrahams, Aleksey Gurovoy): [online](http://proquest.tech.safaribooksonline.de/0321227255)