mathgl 0.0.4 → 0.0.5

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: 7714f6721576320ab6f0679a7d02ebb9f96e1903
4
- data.tar.gz: d27bf666273a517984dceec4512226f5ecd59cb4
3
+ metadata.gz: 06c2518dd4b16e32817d24c3054fa990a7e28d24
4
+ data.tar.gz: cab0f32cbff4470f915dbd23641e0e534c170d5a
5
5
  SHA512:
6
- metadata.gz: 1221ea78f95d9102142ffcdb0c613846db734e7a90c5dae111f03478361403d6c5f0cf9953a77a9fc2a8a3658f5cc1d2fdf80665df5d0bb004e1a38eb5c35e80
7
- data.tar.gz: 9e80891e54b29b00ad64e4dd6abfe79d2fa472abc60bc71d0e330ad8702abca3aca28c5328d2468a616dc96d48485b17419c5b6ceb0b6cdd00d24a5afbe62399
6
+ metadata.gz: 00e0c8554df34bdff058186560d5494494aea69ef4639e9f9c5c3e1ec6b5dadd1ae365f80c79ee27e31a36b9ad7d7f2e0764d1e97d50391d45cd17195e7c68fb
7
+ data.tar.gz: 0ca0a37b016680e584f0f40a92f2ec630c346cbc4b6a7ad0904acff6528d2f5e2e61a88c4d7df991f5a0e885cf3d2d53b0e72fde3759785de2f556066e6eebea
data/README.md CHANGED
@@ -1,10 +1,15 @@
1
1
  # Ruby/MathGL
2
2
 
