File: add_newdocs.py

package info (click to toggle)
python-scipy 0.10.1%2Bdfsg2-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 42,232 kB
  • sloc: cpp: 224,773; ansic: 103,496; python: 85,210; fortran: 79,130; makefile: 272; sh: 43
file content (67 lines) | stat: -rw-r--r-- 1,619 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

# Adding documentation to the logit and expit ufuncs

from _logit import logit, expit

try:
    from numpy.lib import add_newdoc_ufunc

    add_newdoc_ufunc(logit,
        """
        Logit ufunc for ndarrays.

        The logit function is defined as logit(p) = log(p/(1-p)).
        Note that logit(0) = -inf, logit(1) = inf, and logit(p)
        for p<0 or p>1 yields nan.

        Parameters
        ----------
        x : ndarray
            The ndarray to apply logit to element-wise.

        Returns
        -------
        out : ndarray
            An ndarray of the same shape as x. Its entries
            are logit of the corresponding entry of x.

        Notes
        -----
        As a ufunc logit takes a number of optional
        keywork arguments. For more information
        see `ufuncs <http://docs.scipy.org/doc/numpy/reference/ufuncs.html>`_
        """)

    add_newdoc_ufunc(expit,
        """
        Expit ufunc for ndarrays.

        The expit function is defined as expit(x) = 1/(1+exp(-x)).
        Note that expit is the inverse logit function.

        Parameters
        ----------
        x : ndarray
            The ndarray to apply expit to element-wise.

        Returns
        -------
        out : ndarray
            An ndarray of the same shape as x. Its entries
            are expit of the corresponding entry of x.

        Notes
        -----
        As a ufunc logit takes a number of optional
        keywork arguments. For more information
        see `ufuncs <http://docs.scipy.org/doc/numpy/reference/ufuncs.html>`_
        """)

except ImportError:
    pass