Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
View | Details | Raw Unified | Return to bug 465536
Collapse All | Expand All

(-)octave-3.6.4-orig/doc/interpreter/audio.texi (-8 / +8 lines)
Lines 146-163 Link Here
146
Load the RIFF/WAVE sound file @var{filename}, and return the samples
146
Load the RIFF/WAVE sound file @var{filename}, and return the samples
147
in vector @var{y}.  If the file contains multichannel data, then
147
in vector @var{y}.  If the file contains multichannel data, then
148
@var{y} is a matrix with the channels represented as columns.
148
@var{y} is a matrix with the channels represented as columns.
149
149
@end deftypefn
150
@deftypefnx {Function File} {[@var{y}, @var{Fs}, @var{bps}] =} wavread (@var{filename})
150
@deftypefn {Function File} {[@var{y}, @var{Fs}, @var{bps}] =} wavread (@var{filename})
151
Additionally return the sample rate (@var{fs}) in Hz and the number of bits
151
Additionally return the sample rate (@var{fs}) in Hz and the number of bits
152
per sample (@var{bps}).
152
per sample (@var{bps}).
153
153
@end deftypefn
154
@deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, @var{n})
154
@deftypefn {Function File} {[@dots{}] =} wavread (@var{filename}, @var{n})
155
Read only the first @var{n} samples from each channel.
155
Read only the first @var{n} samples from each channel.
156
156
@end deftypefn
157
@deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, @var{n1} @var{n2})
157
@deftypefn {Function File} {[@dots{}] =} wavread (@var{filename}, @var{n1} @var{n2})
158
Read only samples @var{n1} through @var{n2} from each channel.
158
Read only samples @var{n1} through @var{n2} from each channel.
159
159
@end deftypefn
160
@deftypefnx {Function File} {[@var{samples}, @var{channels}] =} wavread (@var{filename}, "size")
160
@deftypefn {Function File} {[@var{samples}, @var{channels}] =} wavread (@var{filename}, "size")
161
Return the number of samples (@var{n}) and channels (@var{ch})
161
Return the number of samples (@var{n}) and channels (@var{ch})
162
instead of the audio data.
162
instead of the audio data.
163
@seealso{@ref{doc-wavwrite,,wavwrite}}
163
@seealso{@ref{doc-wavwrite,,wavwrite}}
(-)octave-3.6.4-orig/doc/interpreter/io.texi (-6 / +6 lines)
Lines 1391-1412 Link Here
1391
for the file.  Valid values for @var{arch} are:
1391
for the file.  Valid values for @var{arch} are:
1392
1392
1393
@table @asis
1393
@table @asis
1394
@samp{native}
1394
@item @samp{native}
1395
The format of the current machine (this is the default).
1395
The format of the current machine (this is the default).
1396
1396
1397
@samp{ieee-be}
1397
@item @samp{ieee-be}
1398
IEEE big endian format.
1398
IEEE big endian format.
1399
1399
1400
@samp{ieee-le}
1400
@item @samp{ieee-le}
1401
IEEE little endian format.
1401
IEEE little endian format.
1402
1402
1403
@samp{vaxd}
1403
@item @samp{vaxd}
1404
VAX D floating format.
1404
VAX D floating format.
1405
1405
1406
@samp{vaxg}
1406
@item @samp{vaxg}
1407
VAX G floating format.
1407
VAX G floating format.
1408
1408
1409
@samp{cray}
1409
@item @samp{cray}
1410
Cray floating format.
1410
Cray floating format.
1411
@end table
1411
@end table
1412
1412
(-)octave-3.6.4-orig/doc/interpreter/octave.texi (-1 / +3 lines)
Lines 129-135 Link Here
129
@sp 2
129
@sp 2
130
@multitable @columnfractions 0.4 0.025 0.65
130
@multitable @columnfractions 0.4 0.025 0.65
131
@item
131
@item
132
@flushright @image{octave_logo,2.1in} @end flushright
132
@flushright
133
@image{octave_logo,2.1in}
134
@end flushright
133
@tab
135
@tab
134
@c this is a spacer column
136
@c this is a spacer column
135
@tab
137
@tab
(-)octave-3.6.4-orig/doc/interpreter/plot.texi (-28 / +27 lines)
Lines 2707-2727 Link Here
2707
Set the data aspect ratio of the current axes.  The aspect ratio is
2707
Set the data aspect ratio of the current axes.  The aspect ratio is
2708
a normalized 3-element vector representing the span of the x, y, and
2708
a normalized 3-element vector representing the span of the x, y, and
2709
z-axes limits.
2709
z-axes limits.
2710
2710
@end deftypefn
2711
@deftypefnx {Function File} {@var{data_aspect_ratio} =} daspect ( )
2711
@deftypefn {Function File} {@var{data_aspect_ratio} =} daspect ( )
2712
Return the data aspect ratio of the current axes.
2712
Return the data aspect ratio of the current axes.
2713
2713
@end deftypefn
2714
@deftypefnx {Function File} {} daspect (@var{mode})
2714
@deftypefn {Function File} {} daspect (@var{mode})
2715
Set the data aspect ratio mode of the current axes.
2715
Set the data aspect ratio mode of the current axes.
2716
2716
@end deftypefn
2717
@deftypefnx {Function File} {@var{data_aspect_ratio_mode} =} daspect ("mode")
2717
@deftypefn {Function File} {@var{data_aspect_ratio_mode} =} daspect ("mode")
2718
Return the data aspect ratio mode of the current axes.
2718
Return the data aspect ratio mode of the current axes.
2719
2719
@end deftypefn
2720
@deftypefnx {Function File} {} daspect (@var{hax}, @dots{})
2720
@deftypefn {Function File} {} daspect (@var{hax}, @dots{})
2721
Use the axes, with handle @var{hax}, instead of the current axes.
2721
Use the axes, with handle @var{hax}, instead of the current axes.
2722
2723
@seealso{@ref{doc-axis,,axis}, @ref{doc-pbaspect,,pbaspect}, @ref{doc-xlim,,xlim}, @ref{doc-ylim,,ylim}, @ref{doc-zlim,,zlim}}
2724
@end deftypefn
2722
@end deftypefn
2723
@seealso{@ref{doc-axis,,axis}, @ref{doc-pbaspect,,pbaspect}, @ref{doc-xlim,,xlim}, @ref{doc-ylim,,ylim}, @ref{doc-zlim,,zlim}}
2725
2724
2726
2725
2727
@c pbaspect scripts/plot/pbaspect.m
2726
@c pbaspect scripts/plot/pbaspect.m
Lines 2730-2750 Link Here
2730
Set the plot box aspect ratio of the current axes.  The aspect ratio
2729
Set the plot box aspect ratio of the current axes.  The aspect ratio
2731
is a normalized 3-element vector representing the rendered lengths of
2730
is a normalized 3-element vector representing the rendered lengths of
2732
the x, y, and z-axes.
2731
the x, y, and z-axes.
2733
2732
@end deftypefn
2734
@deftypefnx {Function File} {@var{plot_box_aspect_ratio} =} pbaspect ( )
2733
@deftypefn {Function File} {@var{plot_box_aspect_ratio} =} pbaspect ( )
2735
Return the plot box aspect ratio of the current axes.
2734
Return the plot box aspect ratio of the current axes.
2736
2735
@end deftypefn
2737
@deftypefnx {Function File} {} pbaspect (@var{mode})
2736
@deftypefn {Function File} {} pbaspect (@var{mode})
2738
Set the plot box aspect ratio mode of the current axes.
2737
Set the plot box aspect ratio mode of the current axes.
2739
2738
@end deftypefn
2740
@deftypefnx {Function File} {@var{plot_box_aspect_ratio_mode} =} pbaspect ("mode")
2739
@deftypefn {Function File} {@var{plot_box_aspect_ratio_mode} =} pbaspect ("mode")
2741
Return the plot box aspect ratio mode of the current axes.
2740
Return the plot box aspect ratio mode of the current axes.
2742
2741
@end deftypefn
2743
@deftypefnx {Function File} {} pbaspect (@var{hax}, @dots{})
2742
@deftypefn {Function File} {} pbaspect (@var{hax}, @dots{})
2744
Use the axes, with handle @var{hax}, instead of the current axes.
2743
Use the axes, with handle @var{hax}, instead of the current axes.
2745
2746
@seealso{@ref{doc-axis,,axis}, @ref{doc-daspect,,daspect}, @ref{doc-xlim,,xlim}, @ref{doc-ylim,,ylim}, @ref{doc-zlim,,zlim}}
2747
@end deftypefn
2744
@end deftypefn
2745
@seealso{@ref{doc-axis,,axis}, @ref{doc-daspect,,daspect}, @ref{doc-xlim,,xlim}, @ref{doc-ylim,,ylim}, @ref{doc-zlim,,zlim}}
2748
2746
2749
2747
2750
@node Three-dimensional Function Plotting
2748
@node Three-dimensional Function Plotting
Lines 3147-3153 Link Here
3147
@item "hide"
3145
@item "hide"
3148
  Hide legend on the plot
