mathgl 0.0.3 → 0.0.4

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: e8bbe45fbca997087a501520951e10cccf4ed7c5
4
- data.tar.gz: 918520daf64104438ff0fac7e63e62c912bc8b46
3
+ metadata.gz: 7714f6721576320ab6f0679a7d02ebb9f96e1903
4
+ data.tar.gz: d27bf666273a517984dceec4512226f5ecd59cb4
5
5
  SHA512:
6
- metadata.gz: 2963f4e8cb36ef58b23951154cac048237f7790f876dc9330504a09ce1d11bf913e04f546ab6a757643a90f51ec61e3a9d8fd3762be2757a015689a416fc7ee0
7
- data.tar.gz: 0e15ebf237d03ecfe810534296aa995bbefd6f3b95285b5b651aa13ca4e28121ab392bdcf2bdeee52001f9246709f9bd72888f3f9255f861f5b59b2be143f3a9
6
+ metadata.gz: 1221ea78f95d9102142ffcdb0c613846db734e7a90c5dae111f03478361403d6c5f0cf9953a77a9fc2a8a3658f5cc1d2fdf80665df5d0bb004e1a38eb5c35e80
7
+ data.tar.gz: 9e80891e54b29b00ad64e4dd6abfe79d2fa472abc60bc71d0e330ad8702abca3aca28c5328d2468a616dc96d48485b17419c5b6ceb0b6cdd00d24a5afbe62399
@@ -1,8 +1,10 @@
1
1
  # This document is converted from core_en.texi.
2
+
3
+ # MglGraph class
2
4
  class MglGraph
3
5
 
4
6
  # Create and delete objects.
5
- # Creates the instance of class mglGraph with specified sizes width and height. Parameter kind may have following values: -- use default plotter, -- use OpenGL plotter.
7
+ # Creates the instance of class mglGraph with specified sizes width and height. Parameter kind may have following values: '0' -- use default plotter, '1' -- use OpenGL plotter.
6
8
  # @overload initialize(kind=0,width=600,height=400)
7
9
  # @param [Integer] kind default=0
8
10
  # @param [Integer] width default=600
@@ -43,6 +45,7 @@ end
43
45
 
44
46
  # Transparency.
45
47
  # Set the type of transparency. Possible values are:
48
+ # Types of transparency.
46
49
  # @overload set_transp_type(type)
47
50
  # @param [Integer] type
48
51
  # @return [nil]
@@ -70,7 +73,7 @@ end
70
73
 
71
74
 
72
75
  # Lighting.
73
- # The function adds a light source with identification n in direction d with color c and with brightness bright (which must be in range [0,1]). If position r is specified and isn't NAN then light source is supposed to be local otherwise light source is supposed to be placed at infinity.
76
+ # The function adds a light source with identification n in direction d with color c and with brightness bright (which must be in range (0,1)). If position r is specified and isn't NAN then light source is supposed to be local otherwise light source is supposed to be placed at infinity.
74
77
  # @overload add_light(n,d,c='w',bright=0.5,ap=0)
75
78
  # @param [Integer] n
76
79
  # @param [MglPoint] d
@@ -100,7 +103,7 @@ end
100
103
 
101
104
 
102
105
  # Lighting.
103
- # Sets the brightness of ambient light. The value should be in range [0,1].
106
+ # Sets the brightness of ambient light. The value should be in range (0,1).
104
107
  # @overload set_ambient(bright=0.5)
105
108
  # @param [Float] bright default=0.5
106
109
  # @return [nil]
@@ -109,7 +112,7 @@ end
109
112
 
110
113
 
111
114
  # Fog.
112
- # Function imitate a fog in the plot. Fog start from relative distance dz from view point and its density growths exponentially in depth. So that the fog influence is determined by law ~ 1-exp(-*d*z*). Here *z* is normalized to 1 depth of the plot. If value d=0 then the fog is absent. Note, that fog was applied at stage of image creation, not at stage of drawing.
115
+ # Function imitate a fog in the plot. Fog start from relative distance dz from view point and its density growths exponentially in depth. So that the fog influence is determined by law ~ 1-exp(-d*z). Here *z* is normalized to 1 depth of the plot. If value d=0 then the fog is absent. Note, that fog was applied at stage of image creation, not at stage of drawing. Adding fog
113
116
  # @overload fog(d,dz=0.25)
114
117
  # @param [Float] d
115
118
  # @param [Float] dz default=0.25
@@ -228,7 +231,7 @@ end
228
231
 
229
232
 
230
233
  # Font settings.
231
- # Sets the font specification (see Text printing). Default is -- Roman font centering.
234
+ # Sets the font specification (see Text printing). Default is 'rC' -- Roman font centering.
232
235
  # @overload set_font_def(fnt)
233
236
  # @param [String] fnt
234
237
  # @return [nil]
@@ -303,7 +306,7 @@ end
303
306
 
304
307
 
305
308
  # Palette and colors.
306
- # Sets the palette as selected colors. Default value is "Hbgrcmyhlnqeup" that corresponds to colors: dark gray , blue , green , red , cyan , magenta , yellow , gray , blue-green , sky-blue , orange , yellow-green , blue-violet , purple . The palette is used mostly in 1D plots (see 1D plotting) for curves which styles are not specified. Internal color counter will be nullified by any change of palette. This includes even hidden change (for example, by box or axis functions).
309
+ # Sets the palette as selected colors. Default value is "Hbgrcmyhlnqeup" that corresponds to colors: dark gray 'H', blue 'b', green 'g', red 'r', cyan 'c', magenta 'm', yellow 'y', gray 'h', blue-green 'l', sky-blue 'n', orange 'q', yellow-green 'e', blue-violet 'u', purple 'p'. The palette is used mostly in 1D plots (see 1D plotting) for curves which styles are not specified. Internal color counter will be nullified by any change of palette. This includes even hidden change (for example, by box or axis functions).
307
310
  # @overload set_palette(colors)
308
311
  # @param [String] colors
309
312
  # @return [nil]
@@ -347,7 +350,7 @@ end
347
350
 
348
351
 
349
352
  # Ranges (bounding box).
350
- # Sets the range for -,-,- coordinate or coloring (). See also ranges.
353
+ # Sets the range for 'x'-,'y'-,'z'- coordinate or coloring ('c'). See also ranges.
351
354
  # @overload set_range(dir,v1,v2)
352
355
  # @param [String] dir
353
356
  # @param [Float] v1
@@ -358,7 +361,7 @@ end
358
361
 
359
362
 
360
363
  # Ranges (bounding box).
361
- # Sets the range for -,-,- coordinate or coloring () as minimal and maximal values of data dat. Parameter add=on shows that the new range will be joined to existed one (not replace it).
364
+ # Sets the range for 'x'-,'y'-,'z'- coordinate or coloring ('c') as minimal and maximal values of data dat. Parameter add=on shows that the new range will be joined to existed one (not replace it).
362
365
  # @overload set_range(dir,dat,add=false)
363
366
  # @param [String] dir
364
367
  # @param [MglData] dat
@@ -369,7 +372,7 @@ end
369
372
 
370
373
 
371
374
  # Ranges (bounding box).
372
- # Sets the ranges of coordinates. If minimal and maximal values of the coordinate are the same then they are ignored. Also it sets the range for coloring (analogous to crange z1 z2). This is default color range for 2d plots. Initial ranges are [-1, 1].
375
+ # Sets the ranges of coordinates. If minimal and maximal values of the coordinate are the same then they are ignored. Also it sets the range for coloring (analogous to crange z1 z2). This is default color range for 2d plots. Initial ranges are (-1, 1).
373
376
  # @overload set_ranges(p1,p2)
374
377
  # @param [MglPoint] p1
375
378
  # @param [MglPoint] p2
@@ -387,7 +390,7 @@ end
387
390
 
388
391
 
389
392
  # Ranges (bounding box).
390
- # Sets the ranges of -,-,-coordinates and coloring as minimal and maximal values of data xx, yy, zz, cc correspondingly.
393
+ # Sets the ranges of 'x'-,'y'-,'z'-coordinates and coloring as minimal and maximal values of data xx, yy, zz, cc correspondingly.
391
394
  # @overload set_ranges(xx,yy)
392
395
  # @param [MglData] xx
393
396
  # @param [MglData] yy
@@ -442,7 +445,7 @@ end
442
445
 
443
446
 
444
447
  # Ranges (bounding box).
445
- # Additionally extend axis range for any settings made by SetRange or SetRanges functions according the formula and (or and for log-axis range when or ). Initial ranges are [0, 1]. Attention! this settings can not be overwritten by any other functions, including DefaultPlotParam().
448
+ # Additionally extend axis range for any settings made by SetRange or SetRanges functions according the formula min += (max-min)*p1 and max += (max-min)*p1 (or min *= (max/min)^p1 and max *= (max/min)^p1 for log-axis range when inf>max/min>100 or 0<max/min<0.01). Initial ranges are (0, 1). Attention! this settings can not be overwritten by any other functions, including DefaultPlotParam().
446
449
  # @overload zoom_axis(p1,p2)
447
450
  # @param [MglPoint] p1
448
451
  # @param [MglPoint] p2
@@ -452,7 +455,7 @@ end
452
455
 
453
456
 
454
457
  # Curved coordinates.
455
- # Sets transformation formulas for curvilinear coordinate. Each string should contain mathematical expression for real coordinate depending on internal coordinates , , and or for colorbar. For example, the cylindrical coordinates are introduced as SetFunc("x*cos(y)", "x*sin(y)", "z");. For removing of formulas the corresponding parameter should be empty or NULL. Using transformation formulas will slightly slowing the program. Parameter EqA set the similar transformation formula for color scheme. .
458
+ # Sets transformation formulas for curvilinear coordinate. Each string should contain mathematical expression for real coordinate depending on internal coordinates 'x', 'y', 'z' and 'a' or 'c' for colorbar. For example, the cylindrical coordinates are introduced as SetFunc("x*cos(y)", "x*sin(y)", "z");. For removing of formulas the corresponding parameter should be empty or NULL. Using transformation formulas will slightly slowing the program. Parameter EqA set the similar transformation formula for color scheme. Textual formulas.
456
459
  # @overload set_func(eqx,eqy,eqz="",eqa="")
457
460
  # @param [String] eqx
458
461
  # @param [String] eqy
@@ -464,7 +467,7 @@ end
464
467
 
465
468
 
466
469
  # Curved coordinates.
467
- # Sets one of the predefined transformation formulas for curvilinear coordinate. Paramater how define the coordinates: mglCartesian=0 -- Cartesian coordinates (no transformation); mglPolar=1 -- Polar coordinates ; mglSpherical=2 -- Sperical coordinates ; mglParabolic=3 -- Parabolic coordinates ; mglParaboloidal=4 -- Paraboloidal coordinates ; mglOblate=5 -- Oblate coordinates ; mglProlate=6 -- Prolate coordinates ; mglElliptic=7 -- Elliptic coordinates ; mglToroidal=8 -- Toroidal coordinates ; mglBispherical=9 -- Bispherical coordinates ; mglBipolar=10 -- Bipolar coordinates ; mglLogLog=11 -- log-log coordinates ; mglLogX=12 -- log-x coordinates ; mglLogY=13 -- log-y coordinates .
470
+ # Sets one of the predefined transformation formulas for curvilinear coordinate. Paramater how define the coordinates: mglCartesian=0 -- Cartesian coordinates (no transformation); mglPolar=1 -- Polar coordinates x_n=x*cos(y),y_n=x*sin(y), z_n=z; mglSpherical=2 -- Sperical coordinates x_n=x*sin(y)*cos(z), y_n=x*sin(y)*sin(z), z_n=x*cos(y); mglParabolic=3 -- Parabolic coordinates x_n=x*y, y_n=(x*x-y*y)/2, z_n=z; mglParaboloidal=4 -- Paraboloidal coordinates x_n=(x*x-y*y)*cos(z)/2, y_n=(x*x-y*y)*sin(z)/2, z_n=x*y; mglOblate=5 -- Oblate coordinates x_n=cosh(x)*cos(y)*cos(z), y_n=cosh(x)*cos(y)*sin(z), z_n=sinh(x)*sin(y); mglProlate=6 -- Prolate coordinates x_n=sinh(x)*sin(y)*cos(z), y_n=sinh(x)*sin(y)*sin(z), z_n=cosh(x)*cos(y); mglElliptic=7 -- Elliptic coordinates x_n=cosh(x)*cos(y), y_n=sinh(x)*sin(y), z_n=z; mglToroidal=8 -- Toroidal coordinates x_n=sinh(x)*cos(z)/(cosh(x)-cos(y)), y_n=sinh(x)*sin(z)/(cosh(x)-cos(y)), z_n=sin(y)/(cosh(x)-cos(y)); mglBispherical=9 -- Bispherical coordinates x_n=sin(y)*cos(z)/(cosh(x)-cos(y)), y_n=sin(y)*sin(z)/(cosh(x)-cos(y)), z_n=sinh(x)/(cosh(x)-cos(y)); mglBipolar=10 -- Bipolar coordinates x_n=sinh(x)/(cosh(x)-cos(y)), y_n=sin(y)/(cosh(x)-cos(y)), z_n=z; mglLogLog=11 -- log-log coordinates x_n=lg(x), y_n=lg(y), z_n=lg(z); mglLogX=12 -- log-x coordinates x_n=lg(x), y_n=y, z_n=z; mglLogY=13 -- log-y coordinates x_n=x, y_n=lg(y), z_n=z.
468
471
  # @overload set_coor(how)
469
472
  # @param [Integer] how
470
473
  # @return [nil]
@@ -481,7 +484,7 @@ end
481
484
  #
