update this branch with develop

Author: SteveBronder

make/tests

@@ -38,7 +38,7 @@ endif
 
 ##
 # Adding a test for multiple translation units. If this fails,
-# a new function is probably missing an inline
+# a public umbrella header likely exposes a new non-inline external definition.
 ##
 
 ifneq ($(OS),Windows_NT)

runChecks.py

@@ -142,6 +142,47 @@ def check_non_test_files_in_test():
     return errors
 
 
+def check_rev_test_fixtures():
+    test_files = [
+        x for x in files_in_folder("test/unit/math/rev")
+        if os.path.isfile(x) and x.endswith(testsfx)
+    ]
+    errors = []
+    for filepath in test_files:
+        line_num = 0
+        multi_line_comment = False
+        old_state_multi_line_comment = False
+        with open(filepath, "r") as f:
+            for line in f:
+                line_num += 1
+                if multi_line_comment:
+                    if re.search("\*/", line):
+                        multi_line_comment = False
+                else:
+                    if re.search("/\*", line):
+                        multi_line_comment = True
+                if not multi_line_comment or (
+                    multi_line_comment and not old_state_multi_line_comment
+                ):
+                    if (
+                        not re.search(r".*\bTEST\(.*\*/.*", line)
+                        and not re.search(r".*/\*.*\bTEST\(", line)
+                        and not re.search(r".*//.*\bTEST\(", line)
+                        and re.search(r"\bTEST\(", line)
+                    ):
+                        errors.append(
+                            filepath
+                            + " at line "
+                            + str(line_num)
+                            + ":\n\t[rev-tests] Reverse-mode tests in "
+                            + "test/unit/math/rev must use a cleanup fixture. "
+                            + "Replace raw TEST(...) with TEST_F(AgradRev, ...) "
+                            + "or another approved fixture-based form."
+                        )
+                old_state_multi_line_comment = multi_line_comment
+    return errors
+
+
 def main():
     errors = []
     # Check for files inside stan/math/prim that contain stan/math/rev or stan/math/fwd
@@ -242,6 +283,7 @@ def main():
     )
 
     errors.extend(check_non_test_files_in_test())
+    errors.extend(check_rev_test_fixtures())
 
     errors.extend(check_non_unique_test_names())
 

stan/math/fwd/fun/atan.hpp

