0.4 release

Author: gramian

Makefile

@@ -1,22 +1,12 @@
 # matrico Makefile
 
-#CSC = CHICKEN_REPOSITORY_PATH="/home/ch/opt/CHICKEN/lib/chicken/11/" /home/ch/opt/CHICKEN/bin/csc
-#CSI = CHICKEN_REPOSITORY_PATH="/home/ch/opt/CHICKEN/lib/chicken/11/" /home/ch/opt/CHICKEN/bin/csi
-#CHICKEN_INSTALL = /home/ch/opt/CHICKEN/bin/chicken-install
-#CHICKEN_PROFILE =/home/ch/opt/CHICKEN/bin/chicken-profile
-#TEST_NEW_EGG = /home/ch/opt/CHICKEN/bin/test-new-egg
-
-TAR = tar
-SED = sed
+TAR = tar # homebrew: gtar
+SED = sed # homebrew: gsed
 CSC = csc
 CSI = csi
 CHICKEN_INSTALL = chicken-install
 CHICKEN_PROFILE = chicken-profile
-TEST_NEW_EGG = test-new-egg
-
-TAR = gtar
-SED = gsed
-TEST_NEW_EGG = /opt/homebrew/Cellar/chicken/5.3.0_1/bin/test-new-egg
+TEST_NEW_EGG = test-new-egg # homebrew: /opt/homebrew/Cellar/chicken/5.3.0_1/bin/test-new-egg
 
 CLARG =
 LEVEL = -O3
@@ -111,4 +101,3 @@ clean:
 	      matrico.so matrico.import.scm matrico.import.so matrico.static.o \
 	      matrico.build.sh matrico.install.sh matrico.link matrico.static.so \
 	      matrico-$(VERSION).tar.gz PROFILE.*
-

README.md

@@ -39,22 +39,38 @@
 
 ### Install and Test `matrico` Egg
 
-```
+```shell
 CHICKEN_INSTALL_REPOSITORY="/my/egg/directory/" chicken-install -test matrico
 ```
 
 ### Locate and Provide `matrico` Egg
 
-```
+```shell
 CHICKEN_REPOSITORY_PATH="`chicken-install -repository`:/my/egg/directory/" csi
 ```
 
-### Run Demo Code
+### Clone and Try `matrico` Code
 
+```scheme
+(load "matrico.scm")
+
+(import matrico)
 ```
+
+### Run Demo Code
+
+```scheme
 (load "RUNME.scm")
 ```
 
+```scheme
+(load "demos/heat.scm")
+```
+
+```scheme
+(load "demos/flame.scm")
+```
+
 ### Minimal Explanation
 
 `matrico` is a ...
@@ -208,17 +224,17 @@ CHICKEN_REPOSITORY_PATH="`chicken-install -repository`:/my/egg/directory/" csi
 
 * `(mx-ref mat row col)` **flonum** being **matrix** `mat` entry in row and column specified by positive **fixnum**s `row`, `col`.
 
+* `(mx-set mat row col val)` returns **matrix** copy of **matrix** `mat` but with entry in row **fixnum** `row` and column **fixnum** `col` set to **flonum** or one-by-one **matrix** `val`.
+
+* `(mx-set! mat row col val)` returns **void**, sets entry of **matrix** `mat` in row and column specified by positive **fixnum**s `row` and `col` to **flonum** or one-by-one **matrix** `val`.
+
 * `(mx-col mat col)` returns **matrix** being **matrix** `mat`'s column specified by positive **fixnum** `col`.
 
 * `(mx-row mat row)` returns **matrix** being **matrix** `mat`'s row specified by positive **fixnum** `row`.
 
-* `(mx-submatrix mat row1 row2 col1 col2)` returns **matrix** holding entries of **matrix** `mat` in rows specified by positive **fixnum**s `row1` to `row2` and columns specified by positive **fixnum**s `col1` to `col2`.
-
 * `(mx-diag mat)` returns column-**matrix** holding **matrix** `mat`'s diagonal entries.
 