482
485
  # Projections can be obtained by adding value 4 to tern argument. So, that tern=4 will draw projections in Cartesian coordinates, tern=5 will draw projections in Ternary coordinates, tern=6 will draw projections in Quaternary coordinates.
483
486
  #
484
- # Use Ternary(0) for returning to usual axis.
487
+ # Use Ternary(0) for returning to usual axis. Ternary axis Axis projection
485
488
  # @overload ternary(tern)
486
489
  # @param [Integer] tern
487
490
  # @return [nil]
@@ -511,7 +514,7 @@ end
511
514
 
512
515
 
513
516
  # Ticks.
514
- # Set the manual positions val and its labels lbl for ticks along axis dir. If array val is absent then values equidistantly distributed in interval [Min.x, Max.x] are used. Labels are separated by symbol. Use SetTicks() to restore automatic ticks.
517
+ # Set the manual positions val and its labels lbl for ticks along axis dir. If array val is absent then values equidistantly distributed in interval (Min.x, Max.x) are used. Labels are separated by '\n' symbol. Use SetTicks() to restore automatic ticks.
515
518
  # @overload set_ticks_val(dir,lbl,add=false)
516
519
  # @param [String] dir
517
520
  # @param [String] lbl
@@ -528,7 +531,7 @@ end
528
531
 
529
532
 
530
533
  # Ticks.
531
- # Set template templ for x-,y-,z-axis ticks or colorbar ticks. It may contain TeX symbols also. If templ="" then default template is used (in simplest case it is ). Setting on template switch off automatic ticks tuning.
534
+ # Set template templ for x-,y-,z-axis ticks or colorbar ticks. It may contain TeX symbols also. If templ="" then default template is used (in simplest case it is '%.2g'). Setting on template switch off automatic ticks tuning.
532
535
  # @overload set_tick_templ(dir,templ)
533
536
  # @param [String] dir
534
537
  # @param [String] templ
@@ -538,7 +541,7 @@ end
538
541
 
539
542
 
540
543
  # Ticks.
541
- # Sets time labels with step val and template templ for x-,y-,z-axis ticks or colorbar ticks. It may contain TeX symbols also. The format of template templ is the same as described in . Most common variants are for national representation of time, for national representation of date, for year with century. If val=0 and/or templ="" then automatic tick step and/or template will be selected. You can use mgl_get_time() function for obtaining number of second for given date/time string. Note, that MS Visual Studio couldn't handle date before 1970.
544
+ # Sets time labels with step val and template templ for x-,y-,z-axis ticks or colorbar ticks. It may contain TeX symbols also. The format of template templ is the same as described in http://www.manpagez.com/man/3/strftime/. Most common variants are '%X' for national representation of time, '%x' for national representation of date, '%Y' for year with century. If val=0 and/or templ="" then automatic tick step and/or template will be selected. You can use mgl_get_time() function for obtaining number of second for given date/time string. Note, that MS Visual Studio couldn't handle date before 1970.
542
545
  # @overload set_ticks_time(dir,val,templ)
543
546
  # @param [String] dir
544
547
  # @param [Float] val
@@ -615,7 +618,7 @@ end
615
618
 
616
619
 
617
620
  # Ticks.
618
- # The line style of axis (stl), ticks (tck) and subticks (sub). If stl is empty then default style is used ( or depending on transparency type). If tck or sub is empty then axis style is used (i.e. stl).
621
+ # The line style of axis (stl), ticks (tck) and subticks (sub). If stl is empty then default style is used ('k' or 'w' depending on transparency type). If tck or sub is empty then axis style is used (i.e. stl).
619
622
  # @overload set_axis_stl(stl="k",tck=0,sub=0)
620
623
  # @param [String] stl default="k"
621
624
  # @param [String] tck default=0
@@ -655,7 +658,7 @@ end
655
658
 
656
659
 
657
660
  # Subplots and rotation.
658
- # Puts further plotting in some region of the whole frame surface. This function allows one to create a plot in arbitrary place of the screen. The position is defined by rectangular coordinates [x1, x2]*[y1, y2]. The coordinates x1, x2, y1, y2 are normalized to interval [0, 1]. If parameter rel=true then the relative position to current subplot (or inplot with rel=false) is used. This function set off any aspects or rotations. So it should be used first for creating subplot.
661
+ # Puts further plotting in some region of the whole frame surface. This function allows one to create a plot in arbitrary place of the screen. The position is defined by rectangular coordinates (x1, x2)*(y1, y2). The coordinates x1, x2, y1, y2 are normalized to interval (0, 1). If parameter rel=true then the relative position to current subplot (or inplot with rel=false) is used. This function set off any aspects or rotations. So it should be used first for creating subplot.
659
662
  # @overload in_plot(x1,x2,y1,y2,rel=true)
660
663
  # @param [Float] x1
661
664
  # @param [Float] x2
@@ -749,7 +752,7 @@ end
749
752
 
750
753
 
751
754
  # Subplots and rotation.
752
- # Add (switch on) the perspective to plot. The parameter \in [0,1)}. By default (a=0) the perspective is off.
755
+ # Add (switch on) the perspective to plot. The parameter a ~ 1/z_(eff@ \in (0,1)}. By default (a=0) the perspective is off.
753
756
  # @overload perspective(a)
754
757
  # @param [Float] a
755
758
  # @return [nil]
@@ -794,7 +797,7 @@ end
794
797
 
795
798
 
796
799
  # Subplots and rotation.
797
- # The function changes the scale of graphics that correspond to zoom in/out of the picture. After function call the current plot will be cleared and further the picture will contain plotting from its part [x1,x2]*[y1,y2]. Here picture coordinates x1, x2, y1, y2 changes from 0 to 1. Attention! this settings can not be overwritten by any other functions, including DefaultPlotParam(). Use Zoom(0,0,1,1) to return default view.
800
+ # The function changes the scale of graphics that correspond to zoom in/out of the picture. After function call the current plot will be cleared and further the picture will contain plotting from its part (x1,x2)*(y1,y2). Here picture coordinates x1, x2, y1, y2 changes from 0 to 1. Attention! this settings can not be overwritten by any other functions, including DefaultPlotParam(). Use Zoom(0,0,1,1) to return default view.
798
801
  # @overload zoom(x1,y1,x2,y2)
799
802
  # @param [Float] x1
800
803
  # @param [Float] y1
@@ -806,7 +809,7 @@ end
806
809
 
807
810
 
808
811
  # Export picture.
809
- # Sets size of picture in pixels. This function called before any other plotting because it completely remove picture contents.
812
+ # Sets size of picture in pixels. This function must be called before any other plotting because it completely remove picture contents.
810
813
  # @overload set_size(width,height)
811
814
  # @param [Integer] width
812
815
  # @param [Integer] height
@@ -850,7 +853,7 @@ end
850
853
 
851
854
 
852
855
  # Export to file.
853
- # Exports current frame to a file fname which type is determined by the extension. Parameter descr adds description to file (can be ""). If fname="" then the file is used, where is current frame id and name is defined by plotid class property.
856
+ # Exports current frame to a file fname which type is determined by the extension. Parameter descr adds description to file (can be ""). If fname="" then the file 'frame####.jpg' is used, where '####' is current frame id and name 'frame' is defined by plotid class property.
854
857
  # @overload write_frame(fname="",descr="")
855
858
  # @param [String] fname default=""
856
859
  # @param [String] descr default=""
@@ -912,7 +915,7 @@ end
912
915
 
913
916
 
914
917
  # Export to file.
915
- # Exports current frame to EPS file using vector representation. So it is not recommended for the export of large data plot. It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file. By default there is no description added. If file name is terminated by (for example, ) then file will be compressed in gzip format.
918
+ # Exports current frame to EPS file using vector representation. So it is not recommended for the export of large data plot. It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file. By default there is no description added. If file name is terminated by 'z' (for example, 'fname.eps.gz') then file will be compressed in gzip format.
916
919
  # @overload write_eps(fname,descr="")
917
920
  # @param [String] fname
918
921
  # @param [String] descr default=""
@@ -922,7 +925,7 @@ end
922
925
 
923
926
 
924
927
  # Export to file.
925
- # Exports current frame to EPS file using bitmap representation. Parameter fname specifies the file name, descr adds description to file. By default there is no description added. If file name is terminated by (for example, ) then file will be compressed in gzip format.
928
+ # Exports current frame to EPS file using bitmap representation. Parameter fname specifies the file name, descr adds description to file. By default there is no description added. If file name is terminated by 'z' (for example, 'fname.eps.gz') then file will be compressed in gzip format.
926
929
  # @overload write_bps(fname,descr="")
927
930
  # @param [String] fname
928
931
  # @param [String] descr default=""
@@ -932,7 +935,7 @@ end
932
935
 
933
936
 
934
937
  # Export to file.
935
- # Exports current frame to SVG (Scalable Vector Graphics) file using vector representation. In difference of EPS format, SVG format support transparency that allows to correctly draw semitransparent plot (like surfa, surf3a or cloud). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name). If file name is terminated by (for example, ) then file will be compressed in gzip format.
938
+ # Exports current frame to SVG (Scalable Vector Graphics) file using vector representation. In difference of EPS format, SVG format support transparency that allows to correctly draw semitransparent plot (like surfa, surf3a or cloud). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name). If file name is terminated by 'z' (for example, 'fname.svgz') then file will be compressed in gzip format.
936
939
  # @overload write_svg(fname,descr="")
937
940
  # @param [String] fname
938
941
  # @param [String] descr default=""
@@ -952,7 +955,7 @@ end
952
955
 
953
956
 
954
957
  # Export to file.
955
- # Exports current frame to PRC file using vector representation (see ). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name). If parameter make_pdf=true and PDF was enabled at MathGL configure then corresponding PDF file with 3D image will be created.
958
+ # Exports current frame to PRC file using vector representation (see http://en.wikipedia.org/wiki/PRC_%28file_format%29). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name). If parameter make_pdf=true and PDF was enabled at MathGL configure then corresponding PDF file with 3D image will be created.
956
959
  # @overload write_prc(fname,descr="",make_pdf=true)
957
960
  # @param [String] fname
958
961
  # @param [String] descr default=""
@@ -963,7 +966,7 @@ end
963
966
 
964
967
 
965
968
  # Export to file.
966
- # Exports current frame to OBJ/MTL file using vector representation (see for details). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name).
969
+ # Exports current frame to OBJ/MTL file using vector representation (see http://en.wikipedia.org/wiki/Wavefront_.obj_file, OBJ format for details). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name).
967
970
  # @overload write_obj(fname,descr="")
968
971
  # @param [String] fname
969
972
  # @param [String] descr default=""
@@ -973,7 +976,7 @@ end
973
976
 
974
977
 
975
978
  # Export to file.
976
- # Exports current frame to XYZ/XYZL/XYZF files using vector representation (see for details). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name).
979
+ # Exports current frame to XYZ/XYZL/XYZF files using vector representation (see http://people.sc.fsu.edu/~jburkardt/data/xyz/xyz.html, XYZ format for details). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name).
977
980
  # @overload write_xyz(fname,descr="")
978
981
  # @param [String] fname
979
982
  # @param [String] descr default=""
@@ -983,7 +986,7 @@ end
983
986
 
984
987
 
985
988
  # Export to file.
986
- # Exports current frame to STL file using vector representation (see for details). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name.
989
+ # Exports current frame to STL file using vector representation (see http://en.wikipedia.org/wiki/STL_(file_format), STL format for details). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name.
987
990
  # @overload write_stl(fname,descr="")
988
991
  # @param [String] fname
989
992
  # @param [String] descr default=""
@@ -993,7 +996,7 @@ end
993
996
 
994
997
 
995
998
  # Export to file.
996
- # Exports current frame to OFF file using vector representation (see for details). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name).
999
+ # Exports current frame to OFF file using vector representation (see http://people.sc.fsu.edu/~jburkardt/data/off/off.html, OFF format for details). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name).
997
1000
  # @overload write_off(fname,descr="",colored=false)
998
1001
  # @param [String] fname
999
1002
  # @param [String] descr default=""
@@ -1044,7 +1047,7 @@ end
1044
1047
 
1045
1048
 
1046
1049
  # Frames/Animation.
1047
- # Creates new frame. Function returns current frame id. This is not thread safe function in OpenGL mode! Use direct list creation in multi-threading drawing. The function EndFrame() be call after the finishing of the frame drawing for each call of this function.
1050
+ # Creates new frame. Function returns current frame id. This is not thread safe function in OpenGL mode! Use direct list creation in multi-threading drawing. The function EndFrame() must be call after the finishing of the frame drawing for each call of this function.
1048
1051
  # @overload new_frame()
1049
1052
  # @return [nil]
1050
1053
  def new_frame
@@ -1068,7 +1071,7 @@ end
1068
1071
 
1069
1072
 
1070
1073
  # Frames/Animation.
1071
- # Finishes the frame drawing and sets drawing data to frame i, which should be in range [0, GetNumFrame()-1]. This function is similar to EndFrame() but don't add frame to the GIF image.
1074
+ # Finishes the frame drawing and sets drawing data to frame i, which should be in range (0, GetNumFrame()-1). This function is similar to EndFrame() but don't add frame to the GIF image.
1072
1075
  # @overload set_frame(i)
1073
1076
  # @param [Integer] i
1074
1077
  # @return [nil]
@@ -1112,7 +1115,7 @@ end
1112
1115
 
1113
1116
 
1114
1117
  # Frames/Animation.
1115
- # Start writing frames into animated GIF file fname. Parameter ms set the delay between frames in milliseconds. You change the picture size during writing the cinema. Use CloseGIF() to finalize writing. Note, that this function is disabled in OpenGL mode.
1118
+ # Start writing frames into animated GIF file fname. Parameter ms set the delay between frames in milliseconds. You should not change the picture size during writing the cinema. Use CloseGIF() to finalize writing. Note, that this function is disabled in OpenGL mode.
1116
1119
  # @overload start_gif(fname,ms=100)