@@ -22,7 +22,7 @@ inline fvar<T> atan(const fvar<T>& x) {
  *
  * @tparam T autodiff value type
  * @param[in] z argument
- * @return arc tanget of the argument
+ * @return arc tangent of the argument
  */
 template <typename T>
 inline std::complex<fvar<T>> atan(const std::complex<fvar<T>>& z) {

stan/math/fwd/fun/read_fvar.hpp

@@ -32,7 +32,7 @@ class read_fvar_functor {
 
 /**
  * Function applying the read_fvar_functor to extract the values
- * and tangets of a given fvar matrix into separate matrices.
+ * and tangents of a given fvar matrix into separate matrices.
  *
  * @tparam EigFvar type of the Eigen container of fvar.
  * @tparam EigOut type of the Eigen containers to copy to

stan/math/fwd/functor/finite_diff.hpp

@@ -51,8 +51,8 @@ inline auto aggregate_tangent(const FuncTangent& tangent, const InputArg& arg) {
 
 /**
  * Construct an fvar<T> where the tangent is calculated by finite-differencing.
- * Finite-differencing is only perfomed where the scalar type to be evaluated is
- * `fvar<T>.
+ * Finite-differencing is only performed where the scalar type to be evaluated
+ * is `fvar<T>.
  *
  * Higher-order inputs (i.e., fvar<var> & fvar<fvar<T>>) are also implicitly
  * supported through auto-diffing the finite-differencing process.
@@ -95,8 +95,8 @@ inline auto finite_diff(const F& func, const TArgs&... args) {
 
 /**
  * Construct an fvar<T> where the tangent is calculated by finite-differencing.
- * Finite-differencing is only perfomed where the scalar type to be evaluated is
- * `fvar<T>.
+ * Finite-differencing is only performed where the scalar type to be evaluated
+ * is `fvar<T>.
  *
  * This overload is used when no fvar<T> arguments are passed and simply
  * evaluates the functor with the provided arguments.

stan/math/fwd/meta/is_fvar.hpp

@@ -21,8 +21,6 @@ struct is_fvar<T,
                std::enable_if_t<internal::is_fvar_impl<std::decay_t<T>>::value>>
     : std::true_type {};
 
-template <typename T>
-inline constexpr bool is_fvar_v = is_fvar<T>::value;
 
 }  // namespace stan
 #endif

stan/math/memory/stack_alloc.hpp

@@ -254,7 +254,7 @@ class stack_alloc {
   /**
    * Return number of bytes allocated to this instance by the heap.
    * This is not the same as the number of bytes allocated through
-   * calls to memalloc_.  The latter number is not calculatable
+   * calls to memalloc_.  The latter number is not calculable
    * because space is wasted at the end of blocks if the next
    * alloc request doesn't fit.  (Perhaps we could trim down to
    * what is actually used?)

stan/math/opencl/kernel_generator.hpp

@@ -10,7 +10,7 @@
  * into a single OpenCL kernel. This is much simpler than writing
  * multi-operation kernels by hand.
  *
- * Because global GPU memory loads and stores are relativly slow compared to
+ * Because global GPU memory loads and stores are relatively slow compared to
  * calculations in a kernel, using one kernel for multiple operations is faster
  * than using one kernel per operation.
  *
@@ -27,13 +27,13 @@
  * Element-wise functions can be added using one of the macros in
  * `elt_functions.hpp`.
  *
- * New kernel generator classes must satsify the conditions below:
+ * New kernel generator classes must satisfy the conditions below:
  *
  * 1. The class must be derived from a class inheriting from `operation_cl`.
  * Optionally, if the operation should support being assigned to, it can be
  * derived from a class inheriting `operation_cl_lhs` instead.
  * 2. It's parent template arguments should be set to derived type, type of
- *  scalar and types of any expression arguements.
+ *  scalar and types of any expression arguments.
  * 3. Member type `Scalar` should be defined as scalar type of the result of
  * the operation.
  * 4. Member function `deep_copy` should make a copy of the expression.
@@ -97,7 +97,7 @@
  *
  * A new operation should also have a user-facing function that accepts
  * arguments to the operation and returns the operation object. Arguments should
- * be passed trough function `as_operation_cl` so that they are wrapped in
+ * be passed through function `as_operation_cl` so that they are wrapped in
  * operations if they are not operations themselves. If the operation defines
  * `modify_argument_indices` this function should make copies of arguments by
  * calling `deep_copy()` on them internally.

stan/math/opencl/kernel_generator/broadcast.hpp

@@ -61,7 +61,7 @@ class broadcast_
   }
 
   /**
-   * Sets index/indices along broadcasted dimmension(s) to 0.
+   * Sets index/indices along broadcasted dimension(s) to 0.
    * @param[in, out] row_index_name row index
    * @param[in, out] col_index_name column index
    */
@@ -129,7 +129,7 @@ inline auto broadcast(T&& a) {
 }
 
 /**
- * Broadcast an expression in rowwise dimmension. The argument must have single
+ * Broadcast an expression in rowwise dimension. The argument must have single
  * column. Further expressions can use this expression as if it had any number
  * of columns, repeating the values.
  *
@@ -147,7 +147,7 @@ inline auto rowwise_broadcast(T&& a) {
 }
 
 /**
- * Broadcast an expression in colwise dimmension. The argument must have single
+ * Broadcast an expression in colwise dimension. The argument must have single
  * row. Further expressions can use this expression as if it had any number of
  * rows, repeating the values.
  *

stan/math/opencl/kernel_generator/check_cl.hpp

@@ -142,7 +142,7 @@ class check_cl_ : public operation_cl_lhs<check_cl_<T>, bool> {
 
   /**
    * Adds all write events on any matrices used by nested expression to a list.
-   * Ignores read events anc clears no events.
+   * Ignores read events and clears no events.
    * @param[out] events List of all events.
    */
   inline void get_clear_read_write_events(
@@ -189,7 +189,7 @@ class check_cl_ : public operation_cl_lhs<check_cl_<T>, bool> {
   /**
    * Assignment of a scalar bool triggers the scalar check.
    * @param condition whether the state is ok.
-   * @throws std::domain_error condition is false (chack failed).
+   * @throws std::domain_error condition is false (check failed).
    */
   void operator=(bool condition);  // implemented in multi_result_kernel.hpp
 };