Print a warning when translating subscripted functions
[maxima.git] / doc / info / engineering-format.texi
blob8860fa4770233840d3d65dcb09a9953b989403c2
1 Engineering-format changes the way maxima outputs floating-point numbers
2 to the notation engineers are used to: @code{a*10^b} with @code{b} dividable by
3 three.
4 @menu
5 * Functions and Variables for engineering-format::
6 @end menu
8 @node Functions and Variables for engineering-format, , engineering-format-pkg, engineering-format-pkg
9 @section Functions and Variables for engineering-format
11 @c -----------------------------------------------------------------------------
12 @anchor{engineering_format_floats}
13 @defvr {Option variable} engineering_format_floats
14 Default value: @code{true} 
17 This variable allows to temporarily switch off engineering-format.
18 @c ===beg===
19 @c load("engineering-format");
20 @c float(sin(10)/10000);
21 @c engineering_format_floats:false$
22 @c float(sin(10)/10000);
23 @c ===end===
24 @example
25 @group
26 (%i1) load("engineering-format");
27 (%o1) /home/gunter/src/maxima-code/share/contrib/engineering-for\
28 mat.lisp
29 @end group
30 @group
31 (%i2) float(sin(10)/10000);
32 (%o2)                - 54.40211108893698e-6
33 @end group
34 (%i3) engineering_format_floats:false$
35 @group
36 (%i4) float(sin(10)/10000);
37 (%o4)                - 5.440211108893698e-5
38 @end group
39 @end example
41 See also @mref{fpprintprec} and @mrefdot{float}
43 @opencatbox{Categories:}
44 @category{Display functions}
45 @category{Global flags}
46 @category{Share packages}
47 @closecatbox
48 @end defvr
50 @anchor{engineering_format_min}
51 @defvr {Option variable} engineering_format_min
52 Default value: @code{0.0} 
54 The minimum absolute value that isn't automatically converted to the engineering format.
55 See also @mref{engineering_format_max} and @mrefdot{engineering_format_floats}
57 @c ===beg===
58 @c lst: float([.05,.5,5,500,5000,500000]);
59 @c load("engineering-format");
60 @c lst;
61 @c engineering_format_min:.1$
62 @c engineering_format_max:1000$
63 @c lst;
64 @c ===end===
65 @example
66 @group
67 (%i1) lst: float([.05,.5,5,500,5000,500000]);
68 (%o1)       [0.05, 0.5, 5.0, 500.0, 5000.0, 500000.0]
69 @end group
70 @group
71 (%i2) load("engineering-format");
72 (%o2) /home/gunter/src/maxima-code/share/contrib/engineering-for\
73 mat.lisp
74 @end group
75 @group
76 (%i3) lst;
77 (%o3) [50.0e-3, 500.0e-3, 5.0e+0, 500.0e+0, 5.0e+3, 500.0e+3]
78 @end group
79 (%i4) engineering_format_min:.1$
80 (%i5) engineering_format_max:1000$
81 @group
82 (%i6) lst;
83 (%o6)     [50.0e-3, 0.5, 5.0, 500.0, 5.0e+3, 500.0e+3]
84 @end group
85 @end example
87 @opencatbox{Categories:}
88 @category{Display functions}
89 @category{Global flags}
90 @category{Share packages}
91 @closecatbox
92 @end defvr
95 @anchor{engineering_format_max}
96 @defvr {Option variable} engineering_format_max
97 Default value: @code{0.0} 
99 The maximum absolute value that isn't automatically converted to the engineering format.
100 See also @mref{engineering_format_min} and @mrefdot{engineering_format_floats}
102 @opencatbox{Categories:}
103 @category{Display functions}
104 @category{Global flags}
105 @category{Share packages}
106 @closecatbox
107 @end defvr