Added header comments

andonman · andonman · commit ad4258cdf2f2 · 2014-04-14T12:35:01.000+02:00
diff --git a/cachematrix.R b/cachematrix.R
@@ -11,10 +11,25 @@ if (!is.element('MASS', installed.packages()[,1]))
 	library(MASS)
 
 
-## Put comments here that give an overall description of what your
-## functions do
+## Below are two functions that are used to create a special object that stores
+## a numeric matrix and cache it's inverse
+
+# For example the following code sets matrix c,
+# c=rbind(c(1, -1/4), c(-1/4, 1)) 
+# And x<-  makeCacheMatrix(c) to init the object list
+# After this, the call to solve the matrix, gives 
+# the inverse of the original c matrix
+# cacheSolve(x) , calculates the inverse matrix of c
+# If it is called again, inverse is get from the cache
+
+
+## The first function, makeCacheMatrix creates a list containing a function to
+## - set the values from input matrix
+## - get the values of currently stored matrix
+## - set the values of the inverse matrix
+## - get the values of the inverse matrix
+
 
-## Write a short comment describing this function
 
 makeCacheMatrix <- function(x = matrix()) {
 
