factorial

Calculate factorial and test it using assert statements. Currently broken, so needs to be fixed.

Check that style conforms to clang-tidy options specified in .clang-tidy

There should be no warning or errors when compiled, run, or style checked using clang-tidy.

Included Files

TODO(student): Examine each file and understand what they do
Remove this line after you have examined all the files.

• CMakeLists.txt: For complex projects, cmake CMakeLists.txt will generate a Makefile. We can then use make to compile the project. Optional for a small project like this, but included as an example.

• factorial.cpp: Definitions for factorial functions

• factorialtest.cpp: Test functions to test factorial

• main.cpp: A generic main file to call testAll() to run all tests

• output.txt: Output from ./simple.compile.sh > output.txt 2>&1 showing how the program is compiled and run

• simplecompile.sh: Unix bash script file to compile, run clang-tidy as well as other programs and then delete the executable. Can be used to create an output.txt file

• .clang-tidy: Specify the options for clang-tidy program, so we do not have to enter them on the command line each time. Usage: clang-tidy *.cpp -- -std=c++14

• .clang-format: Not included, but generated by simplecompile.sh based on LLVM style. You can edit simplecompile.sh to change the style. simplecompile.sh will use clang-format program to generate a properly formatted version of each *.cpp file and use diff to compare it to the original file.

• .gitattributes: Options for git. Making sure that simplecompile.sh always has the correct line endings when moving between Windows and unix systems

• .gitignore: Files that should not be checked into git. Mostly ide files and executables.

• .travis.yml: When GitHub is configured correctly, checking the project into GitHub should trigger Travis CI to compile and run the program. See log at https://travis-ci.com/dashboard

• .github/workflows/githubsimplecompile.yml: Checking the project into GitHub should trigger Github Actions to compile and run the program. See log at https://github.com/GITHUB_USER_NAME/REPOSITORY_NAME/actions

Compile and Run

./simplecompile.sh

or

cmake CmakeLists.txt
make
./factorial

or

clang++ -std=c++14 -Wall -Wextra *.cpp -o factorial
./factorial

To save the result of the output fron standard oputput and standard error, use redirect

./simplecompile.sh > output.txt 2>&1

Style check

clang-tidy *.cpp -- -std=c++14

Style Explanation

These options are defined in .clang-tidy file.

If you modify .clang-tidy, you MUST to explain your style choices here.

TODO(student): Remove this line after you have made changes to .clang-tidy
and updated the README.md file.

Perform all check except the following:

• cppcoreguidelines-pro-bounds-array-to-pointer-decay: do not give warnings on assert
• google-build-using-namespace: for simplicity allow using namespace std;
• google-readability-braces-around-statements: allow compact code without {
• readability-braces-around-statements: allow compact code without { (this option is not available in CSS Linux lab under LLVM 3.8.1, but is needed on my PC when using 9.0.0)
• hicpp-no-array-decay: let us use assert without warning
• modernize-use-trailing-return-type: not ready to use ->int as return type for functions

Based on LLVM style in https://llvm.org/docs/CodingStandards.html#the-low-level-issues

If you are adapting a different style, modify .clang-tidy, and explain your style choices here.

TODO(student): Remove this line after you have determined your preferred style.

CheckOptions:
 - { key: readability-identifier-naming.ClassCase,           value: CamelCase  }
 - { key: readability-identifier-naming.StructCase,          value: CamelCase  }
 - { key: readability-identifier-naming.EnumCase,            value: CamelCase  }
 - { key: readability-identifier-naming.VariableCase,        value: CamelCase  }
 - { key: readability-identifier-naming.GlobalConstantCase,  value: UPPER_CASE }
 - { key: readability-identifier-naming.FunctionCase,        value: camelBack  }
 - { key: readability-identifier-naming.PublicMethodCase,    value: camelBack  }
 - { key: readability-identifier-naming.PrivateMethodCase,   value: camelBack  }
 - { key: readability-identifier-naming.PublicMemberCase,    value: CamelCase  } 

Misc

This files is part of a repository located at https://github.com/pisan343/factorial BUT most students will use it as the starting code for GitHub Classroom exercise

IF you are not using this as part of Github Classroom, you can clone the repository using

git clone https://github.com/pisan343/factorial

When Travis CI runs the automated build, the results would be at

https://travis-ci.com/pisan343/factorial

When using via GitHub Classroom, the Travis CI output will be at

https://travis-ci.com/uwbclass/fixfactorial-yourgithubusername

Set your TravisCI account preferences at https://travis-ci.com/account/preferences so you get emails when your build passes or fails.