Clang-tidy Readability Checks

Turn on

readability-math-missing-parentheses

d_x[x_column_backward_index * number_of_grid_cells + tid] /= d_U[nUij_Uii_element.second + tid];
error: '*' has higher precedence than '+'; add parentheses to explicitly specify the order of operations

readability-non-const-parameter

__device__ void WarpReduce(volatile double* sdata, size_t tid)
error: pointer parameter 'sdata' can be pointer to const

readability-convert-member-functions-to-static

inline std::size_t UserDefinedRateConstant::SizeCustomParameters() const
error: method 'SizeCustomParameters' can be made static

readability-braces-around-statements

if (parameters_.branch_ == BranchedRateConstantParameters::Branch::Alkoxy)
return pre * (z_ / (z_ + Atmn));
error: statement should be inside braces

readability-make-member-function-const

inline llvm::AllocaInst* JitFunction::CreateEntryBlockAlloca(llvm::Type* type, const std::string& var_name)
error: method 'CreateEntryBlockAlloca' can be made const

readability-named-parameter

JitProcessSet &operator=(JitProcessSet &&);
error: all parameters should be named in a function

readability-implicit-bool-conversion

assert((!generated_) && "JIT Function already generated");
error: implicit conversion 'const char *' -> 'bool'

readability-simplify-boolean-expr

if (elem == end)
return true;
return false
-> return static_cast<bool>(elem == end)
error: redundant boolean literal in conditional return statement

readability-avoid-unconditional-preprocessor-if

#if 0
error: preprocessor condition is always 'false', consider removing both the condition and its contents

Turn off

readability-magic-numbers

parameters.c_[13] = 0.1631930543123136E+02;
error: 13 is a magic number; consider replacing it with a named constant

readability-avoid-const-params-in-decls

const std::function<LinearSolverPolicy(const SparseMatrixPolicy<double>, double)> create_linear_solver
error: parameter 'create_linear_solver' is const-qualified in the function declaration; 
const-qualification of parameters only has an effect in function definitions

readability-isolate-declaration

double d_ymax, d_scale;
error: multiple declarations in a single statement reduces readability

Conditional

readability-identifier-length turn on for parameters turn off for variables


void Decompose(const SparseMatrixPolicy<T>& A, SparseMatrixPolicy<T>& L, SparseMatrixPolicy<T>& U) const
error: parameter name 'A' is too short, expected at least 3 characters

double k0 = error: variable name 'k0' is too short, expected at least 3 characters

--------------
### Turn off 
 - `readability-named-parameter`: false positive?
micm/include/micm/util/vector_matrix.hpp:167:50: error: all parameters should be named in a function 
```c++
  167 |     VectorMatrix(const std::vector<std::vector<T>> &other)
      |                                                  ^
      |                                                   /*unused*/

NCAR / micm