man-roxygen/iterator_methods.R

In randy3k/arrangements: Fast Generators and Iterators for Permutations, Combinations, Integer Partitions and Compositions

#' @details
#' \preformatted{
#' getnext(d = 1L, layout = NULL, drop = NULL)
#' collect(layout = "row")
#' reset()
#' }
#' \describe{
#' \item{d}{number of fetched arrangements}
#'
#' \item{layout}{if "row", "column" or "list" is specified, the returned value would be a
#'  "row-major" matrix, a "column-major" matrix or a list respectively}
#'
#' \item{drop}{vectorize a matrix or unlist a list}
#' }