3146
  Hide legend on the plot
3149
3147
3150
@itemx "toggle"
3148
@item "toggle"
3151
  Toggles between "hide" and "show"
3149
  Toggles between "hide" and "show"
3152
3150
3153
@item "boxon"
3151
@item "boxon"
Lines 3162-3168 Link Here
3162
@item "right"
3160
@item "right"
3163
  Place text to the right of the keys
3161
  Place text to the right of the keys
3164
3162
3165
@itemx "off"
3163
@item "off"
3166
  Delete the legend object
3164
  Delete the legend object
3167
@end table
3165
@end table
3168
@end deftypefn
3166
@end deftypefn
Lines 4139-4149 Link Here
4139
is sent to a file the size is determined by the plot box defined by
4137
is sent to a file the size is determined by the plot box defined by
4140
the figure's "paperposition" property.
4138
the figure's "paperposition" property.
4141
4139
4142
@itemx -append
4140
@item -append
4143
  Appends the PS, or PDF output to a pre-existing file of the
4141
  Appends the PS, or PDF output to a pre-existing file of the
4144
same type.
4142
same type.
4145
4143
4146
@itemx -r@var{NUM}
4144
@item -r@var{NUM}
4147
  Resolution of bitmaps in pixels per inch.  For both metafiles and
4145
  Resolution of bitmaps in pixels per inch.  For both metafiles and