1117
1120
  # @param [String] fname
1118
1121
  # @param [Integer] ms default=100
@@ -1130,7 +1133,7 @@ end
1130
1133
 
1131
1134
 
1132
1135
  # Bitmap in memory.
1133
- # Gets RGB bitmap of the current state of the image. Format of each element of bits is: (red, green, blue). Number of elements is Width*Height. Position of element (i,j) is [3*i + 3*Width*j] (or is [4*i + 4*Width*j] for GetBGRN()). You have to provide the proper size of the buffer, buf, i.e. the code for Python should look like
1136
+ # Gets RGB bitmap of the current state of the image. Format of each element of bits is: (red, green, blue). Number of elements is Width*Height. Position of element (i,j) is (3*i + 3*Width*j) (or is (4*i + 4*Width*j) for GetBGRN()). You have to provide the proper size of the buffer, buf, i.e. the code for Python should look like
1134
1137
  # @overload get_rgb()
1135
1138
  # @return [unsigned char]
1136
1139
  # @overload get_rgb(buf,size)
@@ -1141,12 +1144,12 @@ end
1141
1144
  # @param [String] buf
1142
1145
  # @param [Integer] size
1143
1146
  # @return [nil]
1144
- def get_bgrn
1147
+ def get_rgb
1145
1148
  end
1146
1149
 
1147
1150
 
1148
1151
  # Bitmap in memory.
1149
- # Gets RGBA bitmap of the current state of the image. Format of each element of bits is: (red, green, blue, alpha). Number of elements is Width*Height. Position of element (i,j) is [4*i + 4*Width*j].
1152
+ # Gets RGBA bitmap of the current state of the image. Format of each element of bits is: (red, green, blue, alpha). Number of elements is Width*Height. Position of element (i,j) is (4*i + 4*Width*j).
1150
1153
  # @overload get_rgba()
1151
1154
  # @return [unsigned char]
1152
1155
  # @overload get_rgba(buf,size)
@@ -1163,7 +1166,7 @@ end
1163
1166
  # @return [Integer]
1164
1167
  # @overload get_height()
1165
1168
  # @return [Integer]
1166
- def get_height
1169
+ def get_width
1167
1170
  end
1168
1171
 
1169
1172
 
@@ -1276,7 +1279,7 @@ end
1276
1279
 
1277
1280
 
1278
1281
  # Primitives.
1279
- # Draws a mark (point by default) at position p=(x, y, z) with color col.
1282
+ # Draws a mark (point '.' by default) at position p=(x, y, z) with color col.
1280
1283
  # @overload ball(p,col='r')
1281
1284
  # @param [MglPoint] p
1282
1285
  # @param [String] col default='r'
@@ -1285,7 +1288,7 @@ end
1285
1288
  # @param [MglPoint] p
1286
1289
  # @param [String] mark
1287
1290
  # @return [nil]
1288
- def mark
1291
+ def ball
1289
1292
  end
1290
1293
 
1291
1294
 
@@ -1340,7 +1343,7 @@ end
1340
1343
 
1341
1344
 
1342
1345
  # Primitives.
1343
- # Draws the solid rectangle (face) perpendicular to [x,y,z]-axis correspondingly at position (x0, y0, z0) with color stl and with widths wx, wy, wz along corresponding directions. At this colors can be the same for all vertexes or separately if all 4 colors are specified for each vertex. Parameters d1!=0, d2!=0 set additional shift of the last vertex (i.e. to draw quadrangle). Face will be drawn even if it lies out of bounding box.
1346
+ # Draws the solid rectangle (face) perpendicular to (x,y,z)-axis correspondingly at position (x0, y0, z0) with color stl and with widths wx, wy, wz along corresponding directions. At this colors can be the same for all vertexes or separately if all 4 colors are specified for each vertex. Parameters d1!=0, d2!=0 set additional shift of the last vertex (i.e. to draw quadrangle). Face will be drawn even if it lies out of bounding box.
1344
1347
  # @overload face_x(x0,y0,z0,wy,wz,stl="w",d1=0,d2=0)
1345
1348
  # @param [Float] x0
1346
1349
  # @param [Float] y0
@@ -1371,7 +1374,7 @@ end
1371
1374
  # @param [Float] d1 default=0
1372
1375
  # @param [Float] d2 default=0
1373
1376
  # @return [nil]
1374
- def face_z
1377
+ def face_x
1375
1378
  end
1376
1379
 
1377
1380
 
@@ -1387,7 +1390,7 @@ end
1387
1390
 
1388
1391
 
1389
1392
  # Primitives.
1390
- # Draw the drop with radius r at point p elongated in direction d and with color col. Parameter shift set the degree of drop oblongness: is sphere, is maximally oblongness drop. Parameter ap set relative width of the drop (this is analogue of ``ellipticity'' for the sphere).
1393
+ # Draw the drop with radius r at point p elongated in direction d and with color col. Parameter shift set the degree of drop oblongness: '0' is sphere, '1' is maximally oblongness drop. Parameter ap set relative width of the drop (this is analogue of ``ellipticity'' for the sphere).
1391
1394
  # @overload drop(p,d,r,col="r",shift=1,ap=1)
1392
1395
  # @param [MglPoint] p
1393
1396
  # @param [MglPoint] d
@@ -1401,7 +1404,7 @@ end
1401
1404
 
1402
1405
 
1403
1406
  # Primitives.
1404
- # Draw tube (or truncated cone if edge=false) between points p1, p2 with radius at the edges r1, r2. If r2<0 then it is supposed that r2=r1. The cone color is defined by string stl. If style contain then edges will be drawn.
1407
+ # Draw tube (or truncated cone if edge=false) between points p1, p2 with radius at the edges r1, r2. If r2<0 then it is supposed that r2=r1. The cone color is defined by string stl. If style contain '@' then edges will be drawn.
1405
1408
  # @overload cone(p1,p2,r1,r2=-1,stl="B")
1406
1409
  # @param [MglPoint] p1
1407
1410
  # @param [MglPoint] p2
@@ -1468,7 +1471,7 @@ end
1468
1471
 
1469
1472
 
1470
1473
  # Text printing.
1471
- # The function plots the string text at position p along direction d with specified size. Parameter fnt set text style and text position: above () or under () the line.
1474
+ # The function plots the string text at position p along direction d with specified size. Parameter fnt set text style and text position: above ('T') or under ('t') the line.
1472
1475
  # @overload puts(p,d,text,fnt=":L",size=-1)
1473
1476
  # @param [MglPoint] p
1474
1477
  # @param [MglPoint] d
@@ -1481,7 +1484,7 @@ end
1481
1484
 
1482
1485
 
1483
1486
  # Text printing.
1484
- # The function draws text along the curve between points (x[i], y[i], z[i]) by font style fnt. The string fnt may contain symbols for printing the text under the curve (default), or for printing the text above the curve. The sizes of 1st dimension must be equal for all arrays x.nx=y.nx=z.nx. If array x is not specified then its an automatic array is used with values equidistantly distributed in interval [Min.x, Max.x] (see Ranges (bounding box)). If array z is not specified then z[i] = Min.z is used. String opt contain command options (see Command options).
1487
+ # The function draws text along the curve between points (x(i), y(i), z(i)) by font style fnt. The string fnt may contain symbols 't' for printing the text under the curve (default), or 'T' for printing the text above the curve. The sizes of 1st dimension must be equal for all arrays x.nx=y.nx=z.nx. If array x is not specified then its an automatic array is used with values equidistantly distributed in interval (Min.x, Max.x) (see Ranges (bounding box)). If array z is not specified then z(i) = Min.z is used. String opt contain command options (see Command options).
1485
1488
  # @overload text(y,text,fnt="",opt="")
1486
1489
  # @param [MglData] y
1487
1490
  # @param [String] text
@@ -1509,7 +1512,7 @@ end
1509
1512
 
1510
1513
  # Axis and Colorbar.
1511
1514
  # Draws axes with ticks (see Axis settings). Parameter dir may contain:
1512
- # Styles of ticks and axis can be overrided by using stl string.
1515
+ # Styles of ticks and axis can be overrided by using stl string. Axis and ticks
1513
1516
  # @overload axis(dir="xyz",stl="",opt="")
1514
1517
  # @param [String] dir default="xyz"
1515
1518
  # @param [String] stl default=""
@@ -1521,6 +1524,7 @@ end
1521
1524
 
1522
1525
  # Axis and Colorbar.
1523
1526
  # Draws colorbar. Parameter sch may contain:
1527
+ # Colorbars
1524
1528
  # @overload colorbar(sch="")
1525
1529
  # @param [String] sch default=""
1526
1530
  # @return [nil]
@@ -1529,7 +1533,7 @@ end
1529
1533
 
1530
1534
 
1531
1535
  # Axis and Colorbar.
1532
- # The same as previous but with sharp colors sch (current palette if sch="") for values v.
1536
+ # The same as previous but with sharp colors sch (current palette if sch="") for values v. ContD sample
1533
1537
  # @overload colorbar(v,sch="")
1534
1538
  # @param [MglData] v
1535
1539
  # @param [String] sch default=""
@@ -1539,7 +1543,7 @@ end
1539
1543
 
1540
1544
 
1541
1545
  # Axis and Colorbar.
1542
- # The same as first one but at arbitrary position of subplot (x, y) (supposed to be in range [0,1]). Parameters w, h set the relative width and height of the colorbar.
1546
+ # The same as first one but at arbitrary position of subplot (x, y) (supposed to be in range (0,1)). Parameters w, h set the relative width and height of the colorbar.
1543
1547
  # @overload colorbar(sch,x,y,w=1,h=1)
1544
1548
  # @param [String] sch
1545
1549
  # @param [Float] x
@@ -1552,7 +1556,7 @@ end
1552
1556
 
1553
1557
 
1554
1558
  # Axis and Colorbar.
1555
- # The same as previous but with sharp colors sch (current palette if sch="") for values v.
1559
+ # The same as previous but with sharp colors sch (current palette if sch="") for values v. ContD sample
1556
1560
  # @overload colorbar(v,sch,x,y,w=1,h=1)
1557
1561
  # @param [MglData] v
1558
1562
  # @param [String] sch
@@ -1566,7 +1570,7 @@ end
1566
1570
 
1567
1571
 
1568
1572
  # Axis and Colorbar.
1569
- # Draws grid lines perpendicular to direction determined by string parameter dir. The step of grid lines is the same as tick step for axis. The style of lines is determined by pen parameter (default value is dark blue solid line ).
1573
+ # Draws grid lines perpendicular to direction determined by string parameter dir. The step of grid lines is the same as tick step for axis. The style of lines is determined by pen parameter (default value is dark blue solid line 'B-').
1570
1574
  # @overload grid(dir="xyz",pen="B",opt="")
1571
1575
  # @param [String] dir default="xyz"
1572
1576
  # @param [String] pen default="B"
@@ -1577,7 +1581,7 @@ end
1577
1581
 
1578
1582
 
1579
1583
  # Axis and Colorbar.
1580
- # Draws bounding box outside the plotting volume with color col. If col contain then filled faces are drawn. At this first color is used for faces (default is light yellow), last one for edges.
1584
+ # Draws bounding box outside the plotting volume with color col. If col contain '@' then filled faces are drawn. At this first color is used for faces (default is light yellow), last one for edges. Bounding box
1581
1585
  # @overload box(col="",ticks=true)
1582
1586
  # @param [String] col default=""
1583
1587
  # @param [bool] ticks default=true
@@ -1587,7 +1591,7 @@ end
1587
1591
 
1588
1592
 
1589
1593
  # Axis and Colorbar.
1590
- # Prints the label text for axis dir=,,, (here is ``ternary'' axis ). The position of label is determined by pos parameter. If pos=0 then label is printed at the center of axis. If pos>0 then label is printed at the maximum of axis. If pos<0 then label is printed at the minimum of axis. Value option set additional shifting of the label. .
1594
+ # Prints the label text for axis dir='x','y','z','t' (here 't' is ``ternary'' axis t=1-x-y). The position of label is determined by pos parameter. If pos=0 then label is printed at the center of axis. If pos>0 then label is printed at the maximum of axis. If pos<0 then label is printed at the minimum of axis. Value option set additional shifting of the label. Text printing.
1591
1595
  # @overload label(dir,text,pos=1,opt="")
1592
1596
  # @param [String] dir
1593
1597
  # @param [String] text
@@ -1599,7 +1603,7 @@ end
1599
1603
 
1600
1604
 
1601
1605
  # Legend.
1602
- # Draws legend of accumulated legend entries by font fnt with size. Parameter pos sets the position of the legend: is bottom left corner, is bottom right corner, is top left corner, is top right corner (is default). Parameter fnt can contain colors for face (1st one), for border (2nd one) and for text (last one). If less than 3 colors are specified then the color for border is black (for 2 and less colors), and the color for face is white (for 1 or none colors). If string fnt contain then border around the legend is drawn. If string fnt contain then legend entries will arranged horizontally.
1606
+ # Draws legend of accumulated legend entries by font fnt with size. Parameter pos sets the position of the legend: '0' is bottom left corner, '1' is bottom right corner, '2' is top left corner, '3' is top right corner (is default). Parameter fnt can contain colors for face (1st one), for border (2nd one) and for text (last one). If less than 3 colors are specified then the color for border is black (for 2 and less colors), and the color for face is white (for 1 or none colors). If string fnt contain '#' then border around the legend is drawn. If string fnt contain '-' then legend entries will arranged horizontally.
1603
1607
  # @overload legend(pos=0x3,fnt="#",opt="")
1604
1608
  # @param [Integer] pos default=0x3
1605
1609
  # @param [String] fnt default="#"
