mirror of
https://github.com/Karaka-Management/Developer-Guide.git
synced 2026-01-13 05:18:41 +00:00
Dennis Eichhorn
f7b82f8da3
Some checks failed
CI / linting (push) Has been cancelled
Signed-off-by: Dennis Eichhorn <spl1nes.com@googlemail.com>
70 lines
2.2 KiB
Markdown
Executable File
70 lines
2.2 KiB
Markdown
Executable File
# C/C++
|
|
|
|
The C/C++ code should focus on using simplicity over "modern solutions". This may often mean to heavily restrict the code. The following rule of thumb applies:
|
|
|
|
1. C99 and C++11 should be used where reasonable
|
|
2. C++ may be used in places where external libraries basically require C++
|
|
|
|
The reason for the strong focus on C is that we **personally** believe that C is simpler and easier to understand than the various abstractions provided by C++.
|
|
|
|
## Operating system support
|
|
|
|
C/C++ solutions should be valid on Windows 10+ and Linux.
|
|
|
|
## Performance
|
|
|
|
When writing code keep the following topics in mind:
|
|
|
|
* Branching / Branchless programming
|
|
* Instruction tables and their latency / throughput
|
|
* Cache Sizes
|
|
* Cache Line Size
|
|
* Cache Locality
|
|
* Cache Associativity
|
|
* Memory Bandwidth
|
|
* Memory Latency
|
|
* Prefetching
|
|
* Alignment / Packing
|
|
* Array of Structs vs Struct of Arrays
|
|
* SIMD
|
|
* Choosing correct data types
|
|
* Data Type Sizes (e.g. 32 bit vs 64 bit)
|
|
* Containers (e.g. arrays vs vectors)
|
|
* Signed vs unsigned
|
|
* Threading
|
|
* Cost of abstractions
|
|
* atomics vs locking
|
|
|
|
## Namespace
|
|
|
|
### use
|
|
|
|
Namespaces must never be globally used. This means for example `use namespace std;` is prohibited and functions from the standard namespace should be prefixed instead `std::`
|
|
|
|
## Templates
|
|
|
|
Don't use C++ templates.
|
|
|
|
## Allocation
|
|
|
|
Use memory arenas instead of over and over manually allocating memory.
|
|
|
|
However, if neccessary use C allocation methods for heap allocation.
|
|
|
|
## Functions
|
|
|
|
### C++ function
|
|
|
|
Don't use C++ standard library functions or C++ functions provided by other C++ header files unless you have to work with C++ types which is often required when working with third party libraries.
|
|
|
|
### Parameters
|
|
|
|
Generally, functions that take pointers to non-scalar types should modify the data instead of allocating new memory **IF** reasonable. This forces programmers to consciously create copies before passing data **IF** they need the original data. To indicate that a reference/pointer is not modified by a function define them as const!
|
|
|
|
We believe this approach provides a framework for better memory management and better performance in general.
|
|
|
|
Examples for this can be:
|
|
|
|
* Matrix multiplication with a scalar
|
|
* Sorting data (depends on sorting algorithm)
|