4148
SVG the default is the screen resolution, for other it is 150 dpi.
4146
SVG the default is the screen resolution, for other it is 150 dpi.
4149
To specify screen resolution, use "-r0".
4147
To specify screen resolution, use "-r0".
Lines 6296-6310 Link Here
6296
A character indicating a plot marker to be place at each data point, or
6294
A character indicating a plot marker to be place at each data point, or
6297
@code{"none"}, meaning no markers should be displayed.
6295
@code{"none"}, meaning no markers should be displayed.
6298
6296
6299
@itemx markeredgecolor
6297
@item markeredgecolor
6300
The color of the edge around the marker, or @code{"auto"}, meaning that
6298
The color of the edge around the marker, or @code{"auto"}, meaning that
6301
the edge color is the same as the face color.  @xref{Colors}.
6299
the edge color is the same as the face color.  @xref{Colors}.
6302
6300
6303
@itemx markerfacecolor
6301
@item markerfacecolor
6304
The color of the marker, or @code{"none"} to indicate that the marker
6302
The color of the marker, or @code{"none"} to indicate that the marker
6305
should not be filled.  @xref{Colors}.
6303
should not be filled.  @xref{Colors}.
6306
6304
6307
@itemx markersize
6305
@item markersize
6308
A number specifying the size of the marker.  The default is 1.  A value
6306
A number specifying the size of the marker.  The default is 1.  A value
6309
of 2 is twice as large as the default, etc.
6307
of 2 is twice as large as the default, etc.
6310
@end table
6308
@end table
Lines 6442-6448 Link Here
6442
@deftypefn {Function File} {@var{value} =} getappdata (@var{h}, @var{name})
6440
@deftypefn {Function File} {@var{value} =} getappdata (@var{h}, @var{name})
6443
Return the @var{value} for named application data for the object(s) with
6441
Return the @var{value} for named application data for the object(s) with
6444
handle(s) @var{h}.
6442
handle(s) @var{h}.
6445
@deftypefnx {Function File} {@var{appdata} =} getappdata (@var{h})
6443
@end deftypefn
6444
@deftypefn {Function File} {@var{appdata} =} getappdata (@var{h})
6446
Return a structure, @var{appdata}, whose fields correspond to the appdata
6445
Return a structure, @var{appdata}, whose fields correspond to the appdata
6447
properties.
6446
properties.
6448
@end deftypefn
6447
@end deftypefn
(-)octave-3.6.4-orig/doc/interpreter/poly.texi (-2 / +2 lines)
Lines 82-89 Link Here
82
(@var{x}-@var{mu}(1))/@var{mu}(2).
82
(@var{x}-@var{mu}(1))/@var{mu}(2).
83
If @var{x} is a vector or matrix, the polynomial is evaluated for each of
83
If @var{x} is a vector or matrix, the polynomial is evaluated for each of
84
the elements of @var{x}.
84
the elements of @var{x}.
85
85
@end deftypefn
86
@deftypefnx {Function File} {[@var{y}, @var{dy}] =} polyval (@var{p}, @var{x}, @var{s})
86
@deftypefn {Function File} {[@var{y}, @var{dy}] =} polyval (@var{p}, @var{x}, @var{s})
87
@deftypefnx {Function File} {[@var{y}, @var{dy}] =} polyval (@var{p}, @var{x}, @var{s}, @var{mu})
87
@deftypefnx {Function File} {[@var{y}, @var{dy}] =} polyval (@var{p}, @var{x}, @var{s}, @var{mu})
88
In addition to evaluating the polynomial, the second output
88
In addition to evaluating the polynomial, the second output
89
represents the prediction interval, @var{y} +/- @var{dy}, which
89
represents the prediction interval, @var{y} +/- @var{dy}, which
(-)octave-3.6.4-orig/doc/interpreter/set.texi (-1 / +2 lines)
Lines 150-157 Link Here
150
       3   4