@@ -1610,7 +1614,7 @@ end
1610
1614
 
1611
1615
 
1612
1616
  # Legend.
1613
- # Draws legend of accumulated legend entries by font fnt with size. Position of legend is determined by parameter x, y which supposed to be normalized to interval [0,1].
1617
+ # Draws legend of accumulated legend entries by font fnt with size. Position of legend is determined by parameter x, y which supposed to be normalized to interval (0,1).
1614
1618
  # @overload legend(x,y,fnt="#",opt="")
1615
1619
  # @param [Float] x
1616
1620
  # @param [Float] y
@@ -1649,7 +1653,7 @@ end
1649
1653
 
1650
1654
 
1651
1655
  # 1D plotting.
1652
- # These functions draw continuous lines between points (x[i], y[i], z[i]). See also area, step, stem, tube, mark, error, belt, tens, tape.
1656
+ # These functions draw continuous lines between points (x(i), y(i), z(i)). See also area, step, stem, tube, mark, error, belt, tens, tape. Plot sample
1653
1657
  # @overload plot(y,pen="",opt="")
1654
1658
  # @param [MglData] y
1655
1659
  # @param [String] pen default=""
@@ -1673,7 +1677,7 @@ end
1673
1677
 
1674
1678
 
1675
1679
  # 1D plotting.
1676
- # This functions draws radar chart which is continuous lines between points located on an radial lines (like plot in Polar coordinates). Parameter value in options opt set the additional shift of data (i.e. the data a+value is used instead of a). If value<0 then r=max(0, -min(value). If pen containt symbol then "grid" (radial lines and circle for r) is drawn. See also plot.
1680
+ # This functions draws radar chart which is continuous lines between points located on an radial lines (like plot in Polar coordinates). Parameter value in options opt set the additional shift of data (i.e. the data a+value is used instead of a). If value<0 then r=max(0, -min(value). If pen containt '#' symbol then "grid" (radial lines and circle for r) is drawn. See also plot. Radar sample
1677
1681
  # @overload radar(a,pen="",opt="")
1678
1682
  # @param [MglData] a
1679
1683
  # @param [String] pen default=""
@@ -1684,7 +1688,7 @@ end
1684
1688
 
1685
1689
 
1686
1690
  # 1D plotting.
1687
- # These functions draw continuous stairs for points to axis plane. See also plot, stem, tile, boxs.
1691
+ # These functions draw continuous stairs for points to axis plane. See also plot, stem, tile, boxs. Step sample
1688
1692
  # @overload step(y,pen="",opt="")
1689
1693
  # @param [MglData] y
1690
1694
  # @param [String] pen default=""
@@ -1708,7 +1712,7 @@ end
1708
1712
 
1709
1713
 
1710
1714
  # 1D plotting.
1711
- # These functions draw continuous lines between points (x[i], y[i], z[i]) with color defined by the special array c[i] (look like tension plot). String pen specifies the color scheme (see Color scheme) and style and/or width of line (see Line styles). See also plot, mesh, fall.
1715
+ # These functions draw continuous lines between points (x(i), y(i), z(i)) with color defined by the special array c(i) (look like tension plot). String pen specifies the color scheme (see Color scheme) and style and/or width of line (see Line styles). See also plot, mesh, fall. Tens sample
1712
1716
  # @overload tens(y,c,pen="",opt="")
1713
1717
  # @param [MglData] y
1714
1718
  # @param [MglData] c
@@ -1735,7 +1739,7 @@ end
1735
1739
 
1736
1740
 
1737
1741
  # 1D plotting.
1738
- # These functions draw tapes of normals for curve between points (x[i], y[i], z[i]). Initial tape(s) was selected in x-y plane (for in pen) and/or y-z plane (for in pen). The width of tape is proportional to barwidth. See also plot, flow, barwidth.
1742
+ # These functions draw tapes of normals for curve between points (x(i), y(i), z(i)). Initial tape(s) was selected in x-y plane (for 'x' in pen) and/or y-z plane (for 'x' in pen). The width of tape is proportional to barwidth. See also plot, flow, barwidth. Tape sample
1739
1743
  # @overload tape(y,pen="",opt="")
1740
1744
  # @param [MglData] y
1741
1745
  # @param [String] pen default=""
@@ -1759,7 +1763,7 @@ end
1759
1763
 
1760
1764
 
1761
1765
  # 1D plotting.
1762
- # These functions draw continuous lines between points and fills it to axis plane. Also you can use gradient filling if number of specified colors is equal to 2*number of curves. See also plot, bars, stem, region.
1766
+ # These functions draw continuous lines between points and fills it to axis plane. Also you can use gradient filling if number of specified colors is equal to 2*number of curves. See also plot, bars, stem, region. Area sample
1763
1767
  # @overload area(y,pen="",opt="")
1764
1768
  # @param [MglData] y
1765
1769
  # @param [String] pen default=""
@@ -1783,7 +1787,7 @@ end
1783
1787
 
1784
1788
 
1785
1789
  # 1D plotting.
1786
- # These functions fill area between 2 curves. Dimensions of arrays y1 and y2 must be equal. Also you can use gradient filling if number of specified colors is equal to 2*number of curves. If pen contain symbol then only area with y1<y<y2 will be filled else the area with y2<y<y1 will be filled too. See also area, bars, stem.
1790
+ # These functions fill area between 2 curves. Dimensions of arrays y1 and y2 must be equal. Also you can use gradient filling if number of specified colors is equal to 2*number of curves. If pen contain symbol 'i' then only area with y1<y<y2 will be filled else the area with y2<y<y1 will be filled too. See also area, bars, stem. Region sample
1787
1791
  # @overload region(y1,y2,pen="",opt="")
1788
1792
  # @param [MglData] y1
1789
1793
  # @param [MglData] y2
@@ -1802,7 +1806,7 @@ end
1802
1806
 
1803
1807
 
1804
1808
  # 1D plotting.
1805
- # These functions draw vertical lines from points to axis plane. See also area, bars, plot, mark.
1809
+ # These functions draw vertical lines from points to axis plane. See also area, bars, plot, mark. Stem sample
1806
1810
  # @overload stem(y,pen="",opt="")
1807
1811
  # @param [MglData] y
1808
1812
  # @param [String] pen default=""
@@ -1826,7 +1830,7 @@ end
1826
1830
 
1827
1831
 
1828
1832
  # 1D plotting.
1829
- # These functions draw vertical bars from points to axis plane. If string pen contain symbol then lines are drawn one above another (like summation). If string contain symbol then waterfall chart is drawn for determining the cumulative effect of sequentially introduced positive or negative values. You can give different colors for positive and negative values if number of specified colors is equal to 2*number of curves. See also barh, cones, area, stem, chart, barwidth.
1833
+ # These functions draw vertical bars from points to axis plane. If string pen contain symbol 'a' then lines are drawn one above another (like summation). If string contain symbol 'f' then waterfall chart is drawn for determining the cumulative effect of sequentially introduced positive or negative values. You can give different colors for positive and negative values if number of specified colors is equal to 2*number of curves. See also barh, cones, area, stem, chart, barwidth. Bars sample
1830
1834
  # @overload bars(y,pen="",opt="")
1831
1835
  # @param [MglData] y
1832
1836
  # @param [String] pen default=""
@@ -1850,7 +1854,7 @@ end
1850
1854
 
1851
1855
 
1852
1856
  # 1D plotting.
1853
- # These functions draw horizontal bars from points to axis plane. If string contain symbol then lines are drawn one above another (like summation). If string contain symbol then waterfall chart is drawn for determining the cumulative effect of sequentially introduced positive or negative values. You can give different colors for positive and negative values if number of specified colors is equal to 2*number of curves. See also bars, barwidth.
1857
+ # These functions draw horizontal bars from points to axis plane. If string contain symbol 'a' then lines are drawn one above another (like summation). If string contain symbol 'f' then waterfall chart is drawn for determining the cumulative effect of sequentially introduced positive or negative values. You can give different colors for positive and negative values if number of specified colors is equal to 2*number of curves. See also bars, barwidth. Barh sample
1854
1858
  # @overload barh(v,pen="",opt="")
1855
1859
  # @param [MglData] v
1856
1860
  # @param [String] pen default=""
@@ -1867,7 +1871,7 @@ end
1867
1871
 
1868
1872
 
1869
1873
  # 1D plotting.
1870
- # These functions draw cones from points to axis plane. If string contain symbol then cones are drawn one above another (like summation). You can give different colors for positive and negative values if number of specified colors is equal to 2*number of curves. See also bars, barwidth.
1874
+ # These functions draw cones from points to axis plane. If string contain symbol 'a' then cones are drawn one above another (like summation). You can give different colors for positive and negative values if number of specified colors is equal to 2*number of curves. See also bars, barwidth. Cones sample
1871
1875
  # @overload cones(y,pen="",opt="")
1872
1876
  # @param [MglData] y
1873
1877
  # @param [String] pen default=""
@@ -1891,7 +1895,7 @@ end
1891
1895
 
1892
1896
 
1893
1897
  # 1D plotting.
1894
- # The function draws colored stripes (boxes) for data in array a. The number of stripes is equal to the number of rows in a (equal to a.ny). The color of each next stripe is cyclically changed from colors specified in string col or in palette Pal (see Palette and colors). Spaces in colors denote transparent ``color'' (i.e. corresponding stripe(s) are not drawn). The stripe width is proportional to value of element in a. Chart is plotted only for data with non-negative elements. If string col have symbol then black border lines are drawn. The most nice form the chart have in 3d (after rotation of coordinates) or in cylindrical coordinates (becomes so called Pie chart).
1898
+ # The function draws colored stripes (boxes) for data in array a. The number of stripes is equal to the number of rows in a (equal to a.ny). The color of each next stripe is cyclically changed from colors specified in string col or in palette Pal (see Palette and colors). Spaces in colors denote transparent ``color'' (i.e. corresponding stripe(s) are not drawn). The stripe width is proportional to value of element in a. Chart is plotted only for data with non-negative elements. If string col have symbol '#' then black border lines are drawn. The most nice form the chart have in 3d (after rotation of coordinates) or in cylindrical coordinates (becomes so called Pie chart). Chart sample
1895
1899
  # @overload chart(a,col="",opt="")
1896
1900
  # @param [MglData] a
1897
1901
  # @param [String] col default=""
@@ -1902,7 +1906,7 @@ end
1902
1906
 
1903
1907
 
1904
1908
  # 1D plotting.
1905
- # These functions draw boxplot (also known as a box-and-whisker diagram) at points x[i]. This is five-number summaries of data a[i,j] (minimum, lower quartile (Q1), median (Q2), upper quartile (Q3) and maximum) along second (j-th) direction. See also plot, error, bars, barwidth.
1909
+ # These functions draw boxplot (also known as a box-and-whisker diagram) at points x(i). This is five-number summaries of data a(i,j) (minimum, lower quartile (Q1), median (Q2), upper quartile (Q3) and maximum) along second (j-th) direction. See also plot, error, bars, barwidth. BoxPlot sample
1906
1910
  # @overload box_plot(a,pen="",opt="")
1907
1911
  # @param [MglData] a
1908
1912
  # @param [String] pen default=""
@@ -1919,7 +1923,7 @@ end
1919
1923
 
1920
1924
 
1921
1925
  # 1D plotting.
1922
- # These functions draw candlestick chart at points x[i]. This is a combination of a line-chart and a bar-chart, in that each bar represents the range of price movement over a given time interval. Wire (or white) candle correspond to price growth v1[i]<v2[i], opposite case -- solid (or dark) candle. "Shadows" show the minimal y1 and maximal y2 prices. If v2 is absent then it is determined as v2[i]=v1[i+1]. See also plot, bars, barwidth.
1926
+ # These functions draw candlestick chart at points x(i). This is a combination of a line-chart and a bar-chart, in that each bar represents the range of price movement over a given time interval. Wire (or white) candle correspond to price growth v1(i)<v2(i), opposite case -- solid (or dark) candle. "Shadows" show the minimal y1 and maximal y2 prices. If v2 is absent then it is determined as v2(i)=v1(i+1). See also plot, bars, barwidth. Candle sample
1923
1927
  # @overload candle(v1,pen="",opt="")
1924
1928
  # @param [MglData] v1
1925
1929
  # @param [String] pen default=""
@@ -1960,7 +1964,7 @@ end
1960
1964
 
1961
1965
 
1962
1966
  # 1D plotting.
1963
- # These functions draw error boxes (ex[i], ey[i]) at points (x[i], y[i]). This can be useful, for example, in experimental points, or to show numeric error or some estimations and so on. If string pen contain symbol than large semitransparent mark is used instead of error box. See also plot, mark.
1967
+ # These functions draw error boxes (ex(i), ey(i)) at points (x(i), y(i)). This can be useful, for example, in experimental points, or to show numeric error or some estimations and so on. If string pen contain symbol '@' than large semitransparent mark is used instead of error box. See also plot, mark. Error sample
1964
1968
  # @overload error(y,ey,pen="",opt="")
1965
1969
  # @param [MglData] y
1966
1970
  # @param [MglData] ey
@@ -1987,7 +1991,7 @@ end
1987
1991
 
1988
1992
 
1989
1993
  # 1D plotting.
1990
- # These functions draw marks with size r[i]*marksize at points (x[i], y[i], z[i]). If you need to draw markers of the same size then you can use plot function with empty line style . For markers with size in axis range use error with style . See also plot, textmark, error, stem.
1994
+ # These functions draw marks with size r(i)*marksize at points (x(i), y(i), z(i)). If you need to draw markers of the same size then you can use plot function with empty line style ' '. For markers with size in axis range use error with style '@'. See also plot, textmark, error, stem. Mark sample
1991
1995
  # @overload mark(y,r,pen="",opt="")
