Clang-tidy Readability Checks

[boulderdaze]

Closes #516

We decided to disable the following three checks but I had to disable some more checks for the reason described below.

Disabled

• 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

This is disabled because it requires fairly large cleanup efforts. Since this involves with mainly re-defining variables in math domain, it requires communication within the team.

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

Disabled for the following reasons

• readability-avoid-unconditional-preprocessor-if
micm/util /error.hpp has the copyright comments that has to be removed for a fortran code in musica.
  LLVM recently added a feature to exclude headers from clang-tidy analysis. We can revisit this check when the next release is available.

#if 0
/* Copyright (C) 2023-2024 National Center for Atmospheric Research
 *
 * SPDX-License-Identifier: Apache-2.0
 */

• readability-convert-member-functions-to-static
  : This wants to put static in the inlined function defined outside the class definition but static must be specified inside the class definition.

• readability-named-parameter
  : false positives
  micm/include/micm/util/vector_matrix.hpp:167:50: error: all parameters should be named in a function

  167 |     VectorMatrix(const std::vector<std::vector<T>> &other)
      |                                                  ^
      |                                                   /*unused*/

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.90%. Comparing base (20015ed) to head (90b554c).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #526      +/-   ##
==========================================
- Coverage   92.90%   92.90%   -0.01%     
==========================================
  Files          42       42              
  Lines        3270     3268       -2     
==========================================
- Hits         3038     3036       -2     
  Misses        232      232              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[mwaxmonsky]

Great job @boulderdaze!

[mattldawson]

nice work!