-* `(mx-set mat row col val)` returns **matrix** copy of **matrix** `mat` but with entry in row **fixnum** `row` and column **fixnum** `col` set to **flonum** or one-by-one **matrix** `val`.
-
-* `(mx-set! mat row col val)` returns **void**, sets entry of **matrix** `mat` in row and column specified by positive **fixnum**s `row` and `col` to **flonum** or one-by-one **matrix** `val`.
+* `(mx-submatrix mat row1 row2 col1 col2)` returns **matrix** holding entries of **matrix** `mat` in rows specified by positive **fixnum**s `row1` to `row2` and columns specified by positive **fixnum**s `col1` to `col2`.
 
 #### Matrix Expanders
 
@@ -232,8 +248,6 @@ CHICKEN_REPOSITORY_PATH="`chicken-install -repository`:/my/egg/directory/" csi
 
 * `(mx^ x y)` returns **matrix** of entry-wise exponentiation of **matrix**es `x` to the `y`.
 
-* `(mx-dist x y)` returns **matrix** of entry-wise absolute differences of **matrix**es `x` and `y`, aka distance.
-
 * `(mx-where pred x y)` returns **matrix** of entries of **matrix**es `x` or `y` based on predicate **procedure** `pred`.
 
 * `(mx*+ a x y)` returns **matrix** of entry-wise generalized addition of **flonum** `a` times **matrix** `x` plus **matrix** `y`, aka axpy.
@@ -502,6 +516,12 @@ CHICKEN_REPOSITORY_PATH="`chicken-install -repository`:/my/egg/directory/" csi
 
 ##### Internal
 
+* `(matrix-or-flonum? val)` returns **boolean** answering if argument `val` is a **flonum** or **matrix**.
+
+* `(scalar-or-flonum? val)` returns **boolean** answering if argument `val` is a **flonum** or scalar **matrix**.
+
+* `(column-or-flonum? val)` returns **boolean** answering if argument `val` is a **flonum** or column **matrix**.
+
 * `(ensure-mx val)` returns one-by-one **matrix** if `val` is **flonum**, or `val` if `val` is **matrix**.
 
 * `(ensure-fp val)` returns **flonum** if `val` is **flonum**, or element if `val` is one-by-one **matrix**.
@@ -510,8 +530,6 @@ CHICKEN_REPOSITORY_PATH="`chicken-install -repository`:/my/egg/directory/" csi
 
 * `(translate-rows idx)` returns **fixnum** for **matrix** `mat` translated row index **fixnum** `idx` (from 1-based to 0-based and from end).
 
-* `(back-subst R b)` column-**matrix** solving linear problem of upper-right triangular-**matrix** `R` and column-**matrix** `b` by back substitution.
-
 * `(time-stepper typ fun x0 dt tf)` states-times-steps **matrix** trajectory solving an ordinary differential equation, by method **procedure** `typ`, with vector field **procedure** `fun`, initial state column-**matrix** `x0`, time step **flonum** `dt`, and time horizon **flonum** `tf`.
 
 #### Matrix Backend Library
@@ -521,7 +539,7 @@ Defines the matrix type (record) as column-major list-of-columns and provides ge
 
 * `(matrix? any)` returns **boolean** answering if `any` is a **matrix**, generated by `define-record`.
 
-* `(make-matrix lst cols)` returns **matrix** from list `lst` of columns and **fixnum** number `cols` of columns, generated by `define-record`.
+* `(make-matrix cols lst)` returns **matrix** from list `lst` of columns and **fixnum** number `cols` of columns, generated by `define-record`.
 
 * `(make-matrix* rows cols val)` returns `rows`-by-`cols` **matrix** with all entries set to `val` for **fixnum**s `rows`, `cols`.
 
@@ -547,17 +565,17 @@ Defines the matrix type (record) as column-major list-of-columns and provides ge
 
 * `(matrix-ref mat row col)` returns **any** being **matrix** `mat` entry in **fixnum** `row` and **fixnum** `col`umns.
 