1992
1996
  # @param [MglData] y
1993
1997
  # @param [MglData] r
@@ -2014,7 +2018,7 @@ end
2014
2018
 
2015
2019
 
2016
2020
  # 1D plotting.
2017
- # These functions draw string txt as marks with size proportional to r[i]*marksize at points (x[i], y[i], z[i]). By default (if omitted) r[i]=1. See also plot, mark, stem.
2021
+ # These functions draw string txt as marks with size proportional to r(i)*marksize at points (x(i), y(i), z(i)). By default (if omitted) r(i)=1. See also plot, mark, stem. TextMark sample
2018
2022
  # @overload text_mark(y,txt,fnt="",opt="")
2019
2023
  # @param [MglData] y
2020
2024
  # @param [String] txt
@@ -2050,7 +2054,7 @@ end
2050
2054
 
2051
2055
 
2052
2056
  # 1D plotting.
2053
- # These functions draw string txt at points (x[i], y[i], z[i]). If string txt contain , , or then it will be replaced by the value of x-,y-,z-coordinate of the point or its index. See also plot, mark, textmark, table.
2057
+ # These functions draw string txt at points (x(i), y(i), z(i)). If string txt contain '%x', '%y', '%z' or '%n' then it will be replaced by the value of x-,y-,z-coordinate of the point or its index. See also plot, mark, textmark, table. Label sample
2054
2058
  # @overload label(y,txt,fnt="",opt="")
2055
2059
  # @param [MglData] y
2056
2060
  # @param [String] txt
@@ -2077,7 +2081,7 @@ end
2077
2081
 
2078
2082
 
2079
2083
  # 1D plotting.
2080
- # These functions draw table with values of val and captions from string txt (separated by newline symbol ) at points (x, y) (default at (0,0)) related to current subplot. If string fnt contain then cell border will be drawn. If string fnt contain then table width is limited by subplot width (equivalent option ). If string fnt contain then widths of all cells are the same. Option value set the width of the table (default is 1). See also plot, label.
2084
+ # These functions draw table with values of val and captions from string txt (separated by newline symbol '\n') at points (x, y) (default at (0,0)) related to current subplot. If string fnt contain '#' then cell border will be drawn. If string fnt contain '|' then table width is limited by subplot width (equivalent option 'value 1'). If string fnt contain '=' then widths of all cells are the same. Option value set the width of the table (default is 1). See also plot, label. Table sample
2081
2085
  # @overload table(val,txt,fnt="",opt="")
2082
2086
  # @param [MglData] val
2083
2087
  # @param [String] txt
@@ -2097,7 +2101,7 @@ end
2097
2101
 
2098
2102
 
2099
2103
  # 1D plotting.
2100
- # These functions draw the tube with variable radius r[i] along the curve between points (x[i], y[i], z[i]). See also plot.
2104
+ # These functions draw the tube with variable radius r(i) along the curve between points (x(i), y(i), z(i)). See also plot. Tube sample
2101
2105
  # @overload tube(y,r,pen="",opt="")
2102
2106
  # @param [MglData] y
2103
2107
  # @param [MglData] r
@@ -2145,7 +2149,7 @@ end
2145
2149
 
2146
2150
 
2147
2151
  # 1D plotting.
2148
- # These functions draw surface which is result of curve (r, z) rotation around axis. If string pen contain symbols or then rotation axis will be set to specified direction (default is ). If string pen have symbol then wire plot is produced. If string pen have symbol then plot by dots is produced. See also plot, axial.
2152
+ # These functions draw surface which is result of curve (r, z) rotation around axis. If string pen contain symbols 'x' or 'z' then rotation axis will be set to specified direction (default is 'y'). If string pen have symbol '#' then wire plot is produced. If string pen have symbol '.' then plot by dots is produced. See also plot, axial. Torus sample
2149
2153
  # @overload torus(r,z,pen="",opt="")
2150
2154
  # @param [MglData] r
2151
2155
  # @param [MglData] z
@@ -2157,7 +2161,7 @@ end
2157
2161
 
2158
2162
 
2159
2163
  # 2D plotting.
2160
- # The function draws surface specified parametrically (x[i,j], y[i,j], z[i,j]). If string sch have symbol then grid lines are drawn. If string sch have symbol then plot by dots is produced. See also mesh, dens, belt, tile, boxs, surfc, surfa.
2164
+ # The function draws surface specified parametrically (x(i,j), y(i,j), z(i,j)). If string sch have symbol '#' then grid lines are drawn. If string sch have symbol '.' then plot by dots is produced. See also mesh, dens, belt, tile, boxs, surfc, surfa. Surf sample
2161
2165
  # @overload surf(z,sch="",opt="")
2162
2166
  # @param [MglData] z
2163
2167
  # @param [String] sch default=""
@@ -2175,7 +2179,7 @@ end
2175
2179
 
2176
2180
 
2177
2181
  # 2D plotting.
2178
- # The function draws mesh lines for surface specified parametrically (x[i,j], y[i,j], z[i,j]). See also surf, fall, meshnum, cont, tens.
2182
+ # The function draws mesh lines for surface specified parametrically (x(i,j), y(i,j), z(i,j)). See also surf, fall, meshnum, cont, tens. Mesh sample
2179
2183
  # @overload mesh(z,sch="",opt="")
2180
2184
  # @param [MglData] z
2181
2185
  # @param [String] sch default=""
@@ -2193,7 +2197,7 @@ end
2193
2197
 
2194
2198
 
2195
2199
  # 2D plotting.
2196
- # The function draws fall lines for surface specified parametrically (x[i,j], y[i,j], z[i,j]). This plot can be used for plotting several curves shifted in depth one from another. If sch contain then lines are drawn along x-direction else (by default) lines are drawn along y-direction. See also belt, mesh, tens, meshnum.
2200
+ # The function draws fall lines for surface specified parametrically (x(i,j), y(i,j), z(i,j)). This plot can be used for plotting several curves shifted in depth one from another. If sch contain 'x' then lines are drawn along x-direction else (by default) lines are drawn along y-direction. See also belt, mesh, tens, meshnum. Fall sample
2197
2201
  # @overload fall(z,sch="",opt="")
2198
2202
  # @param [MglData] z
2199
2203
  # @param [String] sch default=""
@@ -2211,7 +2215,7 @@ end
2211
2215
 
2212
2216
 
2213
2217
  # 2D plotting.
2214
- # The function draws belts for surface specified parametrically (x[i,j], y[i,j], z[i,j]). This plot can be used as 3d generalization of plot). If sch contain then belts are drawn along x-direction else (by default) belts are drawn along y-direction. See also fall, surf, plot, meshnum.
2218
+ # The function draws belts for surface specified parametrically (x(i,j), y(i,j), z(i,j)). This plot can be used as 3d generalization of plot). If sch contain 'x' then belts are drawn along x-direction else (by default) belts are drawn along y-direction. See also fall, surf, plot, meshnum. Belt sample
2215
2219
  # @overload belt(z,sch="",opt="")
2216
2220
  # @param [MglData] z
2217
2221
  # @param [String] sch default=""
@@ -2229,7 +2233,7 @@ end
2229
2233
 
2230
2234
 
2231
2235
  # 2D plotting.
2232
- # The function draws vertical boxes for surface specified parametrically (x[i,j], y[i,j], z[i,j]). Symbol in sch set to draw filled boxes. See also surf, dens, tile, step.
2236
+ # The function draws vertical boxes for surface specified parametrically (x(i,j), y(i,j), z(i,j)). Symbol '@' in sch set to draw filled boxes. See also surf, dens, tile, step. Boxs sample
2233
2237
  # @overload boxs(z,sch="",opt="")
2234
2238
  # @param [MglData] z
2235
2239
  # @param [String] sch default=""
@@ -2247,7 +2251,7 @@ end
2247
2251
 
2248
2252
 
2249
2253
  # 2D plotting.
2250
- # The function draws horizontal tiles for surface specified parametrically (x[i,j], y[i,j], z[i,j]). Such plot can be used as 3d generalization of step. See also surf, boxs, step, tiles.
2254
+ # The function draws horizontal tiles for surface specified parametrically (x(i,j), y(i,j), z(i,j)). Such plot can be used as 3d generalization of step. See also surf, boxs, step, tiles. Tile sample
2251
2255
  # @overload tile(z,sch="",opt="")
2252
2256
  # @param [MglData] z
2253
2257
  # @param [String] sch default=""
@@ -2265,7 +2269,7 @@ end
2265
2269
 
2266
2270
 
2267
2271
  # 2D plotting.
2268
- # The function draws density plot for surface specified parametrically (x[i,j], y[i,j], z[i,j]) at z = Min.z. If string sch have symbol then grid lines are drawn. If string sch have symbol then plot by dots is produced. See also surf, cont, contf, boxs, tile, dens[xyz].
2272
+ # The function draws density plot for surface specified parametrically (x(i,j), y(i,j), z(i,j)) at z = Min.z. If string sch have symbol '#' then grid lines are drawn. If string sch have symbol '.' then plot by dots is produced. See also surf, cont, contf, boxs, tile, dens(xyz). Dens sample
2269
2273
  # @overload dens(z,sch="",opt="",zval=NAN)
2270
2274
  # @param [MglData] z
2271
2275
  # @param [String] sch default=""
@@ -2285,7 +2289,7 @@ end
2285
2289
 
2286
2290
 
2287
2291
  # 2D plotting.
2288
- # The function draws contour lines for surface specified parametrically (x[i,j], y[i,j], z[i,j]) at z=v[k] or at z = Min.z if sch contain symbol . Contours are plotted for z[i,j]=v[k] where v[k] are values of data array v. If string sch have symbol or then contour labels v[k] will be drawn below (or above) the contours. See also dens, contf, contd, axial, cont[xyz].
2292
+ # The function draws contour lines for surface specified parametrically (x(i,j), y(i,j), z(i,j)) at z=v(k) or at z = Min.z if sch contain symbol '_'. Contours are plotted for z(i,j)=v(k) where v(k) are values of data array v. If string sch have symbol 't' or 'T' then contour labels v(k) will be drawn below (or above) the contours. See also dens, contf, contd, axial, cont(xyz). Cont sample
2289
2293
  # @overload cont(v,z,sch="",opt="")
2290
2294
  # @param [MglData] v
2291
2295
  # @param [MglData] z
@@ -2323,7 +2327,7 @@ end
2323
2327
 
2324
2328
 
2325
2329
  # 2D plotting.
2326
- # The function draws solid (or filled) contour lines for surface specified parametrically (x[i,j], y[i,j], z[i,j]) at z=v[k] or at z = Min.z if sch contain symbol . Contours are plotted for z[i,j]=v[k] where v[k] are values of data array v (must be v.nx>2). See also dens, cont, contd, contf[xyz].
2330
+ # The function draws solid (or filled) contour lines for surface specified parametrically (x(i,j), y(i,j), z(i,j)) at z=v(k) or at z = Min.z if sch contain symbol '_'. Contours are plotted for z(i,j)=v(k) where v(k) are values of data array v (must be v.nx>2). See also dens, cont, contd, contf(xyz). ContF sample
2327
2331
  # @overload cont_f(v,z,sch="",opt="")
2328
2332
  # @param [MglData] v
2329
2333
  # @param [MglData] z
@@ -2361,7 +2365,7 @@ end
2361
2365
 
2362
2366
 
2363
2367
  # 2D plotting.
2364
- # The function draws solid (or filled) contour lines for surface specified parametrically (x[i,j], y[i,j], z[i,j]) at z=v[k] (or at z = Min.z if sch contain symbol ) with manual colors. Contours are plotted for z[i,j]=v[k] where v[k] are values of data array v (must be v.nx>2). String sch sets the contour colors: the color of k-th contour is determined by character sch[k%strlen(sch)]. See also dens, cont, contf.
2368
+ # The function draws solid (or filled) contour lines for surface specified parametrically (x(i,j), y(i,j), z(i,j)) at z=v(k) (or at z = Min.z if sch contain symbol '_') with manual colors. Contours are plotted for z(i,j)=v(k) where v(k) are values of data array v (must be v.nx>2). String sch sets the contour colors: the color of k-th contour is determined by character sch(k%strlen(sch)). See also dens, cont, contf. ContD sample
2365
2369
  # @overload cont_d(v,z,sch="",opt="")
2366
2370
  # @param [MglData] v
2367
2371
  # @param [MglData] z
@@ -2399,7 +2403,7 @@ end
2399
2403
 
2400
2404
 
2401
2405
  # 2D plotting.
2402
- # The function draws vertical cylinder (tube) at contour lines for surface specified parametrically (x[i,j], y[i,j], z[i,j]) at z=v[k] or at z = Min.z if sch contain symbol . Contours are plotted for z[i,j]=v[k] where v[k] are values of data array v. See also cont, contf.
2406
+ # The function draws vertical cylinder (tube) at contour lines for surface specified parametrically (x(i,j), y(i,j), z(i,j)) at z=v(k) or at z = Min.z if sch contain symbol '_'. Contours are plotted for z(i,j)=v(k) where v(k) are values of data array v. See also cont, contf. ContV sample
2403
2407
  # @overload cont_v(v,z,sch="",opt="")
2404
2408
  # @param [MglData] v
2405
2409
  # @param [MglData] z
@@ -2437,7 +2441,7 @@ end
2437
2441
 
2438
2442
 
2439
2443
  # 2D plotting.
