implement and document project

Author: muness

cachematrix.R

@@ -1,15 +1,46 @@
-## Put comments here that give an overall description of what your
-## functions do
-
-## Write a short comment describing this function
 
+#' Meant to be used with cacheSolve. Creates a special matrix that can set/get the value of the matrix and of its inverse.
+#' @param x A matrix
+#' @return The cacheMatrix object
+#' @examples
+#' hilbert <- function(n) { i <- 1:n; 1 / outer(i - 1, i, "+") }
+#' matrix11 <- hilbert(11)
+#' cacheMatrix11 <- makeCacheMatrix(matrix11)
+#' cacheSolve(cacheMatrix11)
+#' cacheSolve(cacheMatrix11)
+#' @export
 makeCacheMatrix <- function(x = matrix()) {
-
+  s <- NULL
+  set <- function(y) {
+    x <<- y
+    s <<- NULL
+  }
+  get <- function() x
+  setSolve <- function(solve) s <<- solve
+  getSolve <- function() s
+  list(set = set, get = get,
+       setSolve = setSolve,
+       getSolve = getSolve)
 }
 
-
-## Write a short comment describing this function
-
+#' Return the cached inverse if available. Otherwise, calculate and cache the inverse then return it.
+#' @param x The cacheMatrix
+#' @return the inverse. The cached inverse will be returned on subsequent calls.
+#' @examples
+#' hilbert <- function(n) { i <- 1:n; 1 / outer(i - 1, i, "+") }
+#' matrix11 <- hilbert(11)
+#' cacheMatrix11 <- makeCacheMatrix(matrix11)
+#' cacheSolve(cacheMatrix11)
+#' cacheSolve(cacheMatrix11)
+#' @export
 cacheSolve <- function(x, ...) {
-        ## Return a matrix that is the inverse of 'x'
+  s <- x$getSolve()
+  if(!is.null(s)) {
+    message("getting cached data")
+    return(s)
+  }
+  data <- x$get()
+  s <- solve(data, ...)
+  x$setSolve(s)
+  s
 }