summaryrefslogtreecommitdiff
path: root/Functions
diff options
context:
space:
mode:
authorChristian Kolset <christian.kolset@gmail.com>2024-12-21 20:33:39 +0100
committerChristian Kolset <christian.kolset@gmail.com>2024-12-21 20:33:39 +0100
commit6c7bb93c5e970d442c2bd64a582a5dabd03153e4 (patch)
treef7d1e4260654c7990cc9622505557e6b34906bd3 /Functions
parent26f9500d3fe5073788354102d157cc5e7978c740 (diff)
Updated Readme texts
Diffstat (limited to 'Functions')
-rw-r--r--Functions/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/Functions/README.md b/Functions/README.md
index a198244..07a3349 100644
--- a/Functions/README.md
+++ b/Functions/README.md
@@ -105,3 +105,27 @@ The current state of this function is **deprecated**. The algorithm fails comput
---
## [specialMatrix.m](specialMatrix.m)
+
+# specialMatrix.m
+Function returns a special matrix A with the following criteria:
+- The value of each element in the first row is the number of the column.
+- The value of each element in the first column is the number of the row.
+- The rest of the elements each has a value equal to the sum of the element above it and element to the left.
+- The function returns a sensible error if the user does not input exactly two arguments.
+
+ Synopsis: `[root, fx, ea, iter] = falsePosition(func, xl, xu, es, maxit, varargin)`.
+
+## Input
+`func` - the function being evaluated.
+`xl` - lower bound guess.
+`xu` - upper bound guess.
+`es` - desired relative error (default 0.0001%)
+`maxit` - maximum number of iterations (default 200)
+`varargin` - any additional parameters used by the function
+
+
+## Output
+`A` - special matrix with the appropriate rules
+
+## Notes:
+This function has not much of a practical application, rather a very good exercise for beginners to get started with the basics of matrix manipulation and user-defined functions.