Fix more documentation issues

vfisikop · Oct 10, 2024 · 7683268 · 7683268
1 parent 12c4278
commit 7683268
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 16 deletions.
diff --git a/R/gen_rand_zonotope.R b/R/gen_rand_zonotope.R
@@ -7,8 +7,8 @@
 #' @param nsegments The number of segments that generate the zonotope.
 #' @param generator A list that could contain two elements.
 #' \describe{
-#' \item{distribution}{ the distribution to pick the length of each segment from \eqn{[0,100]}: (i) 'uniform', (ii) 'gaussian' or (iii) 'exponential', the default value is 'uniform.}
-#' \item {seed}{Optional. A fixed seed for the number generator.}
+#' \item{distribution}{The distribution to pick the length of each segment from \eqn{[0,100]}: (i) 'uniform', (ii) 'gaussian' or (iii) 'exponential', the default value is 'uniform.}
+#' \item{seed}{Optional. A fixed seed for the number generator.}
 #' }
 #'
 #' @return A polytope class representing a zonotope.

diff --git a/R/rotate_polytope.R b/R/rotate_polytope.R
@@ -8,11 +8,11 @@
 #' @return A list that contains the rotated polytope and the matrix \eqn{T} of the linear transformation.
 #'
 #' @details Let \eqn{P} be the given polytope and \eqn{Q} the rotated one and \eqn{T} be the matrix of the linear transformation.
-#' \describe{
-#' \item{If \eqn{P} is in H-representation and \eqn{A} is the matrix that contains the normal vectors of the facets of \eqn{Q} then \eqn{AT} contains the normal vactors of the facets of \eqn{P}.}
-#' \item{If \eqn{P} is in V-representation and \eqn{V} is the matrix that contains column-wise the vertices of \eqn{Q} then \eqn{T^TV} contains the vertices of \eqn{P}.}
-#' \item{If \eqn{P} is a zonotope and \eqn{G} is the matrix that contains column-wise the generators of \eqn{Q} then \eqn{T^TG} contains the generators of \eqn{P}.}
-#' \item{If \eqn{M} is a matrix that contains column-wise points in \eqn{Q} then \eqn{T^TM} contains points in \eqn{P}.}
+#' \itemize{
+#' \item If \eqn{P} is in H-representation and \eqn{A} is the matrix that contains the normal vectors of the facets of \eqn{Q} then \eqn{AT} contains the normal vectors of the facets of \eqn{P}.
+#' \item If \eqn{P} is in V-representation and \eqn{V} is the matrix that contains column-wise the vertices of \eqn{Q} then \eqn{T^TV} contains the vertices of \eqn{P}.
+#' \item If \eqn{P} is a zonotope and \eqn{G} is the matrix that contains column-wise the generators of \eqn{Q} then \eqn{T^TG} contains the generators of \eqn{P}.
+#' \item If \eqn{M} is a matrix that contains column-wise points in \eqn{Q} then \eqn{T^TM} contains points in \eqn{P}.
 #' }
 #' @examples
 #' # rotate a H-polytope (2d unit simplex)

diff --git a/man/gen_rand_zonotope.Rd b/man/gen_rand_zonotope.Rd
diff --git a/man/rotate_polytope.Rd b/man/rotate_polytope.Rd
diff --git a/src/uniform_sample_correlation_matrices.cpp b/src/uniform_sample_correlation_matrices.cpp
@@ -21,7 +21,6 @@
 //' @param validate Optional. Whether to validate the sampled matrices. Default is false.
 //'
 //' @return A list of sampled correlation matrices.
-
 // [[Rcpp::export]]
 Rcpp::List uniform_sample_correlation_matrices(const unsigned int n, const unsigned int num_matrices = 1000,
                                                const unsigned int walk_length=1, const unsigned int nburns = 0,  const bool validate = false) {
@@ -43,7 +42,7 @@ Rcpp::List uniform_sample_correlation_matrices(const unsigned int n, const unsig
                  throw Rcpp::exception("Invalid correlation matrix");
              }
          }
-     } 
+     }
 
     Rcpp::List rcpp_sampled_matrices(randCorMatrices.size());
     int index = 0;