[vspline] 58/72: polished documentation

[Kay F. Jahnke]

This is an automated email from the git hooks/post-receive script.

kfj-guest pushed a commit to branch master
in repository vspline.

commit 128b6f6586d0399d6e824048c54c92ff4c69f2e0
Author: Kay F. Jahnke <kfjahnke at gmail.com>
Date:   Mon May 8 14:24:05 2017 +0200

    polished documentation
---
 README.rst | 37 +++++++++++++++++++++----------------
 1 file changed, 21 insertions(+), 16 deletions(-)

diff --git a/README.rst b/README.rst
index 5465026..83e4c52 100644
--- a/README.rst
+++ b/README.rst
@@ -99,7 +99,9 @@ doxygen vspline.doxy
 
 in vspline's base folder.
 
-You can also access the documentation online from this site_
+There is also 'online documentation'__.
+
+..__: https://kfj.bitbucket.io/
 
 -----
 Speed
@@ -107,25 +109,29 @@ Speed
 
 While performance will vary widely from system to system and between different compiles, I'll quote some measurements from my own system. I include benchmarking code (roundtrip.cc in the examples folder). Here are some measurements done with "roundtrip", working on a full HD (1920*1080) RGB image, using single precision floats internally - the figures are averages of several runs:
 
-testing bc code MIRROR spline degree 3
-avg 32 x prefilter:........................ 13.093750 ms
-avg 32 x remap from unsplit coordinates:... 59.218750 ms
-avg 32 x remap with internal spline:....... 75.125000 ms
-avg 32 x index_remap ...................... 57.781250 ms
+::
+
+  testing bc code MIRROR spline degree 3
+  avg 32 x prefilter:........................ 13.093750 ms
+  avg 32 x remap from unsplit coordinates:... 59.218750 ms
+  avg 32 x remap with internal spline:....... 75.125000 ms
+  avg 32 x index_remap ...................... 57.781250 ms
 
-testing bc code MIRROR spline degree 3 using Vc
-avg 32 x prefilter:........................ 9.562500 ms
-avg 32 x remap from unsplit coordinates:... 22.406250 ms
-avg 32 x remap with internal spline:....... 35.687500 ms
-avg 32 x index_remap ...................... 21.656250 ms
+  testing bc code MIRROR spline degree 3 using Vc
+  avg 32 x prefilter:........................ 9.562500 ms
+  avg 32 x remap from unsplit coordinates:... 22.406250 ms
+  avg 32 x remap with internal spline:....... 35.687500 ms
+  avg 32 x index_remap ...................... 21.656250 ms
 
 As can be seen from these test results, using Vc on my system speeds evaluation up a good deal. When it comes to prefiltering, a lot of time is spent buffering data to make them available for fast vector processing. The time spent on actual calculations is much less. Therefore prefiltering for higher-degree splines doesn't take much more time (when using Vc):
 
-testing bc code MIRROR spline degree 5 using Vc
-avg 32 x prefilter:........................ 10.687500 ms
+::
+
+  testing bc code MIRROR spline degree 5 using Vc
+  avg 32 x prefilter:........................ 10.687500 ms
 
-testing bc code MIRROR spline degree 7 using Vc
-avg 32 x prefilter:........................ 13.656250 ms
+  testing bc code MIRROR spline degree 7 using Vc
+  avg 32 x prefilter:........................ 13.656250 ms
 
 Using double precision arithmetics, vectorization doesn't help so much, and prefiltering is actually slower on my system when using Vc. Doing a complete roundtrip run on your system should give you an idea about which mode of operation best suits your needs.
 
@@ -140,7 +146,6 @@ Some years ago, I needed uniform B-splines for a project in python. I looked for
 .. _libeinspline: http://einspline.sourceforge.net/
 .. _Numpy: http://www.numpy.org/
 .. _repository: https://bitbucket.org/kfj/python-bspline
-.. _site: https://kfj.bitbucket.io/
 
 
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/vspline.git