philipzwanenburg/cpp_advanced_features

Overview

The goal of this project is to provide small working examples demonstrating the incorporation of various library, code and github functionality into a larger code. All examples below assume a unix-like operating system and were run on Ubuntu release 16.04 LTS.

All examples presented here are written in c++ and outline any library dependencies along with command line instructions for how to observe the showcased functionality. Code to be entered on the command line is presented as: $ type_this_on_the_cmd_line.

The examples should generally be reviewed in order as they may assume knowledge of previous examples.

Libraries

MPICH

"MPICH is a high performance and widely portable implementation of the Message Passing Interface (MPI) standard." -MPICH website

Examples

• ex1

To Do

• building with various options: (after cmake is introduced, likely need to modify ex1)
  • ch3:nemesis vs. ch3:sock
  • --enable-debuginfo
  • optimization level
• Debugging with Totalview

Doxygen

"Doxygen is the de facto standard tool for generating documentation from annotated C++ sources." -Doxygen website

Examples

• ex2, ex3

To Do

Add examples usage of:

• Images (jpg and eps).

Presentation:

• See the boostorg/hana github and doxygen generated html for an example of a professional project.

CMake

"CMake is an open-source, cross-platform family of tools designed to build, test and package software." -CMake website

Examples

• ex4, ex5

To Do

• Look into CTest (dashboard)
• Use check_function_exists for: blas functions

Google Test

"Google Test is a unit testing library for the C++ programming language, based on the xUnit architecture." -Wikipedia

Examples

• ex6

To Do

• Usage of features outlined in the Advanced Guide:
  • ::testing::AssertionResult
  • Teaching Google Test How to Print Your Values
  • SCOPED_TRACE()
  • Sharing Resources Between Tests in the Same Test Case
  • Value Parameterized Tests
  • Typed Tests
  • Generating an XML Report
  • Turning Assertion Failures into Break-Points
  • Distributing Test Functions to Multiple Machines
• combined with CTest, CMake and Boost (see this SO discussion)
  • incorporating into an existing cmake project

CDash, CTest, valgrind, gcov

Eigen/Hypre/Petsc/Trilinos (To Do)

• Eigen: Expression templates

blas (To Do)

Paraview (To Do)

Boost

Github

• stacktrace

Online Documentation

• Math
  • special functions
  • complex number functions
  • quaternion (hobby: 3D rotation investigation)
  • root finding, Polynomial and Rational Function Evaluation
• Intrusive
• MPI

GNU vs Clang (llvm) (Aditya mentioned potentially faster compile times for clang)

Code Functionality

Dynamic libraries (To Do)

Intrusive containers.

Automatic differentiation (To Do)

Templated functions (double/complex) for complex step verification, Explicit instantiation (To Do)

Flexible data types (float/double) (To Do)

Protected vs. Private class members (discussion of library modification without modifying the source because of allowed inheritance)

valarray vs vector

Use of restrict

Update list of inherited objects through corresponding list of base objects (Not sure if this is possible)

Github Functionality

Code coverage (To Do)

Build passing/failing (To Do)

License

The code is licensed under the GNU GPLv3.

---