"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "share/gretl_cli_fnref.en" between
gretl-2020a.tar.xz and gretl-2020b.tar.xz

About: gretl (Gnu Regression, Econometrics and Time-series Library) is a cross-platform statistical package mainly for econometric analysis.

gretl_cli_fnref.en  (gretl-2020a.tar.xz):gretl_cli_fnref.en  (gretl-2020b.tar.xz)
skipping to change at line 2092 skipping to change at line 2092
For the inverse function, see "isodate" and also (for the Julian calendar) For the inverse function, see "isodate" and also (for the Julian calendar)
"juldate". "juldate".
# errmsg # errmsg
Output: string Output: string
Argument: errno (integer) Argument: errno (integer)
Retrieves the gretl error message associated with errno. See also "$error". Retrieves the gretl error message associated with errno. See also "$error".
# errorif
Output: scalar
Arguments: condition (boolean)
msg (string)
Applicable only in the context of a user-defined function. If condition
evaluates as non-zero, it causes execution of the current function to
terminate with an error condition flagged; the msg argument is then printed
as part of the message shown to the caller of the function in question.
The return value from this function (1) is purely nominal.
# exists # exists
Output: integer Output: integer
Argument: name (string) Argument: name (string)
Returns non-zero if name is the identifier for a currently defined object, Returns non-zero if name is the identifier for a currently defined object,
be it a scalar, a series, a matrix, list, string, bundle or array; otherwise be it a scalar, a series, a matrix, list, string, bundle or array; otherwise
returns 0. See also "typeof". returns 0. See also "typeof".
# exp # exp
Output: same type as input Output: same type as input
skipping to change at line 2437 skipping to change at line 2449
d (scalar) d (scalar)
Returns the fractional difference of order d for the series y. Returns the fractional difference of order d for the series y.
Note that in theory fractional differentiation is an infinitely long filter. Note that in theory fractional differentiation is an infinitely long filter.
In practice, presample values of y_t are assumed to be zero. In practice, presample values of y_t are assumed to be zero.
A negative value of d can be given, in which case fractional integration is A negative value of d can be given, in which case fractional integration is
performed. performed.
# funcerr
Output: scalar
Argument: message (string, optional)
Applicable only in the context of a user-defined function. Causes execution
of the current function to terminate with an error condition flagged.
If the optional message argument is provided it will be printed as part of
the error message shown to the caller of the function. This gives function
writers the chance to provide a more specific error message than would
otherwise be shown.
The return value from this function is purely nominal since invoking it
necessarily creates an error condition.
# fzero # fzero
Output: scalar Output: scalar
Arguments: fcall (function call) Arguments: fcall (function call)
init (scalar or vector, optional) init (scalar or vector, optional)
toler (scalar, optional) toler (scalar, optional)
Attempts to find a single root of a continuous (typically nonlinear) Attempts to find a single root of a continuous (typically nonlinear)
function f -- that is, a value of the scalar variable x such that f(x) = 0. function f -- that is, a value of the scalar variable x such that f(x) = 0.
The fcall argument should provide a call to the function in question; fcall The fcall argument should provide a call to the function in question; fcall
may include an arbitrary number of arguments but the first one must be the may include an arbitrary number of arguments but the first one must be the
skipping to change at line 4094 skipping to change at line 4091
matrix V will contain (a) the covariance matrix of the parameter estimates, matrix V will contain (a) the covariance matrix of the parameter estimates,
if Y has just one column, or (b) X'X^-1 if Y has multiple columns. if Y has just one column, or (b) X'X^-1 if Y has multiple columns.
By default, estimates are obtained via Cholesky decomposition, with a By default, estimates are obtained via Cholesky decomposition, with a
fallback to QR decomposition if the columns of X are highly collinear. The fallback to QR decomposition if the columns of X are highly collinear. The
use of SVD can be forced via the command set svd on. use of SVD can be forced via the command set svd on.
See also "mpols", "mrls". See also "mpols", "mrls".
# monthlen # monthlen
Output: integer Output: same type as input
Arguments: month (integer) Arguments: month (scalar or series)
year (integer) year (scalar or series)
weeklen (integer) weeklen (integer)
Returns the number of (relevant) days in the specified month in the Returns the number of (relevant) days in the specified month in the
specified year, on the proleptic Gregorian calendar; weeklen, which must specified year, on the proleptic Gregorian calendar. The weeklen argument,
equal 5, 6 or 7, gives the number of days in the week that should be counted which must equal 5, 6 or 7, gives the number of days in the week that should
(a value of 6 omits Sundays, and a value of 5 omits both Saturdays and be counted (a value of 6 omits Sundays, and a value of 5 omits both
Sundays). Saturdays and Sundays).
The return value is a scalar if both month and year are scalars, otherwise a
series.
For example, if you have a monthly dataset open, the call
series wd = monthlen($obsminor, $obsmajor, 5)
will return a series containing the number of working days for each month in
the sample.
# movavg # movavg
Output: series Output: series
Arguments: x (series) Arguments: x (series)
p (scalar) p (scalar)
control (integer, optional) control (integer, optional)
y0 (scalar, optional) y0 (scalar, optional)
Depending on the value of the parameter p, returns either a simple or an Depending on the value of the parameter p, returns either a simple or an
exponentially weighted moving average of the input series x. exponentially weighted moving average of the input series x.
skipping to change at line 4524 skipping to change at line 4531
handle, but it is not recommended if the matrix file is intended for handle, but it is not recommended if the matrix file is intended for
reading by gretl. reading by gretl.
Note that if the matrix file is to be read by a third-party program it is Note that if the matrix file is to be read by a third-party program it is
not advisable to use the gzip or binary options. But if the file is intended not advisable to use the gzip or binary options. But if the file is intended
for reading by gretl the alternative formats save space, and the binary for reading by gretl the alternative formats save space, and the binary
format allows for much faster reading of large matrices. The gzip format is format allows for much faster reading of large matrices. The gzip format is
not recommended for very large matrices, since decompression can be quite not recommended for very large matrices, since decompression can be quite
slow. slow.
See also "mread". See also "mread". And for writing a matrix to file as a dataset, see
"store".
# mxtab # mxtab
Output: matrix Output: matrix
Arguments: x (series or vector) Arguments: x (series or vector)
y (series or vector) y (series or vector)
Returns a matrix holding the cross tabulation of the values contained in x Returns a matrix holding the cross tabulation of the values contained in x
(by row) and y (by column). The two arguments should be of the same type (by row) and y (by column). The two arguments should be of the same type
(both series or both column vectors), and because of the typical usage of (both series or both column vectors), and because of the typical usage of
this function, are assumed to contain integer values only. this function, are assumed to contain integer values only.
skipping to change at line 6064 skipping to change at line 6072
sscanf(S, "%4m", m) sscanf(S, "%4m", m)
print m print m
# sst # sst
Output: scalar Output: scalar
Argument: y (series) Argument: y (series)
Returns the sum of squared deviations from the mean for the non-missing Returns the sum of squared deviations from the mean for the non-missing
observations in series y. See also "var". observations in series y. See also "var".
# stack
Output: series
Arguments: L (list)
n (integer)
offset (integer, optional)
Designed for manipulation of data into the stacked time series format
required by gretl for panel data. The return value is a series obtained by
stacking "vertically" n observations from each series in the list L. By
default the first n observations are used (corresponding to offset = 0) but
the starting point can be shifted by supplying a positive value for offset.
If the resulting series is longer than the existing dataset, observations
are added as needed.
This function can handle the case where a data file holds side-by-side time
series for a number of cross-sectional units, as well as the case where time
runs horizontally and each row represents a cross-sectional unit.
See the section titled "Panel data specifics" in chapter 4 of the Gretl
User's Guide for details and examples of usage.
# stdize # stdize
Output: same type as input Output: same type as input
Arguments: X (series, list or matrix) Arguments: X (series, list or matrix)
v (integer, optional) v (integer, optional)
By default, returns a standardized version of the series, list or matrix: By default, returns a standardized version of the series, list or matrix:
the input is centered and divided by its sample standard deviation (with a the input is centered and divided by its sample standard deviation (with a
degrees of freedom correction of 1). Results are computed by column in the degrees of freedom correction of 1). Results are computed by column in the
case of matrix input. case of matrix input.
skipping to change at line 6253 skipping to change at line 6282
expressions. expressions.
Example: Example:
string s1 = "Hello, Gretl!" string s1 = "Hello, Gretl!"
string s2 = strsub(s1, "Gretl", "Hansl") string s2 = strsub(s1, "Gretl", "Hansl")
print s2 print s2
# strvals # strvals
Output: array of strings Output: array of strings
Argument: y (series) Arguments: y (series)
subsample (boolean, optional)
If the series y is string-valued, returns by default an array containing all
its distinct values (irrespective of the current setting of the sample
range), ordered by the associated numerical values starting at 1. If the
dataset is currently subsampled you can give a non-zero value for the
optional second argument to obtain an array holding just the string values
present in the subsample.
If the series y is string-valued, returns an array containing all its If y is not string-valued an empty strings array is returned. See also
distinct values (irrespective of the current setting of the sample range), "stringify".
ordered by the associated numerical values starting at 1. If y is not
string-valued an empty strings array is returned. See also "stringify".
# substr # substr
Output: string Output: string
Arguments: s (string) Arguments: s (string)
start (integer) start (integer)
end (integer) end (integer)
Returns a substring of s, from the character with (1-based) index start to Returns a substring of s, from the character with (1-based) index start to
that with index end, inclusive. that with index end, inclusive.
 End of changes. 8 change blocks. 
28 lines changed or deleted 63 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)