File: guimath.rst

package info (click to toggle)
neuron 8.2.6-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 34,768 kB
  • sloc: cpp: 149,571; python: 58,449; ansic: 50,329; sh: 3,510; xml: 213; pascal: 51; makefile: 35; sed: 5
file content (116 lines) | stat: -rw-r--r-- 2,252 bytes parent folder | download | duplicates (3)
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

.. _hoc_guimath:

GUIMath
-------



.. hoc:class:: GUIMath


    Syntax:
        ``obj = new GUIMath()``


    Description:
        Contains functions which calculate common relationships between graphics 
        objects. 

         

----



.. hoc:method:: GUIMath.d2line


    Syntax:
        ``d = math.d2line(xpoint, ypoint, xline0, yline0, xline1, yline1)``


    Description:
        Return distance between the point (xpoint,ypoint) and the (infinitely long) 
        line defined by the 0 and 1 points. 

         

----



.. hoc:method:: GUIMath.d2line_seg


    Syntax:
        ``d = math.d2line_seg(xpoint, ypoint, xline0, yline0, xline1, yline1)``


    Description:
        Return distance between the point (xpoint,ypoint) and the line segment 
        line defined by the 0 and 1 points. 

         

----



.. hoc:method:: GUIMath.inside


    Syntax:
        ``boolean = math.inside(xpoint, ypoint, left, bottom, right, top)``


    Description:
        return 1 if the point is inside the box, 0 otherwise 

         

----



.. hoc:method:: GUIMath.feround


    Syntax:
        ``mode = math.feround()``

        ``lastmode = math.feround(mode)``


    Description:
        Set the floating point rounding mode. Mode 1, 2, 3, 4 refers to 
        FE_DOWNWARD, FE_TONEAREST, FE_TOWARDZERO, FE_UPWARD respectively. 
        The default, and most accurate, mode is FE_TONEAREST. 
        The mode is changed only if the argument is 1-4. If there is no 
        support for this function the return value is 0. 
         
        This function is useful to determine if a simulation depends unduly 
        on double precision round-off error. 

    Example:

        .. code-block::
            none

            objref gm 
            gm = new GUIMath() 
            {printf("default rounding mode %d\n", gm.feround())} 
             
            proc test_round() {local i, old, x  localobj gm 
                    gm = new GUIMath() 
                    old = gm.feround($1) 
                    x = 0 
                    for i=1, 1000000 x += 0.1 
                    printf("rounding mode %d x=%25.17lf\n", $1, x) 
                    gm.feround(old) 
            } 
             
            for i=1, 4 test_round(i)