2440
- # The function draws surface which is result of contour plot rotation for surface specified parametrically (x[i,j], y[i,j], z[i,j]). Contours are plotted for z[i,j]=v[k] where v[k] are values of data array v. If string sch have symbol then wire plot is produced. If string sch have symbol then plot by dots is produced. If string contain symbols or then rotation axis will be set to specified direction (default is ). See also cont, contf, torus, surf3.
2444
+ # The function draws surface which is result of contour plot rotation for surface specified parametrically (x(i,j), y(i,j), z(i,j)). Contours are plotted for z(i,j)=v(k) where v(k) are values of data array v. If string sch have symbol '#' then wire plot is produced. If string sch have symbol '.' then plot by dots is produced. If string contain symbols 'x' or 'z' then rotation axis will be set to specified direction (default is 'y'). See also cont, contf, torus, surf3. Axial sample
2441
2445
  # @overload axial(v,z,sch="",opt="")
2442
2446
  # @param [MglData] v
2443
2447
  # @param [MglData] z
@@ -2477,7 +2481,7 @@ end
2477
2481
 
2478
2482
 
2479
2483
  # 2D plotting.
2480
- # The function draws grid lines for density plot of surface specified parametrically (x[i,j], y[i,j], z[i,j]) at z = Min.z. See also dens, cont, contf, meshnum.
2484
+ # The function draws grid lines for density plot of surface specified parametrically (x(i,j), y(i,j), z(i,j)) at z = Min.z. See also dens, cont, contf, meshnum.
2481
2485
  # @overload grid(z,sch="",opt="")
2482
2486
  # @param [MglData] z
2483
2487
  # @param [String] sch default=""
@@ -2495,7 +2499,7 @@ end
2495
2499
 
2496
2500
 
2497
2501
  # 3D plotting.
2498
- # The function draws isosurface plot for 3d array specified parametrically a[i,j,k](x[i,j,k], y[i,j,k], z[i,j,k]) at a(x,y,z)=val. If string contain then wire plot is produced. If string sch have symbol then plot by dots is produced. Note, that there is possibility of incorrect plotting due to uncertainty of cross-section defining if there are two or more isosurface intersections inside one cell. See also cloud, dens3, surf3c, surf3a, axial.
2502
+ # The function draws isosurface plot for 3d array specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)) at a(x,y,z)=val. If string contain '#' then wire plot is produced. If string sch have symbol '.' then plot by dots is produced. Note, that there is possibility of incorrect plotting due to uncertainty of cross-section defining if there are two or more isosurface intersections inside one cell. See also cloud, dens3, surf3c, surf3a, axial. Surf3 sample
2499
2503
  # @overload surf3(val,a,sch="",opt="")
2500
2504
  # @param [Float] val
2501
2505
  # @param [MglData] a
@@ -2535,7 +2539,7 @@ end
2535
2539
 
2536
2540
 
2537
2541
  # 3D plotting.
2538
- # The function draws cloud plot for 3d data specified parametrically a[i,j,k](x[i,j,k], y[i,j,k], z[i,j,k]). This plot is a set of cubes with color and transparency proportional to value of a. The resulting plot is like cloud -- low value is transparent but higher ones are not. The number of plotting cells depend on meshnum. If string sch contain symbol then lower quality plot will produced with much low memory usage. If string sch contain symbol then transparency will be inversed, i.e. higher become transparent and lower become not transparent. See also surf3, meshnum.
2542
+ # The function draws cloud plot for 3d data specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)). This plot is a set of cubes with color and transparency proportional to value of a. The resulting plot is like cloud -- low value is transparent but higher ones are not. The number of plotting cells depend on meshnum. If string sch contain symbol '.' then lower quality plot will produced with much low memory usage. If string sch contain symbol 'i' then transparency will be inversed, i.e. higher become transparent and lower become not transparent. See also surf3, meshnum. Cloud sample
2539
2543
  # @overload cloud(a,sch="",opt="")
2540
2544
  # @param [MglData] a
2541
2545
  # @param [String] sch default=""
@@ -2554,7 +2558,7 @@ end
2554
2558
 
2555
2559
 
2556
2560
  # 3D plotting.
2557
- # The function draws density plot for 3d data specified parametrically a[i,j,k](x[i,j,k], y[i,j,k], z[i,j,k]). Density is plotted at slice sVal in direction (, , ) if sch contain corresponding symbol (by default, direction is used). If string stl have symbol then grid lines are drawn. See also cont3, contf3, dens, grid3.
2561
+ # The function draws density plot for 3d data specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)). Density is plotted at slice sVal in direction ('x', 'y', 'z') if sch contain corresponding symbol (by default, 'y' direction is used). If string stl have symbol '#' then grid lines are drawn. See also cont3, contf3, dens, grid3. Dens3 sample
2558
2562
  # @overload dens3(a,sch="",sval=-1,opt="")
2559
2563
  # @param [MglData] a
2560
2564
  # @param [String] sch default=""
@@ -2575,7 +2579,7 @@ end
2575
2579
 
2576
2580
 
2577
2581
  # 3D plotting.
2578
- # The function draws contour plot for 3d data specified parametrically a[i,j,k](x[i,j,k], y[i,j,k], z[i,j,k]). Contours are plotted for values specified in array v at slice sVal in direction (, , ) if sch contain corresponding symbol (by default, direction is used). If string sch have symbol then grid lines are drawn. If string sch have symbol or then contour labels will be drawn below (or above) the contours. See also dens3, contf3, cont, grid3.
2582
+ # The function draws contour plot for 3d data specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)). Contours are plotted for values specified in array v at slice sVal in direction ('x', 'y', 'z') if sch contain corresponding symbol (by default, 'y' direction is used). If string sch have symbol '#' then grid lines are drawn. If string sch have symbol 't' or 'T' then contour labels will be drawn below (or above) the contours. See also dens3, contf3, cont, grid3. Cont3 sample
2579
2583
  # @overload cont3(v,a,sch="",sval=-1,opt="")
2580
2584
  # @param [MglData] v
2581
2585
  # @param [MglData] a
@@ -2620,7 +2624,7 @@ end
2620
2624
 
2621
2625
 
2622
2626
  # 3D plotting.
2623
- # The function draws solid (or filled) contour plot for 3d data specified parametrically a[i,j,k](x[i,j,k], y[i,j,k], z[i,j,k]). Contours are plotted for values specified in array v at slice sVal in direction (, , ) if sch contain corresponding symbol (by default, direction is used). If string sch have symbol then grid lines are drawn. See also dens3, cont3, contf, grid3.
2627
+ # The function draws solid (or filled) contour plot for 3d data specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)). Contours are plotted for values specified in array v at slice sVal in direction ('x', 'y', 'z') if sch contain corresponding symbol (by default, 'y' direction is used). If string sch have symbol '#' then grid lines are drawn. See also dens3, cont3, contf, grid3. ContF3 sample
2624
2628
  # @overload contf3(v,a,sch="",sval=-1,opt="")
2625
2629
  # @param [MglData] v
2626
2630
  # @param [MglData] a
@@ -2665,7 +2669,7 @@ end
2665
2669
 
2666
2670
 
2667
2671
  # 3D plotting.
2668
- # The function draws grid for 3d data specified parametrically a[i,j,k](x[i,j,k], y[i,j,k], z[i,j,k]). Grid is plotted at slice sVal in direction (, , ) if sch contain corresponding symbol (by default, direction is used). See also cont3, contf3, dens3, grid2, meshnum.
2672
+ # The function draws grid for 3d data specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)). Grid is plotted at slice sVal in direction ('x', 'y', 'z') if sch contain corresponding symbol (by default, 'y' direction is used). See also cont3, contf3, dens3, grid2, meshnum.
2669
2673
  # @overload grid3(a,sch="",sval=-1,opt="")
2670
2674
  # @param [MglData] a
2671
2675
  # @param [String] sch default=""
@@ -2686,7 +2690,7 @@ end
2686
2690
 
2687
2691
 
2688
2692
  # 3D plotting.
2689
- # Draws the isosurface for 3d array a at constant values of a=val. This is special kind of plot for a specified in accompanied coordinates along curve tr with orts g1, g2 and with transverse scale r. Variable flag is bitwise: - draw in accompanied (not laboratory) coordinates; - draw projection to plane; - draw normalized in each slice field. The x-size of data arrays tr, g1, g2 must be nx>2. The y-size of data arrays tr, g1, g2 and z-size of the data array a must be equal. See also surf3.
2693
+ # Draws the isosurface for 3d array a at constant values of a=val. This is special kind of plot for a specified in accompanied coordinates along curve tr with orts g1, g2 and with transverse scale r. Variable flag is bitwise: '0x1' - draw in accompanied (not laboratory) coordinates; '0x2' - draw projection to \rho-z plane; '0x4' - draw normalized in each slice field. The x-size of data arrays tr, g1, g2 must be nx>2. The y-size of data arrays tr, g1, g2 and z-size of the data array a must be equal. See also surf3.
2690
2694
  # @overload beam(tr,g1,g2,a,r,stl="",flag=0,num=3)
2691
2695
  # @param [MglData] tr
2692
2696
  # @param [MglData] g1
@@ -2712,7 +2716,7 @@ end
2712
2716
 
2713
2717
 
2714
2718
  # Dual plotting.
2715
- # The function draws surface specified parametrically (x[i,j], y[i,j], z[i,j]) and color it by matrix c[i,j]. If string sch have symbol then grid lines are drawn. If string sch have symbol then plot by dots is produced. All dimensions of arrays z and c must be equal. Surface is plotted for each z slice of the data. See also surf, surfa, surf3c.
2719
+ # The function draws surface specified parametrically (x(i,j), y(i,j), z(i,j)) and color it by matrix c(i,j). If string sch have symbol '#' then grid lines are drawn. If string sch have symbol '.' then plot by dots is produced. All dimensions of arrays z and c must be equal. Surface is plotted for each z slice of the data. See also surf, surfa, surf3c. SurfC sample
2716
2720
  # @overload surf_c(z,c,sch="",opt="")
2717
2721
  # @param [MglData] z
2718
2722
  # @param [MglData] c
@@ -2732,7 +2736,7 @@ end
2732
2736
 
2733
2737
 
2734
2738
  # Dual plotting.
2735
- # The function draws isosurface plot for 3d array specified parametrically a[i,j,k](x[i,j,k], y[i,j,k], z[i,j,k]) at a(x,y,z)=val. It is mostly the same as surf3 function but the color of isosurface depends on values of array c. If string sch contain then wire plot is produced. If string sch have symbol then plot by dots is produced. See also surf3, surfc, surf3a.
2739
+ # The function draws isosurface plot for 3d array specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)) at a(x,y,z)=val. It is mostly the same as surf3 function but the color of isosurface depends on values of array c. If string sch contain '#' then wire plot is produced. If string sch have symbol '.' then plot by dots is produced. See also surf3, surfc, surf3a. Surf3C sample
2736
2740
  # @overload surf_3c(val,a,c,sch="",opt="")
2737
2741
  # @param [Float] val
2738
2742
  # @param [MglData] a
@@ -2776,7 +2780,7 @@ end
2776
2780
 
2777
2781
 
2778
2782
  # Dual plotting.
2779
- # The function draws surface specified parametrically (x[i,j], y[i,j], z[i,j]) and transparent it by matrix c[i,j]. If string sch have symbol then grid lines are drawn. If string sch have symbol then plot by dots is produced. All dimensions of arrays z and c must be equal. Surface is plotted for each z slice of the data. See also surf, surfc, surf3a.
2783
+ # The function draws surface specified parametrically (x(i,j), y(i,j), z(i,j)) and transparent it by matrix c(i,j). If string sch have symbol '#' then grid lines are drawn. If string sch have symbol '.' then plot by dots is produced. All dimensions of arrays z and c must be equal. Surface is plotted for each z slice of the data. See also surf, surfc, surf3a. SurfA sample
2780
2784
  # @overload surf_a(z,c,sch="",opt="")
2781
2785
  # @param [MglData] z
2782
2786
  # @param [MglData] c
@@ -2796,7 +2800,7 @@ end
2796
2800
 
2797
2801
 
2798
2802
  # Dual plotting.
2799
- # The function draws isosurface plot for 3d array specified parametrically a[i,j,k](x[i,j,k], y[i,j,k], z[i,j,k]) at a(x,y,z)=val. It is mostly the same as surf3 function but the color of isosurface depends on values of array c. If string sch contain then wire plot is produced. If string sch have symbol then plot by dots is produced. See also surf3, surfc, surf3a.
2803
+ # The function draws isosurface plot for 3d array specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)) at a(x,y,z)=val. It is mostly the same as surf3 function but the color of isosurface depends on values of array c. If string sch contain '#' then wire plot is produced. If string sch have symbol '.' then plot by dots is produced. See also surf3, surfc, surf3a. Surf3A sample
2800
2804
  # @overload surf_3a(val,a,c,sch="",opt="")
2801
2805
  # @param [Float] val
2802
2806
  # @param [MglData] a
@@ -2840,7 +2844,7 @@ end
2840
2844
 
2841
2845
 
2842
2846
  # Dual plotting.
2843
- # The function draws horizontal tiles for surface specified parametrically (x[i,j], y[i,j], z[i,j]). It is mostly the same as tile but the size of tiles is determined by r array. This is some kind of ``transparency'' useful for exporting to EPS files. Tiles is plotted for each z slice of the data. See also surfa, tile.
2847
+ # The function draws horizontal tiles for surface specified parametrically (x(i,j), y(i,j), z(i,j)). It is mostly the same as tile but the size of tiles is determined by r array. This is some kind of ``transparency'' useful for exporting to EPS files. Tiles is plotted for each z slice of the data. See also surfa, tile. TileS sample
2844
2848
  # @overload tile_s(z,c,sch="",opt="")
2845
2849
  # @param [MglData] z
2846
2850
  # @param [MglData] c
@@ -2860,7 +2864,7 @@ end
2860
2864
 
2861
2865
 
2862
2866
  # Dual plotting.
