From 887cd5b0c798a3c5de73a9e155e549a92093d58c Mon Sep 17 00:00:00 2001
From: Andreas Kloeckner <inform@tiker.net>
Date: Tue, 10 May 2016 22:00:01 -0500
Subject: [PATCH] Random123 doc tweaks
---
pyopencl/clrandom.py | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/pyopencl/clrandom.py b/pyopencl/clrandom.py
index 6d4b2222..b2575de6 100644
--- a/pyopencl/clrandom.py
+++ b/pyopencl/clrandom.py
@@ -32,13 +32,13 @@ PyOpenCL now includes and uses some of the `Random123 random number generators
Research. In addition to being usable through the convenience functions above,
they are available in any piece of code compiled through PyOpenCL by::
- #include <pyopencl-philox.cl>
- #include <pyopencl-threefry.cl>
+ #include <pyopencl-random123/philox.cl>
+ #include <pyopencl-random123/threefry.cl>
See the `Philox source
-<https://github.com/pyopencl/pyopencl/blob/master/src/cl/pyopencl-philox.cl>`_
+<https://github.com/pyopencl/pyopencl/blob/master/pyopencl/cl/pyopencl-random123/philox.cl>`_
and the `Threefry source
-<https://github.com/pyopencl/pyopencl/blob/master/src/cl/pyopencl-threefish.cl>`_
+<https://github.com/pyopencl/pyopencl/blob/master/pyopencl/cl/pyopencl-random123/threefry.cl>`_
for some documentation if you're planning on using Random123 directly.
.. note::
@@ -672,12 +672,16 @@ class Random123GeneratorBase(object):
class PhiloxGenerator(Random123GeneratorBase):
+ __doc__ = Random123GeneratorBase.__doc__
+
header_name = "pyopencl-random123/philox.cl"
generator_name = "philox4x32"
key_length = 2
class ThreefryGenerator(Random123GeneratorBase):
+ __doc__ = Random123GeneratorBase.__doc__
+
header_name = "pyopencl-random123/threefry.cl"
generator_name = "threefry4x32"
key_length = 4
--
GitLab