Merge pull request #3295 from stan-dev/typo-fixes

Fix typos in error messages, comments

Author: WardBrian

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/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
 };

stan/math/opencl/kernel_generator/colwise_reduction.hpp

@@ -26,10 +26,10 @@ namespace internal {
 class colwise_reduction_base {};
 
 /**
- * Determine number of work groups in rows direction that will be run fro
+ * Determine number of work groups in rows direction that will be run for
  * colwise reduction of given size.
- * @param n_rows number of rows of expression to resuce
- * @param n_cols number of columns of expression to resuce
+ * @param n_rows number of rows of expression to reduce
+ * @param n_cols number of columns of expression to reduce
  * @return number of work groups in rows direction
  */
 inline int colwise_reduction_wgs_rows(int n_rows, int n_cols) {

stan/math/opencl/kernel_generator/constant.hpp

@@ -118,7 +118,7 @@ class constant_ : public operation_cl<constant_<T>, T> {
  *
  * In most cases scalars should be directly used instead of this. This is,
  * however, useful for initializing some expression to specific value if that
- * expresssion could also be plain `matrix_cl`.
+ * expression could also be plain `matrix_cl`.
  *
  * @tparam T type of argument
  * @param a input argument

stan/math/opencl/kernel_generator/elt_function_cl.hpp

@@ -190,7 +190,7 @@ class elt_function_cl : public operation_cl<Derived, Scal, T...> {
 
 /**
  * Generates a class and function for an unary function, defined by OpenCL with
- * special property that it passes trough zero. That is \f$ f(0)=0 \f$. Such a
+ * special property that it passes through zero. That is \f$ f(0)=0 \f$. Such a
  * function can have triangular view equal to its argument's.
  * @param fun function name
  */