Changeset ca6cbc1c in sasview for src

Timestamp:

Jan 17, 2017 7:20:37 AM (8 years ago)

Author:

wojciech

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

ef0e644

Parents:

ae9b8bf

Message:

Updated documentation for lib functions in sasmodels. Refers to ticket 804

File:

• src/sas/sasgui/perspectives/fitting/media/plugin.rst (modified) (4 diffs)

src/sas/sasgui/perspectives/fitting/media/plugin.rst

@@ -568 +568 @@
     cube(x):
         $x^3$
-    sinc(x):
+    sas_sinx_x(x):
         $\sin(x)/x$, with limit $\sin(0)/0 = 1$.
     powr(x, y):
@@ -669 +669 @@
         (`link to Bessel function's code <https://github.com/SasView/sasmodels/tree/master/sasmodels/models/lib/sas_JN.c>`_)
 
-    Si(x):
+    sas_Si(x):
         Sine integral $\text{Si}(x) = \int_0^x \tfrac{\sin t}{t}\,dt$.
 
@@ -693 +693 @@
         (`link to code <https://github.com/SasView/sasmodels/tree/master/sasmodels/models/lib/Si.c>`_)
 
-    sph_j1c(x):
+    sas_3j1x_x(x):
         Spherical Bessel form
         $\text{sph_j1c}(x) = 3 j_1(x)/x = 3 (\sin(x) - x \cos(x))/x^3$,
@@ -701 +701 @@
         This function uses a Taylor series for small $x$ for numerical accuracy.
 
-        :code:`source = ["lib/sph_j1c.c", ...]`
-        (`link to code <https://github.com/SasView/sasmodels/tree/master/sasmodels/models/lib/sph_j1c.c>`_)
-
-
-    sas_J1c(x):
+        :code:`source = ["lib/sas_3j1x_x.c", ...]`
+        (`link to code <https://github.com/SasView/sasmodels/tree/master/sasmodels/models/lib/sas_3j1x_x.c>`_)
+
+
+    sas_2J1x_x(x):
         Bessel form $\text{sas_J1c}(x) = 2 J_1(x)/x$, with a limiting value
         of 1 at $x=0$, where $J_1(x)$ is the Bessel function of first kind