R/square.R

In vincenzocoia/powers: Convenient Computation of Powers

#' Apply a useful power
#'
#' Square, cube, or take the reciprocal/inverse
#' of a vector OR a list of numbers.
#'
#' @param x Vector or list of numbers.
#'
#' @return
#' A vector (atomic, double) that is the:
#' \itemize{
#'      \item square (for \code{square})
#'      \item cube (for \code{cube})
#'      \item reciprocal/inverse (for \code{reciprocal})
#' }
#' of \code{x}.
#'
#' @examples
#' cube(tenvec)
#' square(-5)
#' reciprocal(2)
#' square(list(1, 4, 5))
#' @rdname convenience
#' @export
square <- function(x) {
    raise(x, to = 2)
}