150
       3   4
151
@end group
151
@end group
152
@end example
152
@end example
153
@end deftypefn
153
154
154
@deftypefnx {Function File} {[@var{c}, @var{ia}, @var{ib}] =} union (@var{a}, @var{b})
155
@deftypefn {Function File} {[@var{c}, @var{ia}, @var{ib}] =} union (@var{a}, @var{b})
155
156
156
Return index vectors @var{ia} and @var{ib} such that @code{a(ia)} and
157
Return index vectors @var{ia} and @var{ib} such that @code{a(ia)} and
157
@code{b(ib)} are disjoint sets whose union is @var{c}.
158
@code{b(ib)} are disjoint sets whose union is @var{c}.
(-)octave-3.6.4-orig/doc/interpreter/signal.texi (-6 / +6 lines)
Lines 454-470 Link Here
454
454
455
For fastest computation, @var{n} should factor into a small number of
455
For fastest computation, @var{n} should factor into a small number of
456
small primes.
456
small primes.
457
457
@end deftypefn
458
@deftypefnx {Function File} {@var{h} =} freqz (@var{b}, @var{a}, @var{w})
458
@deftypefn {Function File} {@var{h} =} freqz (@var{b}, @var{a}, @var{w})
459
Evaluate the response at the specific frequencies in the vector @var{w}.
459
Evaluate the response at the specific frequencies in the vector @var{w}.
460
The values for @var{w} are measured in radians.
460
The values for @var{w} are measured in radians.
461
461
@end deftypefn
462
@deftypefnx {Function File} {[@dots{}] =} freqz (@dots{}, @var{Fs})
462
@deftypefn {Function File} {[@dots{}] =} freqz (@dots{}, @var{Fs})
463
Return frequencies in Hz instead of radians assuming a sampling rate
463
Return frequencies in Hz instead of radians assuming a sampling rate
464
@var{Fs}.  If you are evaluating the response at specific frequencies
464
@var{Fs}.  If you are evaluating the response at specific frequencies
465
@var{w}, those frequencies should be requested in Hz rather than radians.
465
@var{w}, those frequencies should be requested in Hz rather than radians.
466
466
@end deftypefn
467
@deftypefnx {Function File} {} freqz (@dots{})
467
@deftypefn {Function File} {} freqz (@dots{})
468
Plot the pass band, stop band and phase response of @var{h} rather
468
Plot the pass band, stop band and phase response of @var{h} rather
469
than returning them.
469
than returning them.
470
@end deftypefn
470
@end deftypefn
(-)octave-3.6.4-orig/doc/interpreter/strings.texi (-1 / +1 lines)
Lines 1136-1142 Link Here
1136
@item %s
1136
@item %s
1137
The word is parsed as a string.
1137
The word is parsed as a string.
1138
1138
1139
@itemx %f
1139
@item %f
1140
@itemx %n
1140
@itemx %n
1141
The word is parsed as a number and converted to double.
1141
The word is parsed as a number and converted to double.
1142
1142
(-)octave-3.6.4-orig/doc/interpreter/system.texi (-19 / +20 lines)
Lines 839-845 Link Here
839
@deftypefnx {Function File} {} datetick (@var{axis}, @var{form})
839
@deftypefnx {Function File} {} datetick (@var{axis}, @var{form})
840
@deftypefnx {Function File} {} datetick (@dots{}, "keeplimits")
840
@deftypefnx {Function File} {} datetick (@dots{}, "keeplimits")
841
@deftypefnx {Function File} {} datetick (@dots{}, "keepticks")
841
@deftypefnx {Function File} {} datetick (@dots{}, "keepticks")
842
@deftypefnx {Function File} {} datetick (@dots{ax}, @dots{})
842
@comment @deftypefnx {Function File} {} datetick (@dots{ax}, @dots{})
843
Add date formatted tick labels to an axis.  The axis the apply the
843
Add date formatted tick labels to an axis.  The axis the apply the
844
ticks to is determined by @var{axis} that can take the values "x",
844
ticks to is determined by @var{axis} that can take the values "x",
845
"y" or "z".  The default value is "x".  The formatting of the labels is
845
"y" or "z".  The default value is "x".  The formatting of the labels is
Lines 1261-1269 Link Here
1261
interpreted as filename globbing patterns (as they are used by Unix shells).
1261
interpreted as filename globbing patterns (as they are used by Unix shells).
1262
Within a pattern
1262
Within a pattern
1263
@table @code
1263
@table @code
1264
@itemx *
1264
1265
@item *
1265
matches any string, including the null string,
1266
matches any string, including the null string,
1266
@itemx ?
1267
@item ?
1267
matches any single character, and
1268
matches any single character, and
1268
1269
1269
@item [@dots{}]
1270
@item [@dots{}]
Lines 2789-2796 Link Here
2789
Display a header containing the current Octave version number, license
2790
Display a header containing the current Octave version number, license
2790
string and operating system, followed by the installed package names,
2791
string and operating system, followed by the installed package names,
2791
versions, and installation directories.
2792
versions, and installation directories.
2792
2793
@end deftypefn
2793
@deftypefnx {Function File} {v =} ver ()
2794
@deftypefn {Function File} {v =} ver ()
2794
Return a vector of structures, respecting Octave and each installed package.
2795
Return a vector of structures, respecting Octave and each installed package.
2795
The structure includes the following fields.
2796
The structure includes the following fields.
2796
2797
Lines 2807-2817 Link Here
2807
@item Date
2808
@item Date
2808
Date respecting the version/revision.
2809
Date respecting the version/revision.
2809
@end table
2810
@end table
2810
2811
@end deftypefn
2811
@deftypefnx {Function File} {v =} ver ("Octave")
2812
@deftypefn {Function File} {v =} ver ("Octave")
2812
Return version information for Octave only.
2813
Return version information for Octave only.
2813
2814
@end deftypefn
2814
@deftypefnx {Function File} {v =} ver (@var{package})
2815
@deftypefn {Function File} {v =} ver (@var{package})
2815
Return version information for @var{package}.
2816
Return version information for @var{package}.
2816
2817
2817
@seealso{@ref{doc-version,,version}, @ref{doc-octave_config_info,,octave_config_info}}
2818
@seealso{@ref{doc-version,,version}, @ref{doc-octave_config_info,,octave_config_info}}
Lines 2878-2896 Link Here
2878
@anchor{doc-license}
2879
@anchor{doc-license}
2879
@deftypefn {Function File} {} license
2880
@deftypefn {Function File} {} license
2880
Display the license of Octave.
2881
Display the license of Octave.
2881
2882
@end deftypefn
2882
@deftypefnx {Function File} {} license ("inuse")
2883
@deftypefn {Function File} {} license ("inuse")
2883
Display a list of packages currently being used.
2884
Display a list of packages currently being used.
2884
2885
@end deftypefn
2885
@deftypefnx {Function File} {@var{retval} =} license ("inuse")
2886
@deftypefn {Function File} {@var{retval} =} license ("inuse")
2886
Return a structure containing the fields @code{feature} and @code{user}.
2887
Return a structure containing the fields @code{feature} and @code{user}.
2887
2888
@end deftypefn
2888
@deftypefnx {Function File} {@var{retval} =} license ("test", @var{feature})
2889
@deftypefn {Function File} {@var{retval} =} license ("test", @var{feature})
2889
Return 1 if a license exists for the product identified by the string
2890
Return 1 if a license exists for the product identified by the string
2890
@var{feature} and 0 otherwise.  The argument @var{feature} is case
2891
@var{feature} and 0 otherwise.  The argument @var{feature} is case
2891
insensitive and only the first 27 characters are checked.
2892
insensitive and only the first 27 characters are checked.
2892
2893
@end deftypefn
2893
@deftypefnx {Function File} {} license ("test", @var{feature}, @var{toggle})
2894
@deftypefn {Function File} {} license ("test", @var{feature}, @var{toggle})
2894
Enable or disable license testing for @var{feature}, depending on
2895
Enable or disable license testing for @var{feature}, depending on
2895
@var{toggle}, which may be one of:
2896
@var{toggle}, which may be one of:
2896
2897
Lines 2902-2909 Link Here
2902
@item "disable"
2903
@item "disable"
2903
Future tests for the specified license of @var{feature} return 0.
2904
Future tests for the specified license of @var{feature} return 0.
2904
@end table
2905
@end table
2905
2906
@end deftypefn
2906
@deftypefnx {Function File} {@var{retval} =} license ("checkout", @var{feature})
2907
@deftypefn {Function File} {@var{retval} =} license ("checkout", @var{feature})
2907
Check out a license for @var{feature}, returning 1 on success and 0
2908
Check out a license for @var{feature}, returning 1 on success and 0
2908
on failure.
2909
on failure.
2909
2910

Return to bug 465536