2863
- # The function draws mapping plot for matrices (ax, ay ) which parametrically depend on coordinates x, y. The initial position of the cell (point) is marked by color. Height is proportional to Jacobian(ax,ay). This plot is like Arnold diagram ??? If string sch contain symbol then the color ball at matrix knots are drawn otherwise face is drawn.
2867
+ # The function draws mapping plot for matrices (ax, ay ) which parametrically depend on coordinates x, y. The initial position of the cell (point) is marked by color. Height is proportional to Jacobian(ax,ay). This plot is like Arnold diagram ??? If string sch contain symbol '.' then the color ball at matrix knots are drawn otherwise face is drawn. Mapping visualization
2864
2868
  # @overload map(ax,ay,sch="",opt="")
2865
2869
  # @param [MglData] ax
2866
2870
  # @param [MglData] ay
@@ -2880,7 +2884,7 @@ end
2880
2884
 
2881
2885
 
2882
2886
  # Dual plotting.
2883
- # Draws spectrogram of complex array re+i*im for Fourier size of dn points at plane z=Min.z. For example in 1D case, result is density plot of data with size (int(nx/dn), dn, ny). At this array re, im parametrically depend on coordinates x, y. The size of re and im must be the same. The minor dimensions of arrays x, y, re should be equal. Arrays x, y can be vectors (not matrix as re).
2887
+ # Draws spectrogram of complex array re+i*im for Fourier size of dn points at plane z=Min.z. For example in 1D case, result is density plot of data res(i,j)=|\sum_d^dn exp(I*j*d)*(re(i*dn+d)+I*im(i*dn+d))|/dn with size (int(nx/dn), dn, ny). At this array re, im parametrically depend on coordinates x, y. The size of re and im must be the same. The minor dimensions of arrays x, y, re should be equal. Arrays x, y can be vectors (not matrix as re). STFA sample
2884
2888
  # @overload stfa(re,im,dn,sch="",opt="")
2885
2889
  # @param [MglData] re
2886
2890
  # @param [MglData] im
@@ -2902,7 +2906,7 @@ end
2902
2906
 
2903
2907
 
2904
2908
  # Vector fields.
2905
- # The function draws vectors (ax, ay, az) along a curve (x, y, z). The length of arrows are proportional to }. String pen specifies the color (see Line styles). By default (pen="") color from palette is used (see Palette and colors). Option value set the vector length factor (if non-zero) or vector length to be proportional the distance between curve points (if value=0). The minor sizes of all arrays must be equal and large 2. The plots are drawn for each row if one of the data is the matrix. See also vect.
2909
+ # The function draws vectors (ax, ay, az) along a curve (x, y, z). The length of arrows are proportional to \sqrt(ax^2+ay^2+az^2). String pen specifies the color (see Line styles). By default (pen="") color from palette is used (see Palette and colors). Option value set the vector length factor (if non-zero) or vector length to be proportional the distance between curve points (if value=0). The minor sizes of all arrays must be equal and large 2. The plots are drawn for each row if one of the data is the matrix. See also vect. Traj sample
2906
2910
  # @overload traj(x,y,ax,ay,sch="",opt="")
2907
2911
  # @param [MglData] x
2908
2912
  # @param [MglData] y
@@ -2926,8 +2930,8 @@ end
2926
2930
 
2927
2931
 
2928
2932
  # Vector fields.
2929
- # The function draws plane vector field plot for the field (ax, ay) depending parametrically on coordinates x, y at level z=Min.z. The length and color of arrows are proportional to }. The number of arrows depend on meshnum. The appearance of the hachures (arrows) can be changed by symbols:
2930
- # See also flow, dew.
2933
+ # The function draws plane vector field plot for the field (ax, ay) depending parametrically on coordinates x, y at level z=Min.z. The length and color of arrows are proportional to \sqrt(ax^2+ay^2). The number of arrows depend on meshnum. The appearance of the hachures (arrows) can be changed by symbols:
2934
+ # See also flow, dew. Vect sample
2931
2935
  # @overload vect(ax,ay,sch="",opt="")
2932
2936
  # @param [MglData] ax
2933
2937
  # @param [MglData] ay
@@ -2947,7 +2951,7 @@ end
2947
2951
 
2948
2952
 
2949
2953
  # Vector fields.
2950
- # This is 3D version of the first functions. Here arrays ax, ay, az must be 3-ranged tensors with equal sizes and the length and color of arrows is proportional to }.
2954
+ # This is 3D version of the first functions. Here arrays ax, ay, az must be 3-ranged tensors with equal sizes and the length and color of arrows is proportional to \sqrt(ax^2+ay^2+az^2).
2951
2955
  # @overload vect(ax,ay,az,sch="",opt="")
2952
2956
  # @param [MglData] ax
2953
2957
  # @param [MglData] ay
@@ -2970,8 +2974,8 @@ end
2970
2974
 
2971
2975
 
2972
2976
  # Vector fields.
2973
- # The function draws 3D vector field plot for the field (ax, ay, az) depending parametrically on coordinates x, y, z. Vector field is drawn at slice sVal in direction (, , ) if sch contain corresponding symbol (by default, direction is used). The length and color of arrows are proportional to }. The number of arrows depend on meshnum. The appearance of the hachures (arrows) can be changed by symbols:
2974
- # See also vect, flow, dew.
2977
+ # The function draws 3D vector field plot for the field (ax, ay, az) depending parametrically on coordinates x, y, z. Vector field is drawn at slice sVal in direction ('x', 'y', 'z') if sch contain corresponding symbol (by default, 'y' direction is used). The length and color of arrows are proportional to \sqrt(ax^2+ay^2+az^2). The number of arrows depend on meshnum. The appearance of the hachures (arrows) can be changed by symbols:
2978
+ # See also vect, flow, dew. Vect3 sample
2975
2979
  # @overload vect3(ax,ay,az,sch="",sval=-1,opt="")
2976
2980
  # @param [MglData] ax
2977
2981
  # @param [MglData] ay
@@ -2996,7 +3000,7 @@ end
2996
3000
 
2997
3001
 
2998
3002
  # Vector fields.
2999
- # The function draws dew-drops for plane vector field (ax, ay) depending parametrically on coordinates x, y at level z=Min.z. Note that this is very expensive plot in memory usage and creation time! The color of drops is proportional to }. The number of drops depend on meshnum. See also vect.
3003
+ # The function draws dew-drops for plane vector field (ax, ay) depending parametrically on coordinates x, y at level z=Min.z. Note that this is very expensive plot in memory usage and creation time! The color of drops is proportional to \sqrt(ax^2+ay^2). The number of drops depend on meshnum. See also vect. Dew sample
3000
3004
  # @overload dew(ax,ay,sch="",opt="")
3001
3005
  # @param [MglData] ax
3002
3006
  # @param [MglData] ay
@@ -3017,7 +3021,7 @@ end
3017
3021
 
3018
3022
  # Vector fields.
3019
3023
  # The function draws flow threads for the plane vector field (ax, ay) parametrically depending on coordinates x, y at level z = Min.z. Number of threads is proportional to value option (default is 5). String sch may contain:
3020
- # See also pipe, vect, tape, barwidth.
3024
+ # See also pipe, vect, tape, barwidth. Flow sample
3021
3025
  # @overload flow(ax,ay,sch="",opt="")
3022
3026
  # @param [MglData] ax
3023
3027
  # @param [MglData] ay
@@ -3037,7 +3041,7 @@ end
3037
3041
 
3038
3042
 
3039
3043
  # Vector fields.
3040
- # This is 3D version of the first functions. Here arrays ax, ay, az must be 3-ranged tensors with equal sizes and the color of line is proportional to }.
3044
+ # This is 3D version of the first functions. Here arrays ax, ay, az must be 3-ranged tensors with equal sizes and the color of line is proportional to \sqrt(ax^2+ay^2+az^2).
3041
3045
  # @overload flow(ax,ay,az,sch="",opt="")
3042
3046
  # @param [MglData] ax
3043
3047
  # @param [MglData] ay
@@ -3107,7 +3111,7 @@ end
3107
3111
 
3108
3112
 
3109
3113
  # Vector fields.
3110
- # The function draws gradient lines for scalar field phi[i,j] (or phi[i,j,k] in 3d case) specified parametrically (x[i,j,k], y[i,j,k], z[i,j,k]). Number of lines is proportional to value option (default is 5). See also dens, cont, flow.
3114
+ # The function draws gradient lines for scalar field phi(i,j) (or phi(i,j,k) in 3d case) specified parametrically (x(i,j,k), y(i,j,k), z(i,j,k)). Number of lines is proportional to value option (default is 5). See also dens, cont, flow.
3111
3115
  # @overload grad(phi,sch="",opt="")
3112
3116
  # @param [MglData] phi
3113
3117
  # @param [String] sch default=""
@@ -3133,7 +3137,7 @@ end
3133
3137
 
3134
3138
 
3135
3139
  # Vector fields.
3136
- # The function draws flow pipes for the plane vector field (ax, ay) parametrically depending on coordinates x, y at level z = Min.z. Number of pipes is proportional to value option (default is 5). If symbol is specified then pipes start only from edges of axis range. The color of lines is proportional to }. Warm color corresponds to normal flow (like attractor). Cold one corresponds to inverse flow (like source). Parameter r0 set the base pipe radius. If r0<0 or symbol is specified then pipe radius is inverse proportional to amplitude. The vector field is plotted for each z slice of ax, ay. See also flow, vect.
3140
+ # The function draws flow pipes for the plane vector field (ax, ay) parametrically depending on coordinates x, y at level z = Min.z. Number of pipes is proportional to value option (default is 5). If '#' symbol is specified then pipes start only from edges of axis range. The color of lines is proportional to \sqrt(ax^2+ay^2). Warm color corresponds to normal flow (like attractor). Cold one corresponds to inverse flow (like source). Parameter r0 set the base pipe radius. If r0<0 or symbol 'i' is specified then pipe radius is inverse proportional to amplitude. The vector field is plotted for each z slice of ax, ay. See also flow, vect. Pipe sample
3137
3141
  # @overload pipe(ax,ay,sch="",r0=0.05,opt="")
3138
3142
  # @param [MglData] ax
3139
3143
  # @param [MglData] ay
@@ -3155,7 +3159,7 @@ end
3155
3159
 
3156
3160
 
3157
3161
  # Vector fields.
3158
- # This is 3D version of the first functions. Here arrays ax, ay, az must be 3-ranged tensors with equal sizes and the color of line is proportional to }.
3162
+ # This is 3D version of the first functions. Here arrays ax, ay, az must be 3-ranged tensors with equal sizes and the color of line is proportional to \sqrt(ax^2+ay^2+az^2).
3159
3163
  # @overload pipe(ax,ay,az,sch="",r0=0.05,opt="")
3160
3164
  # @param [MglData] ax
3161
3165
  # @param [MglData] ay
@@ -3180,7 +3184,7 @@ end
3180
3184
 
3181
3185
 
3182
3186
  # Other plotting.
3183
- # These plotting functions draw density plot in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContXYZ, ContFXYZ, dens, Data manipulation.
3187
+ # These plotting functions draw density plot in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContXYZ, ContFXYZ, dens, Data manipulation. Dens projection sample
3184
3188
  # @overload dens_x(a,stl="",sval=NAN,opt="")
3185
3189
  # @param [MglData] a
3186
3190
  # @param [String] stl default=""
@@ -3199,12 +3203,12 @@ end
3199
3203
  # @param [Float] sval default=NAN
3200
3204
  # @param [String] opt default=""
3201
3205
  # @return [nil]
3202
- def dens_z
3206
+ def dens_x
3203
3207
  end
3204
3208
 
3205
3209
 
3206
3210
  # Other plotting.
3207
- # These plotting functions draw contour lines in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContFXYZ, DensXYZ, cont, Data manipulation.
3211
+ # These plotting functions draw contour lines in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContFXYZ, DensXYZ, cont, Data manipulation. Cont projection sample
3208
3212
  # @overload cont_x(a,stl="",sval=NAN,opt="")
3209
3213
  # @param [MglData] a
3210
3214
  # @param [String] stl default=""
@@ -3223,7 +3227,7 @@ end
3223
3227
  # @param [Float] sval default=NAN
3224
3228
  # @param [String] opt default=""
3225
3229
  # @return [nil]
3226
- def cont_z
3230
+ def cont_x
3227
3231
  end
3228
3232
 
3229
3233
 
@@ -3250,12 +3254,12 @@ end
3250
3254
  # @param [Float] sval default=NAN
3251
3255
  # @param [String] opt default=""
3252
3256
  # @return [nil]
3253
- def cont_z
3257
+ def cont_x
3254
3258
  end
3255
3259
 
3256
3260
 
3257
3261
  # Other plotting.
3258
- # These plotting functions draw solid contours in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContFXYZ, DensXYZ, cont, Data manipulation.
3262
+ # These plotting functions draw solid contours in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContFXYZ, DensXYZ, cont, Data manipulation. ContF projection sample
3259
3263
  # @overload cont_fx(a,stl="",sval=NAN,opt="")
3260
3264
  # @param [MglData] a
3261
3265
  # @param [String] stl default=""
@@ -3274,7 +3278,7 @@ end
3274
3278
  # @param [Float] sval default=NAN
3275
3279
  # @param [String] opt default=""
3276
3280
  # @return [nil]
3277
- def cont_fz
3281
+ def cont_fx
3278
3282
  end
3279
3283
 
3280
3284
 
@@ -3301,12 +3305,12 @@ end
3301
3305
  # @param [Float] sval default=NAN
3302
3306
  # @param [String] opt default=""
3303
3307
  # @return [nil]
3304
- def cont_fz
3308
+ def cont_fx
3305
3309
  end
3306
3310
 
3307
3311
 
3308
3312
  # Other plotting.