3
- Ruby wrapper of [MathGL - library for scientific data visualization](http://mathgl.sourceforge.net/) made using SWIG.
3
+ Ruby wrapper of [MathGL](http://mathgl.sourceforge.net/), made using SWIG.
4
+
5
+ MathGL is a library for scientific data visualization developed by Alexey Balakin.
4
6
 
5
7
  (This package is under construction.)
6
8
 
7
- - [Ruby/MathGL Sample Plots](https://github.com/masa16/ruby-mathgl-sample)
9
+ - [Plot Samples](https://github.com/masa16/ruby-mathgl-sample)
10
+ - [API Document](http://masa16.github.io/ruby-mathgl/doc/frames.html)
11
+ - [GitHub](https://github.com/masa16/ruby-mathgl)
12
+ - [RubyGems](https://rubygems.org/gems/mathgl)
8
13
 
9
14
  ## Installation
10
15
 
@@ -12,13 +17,13 @@ Ruby wrapper of [MathGL - library for scientific data visualization](http://math
12
17
 
13
18
  2. Install Ruby/MathGL from source:
14
19
 
15
- $ ruby setup.rb config -- --with-mathgl-dir=/usr/local
16
- $ ruby setup.rb setup
17
- $ ruby setup.rb install
20
+ ruby setup.rb config -- --with-mathgl-dir=/usr/local
21
+ ruby setup.rb setup
22
+ ruby setup.rb install
18
23
 
19
- Or install with gem:
24
+ Or install with gem:
20
25
 
21
- $ gem install mathgl -- --with-mathgl-dir=/usr/local
26
+ gem install mathgl -- --with-mathgl-dir=/usr/local
22
27
 
23
28
  ## Usage
24
29
 
@@ -1,3 +1,3 @@
1
- module Mathgl
2
- VERSION = "0.0.4"
1
+ module MathGL
2
+ VERSION = "0.0.5"
3
3
  end
@@ -5,7 +5,7 @@ require 'mathgl/version'
5
5
 
6
6
  Gem::Specification.new do |spec|
7
7
  spec.name = "mathgl"
8
- spec.version = Mathgl::VERSION
8
+ spec.version = MathGL::VERSION
9
9
  spec.authors = ["Masahiro TANAKA"]
10
10
  spec.email = ["masa16.tanaka@gmail.com"]
11
11
  spec.description = %q{Ruby wrapper for MathGL - library for scientific data visualization}
@@ -0,0 +1,10 @@
1
+ require 'rake/clean'
2
+
3
+ task :mkdoc do
4
+ sh "ruby conv_texi.rb"
5
+ sh "yard -r ../README.md --title 'Ruby/MathGL document'"
6
+ end
7
+
8
+ task :default => :mkdoc
9
+
10
+ CLEAN.include %w[doc .yardoc]
@@ -93,6 +93,7 @@ class MethodType
93
93
  @docs.each do |s|
94
94
  d << s
95
95
  end
96
+ d << "#"
96
97
  d << "# @overload #{name}(#{vars.join(',')})"
97
98
  @args.each do |a|
98
99
  d << "# @param [#{a.type}] #{a.name} #{a.default_s}"
@@ -130,9 +131,13 @@ class MethodType
130
131
 
131
132
  def decomp_parms(parms)
132
133
  parms.split(/,/).each_with_index do |x,i|
134
+ x.strip!
133
135
  if /(\S.*[\s*&])(\w+)(=([^=]+))?/ =~ x
134
136
  @args[i] = Args.new($1,$2,$4)
137
+ elsif x=="num"
138
+ @args[i] = Args.new("Numeric",x)
135
139
  else
140
+ puts "unknown params: "+x+" in "+parms
136
141
  @args[i] = Args.new("unknown","error")
137
142
  end
138
143
  end
@@ -152,12 +157,13 @@ class MethodType
152
157
  end
153
158
 
154
159
  def valid
155
- re_ignore = /\b(HMGL|HCDT|HMPR|HMDT|HADT)\b/
160
+ re_ignore = /\b(HMGL|HCDT|HMPR|HMDT|HADT|dual)\b/
156
161
  @name !~ /=$/ and
157
162
  @name !~ /^mgl_/ and
158
163
  @name != "!" and
159
164
  @name != "unknown_method" and
160
165
  @clss =~ /^mgl/i and
166
+ @clss !~ /^mgldatac/i and
161
167
  @return_type !~ re_ignore and
162
168
  @args.all?{|a| re_ignore !~ a.type}
163
169
  end
@@ -198,7 +204,11 @@ class TexiParse
198
204
  def write(io)
199
205
  @docs.each do |clss,docs|
200
206
  if clss
201
- io.print "\n# #{clss} class\nclass #{clss}\n\n"
207
+ if clss == "MglVar"
208
+ io.print "\n# #{clss} class\nclass #{clss} < MglData\n\n"
209
+ else
210
+ io.print "\n# #{clss} class\nclass #{clss}\n\n"
211
+ end
202
212
  docs.each do |x|
203
213
  io.print x+"\n\n"
204
214
  end
@@ -248,12 +258,15 @@ class TexiParse
248
258
  end
249
259
 
250
260
  def parse_inline(a)
251
- a = a.gsub(/@(\w+)\{([^}]*)\}/){|x| parse_tag($1,$2)}
261
+ a.gsub(/@(\w+)\{([^}]*)\}/){|x| parse_tag($1,$2)}
262
+ end
263
+
264
+ def escape(a)
252
265
  #a.gsub!(/@\{/,"&#123;")
253
266
  #a.gsub!(/@\}/,"&#125;")
254
267
  #a.gsub!(/\[/,'&#91;')
255
268
  #a.gsub!(/\]/,'&#93;')
256
- a.gsub!(/@\{/,'(')
269
+ a = a.gsub(/@\{/,'(')
257
270
  a.gsub!(/@\}/,')')
258
271
  a.gsub!(/\[/,'(')
259
272
  a.gsub!(/\]/,')')
@@ -270,7 +283,7 @@ class TexiParse
270
283
  line = parse_inline(a)
271
284
  end
272
285
  if line
273
- @block_nest.last.push(line)
286
+ @block_nest.last.push(escape(line))
274
287
  end
275
288
  end
276
289
 
@@ -322,14 +335,18 @@ class TexiParse
322
335
  end
323
336
  end
324
337
  h.each do |clss,a|
325
- d = s.dup
326
- a.each do |m|
327
- d << m.mkdoc
338
+ mn = {}
339
+ a.each{|m| mn[m.name]=true}
340
+ mn.keys.each do |name|
341
+ d = s.dup
342
+ a.each do |m|
343
+ if m.name==name
344
+ d << m.mkdoc
345
+ end
346
+ end
347
+ d << "def #{name}\nend\n"
348
+ (@docs[clss] ||= []) << d
328
349
  end
329
- d << a[0].ruby_def
330
- b = @docs[clss]
331
- @docs[clss] = b = [] unless b
332
- b << d
333
350
  end
334
351
  nil
335
352
  end
@@ -405,7 +422,7 @@ class TexiParse
405
422
  end
406
423
 
407
424
  srcdir = ENV["HOME"]+"/2013/src/mathgl-2.1.3.1/texinfo/"
408
- dstdir = ENV["HOME"]+"/2013/git/ruby-mathgl/lib/mathgl/"
425
+ dstdir = "lib/mathgl/"
409
426
 
410
427
  %w[core data other parse].each do |b|
411
428
  rf = srcdir+b+'_en.texi'
@@ -418,8 +435,12 @@ dstdir = ENV["HOME"]+"/2013/git/ruby-mathgl/lib/mathgl/"
418
435
  tp.parse(src)
419
436
  if !tp.empty?
420
437
  open(wf,"w"){|io|
421
- io.puts "# This document is converted from #{File.basename(rf)}."
438
+ io.puts "# This document is converted from #{File.basename(rf)}."
439
+ io.puts ""
440
+ io.puts "# module MathGL"
441
+ io.puts "module MathGL"
422
442
  tp.write(io)
443
+ io.puts "end"
423
444
  }
424
445
  end
425
446
  end
@@ -1,15 +1,20 @@
1
1
  # This document is converted from core_en.texi.
2
2
 
3
+ # module MathGL
4
+ module MathGL
5
+
3
6
  # MglGraph class
4
7
  class MglGraph
5
8
 
6
9
  # Create and delete objects.
7
10
  # 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.
11
+ #
8
12
  # @overload initialize(kind=0,width=600,height=400)
9
13
  # @param [Integer] kind default=0
10
14
  # @param [Integer] width default=600
11
15
  # @param [Integer] height default=400
12
16
  # @return [MglGraph]
17
+ #
13
18
  # @overload initialize(gr)
14
19
  # @param [MglGraph] gr
15
20
  # @return [MglGraph]
@@ -19,6 +24,7 @@ end
19
24
 
20
25
  # Graphics setup.
21
26
  # Restore initial values for all of parameters.
27
+ #
22
28
  # @overload default_plot_param()
23
29
  # @return [nil]
24
30
  def default_plot_param
@@ -27,6 +33,7 @@ end
27
33
 
28
34
  # Transparency.
29
35
  # Sets the transparency on/off and returns previous value of transparency. It is recommended to call this function before any plotting command. Default value is transparency off.
36
+ #
30
37
  # @overload alpha(enable)
31
38
  # @param [bool] enable
32
39
  # @return [nil]
@@ -36,6 +43,7 @@ end
36
43
 
37
44
  # Transparency.
38
45
  # Sets default value of alpha channel (transparency) for all plotting functions. Initial value is 0.5.
46
+ #
39
47
  # @overload set_alpha_def(val)
40
48
  # @param [Float] val
41
49
  # @return [nil]
@@ -46,6 +54,7 @@ end
46
54
  # Transparency.
47
55
  # Set the type of transparency. Possible values are:
48
56
  # Types of transparency.
57
+ #
49
58
  # @overload set_transp_type(type)
50
59
  # @param [Integer] type
51
60
  # @return [nil]
@@ -55,6 +64,7 @@ end
55
64
 
56
65
  # Lighting.
57
66
  # Sets the using of light on/off for overall plot. Function returns previous value of lighting. Default value is lightning off.
67
+ #
58
68
  # @overload light(enable)
59
69
  # @param [bool] enable
60
70
  # @return [bool]
@@ -64,6 +74,7 @@ end
64
74
 
65
75
  # Lighting.
66
76
  # Switch on/off n-th light source separately.
77
+ #
67
78
  # @overload light(n,enable)
68
79
  # @param [Integer] n
69
80
  # @param [bool] enable
@@ -74,6 +85,7 @@ end
74
85
 
75
86
  # Lighting.
76
87
  # 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.
88
+ #
77
89
  # @overload add_light(n,d,c='w',bright=0.5,ap=0)
78
90
  # @param [Integer] n
79
91
  # @param [MglPoint] d
@@ -81,6 +93,7 @@ end
81
93
  # @param [Float] bright default=0.5
82
94
  # @param [Float] ap default=0
83
95
  # @return [nil]
96
+ #
84
97
  # @overload add_light(n,r,d,c='w',bright=0.5,ap=0)
85
98
  # @param [Integer] n
86
99
  # @param [MglPoint] r
@@ -95,6 +108,7 @@ end
95
108
 
96
109
  # Lighting.
97
110
  # Set on/off to use diffusive light (only for local light sources).
111
+ #
98
112
  # @overload set_dif_light(enable)
99
113
  # @param [bool] enable
100
114
  # @return [nil]
@@ -104,6 +118,7 @@ end
104
118
 
105
119
  # Lighting.
106
120
  # Sets the brightness of ambient light. The value should be in range (0,1).
121
+ #
107
122
  # @overload set_ambient(bright=0.5)
108
123
  # @param [Float] bright default=0.5
109
124
  # @return [nil]
@@ -113,6 +128,7 @@ end
113
128
 
114
129
  # Fog.
115
130
  # 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
131
+ #
116
132
  # @overload fog(d,dz=0.25)
117
133
  # @param [Float] d
118
134
  # @param [Float] dz default=0.25
@@ -123,6 +139,7 @@ end
123
139
 
124
140
  # Default sizes.
125
141
  # Sets relative width of rectangles in bars, barh, boxplot, candle. Default value is 0.7.
142
+ #
126
143
  # @overload set_bar_width(val)
127
144
  # @param [Float] val
128
145
  # @return [nil]
@@ -132,6 +149,7 @@ end
132
149
 
133
150
  # Default sizes.
134
151
  # Sets size of marks for 1D plotting. Default value is 1.
152
+ #
135
153
  # @overload set_mark_size(val)
136
154
  # @param [Float] val
137
155
  # @return [nil]
@@ -141,6 +159,7 @@ end
141
159
 
142
160
  # Default sizes.
143
161
  # Sets size of arrows for 1D plotting, lines and curves (see Primitives). Default value is 1.
162
+ #
144
163
  # @overload set_arrow_size(val)
145
164
  # @param [Float] val
146
165
  # @return [nil]
@@ -150,6 +169,7 @@ end
150
169
 
151
170
  # Default sizes.
152
171
  # Sets approximate number of lines in mesh, fall, grid and also the number of hachures in vect, dew and the number of cells in cloud. By default (=0) it draws all lines/hachures/cells.
172
+ #
153
173
  # @overload set_mesh_num(val)
154
174
  # @param [Integer] val
155
175
  # @return [nil]
@@ -159,6 +179,7 @@ end
159
179
 
160
180
  # Default sizes.
161
181
  # Sets approximate number of visible faces. Can be used for speeding up drawing by cost of lower quality. By default (=0) it draws all of them.
182
+ #
162
183
  # @overload set_face_num(val)
163
184
  # @param [Integer] val
164
185
  # @return [nil]
@@ -168,6 +189,7 @@ end
168
189
 
169
190
  # Default sizes.
170
191
  # Sets default name id as filename for saving (in FLTK window for example).
192
+ #
171
193
  # @overload set_plot_id(id)
172
194
  # @param [String] id
173
195
  # @return [nil]
@@ -177,6 +199,7 @@ end
177
199
 
178
200
  # Default sizes.
179
201
  # Gets default name id as filename for saving (in FLTK window for example).
202
+ #
180
203
  # @overload get_plot_id()
181
204
  # @return [String]
182
205
  def get_plot_id
@@ -185,6 +208,7 @@ end
185
208
 
186
209
  # Cutting.
187
210
  # Flag which determines how points outside bounding box are drawn. If it is true then points are excluded from plot (it is default) otherwise the points are projected to edges of bounding box.
211
+ #
188
212
  # @overload set_cut(val)
189
213
  # @param [bool] val
190
214
  # @return [nil]
@@ -194,6 +218,7 @@ end
194
218
 
195
219
  # Cutting.
196
220
  # Lower and upper edge of the box in which never points are drawn. If both edges are the same (the variables are equal) then the cutting box is empty.
221
+ #
197
222
  # @overload set_cut_box(p1,p1)
198
223
  # @param [MglPoint] p1
199
224
  # @param [MglPoint] p1
@@ -204,6 +229,7 @@ end
204
229
 
205
230
  # Cutting.
206
231
  # Sets the cutting off condition by formula cond. This condition determine will point be plotted or not. If value of formula is nonzero then point is omitted, otherwise it plotted. Set argument as "" to disable cutting off condition.
232
+ #
207
233
  # @overload cut_off(cond)
208
234
  # @param [String] cond
209
235
  # @return [nil]
@@ -213,6 +239,7 @@ end
213
239
 
214
240
  # Font settings.
215
241
  # Sets to use or not text rotation.
242
+ #
216
243
  # @overload set_rotated_text(val)
217
244
  # @param [bool] val
218
245
  # @return [nil]
@@ -222,6 +249,7 @@ end
222
249
 
223
250
  # Font settings.
224
251
  # Load font typeface from path/name. Empty name will load default font.
252
+ #
225
253
  # @overload load_font(name,path="")
226
254
  # @param [String] name
227
255
  # @param [String] path default=""
@@ -232,6 +260,7 @@ end
232
260
 
233
261
  # Font settings.
234
262
  # Sets the font specification (see Text printing). Default is 'rC' -- Roman font centering.
263
+ #
235
264
  # @overload set_font_def(fnt)
236
265
  # @param [String] fnt
237
266
  # @return [nil]
@@ -241,6 +270,7 @@ end
241
270
 
242
271
  # Font settings.
243
272
  # Sets the size of font for tick and axis labels. Default font size of axis labels is 1.4 times large than for tick labels.
273
+ #
244
274
  # @overload set_font_size(val)
245
275
  # @param [Float] val
246
276
  # @return [nil]
@@ -250,6 +280,7 @@ end
250
280
 
251
281
  # Font settings.
252
282
  # Set FontSize by size in pt and picture DPI (default is 16 pt for dpi=72).
283
+ #
253
284
  # @overload set_font_size_pt(cm,dpi=72)
254
285
  # @param [Float] cm
255
286
  # @param [Integer] dpi default=72
@@ -260,6 +291,7 @@ end
260
291
 
261
292
  # Font settings.
262
293
  # Set FontSize by size in centimeters and picture DPI (default is 0.56 cm = 16 pt).
294
+ #
263
295
  # @overload set_font_size_cm(cm,dpi=72)
264
296
  # @param [Float] cm
265
297
  # @param [Integer] dpi default=72
@@ -270,6 +302,7 @@ end
270
302
 
271
303
  # Font settings.
272
304
  # Set FontSize by size in inch and picture DPI (default is 0.22 in = 16 pt).
305
+ #
273
306
  # @overload set_font_size_in(cm,dpi=72)
274
307
  # @param [Float] cm
275
308
  # @param [Integer] dpi default=72
@@ -280,6 +313,7 @@ end
280
313
 
281
314
  # Font settings.
282
315
  # Load font typeface from path/name.
316
+ #
283
317
  # @overload load_font(name,path="")
284
318
  # @param [String] name
285
319
  # @param [String] path default=""
@@ -290,6 +324,7 @@ end
290
324
 
291
325
  # Font settings.
292
326
  # Copy font data from another mglGraph object.
327
+ #
293
328
  # @overload copy_font(from)
294
329
  # @param [MglGraph] from
295
330
  # @return [nil]
@@ -299,6 +334,7 @@ end
299
334
 
300
335
  # Font settings.
301
336
  # Restore font data to default typeface.
337
+ #
302
338
  # @overload restore_font()
303
339
  # @return [nil]
304
340
  def restore_font
@@ -307,6 +343,7 @@ end
307
343
 
308
344
  # Palette and colors.
309
345
  # 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).
346
+ #
310
347
  # @overload set_palette(colors)
311
348
  # @param [String] colors
312
349
  # @return [nil]
@@ -316,6 +353,7 @@ end
316
353
 
317
354
  # Palette and colors.
318
355
  # Sets the sch as default color scheme. Default value is "BbcyrR".
356
+ #
319
357
  # @overload set_def_scheme(sch)
320
358
  # @param [String] sch
321
359
  # @return [nil]
@@ -325,6 +363,7 @@ end
325
363
 
326
364
  # Error handling.
327
365
  # Set warning code. Normally you should call this function only for clearing the warning state, i.e. call SetWarn(0);. Text info will be printed as is if code<0.
366
+ #
328
367
  # @overload set_warn(code,info="")
329
368
  # @param [Integer] code
330
369
  # @param [String] info default=""
@@ -335,6 +374,7 @@ end
335
374
 
336
375
  # Error handling.
337
376
  # Return messages about matters why some plot are not drawn. If returned string is empty then there are no messages.
377
+ #
338
378
  # @overload message()
339
379
  # @return [String]
340
380
  def message
@@ -343,6 +383,7 @@ end
343
383
 
344
384
  # Error handling.
345
385
  # Return the numerical ID of warning about the not drawn plot. Possible values are:
386
+ #
346
387
  # @overload get_warn_code()
347
388
  # @return [Integer]
348
389
  def get_warn_code
@@ -351,6 +392,7 @@ end
351
392
 
352
393
  # Ranges (bounding box).
353
394
  # Sets the range for 'x'-,'y'-,'z'- coordinate or coloring ('c'). See also ranges.
395
+ #
354
396
  # @overload set_range(dir,v1,v2)
355
397
  # @param [String] dir
356
398
  # @param [Float] v1
@@ -362,6 +404,7 @@ end
362
404
 
363
405
  # Ranges (bounding box).
364
406
  # 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).
407
+ #
365
408
  # @overload set_range(dir,dat,add=false)
366
409
  # @param [String] dir
367
410
  # @param [MglData] dat
@@ -373,10 +416,12 @@ end
373
416
 
374
417
  # Ranges (bounding box).
375
418
  # 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).
419
+ #
376
420
  # @overload set_ranges(p1,p2)
377
421
  # @param [MglPoint] p1
378
422
  # @param [MglPoint] p2
379
423
  # @return [nil]
424
+ #
380
425
  # @overload set_ranges(x1,x2,y1,y2,z1=0,z2=0)
381
426
  # @param [Float] x1
382
427
  # @param [Float] x2
@@ -391,15 +436,18 @@ end
391
436
 
392
437
  # Ranges (bounding box).
393
438
  # Sets the ranges of 'x'-,'y'-,'z'-coordinates and coloring as minimal and maximal values of data xx, yy, zz, cc correspondingly.
439
+ #
394
440
  # @overload set_ranges(xx,yy)
395
441
  # @param [MglData] xx
396
442
  # @param [MglData] yy
397
443
  # @return [nil]
444
+ #
398
445
  # @overload set_ranges(xx,yy,zz)
399
446
  # @param [MglData] xx
400
447
  # @param [MglData] yy
401
448
  # @param [MglData] zz
402
449
  # @return [nil]
450
+ #
403
451
  # @overload set_ranges(xx,yy,zz,cc)
404
452
  # @param [MglData] xx
405
453
  # @param [MglData] yy
@@ -412,10 +460,12 @@ end
412
460
 
413
461
  # Ranges (bounding box).
414
462
  # Sets the ranges for automatic coordinates. If minimal and maximal values of the coordinate are the same then they are ignored.
463
+ #
415
464
  # @overload set_auto_ranges(p1,p2)
416
465
  # @param [MglPoint] p1
417
466
  # @param [MglPoint] p2
418
467
  # @return [nil]
468
+ #
419
469
  # @overload set_auto_ranges(x1,x2,y1,y2,z1=0,z2=0,c1=0,c2=0)
420
470
  # @param [Float] x1
421
471
  # @param [Float] x2
@@ -432,9 +482,11 @@ end
432
482
 
433
483
  # Ranges (bounding box).
434
484
  # Sets center of axis cross section. If one of values is NAN then MathGL try to select optimal axis position.
485
+ #
435
486
  # @overload set_origin(p0)
436
487
  # @param [MglPoint] p0
437
488
  # @return [nil]
489
+ #
438
490
  # @overload set_origin(x0,y0,z0=NAN)
439
491
  # @param [Float] x0
440
492
  # @param [Float] y0
@@ -446,6 +498,7 @@ end
446
498
 
447
499
  # Ranges (bounding box).
448
500
  # 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().
501
+ #
449
502
  # @overload zoom_axis(p1,p2)
450
503
  # @param [MglPoint] p1
451
504
  # @param [MglPoint] p2
@@ -456,6 +509,7 @@ end
456
509
 
457
510
  # Curved coordinates.
458
511
  # 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.
512
+ #
459
513
  # @overload set_func(eqx,eqy,eqz="",eqa="")
460
514
  # @param [String] eqx
461
515
  # @param [String] eqy
@@ -468,6 +522,7 @@ end
468
522
 
469
523
  # Curved coordinates.
470
524
  # 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.
525
+ #
471
526
  # @overload set_coor(how)
472
527
  # @param [Integer] how
473
528
  # @return [nil]
@@ -485,6 +540,7 @@ end
485
540
  # 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.
486
541
  #
487
542
  # Use Ternary(0) for returning to usual axis. Ternary axis Axis projection
543
+ #
488
544
  # @overload ternary(tern)
489
545
  # @param [Integer] tern
490
546
  # @return [nil]
@@ -494,6 +550,7 @@ end
494
550
 
495
551
  # Ticks.
496
552
  # Set the ticks step, number of sub-ticks and initial ticks position to be the most human readable for the axis along direction(s) dir. Also set SetTuneTicks(true). Usually you don't need to call this function except the case of returning to default settings.
553
+ #
497
554
  # @overload adjust(dir="xyzc")
498
555
  # @param [String] dir default="xyzc"
499
556
  # @return [nil]
@@ -503,6 +560,7 @@ end
503
560
 
504
561
  # Ticks.
505
562
  # Set the ticks step d, number of sub-ticks ns (used for positive d) and initial ticks position org for the axis along direction dir (use 'c' for colorbar ticks). Variable d set step for axis ticks (if positive) or it's number on the axis range (if negative). Zero value set automatic ticks. If org value is NAN then axis origin is used.
563
+ #
506
564
  # @overload set_ticks(dir,d=0,ns=0,org=NAN)
507
565
  # @param [String] dir
508
566
  # @param [Float] d default=0
@@ -515,11 +573,13 @@ end
515
573
 
516
574
  # Ticks.
517
575
  # 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.
576
+ #
518
577
  # @overload set_ticks_val(dir,lbl,add=false)
519
578
  # @param [String] dir
520
579
  # @param [String] lbl
521
580
  # @param [bool] add default=false
522
581
  # @return [nil]
582
+ #
523
583
  # @overload set_ticks_val(dir,val,lbl,add=false)
524
584
  # @param [String] dir
525
585
  # @param [MglData] val
@@ -532,6 +592,7 @@ end
532
592
 
533
593
  # Ticks.
534
594
  # 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.
595
+ #
535
596
  # @overload set_tick_templ(dir,templ)
536
597
  # @param [String] dir
537
598
  # @param [String] templ
@@ -542,6 +603,7 @@ end
542
603
 
543
604
  # Ticks.
544
605
  # 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.
606
+ #
545
607
  # @overload set_ticks_time(dir,val,templ)
546
608
  # @param [String] dir
547
609
  # @param [Float] val
@@ -553,6 +615,7 @@ end
553
615
 
554
616
  # Ticks.
555
617
  # Switch on/off ticks enhancing by factoring common multiplier (for small, like from 0.001 to 0.002, or large, like from 1000 to 2000, coordinate values -- enabled if tune&1 is nonzero) or common component (for narrow range, like from 0.999 to 1.000 -- enabled if tune&2 is nonzero). Also set the position pos of common multiplier/component on the axis: =0 at minimal axis value, =1 at maximal axis value. Default value is 1.15.
618
+ #
556
619
  # @overload set_tune_ticks(tune,pos=1.15)
557
620
  # @param [Integer] tune
558
621
  # @param [Float] pos default=1.15
@@ -563,6 +626,7 @@ end
563
626
 
564
627
  # Ticks.
565
628
  # Set value of additional shift for ticks labels.
629
+ #
566
630
  # @overload set_tick_shift(d)
567
631
  # @param [MglPoint] d
568
632
  # @return [nil]
@@ -572,6 +636,7 @@ end
572
636
 
573
637
  # Ticks.
574
638
  # Enable/disable ticks rotation if there are too many ticks or ticks labels are too long.
639
+ #
575
640
  # @overload set_tick_rotate(val)
576
641
  # @param [bool] val
577
642
  # @return [nil]
@@ -581,6 +646,7 @@ end
581
646
 
582
647
  # Ticks.
583
648
  # Enable/disable ticks skipping if there are too many ticks or ticks labels are too long.
649
+ #
584
650
  # @overload set_tick_skip(val)
585
651
  # @param [bool] val
586
652
  # @return [nil]
@@ -591,6 +657,7 @@ end
591
657
  # Ticks.
592
658
  #
593
659
  # Enable/disable using UTC time for ticks labels. In C/Fortran you can use mgl_set_flag(gr,val, MGL_USE_GMTIME);.
660
+ #
594
661
  # @overload set_time_utc(val)
595
662
  # @param [bool] val
596
663
  # @return [nil]
@@ -600,6 +667,7 @@ end
600
667
 
601
668
  # Ticks.
602
669
  # Enable/disable drawing of ticks labels at axis origin. In C/Fortran you can use mgl_set_flag(gr,val, MGL_NO_ORIGIN);.
670
+ #
603
671
  # @overload set_origin_tick(val=true)
604
672
  # @param [bool] val default=true
605
673
  # @return [nil]
@@ -609,6 +677,7 @@ end
609
677
 
610
678
  # Ticks.
611
679
  # The relative length of axis ticks. Default value is 0.1. Parameter stt>0 set relative length of subticks which is in sqrt(1+stt) times smaller.
680
+ #
612
681
  # @overload set_tick_len(val,stt=1)
613
682
  # @param [Float] val
614
683
  # @param [Float] stt default=1
@@ -619,6 +688,7 @@ end
619
688
 
620
689
  # Ticks.
621
690
  # 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).
691
+ #
622
692
  # @overload set_axis_stl(stl="k",tck=0,sub=0)
623
693
  # @param [String] stl default="k"
624
694
  # @param [String] tck default=0
@@ -631,6 +701,7 @@ end
631
701
  # Subplots and rotation.
632
702
  # Puts further plotting in a m-th cell of nx*ny grid of the whole frame area. This function set off any aspects or rotations. So it should be used first for creating the subplot. Extra space will be reserved for axis/colorbar if stl contain:
633
703
  # From the aesthetical point of view it is not recommended to use this function with different matrices in the same frame. The position of the cell can be shifted from its default position by relative size dx, dy.
704
+ #
634
705
  # @overload sub_plot(nx,ny,m,stl="<>_^",dx=0,dy=0)
635
706
  # @param [Integer] nx
636
707
  # @param [Integer] ny
@@ -645,6 +716,7 @@ end
645
716
 
646
717
  # Subplots and rotation.
647
718
  # Puts further plotting in a rectangle of dx*dy cells starting from m-th cell of nx*ny grid of the whole frame area. This function set off any aspects or rotations. So it should be used first for creating subplot. Extra space will be reserved for axis/colorbar if stl contain:
719
+ #
648
720
  # @overload multi_plot(nx,ny,m,dx,dy,stl="<>_^")
649
721
  # @param [Integer] nx
650
722
  # @param [Integer] ny
@@ -659,6 +731,7 @@ end
659
731
 
660
732
  # Subplots and rotation.
661
733
  # 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.
734
+ #
662
735
  # @overload in_plot(x1,x2,y1,y2,rel=true)
663
736
  # @param [Float] x1
664
737
  # @param [Float] x2
@@ -672,6 +745,7 @@ end
672
745
 
673
746
  # Subplots and rotation.
674
747
  # Puts further plotting in ind-th cell of column with num cells. The position is relative to previous subplot (or inplot with rel=false). Parameter d set extra gap between cells.
748
+ #
675
749
  # @overload column_plot(num,ind,d=0)
676
750
  # @param [Integer] num
677
751
  # @param [Integer] ind
@@ -683,6 +757,7 @@ end
683
757
 
684
758
  # Subplots and rotation.
685
759
  # Puts further plotting in ind-th cell of nx*ny grid. The position is relative to previous subplot (or inplot with rel=false). Parameter d set extra gap between cells.
760
+ #
686
761
  # @overload grid_plot(nx,ny,ind,d=0)
687
762
  # @param [Integer] nx
688
763
  # @param [Integer] ny
@@ -695,6 +770,7 @@ end
695
770
 
696
771
  # Subplots and rotation.
697
772
  # Puts further plotting in ind-th cell of stick with num cells. At this, stick is rotated on angles tet, phi. The position is relative to previous subplot (or inplot with rel=false).
773
+ #
698
774
  # @overload stick_plot(num,ind,tet,phi)
699
775
  # @param [Integer] num
700
776
  # @param [Integer] ind
@@ -708,6 +784,7 @@ end
708
784
  # Subplots and rotation.
709
785
  # Add text title for current subplot/inplot. Paramater stl can contain:
710
786
  # Parameter size set font size. This function set off any aspects or rotations. So it should be used just after creating subplot.
787
+ #
711
788
  # @overload title(txt,stl="",size=-2)
712
789
  # @param [String] txt
713
790
  # @param [String] stl default=""
@@ -719,6 +796,7 @@ end
719
796
 
720
797
  # Subplots and rotation.
721
798
  # Rotates a further plotting relative to each axis (x, z, y) consecutively on angles TetX, TetZ, TetY.
799
+ #
722
800
  # @overload rotate(tetx,tetz,tety=0)
723
801
  # @param [Float] tetx
724
802
  # @param [Float] tetz
@@ -730,6 +808,7 @@ end
730
808
 
731
809
  # Subplots and rotation.
732
810
  # Rotates a further plotting around vector (x, y, z) on angle Tet.
811
+ #
733
812
  # @overload rotate_n(tet,x,y,z)
734
813
  # @param [Float] tet
735
814
  # @param [Float] x
@@ -742,6 +821,7 @@ end
742
821
 
743
822
  # Subplots and rotation.
744
823
  # Defines aspect ratio for the plot. The viewable axes will be related one to another as the ratio Ax:Ay:Az. For the best effect it should be used after rotate function. If Ax is NAN then function try to select optimal aspect ratio to keep equal ranges for x-y axis. At this, Ay will specify proportionality factor, or set to use automatic one if Ay=NAN.
824
+ #
745
825
  # @overload aspect(ax,ay,az=1)
746
826
  # @param [Float] ax
747
827
  # @param [Float] ay
@@ -753,6 +833,7 @@ end
753
833
 
754
834
  # Subplots and rotation.
755
835
  # Add (switch on) the perspective to plot. The parameter a ~ 1/z_(eff@ \in (0,1)}. By default (a=0) the perspective is off.
836
+ #
756
837
  # @overload perspective(a)
757
838
  # @param [Float] a
758
839
  # @return [nil]
@@ -762,6 +843,7 @@ end
762
843
 
763
844
  # Subplots and rotation.
764
845
  # Push transformation matrix into stack. Later you can restore its current state by Pop() function.
846
+ #
765
847
  # @overload push()
766
848
  # @return [nil]
767
849
  def push
@@ -770,6 +852,7 @@ end
770
852
 
771
853
  # Subplots and rotation.
772
854
  # Pop (restore last 'pushed') transformation matrix into stack.
855
+ #
773
856
  # @overload pop()
774
857
  # @return [nil]
775
858
  def pop
@@ -778,6 +861,7 @@ end
778
861
 
779
862
  # Subplots and rotation.
780
863
  # Sets the factor of plot size. It is not recommended to set it lower then 1.5. This is some analogue of function Zoom() but applied not to overall image but for each InPlot. Use negative value or zero to enable automatic selection.
864
+ #
781
865
  # @overload set_plot_factor(val)
782
866
  # @param [Float] val
783
867
  # @return [nil]
@@ -787,6 +871,7 @@ end
787
871
 
788
872
  # Subplots and rotation.
789
873
  # Rotates a further plotting relative to each axis (x, z, y) consecutively on angles TetX, TetZ, TetY. Rotation is done independently on rotate. Attention! this settings can not be overwritten by DefaultPlotParam(). Use Zoom(0,0,1,1) to return default view.
874
+ #
790
875
  # @overload view(tetx,tetz,tety=0)
791
876
  # @param [Float] tetx
792
877
  # @param [Float] tetz
@@ -798,6 +883,7 @@ end
798
883
 
799
884
  # Subplots and rotation.
800
885
  # 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.
886
+ #
801
887
  # @overload zoom(x1,y1,x2,y2)
802
888
  # @param [Float] x1
803
889
  # @param [Float] y1
@@ -810,6 +896,7 @@ end
810
896
 
811
897
  # Export picture.
812
898
  # Sets size of picture in pixels. This function must be called before any other plotting because it completely remove picture contents.
899
+ #
813
900
  # @overload set_size(width,height)
814
901
  # @param [Integer] width
815
902
  # @param [Integer] height
@@ -820,6 +907,7 @@ end
820
907
 
821
908
  # Export picture.
822
909
  # Sets quality of the plot depending on value val: MGL_DRAW_WIRE=0 -- no face drawing (fastest), MGL_DRAW_FAST=1 -- no color interpolation (fast), MGL_DRAW_NORM=2 -- high quality (normal), MGL_DRAW_HIGH=3 -- high quality with 3d primitives (arrows and marks). If MGL_DRAW_LMEM=0x4 is set then direct bitmap drawing is used (low memory usage).
910
+ #
823
911
  # @overload set_quality(val=MGL_DRAW_NORM)
824
912
  # @param [Integer] val default=MGL_DRAW_NORM
825
913
  # @return [nil]
@@ -829,6 +917,7 @@ end
829
917
 
830
918
  # Export picture.
831
919
  # Gets quality of the plot: MGL_DRAW_WIRE=0 -- no face drawing (fastest), MGL_DRAW_FAST=1 -- no color interpolation (fast), MGL_DRAW_NORM=2 -- high quality (normal), MGL_DRAW_HIGH=3 -- high quality with 3d primitives (arrows and marks). If MGL_DRAW_LMEM=0x4 is set then direct bitmap drawing is used (low memory usage).
920
+ #
832
921
  # @overload get_quality()
833
922
  # @return [Integer]
834
923
  def get_quality
@@ -837,6 +926,7 @@ end
837
926
 
838
927
  # Export picture.
839
928
  # Starts group definition. Groups contain objects and other groups, they are used to select a part of a model to zoom to or to make invizible or to make semitransparent and so on.
929
+ #
840
930
  # @overload start_group(name)
841
931
  # @param [String] name
842
932
  # @return [nil]
@@ -846,6 +936,7 @@ end
846
936
 
847
937
  # Export picture.
848
938
  # Ends group definition.
939
+ #
849
940
  # @overload end_group()
850
941
  # @return [nil]
851
942
  def end_group
@@ -854,6 +945,7 @@ end
854
945
 
855
946
  # Export to file.
856
947
  # 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.
948
+ #
857
949
  # @overload write_frame(fname="",descr="")
858
950
  # @param [String] fname default=""
859
951
  # @param [String] descr default=""
@@ -864,6 +956,7 @@ end
864
956
 
865
957
  # Export to file.
866
958
  # Exports current frame to PNG file. Parameter fname specifies the file name, descr adds description to file, alpha gives the transparency type. By default there are no description added and semitransparent image used. This function does nothing if HAVE_PNG isn't defined during compilation of MathGL library.
959
+ #
867
960
  # @overload write_png(fname,descr="",compr="",alpha=true)
868
961
  # @param [String] fname
869
962
  # @param [String] descr default=""
@@ -876,6 +969,7 @@ end
876
969
 
877
970
  # Export to file.
878
971
  # Exports current frame to JPEG file. Parameter fname specifies the file name, descr adds description to file. By default there is no description added. This function does nothing if HAVE_JPEG isn't defined during compilation of MathGL library.
972
+ #
879
973
  # @overload write_jpeg(fname,descr="")
880
974
  # @param [String] fname
881
975
  # @param [String] descr default=""
@@ -886,6 +980,7 @@ end
886
980
 
887
981
  # Export to file.
888
982
  # Exports current frame to GIF file. Parameter fname specifies the file name, descr adds description to file. By default there is no description added. This function does nothing if HAVE_GIF isn't defined during compilation of MathGL library.
983
+ #
889
984
  # @overload write_gif(fname,descr="")
890
985
  # @param [String] fname
891
986
  # @param [String] descr default=""
@@ -896,6 +991,7 @@ end
896
991
 
897
992
  # Export to file.
898
993
  # Exports current frame to BMP file. Parameter fname specifies the file name, descr adds description to file. There is no compression used.
994
+ #
899
995
  # @overload write_bmp(fname,descr="")
900
996
  # @param [String] fname
901
997
  # @param [String] descr default=""
@@ -906,6 +1002,7 @@ end
906
1002
 
907
1003
  # Export to file.
908
1004
  # Exports current frame to TGA file. Parameter fname specifies the file name, descr adds description to file. There is no compression used.
1005
+ #
909
1006
  # @overload write_tga(fname,descr="")
910
1007
  # @param [String] fname
911
1008
  # @param [String] descr default=""
@@ -916,6 +1013,7 @@ end
916
1013
 
917
1014
  # Export to file.
918
1015
  # 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.
1016
+ #
919
1017
  # @overload write_eps(fname,descr="")
920
1018
  # @param [String] fname
921
1019
  # @param [String] descr default=""
@@ -926,6 +1024,7 @@ end
926
1024
 
927
1025
  # Export to file.
928
1026
  # 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.
1027
+ #
929
1028
  # @overload write_bps(fname,descr="")
930
1029
  # @param [String] fname
931
1030
  # @param [String] descr default=""
@@ -936,6 +1035,7 @@ end
936
1035
 
937
1036
  # Export to file.
938
1037
  # 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.
1038
+ #
939
1039
  # @overload write_svg(fname,descr="")
940
1040
  # @param [String] fname
941
1041
  # @param [String] descr default=""
@@ -946,6 +1046,7 @@ end
946
1046
 
947
1047
  # Export to file.
948
1048
  # Exports current frame to LaTeX (package Tikz/PGF) file using vector representation. 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). Note, there is no text scaling now (for example, in subplots), what may produce miss-aligned labels.
1049
+ #
949
1050
  # @overload write_tex(fname,descr="")
950
1051
  # @param [String] fname
951
1052
  # @param [String] descr default=""
@@ -956,6 +1057,7 @@ end
956
1057
 
957
1058
  # Export to file.
958
1059
  # 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.
1060
+ #
959
1061
  # @overload write_prc(fname,descr="",make_pdf=true)
960
1062
  # @param [String] fname
961
1063
  # @param [String] descr default=""
@@ -967,6 +1069,7 @@ end
967
1069
 
968
1070
  # Export to file.
969
1071
  # 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).
1072
+ #
970
1073
  # @overload write_obj(fname,descr="")
971
1074
  # @param [String] fname
972
1075
  # @param [String] descr default=""
@@ -977,6 +1080,7 @@ end
977
1080
 
978
1081
  # Export to file.
979
1082
  # 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).
1083
+ #
980
1084
  # @overload write_xyz(fname,descr="")
981
1085
  # @param [String] fname
982
1086
  # @param [String] descr default=""
@@ -987,6 +1091,7 @@ end
987
1091
 
988
1092
  # Export to file.
989
1093
  # 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.
1094
+ #
990
1095
  # @overload write_stl(fname,descr="")
991
1096
  # @param [String] fname
992
1097
  # @param [String] descr default=""
@@ -997,6 +1102,7 @@ end
997
1102
 
998
1103
  # Export to file.
999
1104
  # 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).
1105
+ #
1000
1106
  # @overload write_off(fname,descr="",colored=false)
1001
1107
  # @param [String] fname
1002
1108
  # @param [String] descr default=""
@@ -1008,6 +1114,7 @@ end
1008
1114
 
1009
1115
  # Export to file.
1010
1116
  # Displays the current picture using external program viewer for viewing. The function save the picture to temporary file and call viewer to display it. If nowait=true then the function return immediately (it will not wait while window will be closed).
1117
+ #
1011
1118
  # @overload show_image(viewer,nowait=false)
1012
1119
  # @param [String] viewer
1013
1120
  # @param [bool] nowait default=false
@@ -1018,6 +1125,7 @@ end
1018
1125
 
1019
1126
  # Export to file.
1020
1127
  # Exports current frame to textual file using JSON format. Later this file can be used for faster loading and viewing by JavaScript script. Parameter fname specifies the file name, descr adds description to file.
1128
+ #
1021
1129
  # @overload write_json(fname,descr="")
1022
1130
  # @param [String] fname
1023
1131
  # @param [String] descr default=""
@@ -1028,6 +1136,7 @@ end
1028
1136
 
1029
1137
  # Export to file.
1030
1138
  # Exports points and primitives in file using MGLD format. Later this file can be used for faster loading and viewing by mglview utility. Parameter fname specifies the file name, descr adds description to file (default is file name).
1139
+ #
1031
1140
  # @overload export_mgld(fname,descr="")
1032
1141
  # @param [String] fname
1033
1142
  # @param [String] descr default=""
@@ -1038,6 +1147,7 @@ end
1038
1147
 
1039
1148
  # Export to file.
1040
1149
  # Imports points and primitives in file using MGLD format. Later this file can be used for faster loading and viewing by mglview utility. Parameter fname specifies the file name, add sets to append or replace primitives to existed ones.
1150
+ #
1041
1151
  # @overload import_mgld(fname,add=false)
1042
1152
  # @param [String] fname
1043
1153
  # @param [bool] add default=false
@@ -1048,6 +1158,7 @@ end
1048
1158
 
1049
1159
  # Frames/Animation.
1050
1160
  # 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.
1161
+ #
1051
1162
  # @overload new_frame()
1052
1163
  # @return [nil]
1053
1164
  def new_frame
@@ -1056,6 +1167,7 @@ end
1056
1167
 
1057
1168
  # Frames/Animation.
1058
1169
  # Finishes the frame drawing.
1170
+ #
1059
1171
  # @overload end_frame()
1060
1172
  # @return [nil]
1061
1173
  def end_frame
@@ -1064,6 +1176,7 @@ end
1064
1176
 
1065
1177
  # Frames/Animation.
1066
1178
  # Gets the number of created frames.
1179
+ #
1067
1180
  # @overload get_num_frame()
1068
1181
  # @return [Integer]
1069
1182
  def get_num_frame
@@ -1072,6 +1185,7 @@ end
1072
1185
 
1073
1186
  # Frames/Animation.
1074
1187
  # 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.
1188
+ #
1075
1189
  # @overload set_frame(i)
1076
1190
  # @param [Integer] i
1077
1191
  # @return [nil]
@@ -1081,6 +1195,7 @@ end
1081
1195
 
1082
1196
  # Frames/Animation.
1083
1197
  # Replaces drawing data by one from frame i. Function work if MGL_VECT_FRAME is set on (by default).
1198
+ #
1084
1199
  # @overload get_frame(i)
1085
1200
  # @param [Integer] i
1086
1201
  # @return [nil]
@@ -1090,6 +1205,7 @@ end
1090
1205
 
1091
1206
  # Frames/Animation.
1092
1207
  # Appends drawing data from frame i to current one. Function work if MGL_VECT_FRAME is set on (by default).
1208
+ #
1093
1209
  # @overload show_frame(i)
1094
1210
  # @param [Integer] i
1095
1211
  # @return [nil]
@@ -1099,6 +1215,7 @@ end
1099
1215
 
1100
1216
  # Frames/Animation.
1101
1217
  # Deletes drawing data for frame i and shift all later frame indexes. Function work if MGL_VECT_FRAME is set on (by default). Do nothing in OpenGL mode.
1218
+ #
1102
1219
  # @overload del_frame(i)
1103
1220
  # @param [Integer] i
1104
1221
  # @return [nil]
@@ -1108,6 +1225,7 @@ end
1108
1225
 
1109
1226
  # Frames/Animation.
1110
1227
  # Reset frames counter (start it from zero).
1228
+ #
1111
1229
  # @overload reset_frames()
1112
1230
  # @return [nil]
1113
1231
  def reset_frames
@@ -1116,6 +1234,7 @@ end
1116
1234
 
1117
1235
  # Frames/Animation.
1118
1236
  # 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.
1237
+ #
1119
1238
  # @overload start_gif(fname,ms=100)
1120
1239
  # @param [String] fname
1121
1240
  # @param [Integer] ms default=100
@@ -1126,6 +1245,7 @@ end
1126
1245
 
1127
1246
  # Frames/Animation.
1128
1247
  # Finish writing animated GIF and close connected pointers.
1248
+ #
1129
1249
  # @overload close_gif()
1130
1250
  # @return [nil]
1131
1251
  def close_gif
@@ -1134,24 +1254,35 @@ end
1134
1254
 
1135
1255
  # Bitmap in memory.
1136
1256
  # 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
1257
+ #
1137
1258
  # @overload get_rgb()
1138
1259
  # @return [unsigned char]
1260
+ #
1139
1261
  # @overload get_rgb(buf,size)
1140
1262
  # @param [String] buf
1141
1263
  # @param [Integer] size
1142
1264
  # @return [nil]
1265
+ def get_rgb
1266
+ end
1267
+
1268
+
1269
+ # Bitmap in memory.
1270
+ # 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
1271
+ #
1143
1272
  # @overload get_bgrn(buf,size)
1144
1273
  # @param [String] buf
1145
1274
  # @param [Integer] size
1146
1275
  # @return [nil]
1147
- def get_rgb
1276
+ def get_bgrn
1148
1277
  end
1149
1278
 
1150
1279
 
1151
1280
  # Bitmap in memory.
1152
1281
  # 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).
1282
+ #
1153
1283
  # @overload get_rgba()
1154
1284
  # @return [unsigned char]
1285
+ #
1155
1286
  # @overload get_rgba(buf,size)
1156
1287
  # @param [String] buf
1157
1288
  # @param [Integer] size
@@ -1162,16 +1293,25 @@ end
1162
1293
 
1163
1294
  # Bitmap in memory.
1164
1295
  # Gets width and height of the image.
1296
+ #
1165
1297
  # @overload get_width()
1166
1298
  # @return [Integer]
1299
+ def get_width
1300
+ end
1301
+
1302
+
1303
+ # Bitmap in memory.
1304
+ # Gets width and height of the image.
1305
+ #
1167
1306
  # @overload get_height()
1168
1307
  # @return [Integer]
1169
- def get_width
1308
+ def get_height
1170
1309
  end
1171
1310
 
1172
1311
 
1173
1312
  # Bitmap in memory.
1174
1313
  # Calculate 3D coordinate (x,y,z) for screen point (xs,ys). At this moment it ignore perspective and transformation formulas (curvilinear coordinates). The calculation are done for the last used InPlot (see Subplots and rotation).
1314
+ #
1175
1315
  # @overload calc_xyz(xs,ys)
1176
1316
  # @param [Integer] xs
1177
1317
  # @param [Integer] ys
@@ -1182,6 +1322,7 @@ end
1182
1322
 
1183
1323
  # Bitmap in memory.
1184
1324
  # Calculate screen point (xs,ys) for 3D coordinate (x,y,z). The calculation are done for the last used InPlot (see Subplots and rotation).
1325
+ #
1185
1326
  # @overload calc_scr(p)
1186
1327
  # @param [MglPoint] p
1187
1328
  # @return [MglPoint]
@@ -1191,6 +1332,7 @@ end
1191
1332
 
1192
1333
  # Bitmap in memory.
1193
1334
  # Set the numeric id for object or subplot/inplot.
1335
+ #
1194
1336
  # @overload set_obj_id(id)
1195
1337
  # @param [Integer] id
1196
1338
  # @return [nil]
@@ -1200,6 +1342,7 @@ end
1200
1342
 
1201
1343
  # Bitmap in memory.
1202
1344
  # Get the numeric id for most upper object at pixel (xs, ys) of the picture.
1345
+ #
1203
1346
  # @overload get_obj_id(xs,ys)
1204
1347
  # @param [Integer] xs
1205
1348
  # @param [Integer] ys
@@ -1210,6 +1353,7 @@ end
1210
1353
 
1211
1354
  # Bitmap in memory.
1212
1355
  # Get the numeric id for most subplot/inplot at pixel (xs, ys) of the picture.
1356
+ #
1213
1357
  # @overload get_spl_id(xs,ys)
1214
1358
  # @param [Integer] xs
1215
1359
  # @param [Integer] ys
@@ -1220,6 +1364,7 @@ end
1220
1364
 
1221
1365
  # Bitmap in memory.
1222
1366
  # Highlight the object with given id.
1367
+ #
1223
1368
  # @overload highlight(id)
1224
1369
  # @param [Integer] id
1225
1370
  # @return [nil]
@@ -1229,6 +1374,7 @@ end
1229
1374
 
1230
1375
  # Bitmap in memory.
1231
1376
  # Checks if point (xs, ys) is close to one of active point (i.e. mglBase::Act) with accuracy d and return its index or -1 if not found. Active points are special points which characterize primitives (like edges and so on). This function for advanced users only.
1377
+ #
1232
1378
  # @overload is_active(xs,ys,d=1)
1233
1379
  # @param [Integer] xs
1234
1380
  # @param [Integer] ys
@@ -1240,6 +1386,7 @@ end
1240
1386
 
1241
1387
  # Parallelization.
1242
1388
  # Combine drawing from instance g with gr (or with this) taking into account Z-ordering of pixels. The width and height of both instances must be the same.
1389
+ #
1243
1390
  # @overload combine(g)
1244
1391
  # @param [MglGraph] g
1245
1392
  # @return [Integer]
@@ -1249,6 +1396,7 @@ end
1249
1396
 
1250
1397
  # Parallelization.
1251
1398
  # Send graphical information from node id using MPI. The width and height in both nodes must be the same.
1399
+ #
1252
1400
  # @overload mpi_send(id)
1253
1401
  # @param [Integer] id
1254
1402
  # @return [Integer]
@@ -1258,6 +1406,7 @@ end
1258
1406
 
1259
1407
  # Parallelization.
1260
1408
  # Receive graphical information from node id using MPI. The width and height in both nodes must be the same.
1409
+ #
1261
1410
  # @overload mpi_recv(id)
1262
1411
  # @param [Integer] id
1263
1412
  # @return [Integer]
@@ -1267,8 +1416,10 @@ end
1267
1416
 
1268
1417
  # Primitives.
1269
1418
  # Clear the picture and fill it by color specified color.
1419
+ #
1270
1420
  # @overload clf()
1271
1421
  # @return [nil]
1422
+ #
1272
1423
  # @overload clf(r,g,b)
1273
1424
  # @param [Float] r
1274
1425
  # @param [Float] g
@@ -1280,20 +1431,29 @@ end
1280
1431
 
1281
1432
  # Primitives.
1282
1433
  # Draws a mark (point '.' by default) at position p=(x, y, z) with color col.
1434
+ #
1283
1435
  # @overload ball(p,col='r')
1284
1436
  # @param [MglPoint] p
1285
1437
  # @param [String] col default='r'
1286
1438
  # @return [nil]
1439
+ def ball
1440
+ end
1441
+
1442
+
1443
+ # Primitives.
1444
+ # Draws a mark (point '.' by default) at position p=(x, y, z) with color col.
1445
+ #
1287
1446
  # @overload mark(p,mark)
1288
1447
  # @param [MglPoint] p
1289
1448
  # @param [String] mark
1290
1449
  # @return [nil]
1291
- def ball
1450
+ def mark
1292
1451
  end
1293
1452
 
1294
1453
 
1295
1454
  # Primitives.
1296
1455
  # Draws a 3d error box at position p=(x, y, z) with sizes e=(ex, ey, ez) and style stl. Use NAN for component of e to reduce number of drawn elements.
1456
+ #
1297
1457
  # @overload error(p,e,stl="")
1298
1458
  # @param [MglPoint] p
1299
1459
  # @param [MglPoint] e
@@ -1305,6 +1465,7 @@ end
1305
1465
 
1306
1466
  # Primitives.
1307
1467
  # Draws a geodesic line (straight line in Cartesian coordinates) from point p1 to p2 using line style stl. Parameter num define the ``quality'' of the line. If num=2 then the stright line will be drawn in all coordinate system (independently on transformation formulas (see Curved coordinates). Contrary, for large values (for example, =100) the geodesic line will be drawn in corresponding coordinate system (straight line in Cartesian coordinates, circle in polar coordinates and so on). Line will be drawn even if it lies out of bounding box.
1468
+ #
1308
1469
  # @overload line(p1,p2,stl="B",num=2)
1309
1470
  # @param [MglPoint] p1
1310
1471
  # @param [MglPoint] p2
@@ -1317,6 +1478,7 @@ end
1317
1478
 
1318
1479
  # Primitives.
1319
1480
  # Draws Bezier-like curve from point p1 to p2 using line style stl. At this tangent is codirected with d1, d2 and proportional to its amplitude. Parameter num define the ``quality'' of the curve. If num=2 then the straight line will be drawn in all coordinate system (independently on transformation formulas, see Curved coordinates). Contrary, for large values (for example, =100) the spline like Bezier curve will be drawn in corresponding coordinate system. Curve will be drawn even if it lies out of bounding box.
1481
+ #
1320
1482
  # @overload curve(p1,d1,p2,d2,stl="B",num=100)
1321
1483
  # @param [MglPoint] p1
1322
1484
  # @param [MglPoint] d1
@@ -1331,6 +1493,7 @@ end
1331
1493
 
1332
1494
  # Primitives.
1333
1495
  # Draws the solid quadrangle (face) with vertexes p1, p2, p3, p4 and with color(s) stl. At this colors can be the same for all vertexes or different if all 4 colors are specified for each vertex. Face will be drawn even if it lies out of bounding box.
1496
+ #
1334
1497
  # @overload face(p1,p2,p3,p4,stl="w")
1335
1498
  # @param [MglPoint] p1
1336
1499
  # @param [MglPoint] p2
@@ -1344,6 +1507,7 @@ end
1344
1507
 
1345
1508
  # Primitives.
1346
1509
  # 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.
1510
+ #
1347
1511
  # @overload face_x(x0,y0,z0,wy,wz,stl="w",d1=0,d2=0)
1348
1512
  # @param [Float] x0
1349
1513
  # @param [Float] y0
@@ -1354,6 +1518,13 @@ end
1354
1518
  # @param [Float] d1 default=0
1355
1519
  # @param [Float] d2 default=0
1356
1520
  # @return [nil]
1521
+ def face_x
1522
+ end
1523
+
1524
+
1525
+ # Primitives.
1526
+ # 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.
1527
+ #
1357
1528
  # @overload face_y(x0,y0,z0,wx,wz,stl="w",d1=0,d2=0)
1358
1529
  # @param [Float] x0
1359
1530
  # @param [Float] y0
@@ -1364,6 +1535,13 @@ end
1364
1535
  # @param [Float] d1 default=0
1365
1536
  # @param [Float] d2 default=0
1366
1537
  # @return [nil]
1538
+ def face_y
1539
+ end
1540
+
1541
+
1542
+ # Primitives.
1543
+ # 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.
1544
+ #
1367
1545
  # @overload face_z(x0,y0,z0,wx,wy,stl="w",d1=0,d2=0)
1368
1546
  # @param [Float] x0
1369
1547
  # @param [Float] y0
@@ -1374,12 +1552,13 @@ end
1374
1552
  # @param [Float] d1 default=0
1375
1553
  # @param [Float] d2 default=0
1376
1554
  # @return [nil]
1377
- def face_x
1555
+ def face_z
1378
1556
  end
1379
1557
 
1380
1558
 
1381
1559
  # Primitives.
1382
1560
  # Draw the sphere with radius r and center at point p=(x0, y0, z0) and color stl.
1561
+ #
1383
1562
  # @overload sphere(p,r,stl="r")
1384
1563
  # @param [MglPoint] p
1385
1564
  # @param [Float] r
@@ -1391,6 +1570,7 @@ end
1391
1570
 
1392
1571
  # Primitives.
1393
1572
  # 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).
1573
+ #
1394
1574
  # @overload drop(p,d,r,col="r",shift=1,ap=1)
1395
1575
  # @param [MglPoint] p
1396
1576
  # @param [MglPoint] d
@@ -1405,6 +1585,7 @@ end
1405
1585
 
1406
1586
  # Primitives.
1407
1587
  # 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.
1588
+ #
1408
1589
  # @overload cone(p1,p2,r1,r2=-1,stl="B")
1409
1590
  # @param [MglPoint] p1
1410
1591
  # @param [MglPoint] p2
@@ -1418,6 +1599,7 @@ end
1418
1599
 
1419
1600
  # Primitives.
1420
1601
  # Draw the circle with radius r and center at point p=(x0, y0, z0). Parameter col may contain
1602
+ #
1421
1603
  # @overload circle(p,r,stl="r")
1422
1604
  # @param [MglPoint] p
1423
1605
  # @param [Float] r
@@ -1429,6 +1611,7 @@ end
1429
1611
 
1430
1612
  # Primitives.
1431
1613
  # Draw the ellipse with radius r and focal points p1, p2. Parameter col may contain
1614
+ #
1432
1615
  # @overload ellipse(p1,p2,r,col="r")
1433
1616
  # @param [MglPoint] p1
1434
1617
  # @param [MglPoint] p2
@@ -1441,6 +1624,7 @@ end
1441
1624
 
1442
1625
  # Primitives.
1443
1626
  # Draw the rhombus with width r and edge points p1, p2. Parameter col may contain
1627
+ #
1444
1628
  # @overload rhomb(p1,p2,r,col="r")
1445
1629
  # @param [MglPoint] p1
1446
1630
  # @param [MglPoint] p2
@@ -1453,12 +1637,14 @@ end
1453
1637
 
1454
1638
  # Text printing.
1455
1639
  # The function plots the string text at position p with fonts specifying by the criteria fnt. The size of font is set by size parameter (default is -1).
1640
+ #
1456
1641
  # @overload puts(p,text,fnt=":C",size=-1)
1457
1642
  # @param [MglPoint] p
1458
1643
  # @param [String] text
1459
1644
  # @param [String] fnt default=":C"
1460
1645
  # @param [Float] size default=-1
1461
1646
  # @return [nil]
1647
+ #
1462
1648
  # @overload puts(x,y,text,fnt=":AC",size=-1)
1463
1649
  # @param [Float] x
1464
1650
  # @param [Float] y
@@ -1472,6 +1658,7 @@ end
1472
1658
 
1473
1659
  # Text printing.
1474
1660
  # 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.
1661
+ #
1475
1662
  # @overload puts(p,d,text,fnt=":L",size=-1)
1476
1663
  # @param [MglPoint] p
1477
1664
  # @param [MglPoint] d
@@ -1485,12 +1672,14 @@ end
1485
1672
 
1486
1673
  # Text printing.
1487
1674
  # 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).
1675
+ #
1488
1676
  # @overload text(y,text,fnt="",opt="")
1489
1677
  # @param [MglData] y
1490
1678
  # @param [String] text
1491
1679
  # @param [String] fnt default=""
1492
1680
  # @param [String] opt default=""
1493
1681
  # @return [nil]
1682
+ #
1494
1683
  # @overload text(x,y,text,fnt="",opt="")
1495
1684
  # @param [MglData] x
1496
1685
  # @param [MglData] y
@@ -1498,6 +1687,7 @@ end
1498
1687
  # @param [String] fnt default=""
1499
1688
  # @param [String] opt default=""
1500
1689
  # @return [nil]
1690
+ #
1501
1691
  # @overload text(x,y,z,text,fnt="",opt="")
1502
1692
  # @param [MglData] x
1503
1693
  # @param [MglData] y
@@ -1513,6 +1703,7 @@ end
1513
1703
  # Axis and Colorbar.
1514
1704
  # Draws axes with ticks (see Axis settings). Parameter dir may contain:
1515
1705
  # Styles of ticks and axis can be overrided by using stl string. Axis and ticks
1706
+ #
1516
1707
  # @overload axis(dir="xyz",stl="",opt="")
1517
1708
  # @param [String] dir default="xyz"
1518
1709
  # @param [String] stl default=""
@@ -1525,6 +1716,7 @@ end
1525
1716
  # Axis and Colorbar.
1526
1717
  # Draws colorbar. Parameter sch may contain:
1527
1718
  # Colorbars
1719
+ #
1528
1720
  # @overload colorbar(sch="")
1529
1721
  # @param [String] sch default=""
1530
1722
  # @return [nil]
@@ -1534,6 +1726,7 @@ end
1534
1726
 
1535
1727
  # Axis and Colorbar.
1536
1728
  # The same as previous but with sharp colors sch (current palette if sch="") for values v. ContD sample
1729
+ #
1537
1730
  # @overload colorbar(v,sch="")
1538
1731
  # @param [MglData] v
1539
1732
  # @param [String] sch default=""
@@ -1544,6 +1737,7 @@ end
1544
1737
 
1545
1738
  # Axis and Colorbar.
1546
1739
  # 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.
1740
+ #
1547
1741
  # @overload colorbar(sch,x,y,w=1,h=1)
1548
1742
  # @param [String] sch
1549
1743
  # @param [Float] x
@@ -1557,6 +1751,7 @@ end
1557
1751
 
1558
1752
  # Axis and Colorbar.
1559
1753
  # The same as previous but with sharp colors sch (current palette if sch="") for values v. ContD sample
1754
+ #
1560
1755
  # @overload colorbar(v,sch,x,y,w=1,h=1)
1561
1756
  # @param [MglData] v
1562
1757
  # @param [String] sch
@@ -1571,6 +1766,7 @@ end
1571
1766
 
1572
1767
  # Axis and Colorbar.
1573
1768
  # 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-').
1769
+ #
1574
1770
  # @overload grid(dir="xyz",pen="B",opt="")
1575
1771
  # @param [String] dir default="xyz"
1576
1772
  # @param [String] pen default="B"
@@ -1582,6 +1778,7 @@ end
1582
1778
 
1583
1779
  # Axis and Colorbar.
1584
1780
  # 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
1781
+ #
1585
1782
  # @overload box(col="",ticks=true)
1586
1783
  # @param [String] col default=""
1587
1784
  # @param [bool] ticks default=true
@@ -1592,6 +1789,7 @@ end
1592
1789
 
1593
1790
  # Axis and Colorbar.
1594
1791
  # 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.
1792
+ #
1595
1793
  # @overload label(dir,text,pos=1,opt="")
1596
1794
  # @param [String] dir
1597
1795
  # @param [String] text
@@ -1604,6 +1802,7 @@ end
1604
1802
 
1605
1803
  # Legend.
1606
1804
  # 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.
1805
+ #
1607
1806
  # @overload legend(pos=0x3,fnt="#",opt="")
1608
1807
  # @param [Integer] pos default=0x3
1609
1808
  # @param [String] fnt default="#"
@@ -1615,6 +1814,7 @@ end
1615
1814
 
1616
1815
  # Legend.
1617
1816
  # 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).
1817
+ #
1618
1818
  # @overload legend(x,y,fnt="#",opt="")
1619
1819
  # @param [Float] x
1620
1820
  # @param [Float] y
@@ -1627,6 +1827,7 @@ end
1627
1827
 
1628
1828
  # Legend.
1629
1829
  # Adds string text to internal legend accumulator. The style of described line and mark is specified in string style (see Line styles).
1830
+ #
1630
1831
  # @overload add_legend(text,style)
1631
1832
  # @param [String] text
1632
1833
  # @param [String] style
@@ -1637,6 +1838,7 @@ end
1637
1838
 
1638
1839
  # Legend.
1639
1840
  # Clears saved legend strings.
1841
+ #
1640
1842
  # @overload clear_legend()
1641
1843
  # @return [nil]
1642
1844
  def clear_legend
@@ -1645,6 +1847,7 @@ end
1645
1847
 
1646
1848
  # Legend.
1647
1849
  # Set the number of marks in the legend. By default 1 mark is used.
1850
+ #
1648
1851
  # @overload set_legend_marks(num)
1649
1852
  # @param [Integer] num
1650
1853
  # @return [nil]
@@ -1654,17 +1857,20 @@ end
1654
1857
 
1655
1858
  # 1D plotting.
1656
1859
  # 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
1860
+ #
1657
1861
  # @overload plot(y,pen="",opt="")
1658
1862
  # @param [MglData] y
1659
1863
  # @param [String] pen default=""
1660
1864
  # @param [String] opt default=""
1661
1865
  # @return [nil]
1866
+ #
1662
1867
  # @overload plot(x,y,pen="",opt="")
1663
1868
  # @param [MglData] x
1664
1869
  # @param [MglData] y
1665
1870
  # @param [String] pen default=""
1666
1871
  # @param [String] opt default=""
1667
1872
  # @return [nil]
1873
+ #
1668
1874
  # @overload plot(x,y,z,pen="",opt="")
1669
1875
  # @param [MglData] x
1670
1876
  # @param [MglData] y
@@ -1678,6 +1884,7 @@ end
1678
1884
 
1679
1885
  # 1D plotting.
1680
1886
  # 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
1887
+ #
1681
1888
  # @overload radar(a,pen="",opt="")
1682
1889
  # @param [MglData] a
1683
1890
  # @param [String] pen default=""
@@ -1689,17 +1896,20 @@ end
1689
1896
 
1690
1897
  # 1D plotting.
1691
1898
  # These functions draw continuous stairs for points to axis plane. See also plot, stem, tile, boxs. Step sample
1899
+ #
1692
1900
  # @overload step(y,pen="",opt="")
1693
1901
  # @param [MglData] y
1694
1902
  # @param [String] pen default=""
1695
1903
  # @param [String] opt default=""
1696
1904
  # @return [nil]
1905
+ #
1697
1906
  # @overload step(x,y,pen="",opt="")
1698
1907
  # @param [MglData] x
1699
1908
  # @param [MglData] y
1700
1909
  # @param [String] pen default=""
1701
1910
  # @param [String] opt default=""
1702
1911
  # @return [nil]
1912
+ #
1703
1913
  # @overload step(x,y,z,pen="",opt="")
1704
1914
  # @param [MglData] x
1705
1915
  # @param [MglData] y
@@ -1713,12 +1923,14 @@ end
1713
1923
 
1714
1924
  # 1D plotting.
1715
1925
  # 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
1926
+ #
1716
1927
  # @overload tens(y,c,pen="",opt="")
1717
1928
  # @param [MglData] y
1718
1929
  # @param [MglData] c
1719
1930
  # @param [String] pen default=""
1720
1931
  # @param [String] opt default=""
1721
1932
  # @return [nil]
1933
+ #
1722
1934
  # @overload tens(x,y,c,pen="",opt="")
1723
1935
  # @param [MglData] x
1724
1936
  # @param [MglData] y
@@ -1726,6 +1938,7 @@ end
1726
1938
  # @param [String] pen default=""
1727
1939
  # @param [String] opt default=""
1728
1940
  # @return [nil]
1941
+ #
1729
1942
  # @overload tens(x,y,z,c,pen="",opt="")
1730
1943
  # @param [MglData] x
1731
1944
  # @param [MglData] y
@@ -1740,17 +1953,20 @@ end
1740
1953
 
1741
1954
  # 1D plotting.
1742
1955
  # 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
1956
+ #
1743
1957
  # @overload tape(y,pen="",opt="")
1744
1958
  # @param [MglData] y
1745
1959
  # @param [String] pen default=""
1746
1960
  # @param [String] opt default=""
1747
1961
  # @return [nil]
1962
+ #
1748
1963
  # @overload tape(x,y,pen="",opt="")
1749
1964
  # @param [MglData] x
1750
1965
  # @param [MglData] y
1751
1966
  # @param [String] pen default=""
1752
1967
  # @param [String] opt default=""
1753
1968
  # @return [nil]
1969
+ #
1754
1970
  # @overload tape(x,y,z,pen="",opt="")
1755
1971
  # @param [MglData] x
1756
1972
  # @param [MglData] y
@@ -1764,17 +1980,20 @@ end
1764
1980
 
1765
1981
  # 1D plotting.
1766
1982
  # 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
1983
+ #
1767
1984
  # @overload area(y,pen="",opt="")
1768
1985
  # @param [MglData] y
1769
1986
  # @param [String] pen default=""
1770
1987
  # @param [String] opt default=""
1771
1988
  # @return [nil]
1989
+ #
1772
1990
  # @overload area(x,y,pen="",opt="")
1773
1991
  # @param [MglData] x
1774
1992
  # @param [MglData] y
1775
1993
  # @param [String] pen default=""
1776
1994
  # @param [String] opt default=""
1777
1995
  # @return [nil]
1996
+ #
1778
1997
  # @overload area(x,y,z,pen="",opt="")
1779
1998
  # @param [MglData] x
1780
1999
  # @param [MglData] y
@@ -1788,12 +2007,14 @@ end
1788
2007
 
1789
2008
  # 1D plotting.
1790
2009
  # 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
2010
+ #
1791
2011
  # @overload region(y1,y2,pen="",opt="")
1792
2012
  # @param [MglData] y1
1793
2013
  # @param [MglData] y2
1794
2014
  # @param [String] pen default=""
1795
2015
  # @param [String] opt default=""
1796
2016
  # @return [nil]
2017
+ #
1797
2018
  # @overload region(x,y1,y2,pen="",opt="")
1798
2019
  # @param [MglData] x
1799
2020
  # @param [MglData] y1
@@ -1807,17 +2028,20 @@ end
1807
2028
 
1808
2029
  # 1D plotting.
1809
2030
  # These functions draw vertical lines from points to axis plane. See also area, bars, plot, mark. Stem sample
2031
+ #
1810
2032
  # @overload stem(y,pen="",opt="")
1811
2033
  # @param [MglData] y
1812
2034
  # @param [String] pen default=""
1813
2035
  # @param [String] opt default=""
1814
2036
  # @return [nil]
2037
+ #
1815
2038
  # @overload stem(x,y,pen="",opt="")
1816
2039
  # @param [MglData] x
1817
2040
  # @param [MglData] y
1818
2041
  # @param [String] pen default=""
1819
2042
  # @param [String] opt default=""
1820
2043
  # @return [nil]
2044
+ #
1821
2045
  # @overload stem(x,y,z,pen="",opt="")
1822
2046
  # @param [MglData] x
1823
2047
  # @param [MglData] y
@@ -1831,17 +2055,20 @@ end
1831
2055
 
1832
2056
  # 1D plotting.
1833
2057
  # 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
2058
+ #
1834
2059
  # @overload bars(y,pen="",opt="")
1835
2060
  # @param [MglData] y
1836
2061
  # @param [String] pen default=""
1837
2062
  # @param [String] opt default=""
1838
2063
  # @return [nil]
2064
+ #
1839
2065
  # @overload bars(x,y,pen="",opt="")
1840
2066
  # @param [MglData] x
1841
2067
  # @param [MglData] y
1842
2068
  # @param [String] pen default=""
1843
2069
  # @param [String] opt default=""
1844
2070
  # @return [nil]
2071
+ #
1845
2072
  # @overload bars(x,y,z,pen="",opt="")
1846
2073
  # @param [MglData] x
1847
2074
  # @param [MglData] y
@@ -1855,11 +2082,13 @@ end
1855
2082
 
1856
2083
  # 1D plotting.
1857
2084
  # 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
2085
+ #
1858
2086
  # @overload barh(v,pen="",opt="")
1859
2087
  # @param [MglData] v
1860
2088
  # @param [String] pen default=""
1861
2089
  # @param [String] opt default=""
1862
2090
  # @return [nil]
2091
+ #
1863
2092
  # @overload barh(y,v,pen="",opt="")
1864
2093
  # @param [MglData] y
1865
2094
  # @param [MglData] v
@@ -1872,17 +2101,20 @@ end
1872
2101
 
1873
2102
  # 1D plotting.
1874
2103
  # 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
2104
+ #
1875
2105
  # @overload cones(y,pen="",opt="")
1876
2106
  # @param [MglData] y
1877
2107
  # @param [String] pen default=""
1878
2108
  # @param [String] opt default=""
1879
2109
  # @return [nil]
2110
+ #
1880
2111
  # @overload cones(x,y,pen="",opt="")
1881
2112
  # @param [MglData] x
1882
2113
  # @param [MglData] y
1883
2114
  # @param [String] pen default=""
1884
2115
  # @param [String] opt default=""
1885
2116
  # @return [nil]
2117
+ #
1886
2118
  # @overload cones(x,y,z,pen="",opt="")
1887
2119
  # @param [MglData] x
1888
2120
  # @param [MglData] y
@@ -1896,6 +2128,7 @@ end
1896
2128
 
1897
2129
  # 1D plotting.
1898
2130
  # 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
2131
+ #
1899
2132
  # @overload chart(a,col="",opt="")
1900
2133
  # @param [MglData] a
1901
2134
  # @param [String] col default=""
@@ -1907,11 +2140,13 @@ end
1907
2140
 
1908
2141
  # 1D plotting.
1909
2142
  # 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
2143
+ #
1910
2144
  # @overload box_plot(a,pen="",opt="")
1911
2145
  # @param [MglData] a
1912
2146
  # @param [String] pen default=""
1913
2147
  # @param [String] opt default=""
1914
2148
  # @return [nil]
2149
+ #
1915
2150
  # @overload box_plot(x,a,pen="",opt="")
1916
2151
  # @param [MglData] x
1917
2152
  # @param [MglData] a
@@ -1924,17 +2159,20 @@ end
1924
2159
 
1925
2160
  # 1D plotting.
1926
2161
  # 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
2162
+ #
1927
2163
  # @overload candle(v1,pen="",opt="")
1928
2164
  # @param [MglData] v1
1929
2165
  # @param [String] pen default=""
1930
2166
  # @param [String] opt default=""
1931
2167
  # @return [nil]
2168
+ #
1932
2169
  # @overload candle(v1,v2,pen="",opt="")
1933
2170
  # @param [MglData] v1
1934
2171
  # @param [MglData] v2
1935
2172
  # @param [String] pen default=""
1936
2173
  # @param [String] opt default=""
1937
2174
  # @return [nil]
2175
+ #
1938
2176
  # @overload candle(v1,y1,y2,pen="",opt="")
1939
2177
  # @param [MglData] v1
1940
2178
  # @param [MglData] y1
@@ -1942,6 +2180,7 @@ end
1942
2180
  # @param [String] pen default=""
1943
2181
  # @param [String] opt default=""
1944
2182
  # @return [nil]
2183
+ #
1945
2184
  # @overload candle(v1,v2,y1,y2,pen="",opt="")
1946
2185
  # @param [MglData] v1
1947
2186
  # @param [MglData] v2
@@ -1950,6 +2189,7 @@ end
1950
2189
  # @param [String] pen default=""
1951
2190
  # @param [String] opt default=""
1952
2191
  # @return [nil]
2192
+ #
1953
2193
  # @overload candle(x,v1,v2,y1,y2,pen="",opt="")
1954
2194
  # @param [MglData] x
1955
2195
  # @param [MglData] v1
@@ -1965,12 +2205,14 @@ end
1965
2205
 
1966
2206
  # 1D plotting.
1967
2207
  # 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
2208
+ #
1968
2209
  # @overload error(y,ey,pen="",opt="")
1969
2210
  # @param [MglData] y
1970
2211
  # @param [MglData] ey
1971
2212
  # @param [String] pen default=""
1972
2213
  # @param [String] opt default=""
1973
2214
  # @return [nil]
2215
+ #
1974
2216
  # @overload error(x,y,ey,pen="",opt="")
1975
2217
  # @param [MglData] x
1976
2218
  # @param [MglData] y
@@ -1978,6 +2220,7 @@ end
1978
2220
  # @param [String] pen default=""
1979
2221
  # @param [String] opt default=""
1980
2222
  # @return [nil]
2223
+ #
1981
2224
  # @overload error(x,y,ex,ey,pen="",opt="")
1982
2225
  # @param [MglData] x
1983
2226
  # @param [MglData] y
@@ -1992,12 +2235,14 @@ end
1992
2235
 
1993
2236
  # 1D plotting.
1994
2237
  # 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
2238
+ #
1995
2239
  # @overload mark(y,r,pen="",opt="")
1996
2240
  # @param [MglData] y
1997
2241
  # @param [MglData] r
1998
2242
  # @param [String] pen default=""
1999
2243
  # @param [String] opt default=""
2000
2244
  # @return [nil]
2245
+ #
2001
2246
  # @overload mark(x,y,r,pen="",opt="")
2002
2247
  # @param [MglData] x
2003
2248
  # @param [MglData] y
@@ -2005,6 +2250,7 @@ end
2005
2250
  # @param [String] pen default=""
2006
2251
  # @param [String] opt default=""
2007
2252
  # @return [nil]
2253
+ #
2008
2254
  # @overload mark(x,y,z,r,pen="",opt="")
2009
2255
  # @param [MglData] x
2010
2256
  # @param [MglData] y
@@ -2019,12 +2265,14 @@ end
2019
2265
 
2020
2266
  # 1D plotting.
2021
2267
  # 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
2268
+ #
2022
2269
  # @overload text_mark(y,txt,fnt="",opt="")
2023
2270
  # @param [MglData] y
2024
2271
  # @param [String] txt
2025
2272
  # @param [String] fnt default=""
2026
2273
  # @param [String] opt default=""
2027
2274
  # @return [nil]
2275
+ #
2028
2276
  # @overload text_mark(y,r,txt,fnt="",opt="")
2029
2277
  # @param [MglData] y
2030
2278
  # @param [MglData] r
@@ -2032,6 +2280,7 @@ end
2032
2280
  # @param [String] fnt default=""
2033
2281
  # @param [String] opt default=""
2034
2282
  # @return [nil]
2283
+ #
2035
2284
  # @overload text_mark(x,y,r,txt,fnt="",opt="")
2036
2285
  # @param [MglData] x
2037
2286
  # @param [MglData] y
@@ -2040,6 +2289,7 @@ end
2040
2289
  # @param [String] fnt default=""
2041
2290
  # @param [String] opt default=""
2042
2291
  # @return [nil]
2292
+ #
2043
2293
  # @overload text_mark(x,y,z,r,txt,fnt="",opt="")
2044
2294
  # @param [MglData] x
2045
2295
  # @param [MglData] y
@@ -2055,12 +2305,14 @@ end
2055
2305
 
2056
2306
  # 1D plotting.
2057
2307
  # 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
2308
+ #
2058
2309
  # @overload label(y,txt,fnt="",opt="")
2059
2310
  # @param [MglData] y
2060
2311
  # @param [String] txt
2061
2312
  # @param [String] fnt default=""
2062
2313
  # @param [String] opt default=""
2063
2314
  # @return [nil]
2315
+ #
2064
2316
  # @overload label(x,y,txt,fnt="",opt="")
2065
2317
  # @param [MglData] x
2066
2318
  # @param [MglData] y
@@ -2068,6 +2320,7 @@ end
2068
2320
  # @param [String] fnt default=""
2069
2321
  # @param [String] opt default=""
2070
2322
  # @return [nil]
2323
+ #
2071
2324
  # @overload label(x,y,z,txt,fnt="",opt="")
2072
2325
  # @param [MglData] x
2073
2326
  # @param [MglData] y
@@ -2082,12 +2335,14 @@ end
2082
2335
 
2083
2336
  # 1D plotting.
2084
2337
  # 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
2338
+ #
2085
2339
  # @overload table(val,txt,fnt="",opt="")
2086
2340
  # @param [MglData] val
2087
2341
  # @param [String] txt
2088
2342
  # @param [String] fnt default=""
2089
2343
  # @param [String] opt default=""
2090
2344
  # @return [nil]
2345
+ #
2091
2346
  # @overload table(x,y,val,txt,fnt="",opt="")
2092
2347
  # @param [Float] x
2093
2348
  # @param [Float] y
@@ -2102,18 +2357,21 @@ end
2102
2357
 
2103
2358
  # 1D plotting.
2104
2359
  # 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
2360
+ #
2105
2361
  # @overload tube(y,r,pen="",opt="")
2106
2362
  # @param [MglData] y
2107
2363
  # @param [MglData] r
2108
2364
  # @param [String] pen default=""
2109
2365
  # @param [String] opt default=""
2110
2366
  # @return [nil]
2367
+ #
2111
2368
  # @overload tube(y,r,pen="",opt="")
2112
2369
  # @param [MglData] y
2113
2370
  # @param [Float] r
2114
2371
  # @param [String] pen default=""
2115
2372
  # @param [String] opt default=""
2116
2373
  # @return [nil]
2374
+ #
2117
2375
  # @overload tube(x,y,r,pen="",opt="")
2118
2376
  # @param [MglData] x
2119
2377
  # @param [MglData] y
@@ -2121,6 +2379,7 @@ end
2121
2379
  # @param [String] pen default=""
2122
2380
  # @param [String] opt default=""
2123
2381
  # @return [nil]
2382
+ #
2124
2383
  # @overload tube(x,y,r,pen="",opt="")
2125
2384
  # @param [MglData] x
2126
2385
  # @param [MglData] y
@@ -2128,6 +2387,7 @@ end
2128
2387
  # @param [String] pen default=""
2129
2388
  # @param [String] opt default=""
2130
2389
  # @return [nil]
2390
+ #
2131
2391
  # @overload tube(x,y,z,r,pen="",opt="")
2132
2392
  # @param [MglData] x
2133
2393
  # @param [MglData] y
@@ -2136,6 +2396,7 @@ end
2136
2396
  # @param [String] pen default=""
2137
2397
  # @param [String] opt default=""
2138
2398
  # @return [nil]
2399
+ #
2139
2400
  # @overload tube(x,y,z,r,pen="",opt="")
2140
2401
  # @param [MglData] x
2141
2402
  # @param [MglData] y
@@ -2150,6 +2411,7 @@ end
2150
2411
 
2151
2412
  # 1D plotting.
2152
2413
  # 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
2414
+ #
2153
2415
  # @overload torus(r,z,pen="",opt="")
2154
2416
  # @param [MglData] r
2155
2417
  # @param [MglData] z
@@ -2162,11 +2424,13 @@ end
2162
2424
 
2163
2425
  # 2D plotting.
2164
2426
  # 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
2427
+ #
2165
2428
  # @overload surf(z,sch="",opt="")
2166
2429
  # @param [MglData] z
2167
2430
  # @param [String] sch default=""
2168
2431
  # @param [String] opt default=""
2169
2432
  # @return [nil]
2433
+ #
2170
2434
  # @overload surf(x,y,z,sch="",opt="")
2171
2435
  # @param [MglData] x
2172
2436
  # @param [MglData] y
@@ -2180,11 +2444,13 @@ end
2180
2444
 
2181
2445
  # 2D plotting.
2182
2446
  # 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
2447
+ #
2183
2448
  # @overload mesh(z,sch="",opt="")
2184
2449
  # @param [MglData] z
2185
2450
  # @param [String] sch default=""
2186
2451
  # @param [String] opt default=""
2187
2452
  # @return [nil]
2453
+ #
2188
2454
  # @overload mesh(x,y,z,sch="",opt="")
2189
2455
  # @param [MglData] x
2190
2456
  # @param [MglData] y
@@ -2198,11 +2464,13 @@ end
2198
2464
 
2199
2465
  # 2D plotting.
2200
2466
  # 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
2467
+ #
2201
2468
  # @overload fall(z,sch="",opt="")
2202
2469
  # @param [MglData] z
2203
2470
  # @param [String] sch default=""
2204
2471
  # @param [String] opt default=""
2205
2472
  # @return [nil]
2473
+ #
2206
2474
  # @overload fall(x,y,z,sch="",opt="")
2207
2475
  # @param [MglData] x
2208
2476
  # @param [MglData] y
@@ -2216,11 +2484,13 @@ end
2216
2484
 
2217
2485
  # 2D plotting.
2218
2486
  # 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
2487
+ #
2219
2488
  # @overload belt(z,sch="",opt="")
2220
2489
  # @param [MglData] z
2221
2490
  # @param [String] sch default=""
2222
2491
  # @param [String] opt default=""
2223
2492
  # @return [nil]
2493
+ #
2224
2494
  # @overload belt(x,y,z,sch="",opt="")
2225
2495
  # @param [MglData] x
2226
2496
  # @param [MglData] y
@@ -2234,11 +2504,13 @@ end
2234
2504
 
2235
2505
  # 2D plotting.
2236
2506
  # 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
2507
+ #
2237
2508
  # @overload boxs(z,sch="",opt="")
2238
2509
  # @param [MglData] z
2239
2510
  # @param [String] sch default=""
2240
2511
  # @param [String] opt default=""
2241
2512
  # @return [nil]
2513
+ #
2242
2514
  # @overload boxs(x,y,z,sch="",opt="")
2243
2515
  # @param [MglData] x
2244
2516
  # @param [MglData] y
@@ -2252,11 +2524,13 @@ end
2252
2524
 
2253
2525
  # 2D plotting.
2254
2526
  # 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
2527
+ #
2255
2528
  # @overload tile(z,sch="",opt="")
2256
2529
  # @param [MglData] z
2257
2530
  # @param [String] sch default=""
2258
2531
  # @param [String] opt default=""
2259
2532
  # @return [nil]
2533
+ #
2260
2534
  # @overload tile(x,y,z,sch="",opt="")
2261
2535
  # @param [MglData] x
2262
2536
  # @param [MglData] y
@@ -2270,12 +2544,14 @@ end
2270
2544
 
2271
2545
  # 2D plotting.
2272
2546
  # 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
2547
+ #
2273
2548
  # @overload dens(z,sch="",opt="",zval=NAN)
2274
2549
  # @param [MglData] z
2275
2550
  # @param [String] sch default=""
2276
2551
  # @param [String] opt default=""
2277
2552
  # @param [Float] zval default=NAN
2278
2553
  # @return [nil]
2554
+ #
2279
2555
  # @overload dens(x,y,z,sch="",opt="",zval=NAN)
2280
2556
  # @param [MglData] x
2281
2557
  # @param [MglData] y
@@ -2290,12 +2566,14 @@ end
2290
2566
 
2291
2567
  # 2D plotting.
2292
2568
  # 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
2569
+ #
2293
2570
  # @overload cont(v,z,sch="",opt="")
2294
2571
  # @param [MglData] v
2295
2572
  # @param [MglData] z
2296
2573
  # @param [String] sch default=""
2297
2574
  # @param [String] opt default=""
2298
2575
  # @return [nil]
2576
+ #
2299
2577
  # @overload cont(v,x,y,z,sch="",opt="")
2300
2578
  # @param [MglData] v
2301
2579
  # @param [MglData] x
@@ -2310,11 +2588,13 @@ end
2310
2588
 
2311
2589
  # 2D plotting.
2312
2590
  # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 7).
2591
+ #
2313
2592
  # @overload cont(z,sch="",opt="")
2314
2593
  # @param [MglData] z
2315
2594
  # @param [String] sch default=""
2316
2595
  # @param [String] opt default=""
2317
2596
  # @return [nil]
2597
+ #
2318
2598
  # @overload cont(x,y,z,sch="",opt="")
2319
2599
  # @param [MglData] x
2320
2600
  # @param [MglData] y
@@ -2328,12 +2608,14 @@ end
2328
2608
 
2329
2609
  # 2D plotting.
2330
2610
  # 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
2611
+ #
2331
2612
  # @overload cont_f(v,z,sch="",opt="")
2332
2613
  # @param [MglData] v
2333
2614
  # @param [MglData] z
2334
2615
  # @param [String] sch default=""
2335
2616
  # @param [String] opt default=""
2336
2617
  # @return [nil]
2618
+ #
2337
2619
  # @overload cont_f(v,x,y,z,sch="",opt="")
2338
2620
  # @param [MglData] v
2339
2621
  # @param [MglData] x
@@ -2348,11 +2630,13 @@ end
2348
2630
 
2349
2631
  # 2D plotting.
2350
2632
  # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 7).
2633
+ #
2351
2634
  # @overload cont_f(z,sch="",opt="")
2352
2635
  # @param [MglData] z
2353
2636
  # @param [String] sch default=""
2354
2637
  # @param [String] opt default=""
2355
2638
  # @return [nil]
2639
+ #
2356
2640
  # @overload cont_f(x,y,z,sch="",opt="")
2357
2641
  # @param [MglData] x
2358
2642
  # @param [MglData] y
@@ -2366,12 +2650,14 @@ end
2366
2650
 
2367
2651
  # 2D plotting.
2368
2652
  # 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
2653
+ #
2369
2654
  # @overload cont_d(v,z,sch="",opt="")
2370
2655
  # @param [MglData] v
2371
2656
  # @param [MglData] z
2372
2657
  # @param [String] sch default=""
2373
2658
  # @param [String] opt default=""
2374
2659
  # @return [nil]
2660
+ #
2375
2661
  # @overload cont_d(v,x,y,z,sch="",opt="")
2376
2662
  # @param [MglData] v
2377
2663
  # @param [MglData] x
@@ -2386,11 +2672,13 @@ end
2386
2672
 
2387
2673
  # 2D plotting.
2388
2674
  # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 7).
2675
+ #
2389
2676
  # @overload cont_d(z,sch="",opt="")
2390
2677
  # @param [MglData] z
2391
2678
  # @param [String] sch default=""
2392
2679
  # @param [String] opt default=""
2393
2680
  # @return [nil]
2681
+ #
2394
2682
  # @overload cont_d(x,y,z,sch="",opt="")
2395
2683
  # @param [MglData] x
2396
2684
  # @param [MglData] y
@@ -2404,12 +2692,14 @@ end
2404
2692
 
2405
2693
  # 2D plotting.
2406
2694
  # 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
2695
+ #
2407
2696
  # @overload cont_v(v,z,sch="",opt="")
2408
2697
  # @param [MglData] v
2409
2698
  # @param [MglData] z
2410
2699
  # @param [String] sch default=""
2411
2700
  # @param [String] opt default=""
2412
2701
  # @return [nil]
2702
+ #
2413
2703
  # @overload cont_v(v,x,y,z,sch="",opt="")
2414
2704
  # @param [MglData] v
2415
2705
  # @param [MglData] x
@@ -2424,11 +2714,13 @@ end
2424
2714
 
2425
2715
  # 2D plotting.
2426
2716
  # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 7).
2717
+ #
2427
2718
  # @overload cont_v(z,sch="",opt="")
2428
2719
  # @param [MglData] z
2429
2720
  # @param [String] sch default=""
2430
2721
  # @param [String] opt default=""
2431
2722
  # @return [nil]
2723
+ #
2432
2724
  # @overload cont_v(x,y,z,sch="",opt="")
2433
2725
  # @param [MglData] x
2434
2726
  # @param [MglData] y
@@ -2442,12 +2734,14 @@ end
2442
2734
 
2443
2735
  # 2D plotting.
2444
2736
  # 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
2737
+ #
2445
2738
  # @overload axial(v,z,sch="",opt="")
2446
2739
  # @param [MglData] v
2447
2740
  # @param [MglData] z
2448
2741
  # @param [String] sch default=""
2449
2742
  # @param [String] opt default=""
2450
2743
  # @return [nil]
2744
+ #
2451
2745
  # @overload axial(v,x,y,z,sch="",opt="")
2452
2746
  # @param [MglData] v
2453
2747
  # @param [MglData] x
@@ -2462,12 +2756,14 @@ end
2462
2756
 
2463
2757
  # 2D plotting.
2464
2758
  # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 3).
2759
+ #
2465
2760
  # @overload axial(z,sch="",opt="",num=3)
2466
2761
  # @param [MglData] z
2467
2762
  # @param [String] sch default=""
2468
2763
  # @param [String] opt default=""
2469
2764
  # @param [Integer] num default=3
2470
2765
  # @return [nil]
2766
+ #
2471
2767
  # @overload axial(x,y,z,sch="",opt="",num=3)
2472
2768
  # @param [MglData] x
2473
2769
  # @param [MglData] y
@@ -2482,11 +2778,13 @@ end
2482
2778
 
2483
2779
  # 2D plotting.
2484
2780
  # 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.
2781
+ #
2485
2782
  # @overload grid(z,sch="",opt="")
2486
2783
  # @param [MglData] z
2487
2784
  # @param [String] sch default=""
2488
2785
  # @param [String] opt default=""
2489
2786
  # @return [nil]
2787
+ #
2490
2788
  # @overload grid(x,y,z,sch="",opt="")
2491
2789
  # @param [MglData] x
2492
2790
  # @param [MglData] y
@@ -2500,12 +2798,14 @@ end
2500
2798
 
2501
2799
  # 3D plotting.
2502
2800
  # 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
2801
+ #
2503
2802
  # @overload surf3(val,a,sch="",opt="")
2504
2803
  # @param [Float] val
2505
2804
  # @param [MglData] a
2506
2805
  # @param [String] sch default=""
2507
2806
  # @param [String] opt default=""
2508
2807
  # @return [nil]
2808
+ #
2509
2809
  # @overload surf3(val,x,y,z,a,sch="",opt="")
2510
2810
  # @param [Float] val
2511
2811
  # @param [MglData] x
@@ -2521,11 +2821,13 @@ end
2521
2821
 
2522
2822
  # 3D plotting.
2523
2823
  # Draws num-th uniformly distributed in color range isosurfaces for 3d data. Here num is equal to parameter value in options opt (default is 3).
2824
+ #
2524
2825
  # @overload surf3(a,sch="",opt="")
2525
2826
  # @param [MglData] a
2526
2827
  # @param [String] sch default=""
2527
2828
  # @param [String] opt default=""
2528
2829
  # @return [nil]
2830
+ #
2529
2831
  # @overload surf3(x,y,z,a,sch="",opt="")
2530
2832
  # @param [MglData] x
2531
2833
  # @param [MglData] y
@@ -2540,11 +2842,13 @@ end
2540
2842
 
2541
2843
  # 3D plotting.
2542
2844
  # 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
2845
+ #
2543
2846
  # @overload cloud(a,sch="",opt="")
2544
2847
  # @param [MglData] a
2545
2848
  # @param [String] sch default=""
2546
2849
  # @param [String] opt default=""
2547
2850
  # @return [nil]
2851
+ #
2548
2852
  # @overload cloud(x,y,z,a,sch="",opt="")
2549
2853
  # @param [MglData] x
2550
2854
  # @param [MglData] y
@@ -2559,12 +2863,14 @@ end
2559
2863
 
2560
2864
  # 3D plotting.
2561
2865
  # 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
2866
+ #
2562
2867
  # @overload dens3(a,sch="",sval=-1,opt="")
2563
2868
  # @param [MglData] a
2564
2869
  # @param [String] sch default=""
2565
2870
  # @param [Float] sval default=-1
2566
2871
  # @param [String] opt default=""
2567
2872
  # @return [nil]
2873
+ #
2568
2874
  # @overload dens3(x,y,z,a,sch="",sval=-1,opt="")
2569
2875
  # @param [MglData] x
2570
2876
  # @param [MglData] y
@@ -2580,6 +2886,7 @@ end
2580
2886
 
2581
2887
  # 3D plotting.
2582
2888
  # 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
2889
+ #
2583
2890
  # @overload cont3(v,a,sch="",sval=-1,opt="")
2584
2891
  # @param [MglData] v
2585
2892
  # @param [MglData] a
@@ -2587,6 +2894,7 @@ end
2587
2894
  # @param [Float] sval default=-1
2588
2895
  # @param [String] opt default=""
2589
2896
  # @return [nil]
2897
+ #
2590
2898
  # @overload cont3(v,x,y,z,a,sch="",sval=-1,opt="")
2591
2899
  # @param [MglData] v
2592
2900
  # @param [MglData] x
@@ -2603,6 +2911,7 @@ end
2603
2911
 
2604
2912
  # 3D plotting.
2605
2913
  # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 7).
2914
+ #
2606
2915
  # @overload cont3(a,sch="",sval=-1,opt="",opt="")
2607
2916
  # @param [MglData] a
2608
2917
  # @param [String] sch default=""
@@ -2610,6 +2919,7 @@ end
2610
2919
  # @param [String] opt default=""
2611
2920
  # @param [String] opt default=""
2612
2921
  # @return [nil]
2922
+ #
2613
2923
  # @overload cont3(x,y,z,a,sch="",sval=-1,opt="")
2614
2924
  # @param [MglData] x
2615
2925
  # @param [MglData] y
@@ -2625,6 +2935,7 @@ end
2625
2935
 
2626
2936
  # 3D plotting.
2627
2937
  # 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
2938
+ #
2628
2939
  # @overload contf3(v,a,sch="",sval=-1,opt="")
2629
2940
  # @param [MglData] v
2630
2941
  # @param [MglData] a
@@ -2632,6 +2943,7 @@ end
2632
2943
  # @param [Float] sval default=-1
2633
2944
  # @param [String] opt default=""
2634
2945
  # @return [nil]
2946
+ #
2635
2947
  # @overload contf3(v,x,y,z,a,sch="",sval=-1,opt="")
2636
2948
  # @param [MglData] v
2637
2949
  # @param [MglData] x
@@ -2648,6 +2960,7 @@ end
2648
2960
 
2649
2961
  # 3D plotting.
2650
2962
  # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 7).
2963
+ #
2651
2964
  # @overload contf3(a,sch="",sval=-1,opt="",opt="")
2652
2965
  # @param [MglData] a
2653
2966
  # @param [String] sch default=""
@@ -2655,6 +2968,7 @@ end
2655
2968
  # @param [String] opt default=""
2656
2969
  # @param [String] opt default=""
2657
2970
  # @return [nil]
2971
+ #
2658
2972
  # @overload contf3(x,y,z,a,sch="",sval=-1,opt="")
2659
2973
  # @param [MglData] x
2660
2974
  # @param [MglData] y
@@ -2670,12 +2984,14 @@ end
2670
2984
 
2671
2985
  # 3D plotting.
2672
2986
  # 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.
2987
+ #
2673
2988
  # @overload grid3(a,sch="",sval=-1,opt="")
2674
2989
  # @param [MglData] a
2675
2990
  # @param [String] sch default=""
2676
2991
  # @param [Float] sval default=-1
2677
2992
  # @param [String] opt default=""
2678
2993
  # @return [nil]
2994
+ #
2679
2995
  # @overload grid3(x,y,z,a,sch="",sval=-1,opt="")
2680
2996
  # @param [MglData] x
2681
2997
  # @param [MglData] y
@@ -2691,6 +3007,7 @@ end
2691
3007
 
2692
3008
  # 3D plotting.
2693
3009
  # 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.
3010
+ #
2694
3011
  # @overload beam(tr,g1,g2,a,r,stl="",flag=0,num=3)
2695
3012
  # @param [MglData] tr
2696
3013
  # @param [MglData] g1
@@ -2701,6 +3018,7 @@ end
2701
3018
  # @param [Integer] flag default=0
2702
3019
  # @param [Integer] num default=3
2703
3020
  # @return [nil]
3021
+ #
2704
3022
  # @overload beam(val,tr,g1,g2,a,r,stl="",flag=0)
2705
3023
  # @param [Float] val
2706
3024
  # @param [MglData] tr
@@ -2717,12 +3035,14 @@ end
2717
3035
 
2718
3036
  # Dual plotting.
2719
3037
  # 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
3038
+ #
2720
3039
  # @overload surf_c(z,c,sch="",opt="")
2721
3040
  # @param [MglData] z
2722
3041
  # @param [MglData] c
2723
3042
  # @param [String] sch default=""
2724
3043
  # @param [String] opt default=""
2725
3044
  # @return [nil]
3045
+ #
2726
3046
  # @overload surf_c(x,y,z,c,sch="",opt="")
2727
3047
  # @param [MglData] x
2728
3048
  # @param [MglData] y
@@ -2737,6 +3057,7 @@ end
2737
3057
 
2738
3058
  # Dual plotting.
2739
3059
  # 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
3060
+ #
2740
3061
  # @overload surf_3c(val,a,c,sch="",opt="")
2741
3062
  # @param [Float] val
2742
3063
  # @param [MglData] a
@@ -2744,6 +3065,7 @@ end
2744
3065
  # @param [String] sch default=""
2745
3066
  # @param [String] opt default=""
2746
3067
  # @return [nil]
3068
+ #
2747
3069
  # @overload surf_3c(val,x,y,z,a,c,sch="",opt="")
2748
3070
  # @param [Float] val
2749
3071
  # @param [MglData] x
@@ -2760,12 +3082,14 @@ end
2760
3082
 
2761
3083
  # Dual plotting.
2762
3084
  # Draws num-th uniformly distributed in color range isosurfaces for 3d data. Here num is equal to parameter value in options opt (default is 3).
3085
+ #
2763
3086
  # @overload surf_3c(a,c,sch="",opt="")
2764
3087
  # @param [MglData] a
2765
3088
  # @param [MglData] c
2766
3089
  # @param [String] sch default=""
2767
3090
  # @param [String] opt default=""
2768
3091
  # @return [nil]
3092
+ #
2769
3093
  # @overload surf_3c(x,y,z,a,c,sch="",opt="")
2770
3094
  # @param [MglData] x
2771
3095
  # @param [MglData] y
@@ -2781,12 +3105,14 @@ end
2781
3105
 
2782
3106
  # Dual plotting.
2783
3107
  # 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
3108
+ #
2784
3109
  # @overload surf_a(z,c,sch="",opt="")
2785
3110
  # @param [MglData] z
2786
3111
  # @param [MglData] c
2787
3112
  # @param [String] sch default=""
2788
3113
  # @param [String] opt default=""
2789
3114
  # @return [nil]
3115
+ #
2790
3116
  # @overload surf_a(x,y,z,c,sch="",opt="")
2791
3117
  # @param [MglData] x
2792
3118
  # @param [MglData] y
@@ -2801,6 +3127,7 @@ end
2801
3127
 
2802
3128
  # Dual plotting.
2803
3129
  # 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
3130
+ #
2804
3131
  # @overload surf_3a(val,a,c,sch="",opt="")
2805
3132
  # @param [Float] val
2806
3133
  # @param [MglData] a
@@ -2808,6 +3135,7 @@ end
2808
3135
  # @param [String] sch default=""
2809
3136
  # @param [String] opt default=""
2810
3137
  # @return [nil]
3138
+ #
2811
3139
  # @overload surf_3a(val,x,y,z,a,c,sch="",opt="")
2812
3140
  # @param [Float] val
2813
3141
  # @param [MglData] x
@@ -2824,12 +3152,14 @@ end
2824
3152
 
2825
3153
  # Dual plotting.
2826
3154
  # Draws num-th uniformly distributed in color range isosurfaces for 3d data. At this array c can be vector with values of transparency and num=c.nx. In opposite case num is equal to parameter value in options opt (default is 3).
3155
+ #
2827
3156
  # @overload surf_3a(a,c,sch="",opt="")
2828
3157
  # @param [MglData] a
2829
3158
  # @param [MglData] c
2830
3159
  # @param [String] sch default=""
2831
3160
  # @param [String] opt default=""
2832
3161
  # @return [nil]
3162
+ #
2833
3163
  # @overload surf_3a(x,y,z,a,c,sch="",opt="")
2834
3164
  # @param [MglData] x
2835
3165
  # @param [MglData] y
@@ -2845,12 +3175,14 @@ end
2845
3175
 
2846
3176
  # Dual plotting.
2847
3177
  # 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
3178
+ #
2848
3179
  # @overload tile_s(z,c,sch="",opt="")
2849
3180
  # @param [MglData] z
2850
3181
  # @param [MglData] c
2851
3182
  # @param [String] sch default=""
2852
3183
  # @param [String] opt default=""
2853
3184
  # @return [nil]
3185
+ #
2854
3186
  # @overload tile_s(x,y,z,r,sch="",opt="")
2855
3187
  # @param [MglData] x
2856
3188
  # @param [MglData] y
@@ -2865,12 +3197,14 @@ end
2865
3197
 
2866
3198
  # Dual plotting.
2867
3199
  # 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
3200
+ #
2868
3201
  # @overload map(ax,ay,sch="",opt="")
2869
3202
  # @param [MglData] ax
2870
3203
  # @param [MglData] ay
2871
3204
  # @param [String] sch default=""
2872
3205
  # @param [String] opt default=""
2873
3206
  # @return [nil]
3207
+ #
2874
3208
  # @overload map(x,y,ax,ay,sch="",opt="")
2875
3209
  # @param [MglData] x
2876
3210
  # @param [MglData] y
@@ -2885,6 +3219,7 @@ end
2885
3219
 
2886
3220
  # Dual plotting.
2887
3221
  # 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
3222
+ #
2888
3223
  # @overload stfa(re,im,dn,sch="",opt="")
2889
3224
  # @param [MglData] re
2890
3225
  # @param [MglData] im
@@ -2892,6 +3227,7 @@ end
2892
3227
  # @param [String] sch default=""
2893
3228
  # @param [String] opt default=""
2894
3229
  # @return [nil]
3230
+ #
2895
3231
  # @overload stfa(x,y,re,im,dn,sch="",opt="")
2896
3232
  # @param [MglData] x
2897
3233
  # @param [MglData] y
@@ -2907,6 +3243,7 @@ end
2907
3243
 
2908
3244
  # Vector fields.
2909
3245
  # 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
3246
+ #
2910
3247
  # @overload traj(x,y,ax,ay,sch="",opt="")
2911
3248
  # @param [MglData] x
2912
3249
  # @param [MglData] y
@@ -2915,6 +3252,7 @@ end
2915
3252
  # @param [String] sch default=""
2916
3253
  # @param [String] opt default=""
2917
3254
  # @return [nil]
3255
+ #
2918
3256
  # @overload traj(x,y,z,ax,ay,az,sch="",opt="")
2919
3257
  # @param [MglData] x
2920
3258
  # @param [MglData] y
@@ -2932,12 +3270,14 @@ end
2932
3270
  # Vector fields.
2933
3271
  # 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
3272
  # See also flow, dew. Vect sample
3273
+ #
2935
3274
  # @overload vect(ax,ay,sch="",opt="")
2936
3275
  # @param [MglData] ax
2937
3276
  # @param [MglData] ay
2938
3277
  # @param [String] sch default=""
2939
3278
  # @param [String] opt default=""
2940
3279
  # @return [nil]
3280
+ #
2941
3281
  # @overload vect(x,y,ax,ay,sch="",opt="")
2942
3282
  # @param [MglData] x
2943
3283
  # @param [MglData] y
@@ -2952,6 +3292,7 @@ end
2952
3292
 
2953
3293
  # Vector fields.
2954
3294
  # 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).
3295
+ #
2955
3296
  # @overload vect(ax,ay,az,sch="",opt="")
2956
3297
  # @param [MglData] ax
2957
3298
  # @param [MglData] ay
@@ -2959,6 +3300,7 @@ end
2959
3300
  # @param [String] sch default=""
2960
3301
  # @param [String] opt default=""
2961
3302
  # @return [nil]
3303
+ #
2962
3304
  # @overload vect(x,y,z,ax,ay,az,sch="",opt="")
2963
3305
  # @param [MglData] x
2964
3306
  # @param [MglData] y
@@ -2976,6 +3318,7 @@ end
2976
3318
  # Vector fields.
2977
3319
  # 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
3320
  # See also vect, flow, dew. Vect3 sample
3321
+ #
2979
3322
  # @overload vect3(ax,ay,az,sch="",sval=-1,opt="")
2980
3323
  # @param [MglData] ax
2981
3324
  # @param [MglData] ay
@@ -2984,6 +3327,7 @@ end
2984
3327
  # @param [Float] sval default=-1
2985
3328
  # @param [String] opt default=""
2986
3329
  # @return [nil]
3330
+ #
2987
3331
  # @overload vect3(x,y,z,ax,ay,az,sch="",sval=-1,opt="")
2988
3332
  # @param [MglData] x
2989
3333
  # @param [MglData] y
@@ -3001,12 +3345,14 @@ end
3001
3345
 
3002
3346
  # Vector fields.
3003
3347
  # 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
3348
+ #
3004
3349
  # @overload dew(ax,ay,sch="",opt="")
3005
3350
  # @param [MglData] ax
3006
3351
  # @param [MglData] ay
3007
3352
  # @param [String] sch default=""
3008
3353
  # @param [String] opt default=""
3009
3354
  # @return [nil]
3355
+ #
3010
3356
  # @overload dew(x,y,ax,ay,sch="",opt="")
3011
3357
  # @param [MglData] x
3012
3358
  # @param [MglData] y
@@ -3022,12 +3368,14 @@ end
3022
3368
  # Vector fields.
3023
3369
  # 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:
3024
3370
  # See also pipe, vect, tape, barwidth. Flow sample
3371
+ #
3025
3372
  # @overload flow(ax,ay,sch="",opt="")
3026
3373
  # @param [MglData] ax
3027
3374
  # @param [MglData] ay
3028
3375
  # @param [String] sch default=""
3029
3376
  # @param [String] opt default=""
3030
3377
  # @return [nil]
3378
+ #
3031
3379
  # @overload flow(x,y,ax,ay,sch="",opt="")
3032
3380
  # @param [MglData] x
3033
3381
  # @param [MglData] y
@@ -3042,6 +3390,7 @@ end
3042
3390
 
3043
3391
  # Vector fields.
3044
3392
  # 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).
3393
+ #
3045
3394
  # @overload flow(ax,ay,az,sch="",opt="")
3046
3395
  # @param [MglData] ax
3047
3396
  # @param [MglData] ay
@@ -3049,6 +3398,7 @@ end
3049
3398
  # @param [String] sch default=""
3050
3399
  # @param [String] opt default=""
3051
3400
  # @return [nil]
3401
+ #
3052
3402
  # @overload flow(x,y,z,ax,ay,az,sch="",opt="")
3053
3403
  # @param [MglData] x
3054
3404
  # @param [MglData] y
@@ -3065,6 +3415,7 @@ end
3065
3415
 
3066
3416
  # Vector fields.
3067
3417
  # The same as first one (flow) but draws single flow thread starting from point p0=(x0,y0,z0).
3418
+ #
3068
3419
  # @overload flow_p(p0,ax,ay,sch="",opt="")
3069
3420
  # @param [MglPoint] p0
3070
3421
  # @param [MglData] ax
@@ -3072,6 +3423,7 @@ end
3072
3423
  # @param [String] sch default=""
3073
3424
  # @param [String] opt default=""
3074
3425
  # @return [nil]
3426
+ #
3075
3427
  # @overload flow_p(p0,x,y,ax,ay,sch="",opt="")
3076
3428
  # @param [MglPoint] p0
3077
3429
  # @param [MglData] x
@@ -3087,6 +3439,7 @@ end
3087
3439
 
3088
3440
  # Vector fields.
3089
3441
  # This is 3D version of the previous functions.
3442
+ #
3090
3443
  # @overload flow_p(p0,ax,ay,az,sch="",opt="")
3091
3444
  # @param [MglPoint] p0
3092
3445
  # @param [MglData] ax
@@ -3095,6 +3448,7 @@ end
3095
3448
  # @param [String] sch default=""
3096
3449
  # @param [String] opt default=""
3097
3450
  # @return [nil]
3451
+ #
3098
3452
  # @overload flow_p(p0,x,y,z,ax,ay,az,sch="",opt="")
3099
3453
  # @param [MglPoint] p0
3100
3454
  # @param [MglData] x
@@ -3112,11 +3466,13 @@ end
3112
3466
 
3113
3467
  # Vector fields.
3114
3468
  # 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.
3469
+ #
3115
3470
  # @overload grad(phi,sch="",opt="")
3116
3471
  # @param [MglData] phi
3117
3472
  # @param [String] sch default=""
3118
3473
  # @param [String] opt default=""
3119
3474
  # @return [nil]
3475
+ #
3120
3476
  # @overload grad(x,y,phi,sch="",opt="")
3121
3477
  # @param [MglData] x
3122
3478
  # @param [MglData] y
@@ -3124,6 +3480,7 @@ end
3124
3480
  # @param [String] sch default=""
3125
3481
  # @param [String] opt default=""
3126
3482
  # @return [nil]
3483
+ #
3127
3484
  # @overload grad(x,y,z,phi,sch="",opt="")
3128
3485
  # @param [MglData] x
3129
3486
  # @param [MglData] y
@@ -3138,6 +3495,7 @@ end
3138
3495
 
3139
3496
  # Vector fields.
3140
3497
  # 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
3498
+ #
3141
3499
  # @overload pipe(ax,ay,sch="",r0=0.05,opt="")
3142
3500
  # @param [MglData] ax
3143
3501
  # @param [MglData] ay
@@ -3145,6 +3503,7 @@ end
3145
3503
  # @param [Float] r0 default=0.05
3146
3504
  # @param [String] opt default=""
3147
3505
  # @return [nil]
3506
+ #
3148
3507
  # @overload pipe(x,y,ax,ay,sch="",r0=0.05,opt="")
3149
3508
  # @param [MglData] x
3150
3509
  # @param [MglData] y
@@ -3160,6 +3519,7 @@ end
3160
3519
 
3161
3520
  # Vector fields.
3162
3521
  # 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).
3522
+ #
3163
3523
  # @overload pipe(ax,ay,az,sch="",r0=0.05,opt="")
3164
3524
  # @param [MglData] ax
3165
3525
  # @param [MglData] ay
@@ -3168,6 +3528,7 @@ end
3168
3528
  # @param [Float] r0 default=0.05
3169
3529
  # @param [String] opt default=""
3170
3530
  # @return [nil]
3531
+ #
3171
3532
  # @overload pipe(x,y,z,ax,ay,az,sch="",r0=0.05,opt="")
3172
3533
  # @param [MglData] x
3173
3534
  # @param [MglData] y
@@ -3185,54 +3546,85 @@ end
3185
3546
 
3186
3547
  # Other plotting.
3187
3548
  # 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
3549
+ #
3188
3550
  # @overload dens_x(a,stl="",sval=NAN,opt="")
3189
3551
  # @param [MglData] a
3190
3552
  # @param [String] stl default=""
3191
3553
  # @param [Float] sval default=NAN
3192
3554
  # @param [String] opt default=""
3193
3555
  # @return [nil]
3556
+ def dens_x
3557
+ end
3558
+
3559
+
3560
+ # Other plotting.
3561
+ # 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
3562
+ #
3194
3563
  # @overload dens_y(a,stl="",sval=NAN,opt="")
3195
3564
  # @param [MglData] a
3196
3565
  # @param [String] stl default=""
3197
3566
  # @param [Float] sval default=NAN
3198
3567
  # @param [String] opt default=""
3199
3568
  # @return [nil]
3569
+ def dens_y
3570
+ end
3571
+
3572
+
3573
+ # Other plotting.
3574
+ # 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
3575
+ #
3200
3576
  # @overload dens_z(a,stl="",sval=NAN,opt="")
3201
3577
  # @param [MglData] a
3202
3578
  # @param [String] stl default=""
3203
3579
  # @param [Float] sval default=NAN
3204
3580
  # @param [String] opt default=""
3205
3581
  # @return [nil]
3206
- def dens_x
3582
+ def dens_z
3207
3583
  end
3208
3584
 
3209
3585
 
3210
3586
  # Other plotting.
3211
3587
  # 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
3588
+ #
3212
3589
  # @overload cont_x(a,stl="",sval=NAN,opt="")
3213
3590
  # @param [MglData] a
3214
3591
  # @param [String] stl default=""
3215
3592
  # @param [Float] sval default=NAN
3216
3593
  # @param [String] opt default=""
3217
3594
  # @return [nil]
3595
+ def cont_x
3596
+ end
3597
+
3598
+
3599
+ # Other plotting.
3600
+ # 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
3601
+ #
3218
3602
  # @overload cont_y(a,stl="",sval=NAN,opt="")
3219
3603
  # @param [MglData] a
3220
3604
  # @param [String] stl default=""
3221
3605
  # @param [Float] sval default=NAN
3222
3606
  # @param [String] opt default=""
3223
3607
  # @return [nil]
3608
+ def cont_y
3609
+ end
3610
+
3611
+
3612
+ # Other plotting.
3613
+ # 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
3614
+ #
3224
3615
  # @overload cont_z(a,stl="",sval=NAN,opt="")
3225
3616
  # @param [MglData] a
3226
3617
  # @param [String] stl default=""
3227
3618
  # @param [Float] sval default=NAN
3228
3619
  # @param [String] opt default=""
3229
3620
  # @return [nil]
3230
- def cont_x
3621
+ def cont_z
3231
3622
  end
3232
3623
 
3233
3624
 
3234
3625
  # Other plotting.
3235
3626
  # The same as previous with manual contour levels.
3627
+ #
3236
3628
  # @overload cont_x(v,a,stl="",sval=NAN,opt="")
3237
3629
  # @param [MglData] v
3238
3630
  # @param [MglData] a
@@ -3240,6 +3632,13 @@ end
3240
3632
  # @param [Float] sval default=NAN
3241
3633
  # @param [String] opt default=""
3242
3634
  # @return [nil]
3635
+ def cont_x
3636
+ end
3637
+
3638
+
3639
+ # Other plotting.
3640
+ # The same as previous with manual contour levels.
3641
+ #
3243
3642
  # @overload cont_y(v,a,stl="",sval=NAN,opt="")
3244
3643
  # @param [MglData] v
3245
3644
  # @param [MglData] a
@@ -3247,6 +3646,13 @@ end
3247
3646
  # @param [Float] sval default=NAN
3248
3647
  # @param [String] opt default=""
3249
3648
  # @return [nil]
3649
+ def cont_y
3650
+ end
3651
+
3652
+
3653
+ # Other plotting.
3654
+ # The same as previous with manual contour levels.
3655
+ #
3250
3656
  # @overload cont_z(v,a,stl="",sval=NAN,opt="")
3251
3657
  # @param [MglData] v
3252
3658
  # @param [MglData] a
@@ -3254,36 +3660,52 @@ end
3254
3660
  # @param [Float] sval default=NAN
3255
3661
  # @param [String] opt default=""
3256
3662
  # @return [nil]
3257
- def cont_x
3663
+ def cont_z
3258
3664
  end
3259
3665
 
3260
3666
 
3261
3667
  # Other plotting.
3262
3668
  # 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
3669
+ #
3263
3670
  # @overload cont_fx(a,stl="",sval=NAN,opt="")
3264
3671
  # @param [MglData] a
3265
3672
  # @param [String] stl default=""
3266
3673
  # @param [Float] sval default=NAN
3267
3674
  # @param [String] opt default=""
3268
3675
  # @return [nil]
3676
+ def cont_fx
3677
+ end
3678
+
3679
+
3680
+ # Other plotting.
3681
+ # 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
3682
+ #
3269
3683
  # @overload cont_fy(a,stl="",sval=NAN,opt="")
3270
3684
  # @param [MglData] a
3271
3685
  # @param [String] stl default=""
3272
3686
  # @param [Float] sval default=NAN
3273
3687
  # @param [String] opt default=""
3274
3688
  # @return [nil]
3689
+ def cont_fy
3690
+ end
3691
+
3692
+
3693
+ # Other plotting.
3694
+ # 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
3695
+ #
3275
3696
  # @overload cont_fz(a,stl="",sval=NAN,opt="")
3276
3697
  # @param [MglData] a
3277
3698
  # @param [String] stl default=""
3278
3699
  # @param [Float] sval default=NAN
3279
3700
  # @param [String] opt default=""
3280
3701
  # @return [nil]
3281
- def cont_fx
3702
+ def cont_fz
3282
3703
  end
3283
3704
 
3284
3705
 
3285
3706
  # Other plotting.
3286
3707
  # The same as previous with manual contour levels.
3708
+ #
3287
3709
  # @overload cont_fx(v,a,stl="",sval=NAN,opt="")
3288
3710
  # @param [MglData] v
3289
3711
  # @param [MglData] a
@@ -3291,6 +3713,13 @@ end
3291
3713
  # @param [Float] sval default=NAN
3292
3714
  # @param [String] opt default=""
3293
3715
  # @return [nil]
3716
+ def cont_fx
3717
+ end
3718
+
3719
+
3720
+ # Other plotting.
3721
+ # The same as previous with manual contour levels.
3722
+ #
3294
3723
  # @overload cont_fy(v,a,stl="",sval=NAN,opt="")
3295
3724
  # @param [MglData] v
3296
3725
  # @param [MglData] a
@@ -3298,6 +3727,13 @@ end
3298
3727
  # @param [Float] sval default=NAN
3299
3728
  # @param [String] opt default=""
3300
3729
  # @return [nil]
3730
+ def cont_fy
3731
+ end
3732
+
3733
+
3734
+ # Other plotting.
3735
+ # The same as previous with manual contour levels.
3736
+ #
3301
3737
  # @overload cont_fz(v,a,stl="",sval=NAN,opt="")
3302
3738
  # @param [MglData] v
3303
3739
  # @param [MglData] a
@@ -3305,12 +3741,13 @@ end
3305
3741
  # @param [Float] sval default=NAN
3306
3742
  # @param [String] opt default=""
3307
3743
  # @return [nil]
3308
- def cont_fx
3744
+ def cont_fz
3309
3745
  end
3310
3746
 
3311
3747
 
3312
3748
  # Other plotting.
3313
3749
  # 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.
3750
+ #
3314
3751
  # @overload fplot(eqy,pen="",opt="")
3315
3752
  # @param [String] eqy
3316
3753
  # @param [String] pen default=""
@@ -3322,6 +3759,7 @@ end
3322
3759
 
3323
3760
  # Other plotting.
3324
3761
  # 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.
3762
+ #
3325
3763
  # @overload fplot(eqx,eqy,eqz,pen,opt="")
3326
3764
  # @param [String] eqx
3327
3765
  # @param [String] eqy
@@ -3335,6 +3773,7 @@ end
3335
3773
 
3336
3774
  # Other plotting.
3337
3775
  # 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.
3776
+ #
3338
3777
  # @overload fsurf(eqz,sch="",opt="")
3339
3778
  # @param [String] eqz
3340
3779
  # @param [String] sch default=""
@@ -3346,6 +3785,7 @@ end
3346
3785
 
3347
3786
  # Other plotting.
3348
3787
  # 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.
3788
+ #
3349
3789
  # @overload fsurf(eqx,eqy,eqz,sch="",opt="")
3350
3790
  # @param [String] eqx
3351
3791
  # @param [String] eqy
@@ -3359,6 +3799,7 @@ end
3359
3799
 
3360
3800
  # Other plotting.
3361
3801
  # 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
3802
+ #
3362
3803
  # @overload tri_plot(id,x,y,sch="",opt="")
3363
3804
  # @param [MglData] id
3364
3805
  # @param [MglData] x
@@ -3366,6 +3807,7 @@ end
3366
3807
  # @param [String] sch default=""
3367
3808
  # @param [String] opt default=""
3368
3809
  # @return [nil]
3810
+ #
3369
3811
  # @overload tri_plot(id,x,y,z,c,sch="",opt="")
3370
3812
  # @param [MglData] id
3371
3813
  # @param [MglData] x
@@ -3375,6 +3817,7 @@ end
3375
3817
  # @param [String] sch default=""
3376
3818
  # @param [String] opt default=""
3377
3819
  # @return [nil]
3820
+ #
3378
3821
  # @overload tri_plot(id,x,y,z,sch="",opt="")
3379
3822
  # @param [MglData] id
3380
3823
  # @param [MglData] x
@@ -3389,6 +3832,7 @@ end
3389
3832
 
3390
3833
  # Other plotting.
3391
3834
  # 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.
3835
+ #
3392
3836
  # @overload tri_cont(id,x,y,z,c,sch="",opt="")
3393
3837
  # @param [MglData] id
3394
3838
  # @param [MglData] x
@@ -3398,6 +3842,7 @@ end
3398
3842
  # @param [String] sch default=""
3399
3843
  # @param [String] opt default=""
3400
3844
  # @return [nil]
3845
+ #
3401
3846
  # @overload tri_cont(id,x,y,z,sch="",opt="")
3402
3847
  # @param [MglData] id
3403
3848
  # @param [MglData] x
@@ -3406,6 +3851,13 @@ end
3406
3851
  # @param [String] sch default=""
3407
3852
  # @param [String] opt default=""
3408
3853
  # @return [nil]
3854
+ def tri_cont
3855
+ end
3856
+
3857
+
3858
+ # Other plotting.
3859
+ # 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.
3860
+ #
3409
3861
  # @overload tri_cont_v(v,id,x,y,z,c,sch="",opt="")
3410
3862
  # @param [MglData] v
3411
3863
  # @param [MglData] id
@@ -3416,6 +3868,7 @@ end
3416
3868
  # @param [String] sch default=""
3417
3869
  # @param [String] opt default=""
3418
3870
  # @return [nil]
3871
+ #
3419
3872
  # @overload tri_cont_v(v,id,x,y,z,sch="",opt="")
3420
3873
  # @param [MglData] v
3421
3874
  # @param [MglData] id
@@ -3425,12 +3878,13 @@ end
3425
3878
  # @param [String] sch default=""
3426
3879
  # @param [String] opt default=""
3427
3880
  # @return [nil]
3428
- def tri_cont
3881
+ def tri_cont_v
3429
3882
  end
3430
3883
 
3431
3884
 
3432
3885
  # Other plotting.
3433
3886
  # 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
3887
+ #
3434
3888
  # @overload quad_plot(id,x,y,sch="",opt="")
3435
3889
  # @param [MglData] id
3436
3890
  # @param [MglData] x
@@ -3438,6 +3892,7 @@ end
3438
3892
  # @param [String] sch default=""
3439
3893
  # @param [String] opt default=""
3440
3894
  # @return [nil]
3895
+ #
3441
3896
  # @overload quad_plot(id,x,y,z,c,sch="",opt="")
3442
3897
  # @param [MglData] id
3443
3898
  # @param [MglData] x
@@ -3447,6 +3902,7 @@ end
3447
3902
  # @param [String] sch default=""
3448
3903
  # @param [String] opt default=""
3449
3904
  # @return [nil]
3905
+ #
3450
3906
  # @overload quad_plot(id,x,y,z,sch="",opt="")
3451
3907
  # @param [MglData] id
3452
3908
  # @param [MglData] x
@@ -3461,6 +3917,7 @@ end
3461
3917
 
3462
3918
  # Other plotting.
3463
3919
  # 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
3920
+ #
3464
3921
  # @overload dots(x,y,z,sch="",opt="")
3465
3922
  # @param [MglData] x
3466
3923
  # @param [MglData] y
@@ -3468,6 +3925,7 @@ end
3468
3925
  # @param [String] sch default=""
3469
3926
  # @param [String] opt default=""
3470
3927
  # @return [nil]
3928
+ #
3471
3929
  # @overload dots(x,y,z,a,sch="",opt="")
3472
3930
  # @param [MglData] x
3473
3931
  # @param [MglData] y
@@ -3482,6 +3940,7 @@ end
3482
3940
 
3483
3941
  # Other plotting.
3484
3942
  # 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
3943
+ #
3485
3944
  # @overload crust(x,y,z,sch="",opt="")
3486
3945
  # @param [MglData] x
3487
3946
  # @param [MglData] y
@@ -3495,6 +3954,7 @@ end
3495
3954
 
3496
3955
  # Nonlinear fitting.
3497
3956
  # 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).
3957
+ #
3498
3958
  # @overload fit_s(a,s,func,var,opt="")
3499
3959
  # @param [MglData] a
3500
3960
  # @param [MglData] s
@@ -3502,6 +3962,7 @@ end
3502
3962
  # @param [String] var
3503
3963
  # @param [String] opt default=""
3504
3964
  # @return [MglData]
3965
+ #
3505
3966
  # @overload fit_s(a,s,func,var,ini,opt="")
3506
3967
  # @param [MglData] a
3507
3968
  # @param [MglData] s
@@ -3510,6 +3971,7 @@ end
3510
3971
  # @param [MglData] ini
3511
3972
  # @param [String] opt default=""
3512
3973
  # @return [MglData]
3974
+ #
3513
3975
  # @overload fit_s(x,a,s,func,var,opt="")
3514
3976
  # @param [MglData] x
3515
3977
  # @param [MglData] a
@@ -3518,6 +3980,7 @@ end
3518
3980
  # @param [String] var
3519
3981
  # @param [String] opt default=""
3520
3982
  # @return [MglData]
3983
+ #
3521
3984
  # @overload fit_s(x,a,s,func,var,ini,opt="")
3522
3985
  # @param [MglData] x
3523
3986
  # @param [MglData] a
@@ -3527,6 +3990,7 @@ end
3527
3990
  # @param [MglData] ini
3528
3991
  # @param [String] opt default=""
3529
3992
  # @return [MglData]
3993
+ #
3530
3994
  # @overload fit_s(x,y,a,s,func,var,opt="")
3531
3995
  # @param [MglData] x
3532
3996
  # @param [MglData] y
@@ -3536,6 +4000,7 @@ end
3536
4000
  # @param [String] var
3537
4001
  # @param [String] opt default=""
3538
4002
  # @return [MglData]
4003
+ #
3539
4004
  # @overload fit_s(x,y,a,s,func,var,ini,opt="")
3540
4005
  # @param [MglData] x
3541
4006
  # @param [MglData] y
@@ -3546,6 +4011,7 @@ end
3546
4011
  # @param [MglData] ini
3547
4012
  # @param [String] opt default=""
3548
4013
  # @return [MglData]
4014
+ #
3549
4015
  # @overload fit_s(x,y,z,a,s,func,var,opt="")
3550
4016
  # @param [MglData] x
3551
4017
  # @param [MglData] y
@@ -3556,6 +4022,7 @@ end
3556
4022
  # @param [String] var
3557
4023
  # @param [String] opt default=""
3558
4024
  # @return [MglData]
4025
+ #
3559
4026
  # @overload fit_s(x,y,z,a,s,func,var,ini,opt="")
3560
4027
  # @param [MglData] x
3561
4028
  # @param [MglData] y
@@ -3573,12 +4040,14 @@ end
3573
4040
 
3574
4041
  # Nonlinear fitting.
3575
4042
  # 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.
4043
+ #
3576
4044
  # @overload fit(a,func,var,opt="")
3577
4045
  # @param [MglData] a
3578
4046
  # @param [String] func
3579
4047
  # @param [String] var
3580
4048
  # @param [String] opt default=""
3581
4049
  # @return [MglData]
4050
+ #
3582
4051
  # @overload fit(a,func,var,ini,opt="")
3583
4052
  # @param [MglData] a
3584
4053
  # @param [String] func
@@ -3586,6 +4055,7 @@ end
3586
4055
  # @param [MglData] ini
3587
4056
  # @param [String] opt default=""
3588
4057
  # @return [MglData]
4058
+ #
3589
4059
  # @overload fit(x,a,func,var,opt="")
3590
4060
  # @param [MglData] x
3591
4061
  # @param [MglData] a
@@ -3593,6 +4063,7 @@ end
3593
4063
  # @param [String] var
3594
4064
  # @param [String] opt default=""
3595
4065
  # @return [MglData]
4066
+ #
3596
4067
  # @overload fit(x,a,func,var,ini,opt="")
3597
4068
  # @param [MglData] x
3598
4069
  # @param [MglData] a
@@ -3601,6 +4072,7 @@ end
3601
4072
  # @param [MglData] ini
3602
4073
  # @param [String] opt default=""
3603
4074
  # @return [MglData]
4075
+ #
3604
4076
  # @overload fit(x,y,a,func,var,opt="")
3605
4077
  # @param [MglData] x
3606
4078
  # @param [MglData] y
@@ -3609,6 +4081,7 @@ end
3609
4081
  # @param [String] var
3610
4082
  # @param [String] opt default=""
3611
4083
  # @return [MglData]
4084
+ #
3612
4085
  # @overload fit(x,y,a,func,var,ini,opt="")
3613
4086
  # @param [MglData] x
3614
4087
  # @param [MglData] y
@@ -3618,6 +4091,7 @@ end
3618
4091
  # @param [MglData] ini
3619
4092
  # @param [String] opt default=""
3620
4093
  # @return [MglData]
4094
+ #
3621
4095
  # @overload fit(x,y,z,a,func,var,opt="")
3622
4096
  # @param [MglData] x
3623
4097
  # @param [MglData] y
@@ -3627,6 +4101,7 @@ end
3627
4101
  # @param [String] var
3628
4102
  # @param [String] opt default=""
3629
4103
  # @return [MglData]
4104
+ #
3630
4105
  # @overload fit(x,y,z,a,func,var,ini,opt="")
3631
4106
  # @param [MglData] x
3632
4107
  # @param [MglData] y
@@ -3643,12 +4118,14 @@ end
3643
4118
 
3644
4119
  # Nonlinear fitting.
3645
4120
  # Fit data along all directions for 2d or 3d arrays a with s=1 and x, y, z equidistantly distributed in interval (Min, Max).
4121
+ #
3646
4122
  # @overload fit2(a,func,var,opt="")
3647
4123
  # @param [MglData] a
3648
4124
  # @param [String] func
3649
4125
  # @param [String] var
3650
4126
  # @param [String] opt default=""
3651
4127
  # @return [MglData]
4128
+ #
3652
4129
  # @overload fit2(fit,a,func,var,ini,opt="")
3653
4130
  # @param [MglData] fit
3654
4131
  # @param [MglData] a
@@ -3657,6 +4134,13 @@ end
3657
4134
  # @param [MglData] ini
3658
4135
  # @param [String] opt default=""
3659
4136
  # @return [MglData]
4137
+ def fit2
4138
+ end
4139
+
4140
+
4141
+ # Nonlinear fitting.
4142
+ # Fit data along all directions for 2d or 3d arrays a with s=1 and x, y, z equidistantly distributed in interval (Min, Max).
4143
+ #
3660
4144
  # @overload fit3(fit,a,func,var,opt="")
3661
4145
  # @param [MglData] fit
3662
4146
  # @param [MglData] a
@@ -3664,6 +4148,7 @@ end
3664
4148
  # @param [String] var
3665
4149
  # @param [String] opt default=""
3666
4150
  # @return [MglData]
4151
+ #
3667
4152
  # @overload fit3(fit,a,func,var,ini,opt="")
3668
4153
  # @param [MglData] fit
3669
4154
  # @param [MglData] a
@@ -3672,12 +4157,13 @@ end
3672
4157
  # @param [MglData] ini
3673
4158
  # @param [String] opt default=""
3674
4159
  # @return [MglData]
3675
- def fit2
4160
+ def fit3
3676
4161
  end
3677
4162
 
3678
4163
 
3679
4164
  # Nonlinear fitting.
3680
4165
  # Print last fitted formula with found coefficients (as numbers) at position p0. The string prefix will be printed before formula. All other parameters are the same as in Text printing.
4166
+ #
3681
4167
  # @overload puts_fit(p,prefix="",font="",size=-1)
3682
4168
  # @param [MglPoint] p
3683
4169
  # @param [String] prefix default=""
@@ -3690,6 +4176,7 @@ end
3690
4176
 
3691
4177
  # Nonlinear fitting.
3692
4178
  # Get last fitted formula with found coefficients (as numbers).
4179
+ #
3693
4180
  # @overload get_fit()
3694
4181
  # @return [String]
3695
4182
  def get_fit
@@ -3698,17 +4185,20 @@ end
3698
4185
 
3699
4186
  # Data manipulation.
3700
4187
  # These functions make distribution (histogram) of data. They do not draw the obtained data themselves. These functions can be useful if user have data defined for random points (for example, after PIC simulation) and he want to produce a plot which require regular data (defined on grid(s)). The range for grids is always selected as axis range. Arrays x, y, z define the positions (coordinates) of random points. Array a define the data value. Number of points in output array res is selected as maximal value of res size and the value of mglFitPnts.
4188
+ #
3701
4189
  # @overload hist(x,a,opt="")
3702
4190
  # @param [MglData] x
3703
4191
  # @param [MglData] a
3704
4192
  # @param [String] opt default=""
3705
4193
  # @return [MglData]
4194
+ #
3706
4195
  # @overload hist(x,y,a,opt="")
3707
4196
  # @param [MglData] x
3708
4197
  # @param [MglData] y
3709
4198
  # @param [MglData] a
3710
4199
  # @param [String] opt default=""
3711
4200
  # @return [MglData]
4201
+ #
3712
4202
  # @overload hist(x,y,z,a,opt="")
3713
4203
  # @param [MglData] x
3714
4204
  # @param [MglData] y
@@ -3722,17 +4212,20 @@ end
3722
4212
 
3723
4213
  # Data manipulation.
3724
4214
  # 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).
4215
+ #
3725
4216
  # @overload fill(u,eq,opt="")
3726
4217
  # @param [MglData] u
3727
4218
  # @param [String] eq
3728
4219
  # @param [String] opt default=""
3729
4220
  # @return [nil]
4221
+ #
3730
4222
  # @overload fill(u,eq,v,opt="")
3731
4223
  # @param [MglData] u
3732
4224
  # @param [String] eq
3733
4225
  # @param [MglData] v
3734
4226
  # @param [String] opt default=""
3735
4227
  # @return [nil]
4228
+ #
3736
4229
  # @overload fill(u,eq,v,w,opt="")
3737
4230
  # @param [MglData] u
3738
4231
  # @param [String] eq
@@ -3746,6 +4239,7 @@ end
3746
4239
 
3747
4240
  # Data manipulation.
3748
4241
  # 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.
4242
+ #
3749
4243
  # @overload data_grid(u,x,y,z,opt="")
3750
4244
  # @param [MglData] u
3751
4245
  # @param [MglData] x
@@ -3759,6 +4253,7 @@ end
3759
4253
 
3760
4254
  # Data manipulation.
3761
4255
  # 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
4256
+ #
3762
4257
  # @overload pde(ham,ini_re,ini_im,dz=0.1,k0=100,opt="")
3763
4258
  # @param [String] ham
3764
4259
  # @param [MglData] ini_re
@@ -3773,3 +4268,4 @@ end
3773
4268
 
3774
4269
  end # MglGraph
3775
4270
 
4271
+ end