added comments

plannifico · plannifico · commit ce2e9144431a · 2015-04-23T22:31:23.000+02:00
diff --git a/cachematrix.R b/cachematrix.R
@@ -1,7 +1,9 @@
-## Put comments here that give an overall description of what your
-## functions do
-
-## Write a short comment describing this function
+## The function creates a special "vector", which is really a 
+## list containing a function to:
+##      - set the value of the matrix
+##      - get the value of the matrix
+##      - set the inverse of the matrix
+##      - get the inverse of the matrix
 
 makeCacheMatrix <- function(x = matrix()) {
 
@@ -19,7 +21,11 @@ makeCacheMatrix <- function(x = matrix()) {
 }
 
 
-## Write a short comment describing this function
+## The function calculates the inverse of the special "matrix" 
+## created with the function "makeCacheMatrix". 
+## It first checks to see if the inverse has already been calculated. 
+##      - If so, it gets the inverse from the cache
+##      - Otherwise, it calculates the inverse and sets the inverse in the cache
 
 cacheSolve <- function(x, ...) {
         ## Return a matrix that is the inverse of 'x'