+* `(matrix-set mat row col val)` returns **matrix** copy of **matrix** `mat` but with entry in row **fixnum** `row` and column **fixnum** `col` set to `val`.
+
+* `(matrix-set! mat row col val)` returns **any**, sets entry of **matrix** `mat` in row **fixnum** `row` and column **fixnum** `col` to `val`.
+
 * `(matrix-col mat col)` returns **matrix** being **matrix** `mat` column specified by **fixnum** `col`.
 
 * `(matrix-row mat row)` returns **matrix** being **matrix** `mat` row specified by **fixnum** `row`.
 
-* `(matrix-submatrix mat row1 row2 col1 col2)` returns **matrix** holding entries of **matrix** `mat` from rows **fixnum**s `row1` to `row2` in columns **fixnum**s `col1` to `col2`.
-
 * `(matrix-diag mat)` returns **matrix** holding **matrix** `mat` diagonal entries as column-**matrix**.
 
-* `(matrix-set mat row col val)` returns **matrix** copy of **matrix** `mat` but with entry in row **fixnum** `row` and column **fixnum** `col` set to `val`.
-
-* `(matrix-set! mat row col val)` returns **any**, sets entry of **matrix** `mat` in row **fixnum** `row` and column **fixnum** `col` to `val`.
+* `(matrix-submatrix mat row1 row2 col1 col2)` returns **matrix** holding entries of **matrix** `mat` from rows **fixnum**s `row1` to `row2` in columns **fixnum**s `col1` to `col2`.
 
 * `(matrix-col? mat)` returns **boolean** answering if **matrix** `mat` has only a single column.
 
@@ -621,8 +639,6 @@ Specifies generic column functions for matrix library with f64vector (flonum vec
 #### Homogeneous Flonum Vector Module
 Provides homogeneous vector transformations analogous to vectors.
 
-* `(f64vector-id)` is **string** `"#f64"`.
-
 * `(f64vector-unfold dim fun)` returns **f64vector** of dimension **fixnum** `dim` with procedurally generated elements by **procedure** `fun`.
 
 * `(f64vector-concat . vecs)` returns **f64vector** of concatenated **list**-of-**f64vector**(s) `vecs`.
@@ -702,14 +718,14 @@ Provides additional mathematical functions, extending CHICKEN's `flonum` module.
 
 * `(fplncosh x)` returns **flonum** log-cosh of **flonum** `x`.
 
-* `(fpgauss x)` returns **flonum** Gauss bell curve function evaluation of **flonum** `x`.
-
 * `(fpsignsqrt x)` returns **flonum** sign times square root of absolute value of **flonum** `x`.
 
 * `(fpsinc x)` returns **flonum** cardinal sine function with removed singularity of **flonum** `x`.
 
 * `(fpsigm x)` returns **flonum** standard logistic function of **flonum** `x`, aka sigmoid.
 
+* `(fpgauss x)` returns **flonum** Gauss bell curve function evaluation of **flonum** `x`.
+
 * `(fpstirling x)` returns **flonum** Stirling approximation of factorial of **flonum** `x`.
 
 * `(fptaper x)` returns **string** representation of **flonum** `x` formatted to 8 character fixed width.

matrico.release-info

@@ -13,4 +13,4 @@
 (release "0.3rel")
 
 (release "0.4rc1")
-
+(release "0.4rel")

src/mx.scm

@@ -834,7 +834,6 @@
                                                     (cmgs (fx+1 i) (mx*+ (fpneg Rik) (head Qi) Qk) (tail Qi)))]))
                            (cons Rk R))))))
 
-; TODO:
 ;;@returns: **function** returning column-**matrix** solving the linear (least-squares) problem of **matrix** `mat`, given a column-**matrix** `vec` via QR decomposition.
 (define* (mx-solver mat)
   (returns "**function** returning column-**matrix** solving the linear (least-squares) problem of **matrix** `mat`, given a column-**matrix** `vec` via QR decomposition.")

version.scm

@@ -1,2 +1,2 @@
-(define (matrico-version) "0.4rc1")
+(define (matrico-version) "0.4rel")