Added UFCS

standard-library.md

@@ -12,23 +12,23 @@ import standard;
 
 This function returns a string representation of the current timestamp.
 
-## _concat(self, other)
+## concat(self, other)
 
 This function only works when self and other are matching compounds (both arrays, dictionaries or strings). It returns a new compound of that kind, with the content of `other` appended to the content of `self`.
 
-## _containsKey(self: dictionary, key)
+## containsKey(self: dictionary, key)
 
 This function returns `true` if `self` contains the given `key`, otherwise it returns false.
 
-## _containsValue(self, value)
+## containsValue(self, value)
 
 This function returns `true` if `self` contains the given `value`, otherwise it returns false.
 
-## _every(self, func: fn)
+## every(self, func: fn)
 
 This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, until `func` returns `false`, at which point this function returns `false`. Otherwise this function returns `true`.
 
-## _forEach(self, func: fn)
+## forEach(self, func: fn)
 
 This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time.
 
@@ -44,23 +44,23 @@ var a = [1, 3, 5];
 a.forEach(p); //prints 1, 3, and 5 to stdout
 ```
 
-## _filter(self, func: fn)
+## filter(self, func: fn)
 
 This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, and the function returns a new compound for every element that `func` returned a truthy value for.
 
-## _getKeys(self: dictionary)
+## getKeys(self: dictionary)
 
 This returns an array of all non-null keys stored within the dictionary. The order is undefined.
 
-## _getValues(self: dictionary)
+## getValues(self: dictionary)
 
 This returns an array of all values with non-null keys stored within the dictionary. The order is undefined.
 
-## _indexOf(self: array, value)
+## indexOf(self: array, value)
 
 This function returns the first index within `self` that is equal to `value`, or `null` if none are found.
 
-## _map(self, func: fn)
+## map(self, func: fn)
 
 This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. It returns an array with the results of each call - the order of the results when called on a dictionary are undefined.
 
@@ -76,7 +76,7 @@ var a = [1, 2, 3];
 print a.map(increment); //prints [2,3,4];
 ```
 
-## _reduce(self, default, func: fn)
+## reduce(self, default, func: fn)
 
 This function takes either an array or a dictionary as the `self` argument, a default value, and a function as `func`. The argument `func` takes three arguments - the first is the accumulator, the second is the index/key and the third is the value. It applies the given function to every element of the array/dictionary, passing the result of each call as the accumulator to the next (the default value is used for the first call). Finally, the final value of the accumulator is returned to the caller.
 
@@ -92,11 +92,11 @@ var a = [1, 2, 3, 4];
 print a.reduce(0, f); //prints "10"
 ```
 
-## _some(self, func: fn)
+## some(self, func: fn)
 
 This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, until `func` returns `true`, at which point this function returns `true`. Otherwise this function returns `false`.
 
-## _sort(self: array, func: fn)
+## sort(self: array, func: fn)
 
 This function takes an array as the `self` argument, and a comparison function as `func`. The argument `func` must take two arguments, and return a truthy or falsy value. The contents of the array in `self` are sorted based on the results of `func`, as though function were the less comparison function.
 
@@ -107,26 +107,26 @@ fn less(a, b) {
     return a < b;
 }
 
-var a = [4, 2, 3, 1];
+var a = [4, 1, 3, 2];
 
 print a.sort(less); //prints "[1, 2, 3, 4]"
 ```
 
-## _toLower(self: string)
+## toLower(self: string)
 
 This function returns a new string which is identical to the string `self`, except any uppercase letters are replaced with the corresponding lowercase letters.
 
-## _toString(self)
+## toString(self)
 
 This function returns a string representation of `self`. This is intended for arrays and dictionaries, but can theoretically work on any printable value.
 
 If the resulting string is longer than `TOY_MAX_STRING_LENGTH` - 1, then it is truncated.
 
-## _toUpper(self: string)
+## toUpper(self: string)
 
 This function returns a new string which is identical to the string `self`, except any lowercase letters are replaced with the corresponding uppercase letters.
 
-## _trim(self: string, trimChars: string = " \t\n\r")
+## trim(self: string, trimChars: string = " \t\n\r")
 
 This function returns a new string which is identical to the string `self`, except any characters at the beginning or end of `self` which are present in the argument `trimChars` are removed. The argument `trimChars` is optional, and has the following characters as the default value:
 
@@ -137,11 +137,11 @@ This function returns a new string which is identical to the string `self`, exce
 
 These characters used because they are the only control characters currently supported by Toy.
 
-## _trimBegin(self: string, trimChars: string = " \t\n\r")
+## trimBegin(self: string, trimChars: string = " \t\n\r")
 
 This is identical to `_trim(self, trimChars)`, except it is only applied to the beginning of the first argument.
 
-## _trimEnd(self: string, trimChars: string = " \t\n\r")
+## trimEnd(self: string, trimChars: string = " \t\n\r")
 
 This is identical to `_trim(self, trimChars)`, except it is only applied to the end of the first argument.