[python-arrayfire] 54/58: Updating changes to reflect new documentation
Ghislain Vaillant
ghisvail-guest at moszumanska.debian.org
Wed Sep 28 13:57:09 UTC 2016
This is an automated email from the git hooks/post-receive script.
ghisvail-guest pushed a commit to branch master
in repository python-arrayfire.
commit 3f1d3ab951aaabbc636738d8bf00119d6325bb84
Author: Pavan Yalamanchili <contact at pavanky.com>
Date: Sun Sep 25 01:13:00 2016 -0700
Updating changes to reflect new documentation
---
__af_version__.py | 4 ++--
arrayfire/array.py | 2 ++
arrayfire/lapack.py | 1 +
arrayfire/random.py | 4 ++--
arrayfire/sparse.py | 4 ++--
docs/arrayfire.random.rst | 7 +++++++
docs/arrayfire.rst | 4 +++-
docs/arrayfire.sparse.rst | 7 +++++++
8 files changed, 26 insertions(+), 7 deletions(-)
diff --git a/__af_version__.py b/__af_version__.py
index 72e423a..828a50d 100644
--- a/__af_version__.py
+++ b/__af_version__.py
@@ -9,6 +9,6 @@
# http://arrayfire.com/licenses/BSD-3-Clause
########################################################
-version = "3.3"
-release = "20160624"
+version = "3.4"
+release = "20160925"
full_version = version + "." + release
diff --git a/arrayfire/array.py b/arrayfire/array.py
index 17c17f2..57f5574 100644
--- a/arrayfire/array.py
+++ b/arrayfire/array.py
@@ -305,6 +305,7 @@ class Array(BaseArray):
- 'L' for unsigned 64 bit integer
- 'F' for 32 bit complex number
- 'D' for 64 bit complex number
+
- if arrayfire.Dtype, must be one of the following:
- Dtype.f32 for float
- Dtype.f64 for double
@@ -318,6 +319,7 @@ class Array(BaseArray):
- Dtype.u64 for unsigned 64 bit integer
- Dtype.c32 for 32 bit complex number
- Dtype.c64 for 64 bit complex number
+
- if None, Dtype.f32 is assumed
Attributes
diff --git a/arrayfire/lapack.py b/arrayfire/lapack.py
index 05c1873..e6ffd5c 100644
--- a/arrayfire/lapack.py
+++ b/arrayfire/lapack.py
@@ -142,6 +142,7 @@ def cholesky(A, is_upper=True):
(R,info): tuple of af.Array, int.
- R - triangular matrix.
- info - 0 if decomposition sucessful.
+
Note
----
diff --git a/arrayfire/random.py b/arrayfire/random.py
index c535792..179833d 100644
--- a/arrayfire/random.py
+++ b/arrayfire/random.py
@@ -186,7 +186,7 @@ def get_seed():
Get the seed for the random number generator.
Returns
- ----------
+ -------
seed: int.
Seed for the random number generator
"""
@@ -221,7 +221,7 @@ def get_default_random_engine():
Get the default random engine
Returns
- ------
+ -------
The default random engine used by randu and randn
"""
diff --git a/arrayfire/sparse.py b/arrayfire/sparse.py
index 830b2c7..b261bdb 100644
--- a/arrayfire/sparse.py
+++ b/arrayfire/sparse.py
@@ -115,7 +115,7 @@ def create_sparse_from_dense(dense, storage = STORAGE.CSR):
safe_call(backend.get().af_create_sparse_array_from_dense(c_pointer(out.arr), dense.arr, storage.value))
return out
-def create_sparse_to_dense(sparse):
+def convert_sparse_to_dense(sparse):
"""
Create a dense matrix from a sparse matrix.
@@ -256,7 +256,7 @@ def sparse_get_storage(sparse):
safe_call(backend.get().af_sparse_get_storage(c_pointer(storage), sparse.arr))
return __to_sparse_enum[storage.value]
-def sparse_convert_to(sparse, storage):
+def convert_sparse(sparse, storage):
"""
Convert sparse matrix from one format to another.
diff --git a/docs/arrayfire.random.rst b/docs/arrayfire.random.rst
new file mode 100644
index 0000000..33c86f9
--- /dev/null
+++ b/docs/arrayfire.random.rst
@@ -0,0 +1,7 @@
+arrayfire.random module
+=========================
+
+.. automodule:: arrayfire.random
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.rst b/docs/arrayfire.rst
index 2ccfd3b..2951fcb 100644
--- a/docs/arrayfire.rst
+++ b/docs/arrayfire.rst
@@ -6,7 +6,7 @@ Introduction
.. automodule:: arrayfire
- Submodules
+Submodules
----------
.. autosummary::
@@ -27,6 +27,8 @@ Introduction
arrayfire.lapack
arrayfire.library
arrayfire.opencl
+ arrayfire.random
+ arrayfire.sparse
arrayfire.signal
arrayfire.statistics
arrayfire.timer
diff --git a/docs/arrayfire.sparse.rst b/docs/arrayfire.sparse.rst
new file mode 100644
index 0000000..cc08788
--- /dev/null
+++ b/docs/arrayfire.sparse.rst
@@ -0,0 +1,7 @@
+arrayfire.sparse module
+=========================
+
+.. automodule:: arrayfire.sparse
+ :members:
+ :undoc-members:
+ :show-inheritance:
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/python-arrayfire.git
More information about the debian-science-commits
mailing list