aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorcloudygoose <[email protected]>2015-06-02 13:59:41 +0800
committercloudygoose <[email protected]>2015-06-02 13:59:41 +0800
commit6e58756ea75fb912c27436b5b3f556fb03e5e647 (patch)
treecfcba1b5ebbf79b303a399a687c6ea8e2fea8b23 /doc
parent2bb2076fe12deb3bf6a38bd2e192dca06c7736e0 (diff)
doc change about matrix
Diffstat (limited to 'doc')
-rw-r--r--doc/nerv_matrix.md28
1 files changed, 27 insertions, 1 deletions
diff --git a/doc/nerv_matrix.md b/doc/nerv_matrix.md
index 0585ee6..aedefbe 100644
--- a/doc/nerv_matrix.md
+++ b/doc/nerv_matrix.md
@@ -42,6 +42,32 @@ Get `nrow`, the number of rows.
Returns the value(not a pointer) of space the `data_ref` pointer pointed to. This function is mainly for debugging.
* __Matrix/Element\_type, boolean Matrix.\_\_index\_\_(Matrix self, int index)__
If the matrix has more than one row, will return the row at `index` as a __Matrix__ . Otherwise it will return the value at `index`.
-* __void Matrix.\_\_newindex\_\_(Matrix self, int index, Element_type value)__
+* __void Matrix.\_\_newindex\_\_(Matrix self, int index, Element_type value)__
Set the element at `index` to be `value`.
---
+* __Matrix Matrix.create(Matrix a)__
+Return a new __Matrix__ of `a`'s size(of the same number of rows and columns).
+* __Matrix Matrix.colsum(Matrix self)__
+Return a new __Matrix__ of size (1,`self.ncol`), which stores the sum of all columns of __Matrix__ `self`.
+* __Matrix Matrix.rowsum(Matrix self)__
+Return a new __Matrix__ of size (`self.nrow`,1), which stores the sum of all rows of __Matrix__ `self`.
+* __Matrix Matrix.rowmax(Matrix self)__
+Return a new __Matrix__ of size (`self.nrow`,1), which stores the max value of all rows of __Matrix__ `self`.
+* __Matrix Matrix.trans(Matrix self)__
+Return a new __Matrix__ of size (`self.ncol`,`self.nrow`), which stores the transpose of __Matrix__ `self`.
+* __void Matrix.copy_fromh(Matrix self, MMatrix a)__
+Copy the content of a __MMatrix__ `a` to __Matrix__ `self`, they should be of the same size.
+* __void Matrix.copy_fromd(Matrix self, CuMatrix a)__
+Copy the content of a __CuMatrix__ `a` to __Matrix__ `self`, they should be of the same size.
+* __void Matrix.copy_toh(Matrix self, MMatrix a)__
+Copy the content of the __Matrix__ `self` to a __MMatrix__ `a`.
+* __void Matrix.copy_tod(Matrix self, CuMatrix a)__
+Copy the content of the __Matrix__ `self` to a __CuMatrix__ `a`.
+* __void Matrix.add(Matrix self, Matrix ma, Matrix mb, Element_type alpha, Element_type beta)__
+It sets the content of __Matrix__ `self` to be `alpha * ma + beta * mb`.__Matrix__ `ma,mb,self` should be of the same size.
+* __void Matrix.mul(Matrix self, Matrix ma, Matrix mb, Element_type alpha, Element_type beta, [string ta, string tb])__
+It sets the content of __Matrix__ `self` to be `beta * self + alpha * ma * mb`. `ta` and `tb` is optional, if `ta` is 'T', then `ma` will be transposed, also if `tb` is 'T', `mb` will be transposed.
+* __void Matrix.add_row(Matrix self, Matrix va, Element_type beta)__
+It sets the content of __Matrix__ `self`(which should be row vector) to be `self + beta * va`.
+* __void Matrix.fill(Matrix self, Element_type value)__
+Fill the content of __Matrix__ to be `value`. \ No newline at end of file