3309
- # Draws command function at plane z=Min.z where variable is changed in xrange. You do not need to create the data arrays to plot it. See also plot.
3313
+ # Draws command function 'y(x)' at plane z=Min.z where 'x' variable is changed in xrange. You do not need to create the data arrays to plot it. See also plot.
3310
3314
  # @overload fplot(eqy,pen="",opt="")
3311
3315
  # @param [String] eqy
3312
3316
  # @param [String] pen default=""
@@ -3317,7 +3321,7 @@ end
3317
3321
 
3318
3322
 
3319
3323
  # Other plotting.
3320
- # Draws command parametrical curve (, , ) where variable is changed in range [0, 1]. You do not need to create the data arrays to plot it. See also plot.
3324
+ # Draws command parametrical curve ('x(t)', 'y(t)', 'z(t)') where 't' variable is changed in range (0, 1). You do not need to create the data arrays to plot it. See also plot.
3321
3325
  # @overload fplot(eqx,eqy,eqz,pen,opt="")
3322
3326
  # @param [String] eqx
3323
3327
  # @param [String] eqy
@@ -3330,7 +3334,7 @@ end
3330
3334
 
3331
3335
 
3332
3336
  # Other plotting.
3333
- # Draws command surface for function where , variable are changed in xrange, yrange. You do not need to create the data arrays to plot it. See also surf.
3337
+ # Draws command surface for function 'z(x,y)' where 'x', 'y' variable are changed in xrange, yrange. You do not need to create the data arrays to plot it. See also surf.
3334
3338
  # @overload fsurf(eqz,sch="",opt="")
3335
3339
  # @param [String] eqz
3336
3340
  # @param [String] sch default=""
@@ -3341,7 +3345,7 @@ end
3341
3345
 
3342
3346
 
3343
3347
  # Other plotting.
3344
- # Draws command parametrical surface (, , ) where , variable are changed in range [0, 1]. You do not need to create the data arrays to plot it. See also surf.
3348
+ # Draws command parametrical surface ('x(u,v)', 'y(u,v)', 'z(u,v)') where 'u', 'v' variable are changed in range (0, 1). You do not need to create the data arrays to plot it. See also surf.
3345
3349
  # @overload fsurf(eqx,eqy,eqz,sch="",opt="")
3346
3350
  # @param [String] eqx
3347
3351
  # @param [String] eqy
@@ -3354,7 +3358,7 @@ end
3354
3358
 
3355
3359
 
3356
3360
  # Other plotting.
3357
- # The function draws the surface of triangles. Triangle vertexes are set by indexes id of data points (x[i], y[i], z[i]). String sch sets the color scheme. If string contain then wire plot is produced. First dimensions of id must be 3 or greater. Arrays x, y, z must have equal sizes. Parameter c set the colors of triangles (if id.ny=c.nx) or colors of vertexes (if x.nx=c.nx). See also dots, crust, quadplot, triangulation.
3361
+ # The function draws the surface of triangles. Triangle vertexes are set by indexes id of data points (x(i), y(i), z(i)). String sch sets the color scheme. If string contain '#' then wire plot is produced. First dimensions of id must be 3 or greater. Arrays x, y, z must have equal sizes. Parameter c set the colors of triangles (if id.ny=c.nx) or colors of vertexes (if x.nx=c.nx). See also dots, crust, quadplot, triangulation. TriPlot and QuadPlot
3358
3362
  # @overload tri_plot(id,x,y,sch="",opt="")
3359
3363
  # @param [MglData] id
3360
3364
  # @param [MglData] x
@@ -3384,7 +3388,7 @@ end
3384
3388
 
3385
3389
 
3386
3390
  # Other plotting.
3387
- # The function draws contour lines for surface of triangles at z=v[k] (or at z = Min.z if sch contain symbol ). Triangle vertexes are set by indexes id of data points (x[i], y[i], z[i]). Contours are plotted for z[i,j]=v[k] where v[k] are values of data array v. String sch sets the color scheme. Array c (if specified) is used for contour coloring. First dimensions of id must be 3 or greater. Arrays x, y, z must have equal sizes. Parameter c set the colors of triangles (if id.ny=c.nx) or colors of vertexes (if x.nx=c.nx). See also triplot, cont, triangulation.
3391
+ # The function draws contour lines for surface of triangles at z=v(k) (or at z = Min.z if sch contain symbol '_'). Triangle vertexes are set by indexes id of data points (x(i), y(i), z(i)). Contours are plotted for z(i,j)=v(k) where v(k) are values of data array v. String sch sets the color scheme. Array c (if specified) is used for contour coloring. First dimensions of id must be 3 or greater. Arrays x, y, z must have equal sizes. Parameter c set the colors of triangles (if id.ny=c.nx) or colors of vertexes (if x.nx=c.nx). See also triplot, cont, triangulation.
3388
3392
  # @overload tri_cont(id,x,y,z,c,sch="",opt="")
3389
3393
  # @param [MglData] id
3390
3394
  # @param [MglData] x
@@ -3421,12 +3425,12 @@ end
3421
3425
  # @param [String] sch default=""
3422
3426
  # @param [String] opt default=""
3423
3427
  # @return [nil]
3424
- def tri_cont_v
3428
+ def tri_cont
3425
3429
  end
3426
3430
 
3427
3431
 
3428
3432
  # Other plotting.
3429
- # The function draws the surface of quadrangles. Quadrangles vertexes are set by indexes id of data points (x[i], y[i], z[i]). String sch sets the color scheme. If string contain then wire plot is produced. First dimensions of id must be 4 or greater. Arrays x, y, z must have equal sizes. Parameter c set the colors of quadrangles (if id.ny=c.nx) or colors of vertexes (if x.nx=c.nx). See also triplot.
3433
+ # The function draws the surface of quadrangles. Quadrangles vertexes are set by indexes id of data points (x(i), y(i), z(i)). String sch sets the color scheme. If string contain '#' then wire plot is produced. First dimensions of id must be 4 or greater. Arrays x, y, z must have equal sizes. Parameter c set the colors of quadrangles (if id.ny=c.nx) or colors of vertexes (if x.nx=c.nx). See also triplot. TriPlot and QuadPlot
3430
3434
  # @overload quad_plot(id,x,y,sch="",opt="")
3431
3435
  # @param [MglData] id
3432
3436
  # @param [MglData] x
@@ -3456,7 +3460,7 @@ end
3456
3460
 
3457
3461
 
3458
3462
  # Other plotting.
3459
- # The function draws the arbitrary placed points (x[i], y[i], z[i]). String sch sets the color scheme. If array a is specified then it define colors of dots. Arrays x, y, z, a must have equal sizes. See also crust, mark, plot.
3463
+ # The function draws the arbitrary placed points (x(i), y(i), z(i)). String sch sets the color scheme. If array a is specified then it define colors of dots. Arrays x, y, z, a must have equal sizes. See also crust, mark, plot. Dots sample
3460
3464
  # @overload dots(x,y,z,sch="",opt="")
3461
3465
  # @param [MglData] x
3462
3466
  # @param [MglData] y
@@ -3477,7 +3481,7 @@ end
3477
3481
 
3478
3482
 
3479
3483
  # Other plotting.
3480
- # The function reconstruct and draws the surface for arbitrary placed points (x[i], y[i], z[i]). String sch sets the color scheme. If string contain then wire plot is produced. Arrays x, y, z must have equal sizes. See also dots, triplot. @c
3484
+ # The function reconstruct and draws the surface for arbitrary placed points (x(i), y(i), z(i)). String sch sets the color scheme. If string contain '#' then wire plot is produced. Arrays x, y, z must have equal sizes. See also dots, triplot. @c Crust sample
3481
3485
  # @overload crust(x,y,z,sch="",opt="")
3482
3486
  # @param [MglData] x
3483
3487
  # @param [MglData] y
@@ -3490,7 +3494,7 @@ end
3490
3494
 
3491
3495
 
3492
3496
  # Nonlinear fitting.
3493
- # Fit data along x-, y- and z-directions for array specified parametrically a[i,j,k](x[i,j,k], y[i,j,k], z[i,j,k]) with weight factor s[i,j,k].
3497
+ # Fit data along x-, y- and z-directions for array specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)) with weight factor s(i,j,k).
3494
3498
  # @overload fit_s(a,s,func,var,opt="")
3495
3499
  # @param [MglData] a
3496
3500
  # @param [MglData] s
@@ -3568,7 +3572,7 @@ end
3568
3572
 
3569
3573
 
3570
3574
  # Nonlinear fitting.
3571
- # Fit data along x-, y- and z-directions for array specified parametrically a[i,j,k](x[i,j,k], y[i,j,k], z[i,j,k]) with weight factor 1.
3575
+ # Fit data along x-, y- and z-directions for array specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)) with weight factor 1.
3572
3576
  # @overload fit(a,func,var,opt="")
3573
3577
  # @param [MglData] a
3574
3578
  # @param [String] func
@@ -3638,7 +3642,7 @@ end
3638
3642
 
3639
3643
 
3640
3644
  # Nonlinear fitting.
3641
- # Fit data along all directions for 2d or 3d arrays a with s=1 and x, y, z equidistantly distributed in interval [Min, Max].
3645
+ # Fit data along all directions for 2d or 3d arrays a with s=1 and x, y, z equidistantly distributed in interval (Min, Max).
3642
3646
  # @overload fit2(a,func,var,opt="")
3643
3647
  # @param [MglData] a
3644
3648
  # @param [String] func
@@ -3668,7 +3672,7 @@ end
3668
3672
  # @param [MglData] ini
3669
3673
  # @param [String] opt default=""
3670
3674
  # @return [MglData]
3671
- def fit3
3675
+ def fit2
3672
3676
  end
3673
3677
 
3674
3678
 
@@ -3717,7 +3721,7 @@ end
3717
3721
 
3718
3722
 
3719
3723
  # Data manipulation.
3720
- # Fills the value of array according to the formula in string eq. Formula is an arbitrary expression depending on variables , , , , , . Coordinates , , are supposed to be normalized in axis range. Variable is the original value of the array. Variables and are values of arrays v, w which can be NULL (i.e. can be omitted).
3724
+ # Fills the value of array 'u' according to the formula in string eq. Formula is an arbitrary expression depending on variables 'x', 'y', 'z', 'u', 'v', 'w'. Coordinates 'x', 'y', 'z' are supposed to be normalized in axis range. Variable 'u' is the original value of the array. Variables 'v' and 'w' are values of arrays v, w which can be NULL (i.e. can be omitted).
3721
3725
  # @overload fill(u,eq,opt="")
3722
3726
  # @param [MglData] u
3723
3727
  # @param [String] eq
@@ -3741,7 +3745,7 @@ end
3741
3745
 
3742
3746
 
3743
3747
  # Data manipulation.
3744
- # Fills the value of array according to the linear interpolation of triangulated surface, found for arbitrary placed points , , . Interpolation is done at points equidistantly distributed in axis range. NAN value is used for grid points placed outside of triangulated surface.
3748
+ # Fills the value of array 'u' according to the linear interpolation of triangulated surface, found for arbitrary placed points 'x', 'y', 'z'. Interpolation is done at points equidistantly distributed in axis range. NAN value is used for grid points placed outside of triangulated surface.
3745
3749
  # @overload data_grid(u,x,y,z,opt="")
3746
3750
  # @param [MglData] u
3747
3751
  # @param [MglData] x
@@ -3754,7 +3758,7 @@ end
3754
3758
 
3755
3759
 
3756
3760
  # Data manipulation.
3757
- # Solves equation du/dz = i*k0*ham(p,q,x,y,z,|u|)[u], where p=-i/k0*d/dx, q=-i/k0*d/dy are pseudo-differential operators. Parameters ini_re, ini_im specify real and imaginary part of initial field distribution. Coordinates , , are supposed to be normalized in axis range. Note, that really this ranges are increased by factor 3/2 for purpose of reducing reflection from boundaries. Parameter dz set the step along evolutionary coordinate z. At this moment, simplified form of function ham is supported -- all ``mixed'' terms (like ->x*d/dx) are excluded. For example, in 2D case this function is effectively . However commutable combinations (like ->x*d/dy) are allowed. Here variable is used for field amplitude |u|. This allow one solve nonlinear problems -- for example, for nonlinear Shrodinger equation you may set ham="p^2 + q^2 - u^2". You may specify imaginary part for wave absorption, like ham = "p^2 + i*x*(x>0)", but only if dependence on variable is linear (i.e. ).
3761
+ # Solves equation du/dz = i*k0*ham(p,q,x,y,z,|u|)(u), where p=-i/k0*d/dx, q=-i/k0*d/dy are pseudo-differential operators. Parameters ini_re, ini_im specify real and imaginary part of initial field distribution. Coordinates 'x', 'y', 'z' are supposed to be normalized in axis range. Note, that really this ranges are increased by factor 3/2 for purpose of reducing reflection from boundaries. Parameter dz set the step along evolutionary coordinate z. At this moment, simplified form of function ham is supported -- all ``mixed'' terms (like 'x*p'->x*d/dx) are excluded. For example, in 2D case this function is effectively ham = f(p,z) + g(x,z,u). However commutable combinations (like 'x*q'->x*d/dy) are allowed. Here variable 'u' is used for field amplitude |u|. This allow one solve nonlinear problems -- for example, for nonlinear Shrodinger equation you may set ham="p^2 + q^2 - u^2". You may specify imaginary part for wave absorption, like ham = "p^2 + i*x*(x>0)", but only if dependence on variable 'i' is linear (i.e. ham = hre+i*him). PDE solving hints
3758
3762
  # @overload pde(ham,ini_re,ini_im,dz=0.1,k0=100,opt="")
3759
3763
  # @param [String] ham
3760
3764
  # @param [MglData] ini_re