gretl-common 2017d-3build1 / usr / share / gretl / gretl_cli_fnref.pt

## Accessors
# $ahat
Resultado:  série

Deve seguir a estimação de um modelo de dados em painel com efeitos fixos.
Retorna uma série com as estimativas dos efeitos individuais fixos
(interceptos por unidade).

# $aic
Resultado:  escalar

Retorna o Critério de Informação de Akaike do último modelo estimado,
quando disponível. Veja guia de utilização do Gretl (Capítulo 24) para
detalhes sobre os cálculos.

# $bic
Resultado:  escalar

Retorna o Critério de Informação Bayesiano de Schwarz para o último
modelo estimado, quando disponível. Veja guia de utilização do Gretl
(Capítulo 24) para detalhes sobre os cálculos.

# $chisq
Resultado:  escalar

Retorna estatística qui-quadrado global do último modelo estimado, quando
disponível.

# $coeff
Resultado:  matriz ou escalar
Argumento:  s (nome do coeficiente, opcional)

Quando utilizado sem argumentos, $coeff retorna um vetor coluna com os
coeficientes estimados do último modelo. Com o argumento opcional de texto
("string") a função retorna, na forma de um escalar, o parâmetro estimado
s. Ver também"$stderr", "$vcv".

Exemplo:

	  open bjg
	  arima 0 1 1 ; 0 1 1 ; lg
	  b = $coeff               # fornece um vetor
	  macoef = $coeff(theta_1) # fornece um escalar

Se o "modelo" em questão for um sistema, o resultado dependerá das
características do sistema: para VARs e VECMs o valor retornado será uma
matriz com uma coluna por equação, caso contrário será um vetor coluna
contendo os coeficientes da primeira equação seguidos pelos coeficientes
da segunda equação e assim sucessivamente.

# $command
Resultado:  texto

Deve ser utilizada após a estimação de um modelo e retorna o seu tipo,
por exemplo ols ou probit.

# $compan
Resultado:  matriz

Deve ser utilizada após a estimação de um VAR ou um VECM e retorna a
matriz companheira.

# $datatype
Resultado:  escalar

Retorna um número representando o tipo dos dados que estão sendo
atualmente utilizados: 0 = sem dados, 1 = dados de corte transversal (não
datados), 2 = dados de séries temporais, 3 = dados em painel.

# $depvar
Resultado:  texto

Deve ser utilizada após a estimação de um modelo com equação única e
retorna o nome da variável dependente.

# $df
Resultado:  escalar

Retorna os graus de liberdade do último modelo estimado. Se o último
modelo for um sistema de equações, o valor retornado será o número de
graus de liberdade por equação. Se os graus de liberdade das equações
forem diferentes então o valor dado será calculado como a diferença entre
o número de observações e a média do número de coeficientes por
equação (essa média será arredondada para o valor inteiro imediatamente
superior).

# $diagpval
Resultado:  escalar

Deve ser utilizada após a estimação de um sistema de equações e retorna
o P-valor associado com a estatística "$diagtest".

# $diagtest
Resultado:  escalar

Deve ser utilizada após a estimação de um sistema de equações. Retorna
a estatística de teste para a hipótese nula de que a matriz de
covariâncias dos resíduos das equações do sistema é diagonal. Este é o
teste de Breusch-Pagan, exceto quando o estimador for o SUR iterado
(irrestrito), nesse caso será um teste de razão de verossimilhança. Veja
guia de utilização do Gretl (Capítulo 30) para detalhes e também
"$diagpval".

# $dwpval
Resultado:  escalar

Retorna o p-valor para a estatística de Durbin-Watson do último modelo
estimado (quando disponível). É calculada via procedimento de Imhof.

Devido a precisão limitada da aritmética computacional, a integral de
Imhof pode se tornar negativa quando a estatística de Durbin-Watson estiver
próxima de seu limite inferior. Nesse caso o acessor retorna NA . Uma vez
que qualquer outra falha será sinalizada, é possivelmente seguro assumir
que um resultado NA indica que o verdadeiro p-valor é "muito pequeno",
embora não seja possível quantificá-lo.

# $ec
Resultado:  matriz

Deve ser utilizada após a estimação de um VECM e retorna uma matriz
contendo os termos de correção de erros. O número de linhas é igual ao
número de observações utilizadas e o número de colunas é igual à ordem
de cointegração do sistema.

# $error
Resultado:  escalar

Retorna o código interno de erro do programa. Esse código será um valor
não-nulo quando a função "catch" tiver sido utilizada. Note que o código
interno de erro irá retornar para zero quando este acessor for utilizado
novamente. Para consultar, posteriormente, a mensagem de erro associada a um
dado $error será necessário armazená-la em uma variável. Isso pode ser
feito da sequinte forma:

	  err = $error
	  if (err)
	      printf "Got error %d (%s)\n", err, errmsg(err);
	  endif

Ver também"catch", "errmsg".

# $ess
Resultado:  escalar

Retorna o erro da soma dos quadrados do último modelo estimado, quando
disponível.

# $evals
Resultado:  matriz

Deve ser utilizada após a estimação de um VECM e retorna um vetor
contendo os autovalores que foram utilizados no cálculo do teste traço
para verificação da cointegração.

# $fcast
Resultado:  matriz

Deve ser utilizada após o comando "fcast" e retorna os valores previstos na
forma de uma matriz. Se foi utilizado um sistema de equações para realizar
as previsões a matriz será composta por uma coluna para cada equação,
caso contrário será um vetor coluna.

# $fcse
Resultado:  matriz

Deve ser utilizada após o comando "fcast" e retorna os erros padrão das
previsões, quando disponíveis, na forma de uma matriz. Se foi utilizado um
sistema de equações para realizar as previsões a matriz será composta
por uma coluna para cada equação, caso contrário será um vetor coluna.

# $fevd
Resultado:  matriz

Deve ser utilizada após a estimação de um VAR e retorna uma matriz
contendo a decomposição da variância dos erros de previsão (FEVD, na
sigla em inglês). Essa matriz possui h linhas, ou seja, indica a quantidade
de períodos do horizonte de previsão que, por sua vez, pode ser escolhida
de forma manual via set horizon ou de forma automática com base na
frequência dos dados.

Para um VAR com p variáveis, a matriz possui p ^2 colunas: as primeiras p
colunas contém a FEVD para a primeira variável do VAR, as p colunas
seguintes contém a FEVD para a segunda variável do VAR e assim
sucessivamente. A fração (em termos decimais) do erro de previsão da
variável i causado por uma inovação na variável j é então encontrado
na coluna (i - 1) p + j.

# $Fstat
Resultado:  escalar

Retorna estatística F global do último modelo estimado, quando
disponível.

# $gmmcrit
Resultado:  escalar

Deve ser utilizada após um bloco gmm. Retorna o valor da função objetivo
GMM em seu mínimo.

# $h
Resultado:  série

Deve ser utilizada após o comando garch. Retorna a série da variância
condicional estimada.

# $hausman
Resultado:  vetor linha

Deve ser utilizada após a estimação de um modelo via tsls ou panel com a
opção de efeitos aleatórios. Retorna um vetor 1 x 3 contendo o valor da
estatística do teste de Hausman, os graus de liberdade correspondentes e o
p-valor para o teste, respectivamente.

# $hqc
Resultado:  escalar

Retorna o Critério de Informação de Hannan-Quinn para o último modelo
estimado, quando disponível. Veja guia de utilização do Gretl (Capítulo
24) para detalhes sobre os cálculos.

# $huge
Resultado:  escalar

Retorna um número positivo com valor bastante elevado. Por padrão é igual
a 1.0E100, mas pode ser alterado via comando "set".

# $jalpha
Resultado:  matriz

Deve ser utilizada após a estimação de um VECM e retorna a matriz de
cargas. O número de linhas dessa matriz é igual ao número de variáveis
do VECM e o número de colunas é igual a ordem de cointegração.

# $jbeta
Resultado:  matriz

Deve ser utilizada após a estimação de um VECM e retorna a matriz de
cointegração. O número de linhas dessa matriz é igual ao número de
variáveis no VECM (se existirem variáveis exógenas restritas ao espaço
de cointegração adiciona-se mais uma linha) e o número de colunas é
igual a ordem de cointegração.

# $jvbeta
Resultado:  matriz quadrada

Deve ser utilizada após a estimação de um VECM e retorna a matriz de
covariâncias estimada para os elementoss dos vetores de cointegração.

No caso de uma estimação sem restrições, o número de linhas dessa
matriz é igual ao número de elementos irrestritos do espaço de
cointegração após a normalização de Phillips. Entretanto, se for
estimado um sistema restrito via comando restrict com a opção --full, uma
matriz singular com (n+m)r linhas será retornada (sendo n o número de
variáveis endógenas, m o número de variáveis exógenas restritas ao
espaço de cointegração e r a ordem de cointegração).

Exemplo: o código

	  open denmark.gdt
	  vecm 2 1 LRM LRY IBO IDE --rc --seasonals -q
	  s0 = $jvbeta

	  restrict --full
	    b[1,1] = 1
	    b[1,2] = -1
	    b[1,3] + b[1,4] = 0
	  end restrict
	  s1 = $jvbeta

	  print s0
	  print s1

produz a seguinte saída.

	  s0 (4 x 4)

          0.019751     0.029816  -0.00044837     -0.12227
          0.029816      0.31005     -0.45823     -0.18526
	   -0.00044837     -0.45823       1.2169    -0.035437
          -0.12227     -0.18526    -0.035437      0.76062

	  s1 (5 x 5)

	  0.0000       0.0000       0.0000       0.0000       0.0000
	  0.0000       0.0000       0.0000       0.0000       0.0000
	  0.0000       0.0000      0.27398     -0.27398    -0.019059
	  0.0000       0.0000     -0.27398      0.27398     0.019059
	  0.0000       0.0000    -0.019059     0.019059    0.0014180

# $lang
Resultado:  texto

Retorna o texto ("string") com o código do idioma que está sendo utilizado
no momento, desde que este possa ser determinado. O texto é composto pelo
código ISO 639-1 com duas letras (por exemplo, en para inglês, jp para
japonês, el para grego) seguido de um sublinhado e o código do país de
acordo com o ISO 3166-1. Assim, por exemplo, o português de Portugal é
representado por pt_PT enquanto o português do Brasil é representado por
pt_BR.

Se o idioma não puder ser determinado será retornado o texto "unknown".

# $llt
Resultado:  série

Para determinado modelos estimados via Máxima Verossimilhança a função
retorna os valores do log da verossimilhança para cada observação.
Atualmente essa função está disponível para logit e probit binários,
tobit e heckit.

# $lnl
Resultado:  escalar

Retorna a log-verossimilhança para o último modelo estimado (quando for
aplicável).

# $macheps
Resultado:  escalar

Retorna o valor do "épsilon da máquina" que, por sua vez, fornece um
limite superior para o erro relativo devido ao arredondamento na aritmética
de ponto flutuante com precisão dupla.

# $mnlprobs
Resultado:  matriz

Deve seguir a estimação de um modelo logit multinomial (apenas) e retorna
uma matriz com as probabilidades estimadas para cada resultado possível em
cada observação dentro da amostra utilizada na estimação do modelo. Cada
linha representa uma observação e cada coluna representa um resultado.

# $model
Resultado:  lote

Deve seguir a estimação de modelos de equação única e retorna um pacote
("bundle") contendo vários itens pertencentes ao modelo. Todos os acessores
de modelos regulares são incluídos e são referenciados por chaves iguais
aos nomes dos acessores regulares menos o cifrão inicial. Assim, por
exemplo, os resíduos aparecem sob a chave uhat e o quadrado da soma dos
erros sob ess.

Dependendo do estimador, informações adicionais podem ser
disponibilizadas. As chaves para tais informações são normalmente
auto-explicativas. Para ver o que está disponível basta salvar o pacote e
imprimir seu conteúdo. Isso é mostrado no exemplo a seguir:

	  ols y 0 x
	  bundle b = $model
	  print b

# $ncoeff
Resultado:  número inteiro

Retorna o número total de coeficientes estimados no último modelo.

# $nobs
Resultado:  número inteiro

Retorna o número de observações na amostra atualmente selecionada.

# $nvars
Resultado:  número inteiro

Retorna o número de variáveis no conjunto de dados (incluindo a
constante).

# $obsdate
Resultado:  série

Deve ser utilizada quando o conjunto de dados corrente for composto por
séries temporais com frequência decenal, anual, trimestral, mensal,
semanal (datada) ou diária (datada). Pode ser utilizada também com dados
em painel quando a informação temporal estiver ajustada corretamente (veja
o comando "setobs"). A série que será retornada é composta por números
com 8 dígitos seguindo o padrão YYYYMMDD (formato de dados "básico" do
ISO 8601), que correspondem ao dia da observação ou ao primeiro dia da
observação no caso de frequências de séries temporais menores que a
diária.

Esta série pode ser útil na utilização do comando "join".

# $obsmajor
Resultado:  série

É aplicável quando as observações no conjunto de dados corrente têm uma
estrutura maior:menor, como em séries temporais trimestrais
(ano:trimestre), séries temporais mensais (ano:mês), dados de horas
(dia:hora) e dados em painel (indíviduo:período). Retorna uma série
contendo o componente maior, ou de menor frequência, de cada observação
(por exemplo, o ano).

Ver também"$obsminor", "$obsmicro".

# $obsmicro
Resultado:  série

É aplicável quando as observações no conjunto de dados corrente têm uma
estrutura maior:menor:micro, como em séries temporais datadas diárias
(ano:mês:dia). Retorna uma série contendo o componente micro, ou de maior
frequência, de cada observação (por exemplo, o dia).

Ver também"$obsmajor", "$obsminor".

# $obsminor
Resultado:  série

É aplicável quando as observações no conjunto de dados corrente têm uma
estrutura maior:menor, como em séries temporais trimestrais
(ano:trimestre), séries temporais mensais (ano:mês), dados de horas
(dia:hora) e dados em painel (indíviduo:período). Retorna uma série
contendo o componente menor, ou de maior frequência, de cada observação
(por exemplo, o mês).

No caso de dados diários datados, $obsminor retorna o mês de cada
observação.

Ver também"$obsmajor", "$obsmicro".

# $pd
Resultado:  número inteiro

Retorna a frequência ou periodicidade dos dados (por exemplo: 4 para dados
trimestrais). No caso de dados em painel o valor retornado será a
quantidade de períodos de tempo no conjunto de dados.

# $pi
Resultado:  escalar

Retorna o valor de pi com dupla precisão.

# $pvalue
Resultado:  escalar ou matriz

Retorna o p-valor da estatística de teste que foi gerada pelo último
comando explícito de teste de hipóteses (por exemplo: chow). Veja guia de
utilização do Gretl (Capítulo 9) para detalhes.

Geralmente retorna um escalar, mas em alguns casos retorna uma matriz. Isso
ocorre, por exemplo, com os p-valores dos testes lâmbda traço e lâmbda
máximo associadas ao teste de cointegração de Johansen). Nesse caso os
valores na matriz estarão dispostos da mesma forma que na saída do teste.

Ver também"$test".

# $qlrbreak
Resultado:  escalar

Deve ser utilizada após o comando "qlrtest" (que realiza o teste QLR para
quebra estrutural em um ponto desconhecido. Retorna o número da
observação no qual a estatística de teste é maximizada.

# $rho
Resultado:  escalar
Argumento:  n (escalar, opcional)

Se for utilizada sem argumentos a função retorna o coeficiente
autorregressivo de primeira ordem para os resíduos do último modelo. Após
a estimação de um modelo via comando ar, a sintaxe $rho(n) retorna a
esimativa correspondente de rho(n).

# $rsq
Resultado:  escalar

Retorna o R^2 não ajustado do último modelo estimado, quando disponível.

# $sample
Resultado:  série

Deve ser utilizada após a estimação de um modelo com equação simples e
retona uma variável dummy com valores iguais a 1 nas observações
utilizadas na estimação, 0 nas observações na amostra corrente e que
não foram utilizadas na estimação (possivelmente devido a valores
ausentes) e NA nas observações fora da amostra selecionada corrente.

Caso se queira calcular estatísticas baseadas na amostra que foi utilizada
para um dado modelo, pode-se fazer, por exemplo:

	  ols y 0 xlist
	  genr sdum = $sample
	  smpl sdum --dummy

# $sargan
Resultado:  vetor linha

Deve ser utilizada após o comando tsls. Retorna um vetor 1 x 3 contendo a
estatística do teste de sobre-identificação de Sargan e os
correspondentes graus de liberdade e p-valor, respectivamente. Se o modelo
for exatamente identificado a estatística não estará disponível e tentar
acessá-la irá provocar um erro.

# $sigma
Resultado:  escalar ou matriz

Se o último modelo estimado foi uma equação simples, retorna o erro
padrão da regressão na forma de um escalar (ou, em outras palavras,
retorna o desvio padrão dos resíduos com uma correção apropriada de
graus de liberdade). Se o último model foi um sistema de equações,
retorna a matriz de covariâncias dos resíduos das equações do sistema.

# $stderr
Resultado:  matriz ou escalar
Argumento:  s (nome do coeficiente, opcional)

Quando utilizado sem argumentos, $stderr retorna um vetor coluna com os
erros padrão dos coeficientes do último modelo estimado. Com o argumento
opcional de texto ("string") a função retorna, na forma de um escalar, o
parâmetro estimado s.

Se o "modelo" um sistema, o resultado dependerá de suas características:
para VARs e VECMs o valor retornado será uma matriz contendo uma coluna
para cada equação, caso contrário, será um vetor coluna contendo os
coeficientes da primeira equação seguidos pelos coeficientes da segunda
equação e assim sucessivamente.

Ver também"$coeff", "$vcv".

# $stopwatch
Resultado:  escalar

Deve ser precedida pelo comando set stopwatch que, por sua vez, ativa a
medição de tempo da CPU. Na primeira utilização do acessor obtem-se a
quantidade de segundos que se passaram desde o comando set stopwatch. A cada
acesso o relógio será reiniciado de forma que as utilizações
subsequentes de $stopwatch irão fornecer os segundos da CPU entre as duas
utilizações.

# $sysA
Resultado:  matriz

Deve ser utilizada após a estimação de um sistema de equações
simultâneas. Retorna a matriz com os coeficientes das variáveis endógenas
defasadas, caso existam, na forma estrutural do sistema. Veja o comando
"system".

# $sysB
Resultado:  matriz

Deve ser utilizada após a estimação de um sistema de equações
simultâneas. Retorna a matriz com os coeficientes das variáveis exógenas
na forma estrutural do sistema. Veja o comando "system".

# $sysGamma
Resultado:  matriz

Deve ser utilizada após a estimação de um sistema de equações
simultâneas. Retorna a matriz com os coeficientes das variáveis endógenas
contemporâneas na forma estrutural do sistema. Veja o comando "system".

# $sysinfo
Resultado:  lote

Retorna um pacote ("bundle") contendo informações sobre o Gretl e o
sistema operacional onde está sendo executado. O elementos do pacote são
especificados a seguir.

  mpi: inteiro, igual a 1 se o sistema suporta MPI (Message Passing
  Interface), caso contrário 0.

  omp: inteiro, igual a 1 se o Gretl foi compilado com suporte a Open MP,
  caso contrário 0.

  nproc: inteiro, indica o número de processadores disponíveis.

  mpimax: inteiro, indica o número máximo de processos MPI que podem ser
  executados em paralelo. É igual a zero se não houver suporte para MPI,
  caso contrário é igual ao valor de nproc local. Se for especificado um
  arquivo de hosts MPI, mpimax será igual a soma do número de
  processadores ou "slots" ao longo de todas a máquinas referenciadas no
  arquivo.

  wordlen: inteiro, igual a 32 ou 64 para sistemas de 32 bit e 64,
  respectivamente.

  os: texto representando o sistema operacional e é igual a linux, osx,
  windows ou other.

  hostname: informa o nome da máquina (ou "host") onde o Gretl está sendo
  executado no momento. Se não for possível determinar o nome, será
  retornado o localhost.

Note que elemntos individuais no pacote podem ser acessados via utilização
da notação "dot" sem a necessidade de copiar o pacote inteiro. Por
exemplo,

	  if $sysinfo.os == "linux"
	      # faça alguma coisa que seja própria do Linux
	  endif

# $T
Resultado:  número inteiro

Retorna o número de observações utilizadas na estimação do último
modelo.

# $t1
Resultado:  número inteiro

Retorna o número da primeira observação na amostra selecionada corrente.

# $t2
Resultado:  número inteiro

Retorna o número da última observação na amostra selecionada corrente.

# $test
Resultado:  escalar ou matriz

Retorna o valor da estatística de teste que foi gerada pelo último comando
explícito de teste de hipóteses (por exemplo: chow). Veja guia de
utilização do Gretl (Capítulo 9) para detalhes.

Geralmente retorna um escalar, mas em alguns casos retorna uma matriz. Isso
ocorre, por exemplo, com as estatísticas lâmbda traço e lâmbda máximo
associadas ao teste de cointegração de Johansen). Nesse caso os valores na
matriz estarão dispostos da mesma forma que na saída do teste.

Ver também"dpvalue".

# $trsq
Resultado:  escalar

Retorna TR^2 (tamanho da amostra multiplicado pelo R-quadrado) do último
modelo, quando disponível.

# $uhat
Resultado:  série

Retorna os resíduos do último modelo. Isto pode ter diferentes
significados a depender dos estimadores utilizados. Por exemplo, após a
estimação de um ARMA $uhat irá conter os erros de previsão de 1 passo à
frente, após a estimação de um probit irá conter os resíduos
generalizados.

Se o "modelo" em questão for um sistema (um VAR, um VECM ou um sistema de
equações simultâneas), o $uhat sem parâmetros fornece a matriz de
resíduos, uma coluna por equação.

# $unit
Resultado:  série

Vale apenas para dados de painel. Retorna uma série com valor igual a 1 em
todas as observações na primeira unidade ou grupo, 2 em todas as
observações na segunda unidade ou grupo e assim sucessivamente.

# $vcv
Resultado:  matriz ou escalar
Argumentos: s1 (nome do coeficiente, opcional)
            s2 (nome do coeficiente, opcional)

Quando utilizado sem argumentos, $vcv retorna uma matriz contendo a matriz
de covariâncias estimadas para os coeficientes do último modelo. Se o
último modelo foi uma equação simples, então é possível fornecer os
nomes dos dois parâmetros entre parênteses para se obter a covariância
estimada entre s1 e s2. Ver também"$coeff", "$stderr".

Este acessor não está disponível para VARs ou VECMs. Para modelos desse
tipo "$sigma" e "$xtxinv".

# $vecGamma
Resultado:  matriz

Deve ser utilizada após a estimação de um VECM e retorna uma matriz na
qual as matrizes Gama (coeficientes das diferenças defasadas das variáveis
cointegradas) são empilhadas lado a lado. Cada linha representa uma
equação. Para um VECM de ordem p existem p - 1 sub-matrizes.

# $version
Resultado:  escalar

Retorna um valor inteiro que identifica a versão do Gretl. Atualmente a
versão do Gretl é composta por um texto com o seguinte formato: ano, com 4
dígitos, seguido de uma letra, de a até j, representando as atualizações
dentro desse ano (por exemplo, 2015d). O valor retornado por essa função
é igual ao ano multiplicado por 10 e adicionado de um número
representando, em ordem léxica, a letra. Assim, 2015d seria representado
por 20153.

Em versões anteriores ao Gretl 2015d, o identificador possuia a seguinte
forma: x.y.z (três inteiros separados por pontos) e o valor da função era
calculado como 10000*x + 100*y + z . Assim, por exemplo, a versão 1.10.2
era traduzida como 11002. Note que dessa forma a ordem numérica de $version
foi preservada mesmo com a mudança no esquema de versões.

# $vma
Resultado:  matriz

Deve ser utilizada após a estimação de um VAR ou um VECM e retorna uma
matriz contendo a representação VMA até a ordem especificada via comando
set horizon. Veja guia de utilização do Gretl (Capítulo 28) para
detalhes.

# $windows
Resultado:  número inteiro

Retorna o valor 1 se o Gretl estiver sendo utilizado no Windows e 0 caso
contrário. Através dessa função é possível utilizar comandos "shell "
em scripts que possam ser executados em diferentes sistemas operacionais.

Veja também o comando "shell".

# $xlist
Resultado:  lista

Se o último modelo estimado foi um equação simples a função retorna uma
lista com os regressores. Se o último modelo foi um sistema de equações
ela retorna uma lista "global" com as variáveis exógenas e predeterminadas
(na mesma ordem que aparecem na função "$sysB"). Se o último modelo foi
um VAR ela retorna uma lista com os regressores exógenos, caso existam.

# $xtxinv
Resultado:  matriz

Após a estimação de um VAR ou VECM (apenas), retorna X'X^-1, onde X é a
matriz comum de regressores utilizados em cada equação. Esse acessor não
está dsponível para VECMs estimados com restrições impostas na a matriz
de cargas(α).

# $yhat
Resultado:  série

Retorna os valores ajustados da última regressão.

# $ylist
Resultado:  lista

Se o último modelo estimado foi um VAR, um VECM ou um sistema de equações
simultâneas a função retorna uma lista com as variáveis endógenas. Se o
último modelo foi uma equação simples o acessor retorna uma lista com
apenas um elemento, a variável dependente. No caso especial do modelo
biprobit a lista irá conter dois elementos.

## Functions proper
# abs
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna o valor absoluto de x.

# acos
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna o arco-cosseno de x, isto é, o valor cujo cosseno é x. Resultado
em radianos e o argumento deve estar entre -1 e 1.

# acosh
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna o cosseno hiperbólico inverso de x (solução positiva). x deve ser
maior que 1, caso contrário a função retornará NA. Ver também"cosh".

# aggregate
Resultado:  matriz
Argumentos: x (série ou lista)
            byvar (série ou lista)
            funcname (texto, opcional)

Na forma mais simples de uso, x é igual a null, byvar é uma séries
individual e o terceiro argumento é omitido. Neste caso é retornada uma
matriz com duas colunas contendo na primeira coluna os valores distintos de
byvar, ordenados de forma crescente, e na segunda a quantidade de
observações de byvar para cada um dos valores distintos. Por exemplo,

	  open data4-1
	  eval aggregate(null, bedrms)

will show that the series bedrms has values 3 (with count 5) and 4 (with
count 9).

If x and byvar are both individual series and the third argument is given,
the return value is a matrix with three columns holding, respectively, the
distinct values of byvar, sorted in ascending order; the count of
observations at which byvar takes on each of these values; and the values of
the estatística especificada por funcname calculada na série x, usando
apenas aquelas observações nas quais byvar tem valor igual aos dados na
primeira coluna.

Mais geralmente, se byvar for uma lista com n membros então as n colunas a
esquerda contêm as combinações dos valores distintos de cada uma das n
séries e a coluna de contagem contém o número de observações nas quais
cada combinação é feita. Se x for uma lista com m membros então as m
colunas mais a direita contêm os valores da estatística especificada para
cada uma das x variáveis, novamente calculadas na subamostra indicada na(s)
primeira(s) coluna(s).

Os seguintes valores de funcname são suportados de forma "nativa": "sum",
"sumall", "mean", "sd", "var", "sst", "skewness", "kurtosis", "min", "max",
"median", "nobs" e "gini". Cada uma dessas funções utiliza uma série como
argumento e retorna um valor escalar e, nesse sentido, pode-se dizer que
"agregam" a série de alguma forma. É possível utilizar uma função
definida pelo usuário como um agregador. Da mesma forma que as funções
nativas, tal função deve ter como argumento apenas uma única série e
retornar um valor escalar.

Note que apesar de a contagem de casos ser realizada de forma automática
pela função nobs, a função aggregate não é redundante como uma
agregadora, uma vez que fornece o número de observações válidas (não
ausentes) em x em cada combinação byvar.

Para exemplificar isso, suponha que region representa um código de uma
região geográfica usando valores inteiros de 1 até n e income representa
a renda doméstica. Então o cálculo a seguir deverá produzir uma matriz
de ordem n x 3 contendo os códigos das regiões, a contagem de
observações em cada região e a renda média doméstica para cada uma das
regiões:

	  matrix m = aggregate(income, region, mean)

Para um exemplo usando listas, seja gender uma variável dummy macho/fêmea,
seja race uma variável categórica com três valores e considere o seguinte
código:

	  list BY = gender race
	  list X = income age
	  matrix m = aggregate(X, BY, sd)

A utilização de aggregate produzirá uma matriz de ordem 6 x 5. As
primeiras duas colunas contêm as 6 distintas combinações dos valores de
gênero e raça. A coluna do meio contém a contagem para cada uma dessas
combinações. As duas colunas mais à direita contêm os devios padrão
amostrais de income e age.

Note que se byvar for uma lista, algumas combinações dos valores de byvar
podem não estar presentes nos dados (fornecendo uma contagem igual a zero).
Nesse caso os valores das estatísticas para x são considerados como NaN
(ou seja, não são números). Caso seja desejado ignorar esses casos é
possível utilizar a função "selifr" para selecionar apenas aquelas linhas
que não possuam uma contagem igual a zero. A coluna a ser testada estará
uma posição à direita após o número de variáveis de byvar, assim,
pode-seutilizar o seguinte código:

	  matrix m = aggregate(X, BY, sd)
	  scalar c = nelem(BY)
	  m = selifr(m, m[,c+1])

# argname
Resultado:  texto
Argumento:  s (texto)

Seja s o nome de um parâmetro de uma função definida pelo usuário,
retorna o nome do argumento correspondente ou uma variável de texto
("string") vazia se o argumento for anônimo.

# array
Resultado:  ver abaixo
Argumento:  n (número inteiro)

É a função "construtora" básica de uma nova variável do tipo arranjo
("array"). Ao usar esta função é necessário que se especifique um tipo
(na forma plural) para o arranjo: strings, matrices, bundles ou lists. O
valor de retorno é um arranjo do tipo especificado e com n elementos
"vazios" (exemplos: variável de texto ("string") vazia ou matriz nula).
Exemplos de utilização:

	  strings S = array(5)
	  matrices M = array(3)

Veja também "defarray".

# asin
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna o arco-seno de x, isto é, o valor cujo seno é x. Resultado em
radianos e o argumento deve estar entre -1 e 1.

# asinh
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna o seno hiperbólico inverso de x. Ver também"sinh".

# atan
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna o arco-tangente de x, isto é, o valor cuja tangente é x. Resultado
em radianos.

Ver também"cos", "sin", "tan".

# atanh
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna a tangente hiperbólica inversa de x. Ver também"tanh".

# atof
Resultado:  escalar
Argumento:  s (texto)

Função semelhante à existente na linguagem de programação C, retorna o
resultado da conversão da variável de texto ("string") s (ou sua porção
inicial, após descartar quaisquer espaços em branco no seu início) em
número de ponto flutuante. Diferente do que ocorre na linguagem C, a
função atof (por questões de portabilidade) sempre assume que o caractere
decimal é o ".". Todos os caracteres que se seguem após a parte de s que
pode ser convertida para um número de ponto flutuante são ignorados.

Se nenhum dos caracteres de s (que se seguem após os espaços em branco que
são descartados) puderem ser convertidos a função retornará NA.

	  # Exemplos:
	  x = atof("1.234") # retorna x = 1.234
	  x = atof("1,234") # retorna x = 1
	  x = atof("1.2y")  # retorna x = 1.2
	  x = atof("y")     # retorna x = NA
	  x = atof(",234")  # retorna x = NA

Veja também "sscanf" para maior flexibilidade nas conversões de textos em
números.

# bessel
Resultado:  o mesmo tipo que o argumento
Argumentos: type (caractere)
            v (escalar)
            x (escalar, série ou matriz)

Calcula uma das variantes da função de Bessel de ordem v e argumento x. O
valor retornado será do mesmo tipo de x. A função específica é
selecionada pelo primeiro argumento e deve ser J, Y, I ou K. Uma boa
discussão sobre as funções de Bessel pode ser encontrada na Wikipédia.
Aqui serão feitos comentários breves.

caso J: função de Bessel de primeiro tipo. Se assemelha a uma onda
senoidal amortecida. Definida para v real e x. Se x for negativo então v
deve ser um inteiro.

caso Y: função de Bessel de segundo tipo. Definida para v real e x, mas
com uma singularidade em x = 0.

caso I: função de Bessel modificada de primeiro tipo. Uma função com
crescimento exponencial. Argumentos que podem ser usados são os mesmos do
caso J.

caso K: função de Bessel modificada de segundo tipo. Uma função com
decaimento exponencial. Diverge em x = 0 e não é definida para valores
negativos de x. É simétrica em torno de v = 0.

# BFGSmax
Resultado:  escalar
Argumentos: &b (referência a matriz)
            f (chamada a função)
            g (chamada a função, opcional)

Realiza a maximização numérica via método de Broyden, Fletcher, Goldfarb
e Shanno. O argumento b deve conter os valores inciais de um conjunto de
parâmetros e o argumento f deve especificar uma chamada à função que
calcule o critério (escalar) a ser maximizado, dados os valores correntes
dos parâmetros e quaisquer outros dados que sejam relevantes. Se o objetivo
for de fato uma minimização, esta função deverá retornar o negativo do
critério. Se for completada com sucesso, BFGSmax retorna o valor maximizado
do critério e b contém os valores dos parâmetros que maximizam a
função.

O terceiro argumento, opcional, estabelece uma maneira de fornecer derivadas
analíticas (caso contrário o gradiente será computado numericamente). A
função gradiente g deve ter como primeiro argumento uma matriz
pré-definida que tenha o tamanho adequado para armazenar o gradiente, dado
na forma de fonteiro. Ela também precisa ter o vetor de parâmetros como um
argumento (na forma de ponteiro ou não). Outros argumentos são opcionais.

Para maiores detalhes e exemplos veja o capítulo sobre métodos numéricos
em guia de utilização do Gretl (Capítulo 33). Ver também"BFGScmax",
"NRmax", "fdjac", "simann".

# BFGScmax
Resultado:  escalar
Argumentos: &b (referência a matriz)
            bounds (matriz)
            f (chamada a função)
            g (chamada a função, opcional)

Realiza a maximização com restrições via L-BFGS-B (BFGS com memória
limitada, veja Byrd, Lu, Nocedal e Zhu, 1995). O argumento b deve conter os
valores inciais de um conjunto de parâmetros, bounds deve conter as
restrições que aplicadas aos valores dos parâmetros (veja abaixo) e f
deve especificar uma chamada à função que calcule o critério (escalar) a
ser maximizado, dados os valores correntes dos parâmetros e quaisquer
outros dados que sejam relevantes. Se o objetivo for de fato uma
minimização, esta função deverá retornar o negativo do critério. Se
for completada com sucesso, BFGScmax retorna o valor maximizado do
critério, sujeito às restrições em bounds e b contém os valores dos
parâmetros que maximizam a função.

A matriz bounds deve ter 3 colunas e um número de linhas igual ao número
de elementos restritos no vetor de parâmetros. O primeiro elemento de uma
dada linha é o índice (de base 1) do parâmetro restrito, o segundo e o
terceiro são os limites inferiores e superiores, respectivamente. Os
valores -$huge e $huge devem ser usados para indicar que o parâmetro não
possui restrições inferiores ou superiores, respectivamente. Por exemplo,
a expressão a seguir é a forma de se especificar que o segundo elemento do
vetor de parâmetros deve ser não-negativo:

	  matrix bounds = {2, 0, $huge}

O quarto argumento, opcional, estabelece uma maneira de fornecer derivadas
analíticas (caso contrário o gradiente será computado numericamente). A
função gradiente g deve ter como primeiro argumento uma matriz
pré-definida que tenha o tamanho adequado para armazenar o gradiente, dado
na forma de fonteiro. Ela também precisa ter o vetor de parâmetros como um
argumento (na forma de ponteiro ou não). Outros argumentos são opcionais.

Para maiores detalhes e exemplos veja o capítulo sobre métodos numéricos
em guia de utilização do Gretl (Capítulo 33). Ver também"BFGSmax",
"NRmax", "fdjac", "simann".

# bkfilt
Resultado:  série
Argumentos: y (série)
            f1 (número inteiro, opcional)
            f2 (número inteiro, opcional)
            k (número inteiro, opcional)

Retorna o resultado da aplicação do filtro passa-banda de Baxter-King para
a série y. Os parâmetros opcionais f1 e f2 representam, respectivamente,
os limites inferior e superior da amplitude de frequência a ser extraída,
enquanto k é a ordem de aproximação a ser utilizada.

Se esses argumentos não forem fornecidos então os valores padrão irão
depender da periodicidade do conjunto de dados. Para dados anuais os
padrões para f1, f2 e k são 2, 8 e 3, respectivamente. Para dados
trimestrais são 6, 32 e 12. Para dados mensais são 18, 96 e 36. Esses
valores são escolhidos para coincidir com a escolha mais comum entre os
praticantes, que é a utilização desse filtro para extrair o componente de
frequência do "ciclo de negócios". Isso, por sua vez, é comumente
definido como sendo entre 18 meses e 8 anos. O filtro, por escolha padrão,
abrange 3 anos de dados.

Se f2 for maior ou igual ao número de observações disponíveis, então a
versão "passa-baixa" do filtro será executada e a série resultante deve
ser considerada como uma estimativa do componente de tendência, ao invés
de ciclo. Ver também"bwfilt", "hpfilt".

# boxcox
Resultado:  série
Argumentos: y (série)
            d (escalar)

Retorna a transformação de Box-Cox com parâmetro d para uma série
positiva y.

A série transformada é (y^d - 1)/d para d diferente de zero ou log(y) para
d = 0.

# bread
Resultado:  lote
Argumentos: fname (texto)
            import (booleano, opcional)

Lê um pacote ("bundle") a partir de um arquivo de texto. A variável de
texto ("string") fname deve conter o nome do arquivo no qual o pacote será
lido. Se esse nome tiver a extensão ".gz" será assumido que foi aplicada a
compactação do arquivo via gzip.

O arquivo em questão deve ser um XML apropriadamente definido: ele dever
conter um elemento gretl-bundle, utilizado para armazenar zero ou mais
elementos bundled-item. Por exemplo:

	  <?xml version="1.0" encoding="UTF-8"?>
	  <gretl-bundle name="temp">
          <bundled-item key="s" type="string">moo</bundled-item>
          <bundled-item key="x" type="scalar">3</bundled-item>
	  </gretl-bundle>

Como esperado, tais arquivos são gerados automaticamente pela função
associada "bwrite".

Se o nome do arquivo não contiver a especificação completa de seu
caminho, ele será procurado em vários locais "prováveis", começando no
"workdir" corrente. Entretanto, se for dado um valor não-nulo para o
argumento opcional import, o arquivo será procurado no diretório
"@dotdir". Nesse caso o argumento fname deverá ser um nome simples, sem a
inclusão do caminho.

Se ocorrer algum erro (tal como o arquivo ter sido mal formatado ou ser
inacessível), um erro será retornado via acessor "$error".

Ver também"mread", "bwrite".

# bwfilt
Resultado:  série
Argumentos: y (série)
            n (número inteiro)
            omega (escalar)

Retorna o resultado da aplicação de um filtro passa-baixo de Butterworth
de ordem n e frequência de corte omega na série y. O corte é expresso em
graus e deve ser maior ou igual a 0 e menor que 180. Valores de corte
menores restringem o passa-banda a menores frequências e assim produzem uma
tendência mais suave. Valores maiores de n produzem um corte mais agudo,
mas ao custo de possível instabilidade numérica.

A inspeção preliminar do periodograma da série de interesse é útil
quando se deseja aplicar esta função. Veja guia de utilização do Gretl
(Capítulo 26) para detalhes. Ver também"bkfilt", "hpfilt".

# bwrite
Resultado:  número inteiro
Argumentos: B (lote)
            fname (texto)
            export (booleano, opcional)

Escreve um pacote ("bundle") B em um arquivo XML com nome fname. Para uma
descrição sumária de seu formato, veja "bread". Se já existir um arquivo
fname ele será sobrescrito. O valor de retorno da função é 0 em caso de
sucesso. Se ocorrerem erros, tais como a impossibilidade de sobrescrever o
arquivo, a função retorna um valor não-nulo.

O arquivo de saída será salvo no diretório "workdir", a menos que a
variável fname contenha um caminho para o diretório onde será armazenado.
Entretanto, se for dado um valor não-nulo para o argumento export, o
arquivo de saída será armazenado no diretório "@dotdir". Neste caso um
nome simples, sem especificação de caminho, deverá ser utilizado como
segundo argumento.

Por padrão, o arquivo XML é armazenado sem compressão, mas se fname tiver
a extensão .gz é aplicada a compressão gzip.

Ver também"bread", "mwrite".

# cdemean
Resultado:  matriz
Argumento:  X (matriz)

Centraliza as colunas da matriz X em torno de suas médias.

# cdf
Resultado:  o mesmo tipo que o argumento
Argumentos: d (texto)
            ... (ver abaixo)
            x (escalar, série ou matriz)
Exemplos:   p1 = cdf(N, -2.5)
            p2 = cdf(X, 3, 5.67)
            p3 = cdf(D, 0.25, -1, 1)

Calculadora da função de distribuição acumulada. Retorna P(X <= x), onde
a distribuição de X é especificada pela letra d. Entre os argumentos d e
x, zero ou mais argumentos adicionais são necessários para que se
especifique os parâmetros da distribuição. Isso é feito da seguinte
forma (note que a distribuição normal tem, por conveniência, uma função
própria, "cnorm"):

  Normal padrão (c = z, n ou N): sem argumentos extras

  Normal bivariada (D): coeficiente de correlação

  t de Student (t): graus de liberdade

  Qui-quadrado (c, x ou X): graus de liberdade

  F de Snedecor F (f ou F): graus de liberdade (num.); graus de liberdade
  (den.)

  Gama (g ou G): forma; escala

  Binomial (b ou B): probabilidade; quantidade de tentativas

  Poisson (p ou P): média

  Weibull (w ou W): forma; escala

  Erro Generalizado (E): forma

  Qui-quadrado não-central (ncX): graus de liberdade, parâmetro de
  não-centralidade

  F não-central (ncF): graus de liberdade (num.), graus de liberdade
  (den.), parâmetro de não-centralidade

  t não-central (nct): graus de liberdade, parâmetro de não-centralidade

Note que na maioria dos casos existem pseudônimos para ajudar na
memorização dos códigos. O caso da norma bivariada é especial: a sintaxe
é x = cdf(D, rho, z1, z2) onde rho é a correlação entre as variáveis z1
e z2.

Ver também"pdf", "critical", "invcdf", "pvalue".

# cdiv
Resultado:  matriz
Argumentos: X (matriz)
            Y (matriz)

Divisão de números complexos. Os dois argumentos devem possuir o mesmo
número de linhas, n, e devem possuir uma ou duas colunas. A primeira coluna
contém a parte real e a segunda (se estiver presente) contém a parte
imaginária. A função retorna uma matriz de ordem n x 2 ou, caso não
exista a parte imaginária, um vetor com n linhas. Ver também"cmult".

# ceil
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Consiste na função teto. Retorna o menor inteiro que seja maior ou igual a
x. Ver também"floor", "int".

# cholesky
Resultado:  matriz quadrada
Argumento:  A (matriz positiva definida)

Realiza a decomposição de Cholesky da matriz A, assumindo que seja
simétrica e definida positiva. O resultado será uma matriz triangular
inferior L que satisfaz A = LL'. A função irá falhar se A não for
simétrica ou não for definida positiva. Ver também"psdroot".

# chowlin
Resultado:  matriz
Argumentos: Y (matriz)
            xfac (número inteiro)
            X (matriz, opcional)

Expande os dados de entrada, Y, para uma frequência maior utilizando o
método de Chow e Lin (1971). É assumido que as colunas de Y representam
séries. A matriz retornada tem a mesma quantidade de colunas de Y e xfac
vezes o número de linhas.

O segundo argumento representa o fator de expansão. Deve ser igual a 3 para
expandir dados trimestrais em mensais ou igual a 4 para expandir de anual
para trimestral (estes são os únicos fatores atualmente suportados). O
terceiro argumento, que é opcional, pode ser utilizado para fornecer uma
matriz de covariáveis com frequência maior.

Os regressores utilizados por padrão são uma constante e uma tendência
quadrática. Se X for fornecido, suas colunas devem ser utilizadas como
regressores adicionais. A função retornará um erro se o número de linhas
em X não for igual a xfac vezes o número de linhas em Y.

# cmult
Resultado:  matriz
Argumentos: X (matriz)
            Y (matriz)

Multiplicação complexa. Os dois argumentos devem ter o mesmo número de
linhas, n, e uma ou duas colunas. A primeira coluna contendo a parte real e
a segunda (se existir) a parte imaginária. O valor retornado é uma matriz
n x 2, ou, se o resultado não contiver parte imaginária, um vetor de
tamanho n. Ver também"cdiv".

# cnorm
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna a função de distribuição acumulada para uma normal padrão. Ver
também"dnorm", "qnorm".

# cnumber
Resultado:  escalar
Argumento:  X (matriz)

Retorna o número condicional da matriz X de ordem n x k, conforme definido
em Belsley, Kuh e Welsch (1980). Se as colunas de X forem mutuamente
ortogonais o número condicional de X é a unidade. Um número condicional
grande é um indicador de multicolinearidade, sendo que é considerado
normalmente um valor "grande" algo acima de 50 (ou, algumas vezes, de 30).

Os passos para esses cálculos são: (1) contruir uma matriz Z onde suas
colunas são a divisão das colunas de X divididas por suas respectivas
normas euclidianas; (2) construir Z'Z e obter seus autovalores e; (3)
calcular a raiz quadrada da razão entre o maior e o menor autovalor.

Ver também"rcond".

# colname
Resultado:  texto
Argumentos: M (matriz)
            col (número inteiro)

Retorna o nome da coluna col da matriz M. Se as colunas de M não possuírem
nomes então será retornada um texto ("string") vazio. Se col for maior que
o número de colunas da matriz será sinalizado um erro. Veja também
"colnames".

Exemplo:

	  matrix A = { 11, 23, 13 ; 54, 15, 46 }
	  colnames(A, "Col_A Col_B Col_C")
	  string name = colname(A, 3)
	  print name

# colnames
Resultado:  escalar
Argumentos: M (matriz)
            S (cadeia de texto ou lista)

Adiciona nomes para as colunas da matriz M de ordem T x k . Se S for uma
lista, os nomes serão os das séries listadas. A lista precisa ter k
membros. Se S for um arranjo ("array") de textos ("string"), ele precisa ter
k elementos. Para manter a compatibilidade com versões anteriores do Gretl,
uma única variável de texto também pode ser utilizada como segundo
argumento. Nesse caso ela precisa ter k textos separados por espaços.

Retorna o valor 0 se as colunas forem nomeadas com sucesso. Caso contrário
retorna um valor não-nulo. Veja também "rownames".

Exemplo:

	  matrix M = {1, 2; 2, 1; 4, 1}
	  variável de textos S = array(2)
	  S[1] = "Col1"
	  S[2] = "Col2"
	  colnames(M, S)
	  print M

# cols
Resultado:  número inteiro
Argumento:  X (matriz)

Retorna o número de colunas da matriz X. Ver também"mshape", "rows",
"unvech", "vec", "vech".

# corr
Resultado:  escalar
Argumentos: y1 (série ou vetor)
            y2 (série ou vetor)

Calcula o coeficiente de correlação entre y1 e y2. Os argumentos devem ser
duas séries ou dois vetores com o mesmo tamanho. Ver também"cov", "mcov",
"mcorr", "npcorr".

# corrgm
Resultado:  matriz
Argumentos: x (série, matriz ou lista)
            p (número inteiro)
            y (série ou vetor, opcional)

Se forem fornecidos apenas os dois primeiros argumentos a função calcula o
correlograma de x para as defasagens de 1 até p. Sendo k o número de
elementos em x (igual a 1 se x for uma série, ao número de colunas se x
for uma matriz ou ao número de membros se x for uma lista). O valor
retornado será uma matriz com p linhas e 2k colunas, onde as k primeiras
colunas conterão as respectivas autocorrelações e o restante as
respectivas autocorrelações parciais.

Se um terceiro argumento for fornecido a função irá computar o
correlograma cruzado para cada um dos k elementos em x e y, partindo de +p
até - p. A matriz retornada possui 2p + 1 linhas e k colunas. Se x for uma
série ou lista e y for um vetor, y precisa ter linhas na mesma quantidade
que o total de observações na amostra selecionada.

# cos
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna o cosseno de x. Ver também"sin", "tan", "atan".

# cosh
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna o cosseno hiperbólico de x.

Ver também"acosh", "sinh", "tanh".

# cov
Resultado:  escalar
Argumentos: y1 (série ou vetor)
            y2 (série ou vetor)

Retorna a covariância y1 e y2. Os argumentos devem ser duas séries ou dois
vetores (estes devem possuir o mesmo cumprimento). Ver também"corr",
"mcov", "mcorr".

# critical
Resultado:  o mesmo tipo que o argumento
Argumentos: c (caractere)
            ... (ver abaixo)
            p (escalar, série ou matriz)
Exemplos:   c1 = critical(t, 20, 0.025)
            c2 = critical(F, 4, 48, 0.05)

Calculadora de valores críticos. Retorna x tal que P(X > x) = p, onde a
distribuição X é determinada pela letra c. Entre os argumentos c e p,
zero ou mais argumentos escalares são necessários para especificar os
parâmetros da distribuição, Isso é feito da seguinte forma:

  Normal padrão (c = z, n ou N): sem argumentos extras

  t de Student (t): graus de liberdade

  Chi square (c, x ou X): graus de liberdade

  F de Snedecor (f ou F): g.l. (num.); g.l. (den.)

  Binomial (b ou B): probabilidade; tentativas

  Poisson (p ou P): média

Ver também"cdf", "invcdf", "pvalue".

# cum
Resultado:  o mesmo tipo que o argumento
Argumento:  x (série ou matriz)

Acumula x (isto é, cria uma soma móvel). Quando x for uma série, produz
uma série y onde cada um de seus elementos é igual a soma dos valores de x
até a observação correspondente. O ponto de partida para a acumulação
é a primeira observação não-ausente da amostra selecionada corrente.
Quando x for uma matriz, seus elementos são acumulados por colunas.

Ver também"diff".

# curl
Resultado:  escalar
Argumento:  &b (referência a lote)

Fornece uma maneira relativamente flexível de se obter um buffer de texto
contendo dados de um servidor de internet utilizando a biblioteca libcurl. O
argumento b, do tipo pacote (" bundle"), deve conter uma variável de texto
("string") chamada URL que fornece o endereço completo do recurso no host
alvo. Outros elementos opcionais são apresentados a seguir.

  "header": a variável de texto especificando um header HTTP que será
  enviado para o host.

  "postdata": a variável de texto contendo os dados que serão enviados
  para o host.

Os campos header e postdata são destinados para o uso com uma requisição
HTTP do tipo POST. Se postdata estiver presente o método POST é
implícito, caso contrário o método GET é implícito. Mas note que para
requisições GET diretas a função "readfile" oferece uma interface mais
simples.

Se outro elemento opcional do pacote, um escalar chamado include estiver
presente e possuir valor não-nulo, a requisição irá incluir o header
recebido do host com o corpo de saída.

Ao completar-se a requisição, o texto recebido do servidor é adicionado
ao pacote e recebe o nome de "output".

Se um erro ocorrer na formulação da requisição (por exemplo, não
existir a URL na entrada) a função irá falhar, caso contrário ela
retornará o valor 0 se a requisição for bem sucedida ou um valor não
nulo, sendo que neste caso a mensagem de erro da biblioteca curl será
adicionado ao pacote e identificado como "errmsg". Note, entretanto, que
"sucesso" neste sentido não significa necessariamente que os dados
desejados foram obtidos. Na verdade significa apenas que alguma resposta foi
recebida do servidor. Assim, é necessário conferir o conteúdo do buffer
de saída (que pode ser de fato uma mensagem tal como "Página não
encontrada").

Um bom exemplo de como utilizar essa função é baixar alguns dados do site
do US Bureau of Labor Statistics, que requere o envio de um query JSON. Note
o uso de "sprintf" para inserir aspas duplas no dado POST.

	  bundle req
	  req.URL = "http://api.bls.gov/publicAPI/v1/timeseries/data/"
	  req.include = 1
	  req.header = "Content-Type: application/json"
	  string s = sprintf("{\"seriesid\":[\"LEU0254555900\"]}")
	  req.postdata = s
	  err = curl(&req)
	  if err == 0
	      s = req.output
	      string line
	      loop while getline(s, line) --quiet
	          printf "%s\n", line
	      endloop
	  endif

Veja também a função "jsonget" para processamento de dados recebidos no
formato JSON.

# dayspan
Resultado:  número inteiro
Argumentos: dia1 (número inteiro)
            dia2 (número inteiro)
            dias por semana (número inteiro)

Retorna o número de dias (relevantes) entre os dias dia1 e dia2, inclusive.
Os dias por semana, que têm que ser 5, 6 ou 7, dão o número de dias na
semana que devem contar (um valor de 6, ignora domingos, e um valor de 5
ignora sábados e domingos).

Para obter dias de períodos a partir das formas mais familiares de datas,
ver "epochday".

# defarray
Resultado:  ver abaixo
Argumento:  ... (ver abaixo)

Permite a definição de uma variável do tipo arranjo ("array") de forma
direta, através do fornecimento de um ou mais elementos. Ao utilizar essa
função é necessário que se especifique um tipo (na forma plural) para o
arranjo: strings, matrices, bundles ou lists. Cada um dos argumentos dever
ser um objeto do mesmo tipo que o especificado na definição do arranjo. Em
caso de sucesso na definição, será retornado um arranjo com n elementos,
onde n é igual ao número de argumentos.

	  strings S = defarray("foo", "bar", "baz")
	  matrices M = defarray(I(3), X'X, A*B, P[1:])

Veja também "array".

# deseas
Resultado:  série
Argumentos: x (série)
            c (caractere, opcional)

Precisa que o TRAMO/SEATS e/ou X-12-ARIMA estejam instalados. Retorna a
série x dessazonalizada (ou seja, sazonalmente ajustada). A série a ser
dessazonalida precisa ser mensal ou trimestral. Para utilizar o X-12-ARIMA
forneça X como segundo argumento e para usar o TRAMO/SEATS forneça T. Se o
segundo argumento for omitido o Gretl irá utilizar o X-12-ARIMA.

Note que se a série de entrada não possuir um componente sazonal
detectável a execução da função irá falhar. Note também que tanto o
TRAMO/SEATS quanto o X-12-ARIMA oferecem um grande número de opções, mas
a função deseas utilizará apenas os seus valores padrão. Em ambos os
programas os fatores sazonais são calculados com base em um modelo ARIMA
automaticamente selecionado. Uma das diferenças entre os dois que pode
levar a resultados bastante distintos é o ajuste prévio de observações
aberrantes que o TRAMO/SEATS realiza e que não é feito pelo X-12-ARIMA.

# det
Resultado:  escalar
Argumento:  A (matriz quadrada)

Retorna o determinante de A, calculado via decomposição LU. Ver
também"ldet", "rcond", "cnumber".

# diag
Resultado:  matriz
Argumento:  X (matriz)

Retorna a diagonal principal de X em um vetor coluna. Se X for uma matriz de
ordem m x n o número de elementos do vetor resultante será igual a min(m,
n). Ver também"tr".

# diagcat
Resultado:  matriz
Argumentos: A (matriz)
            B (matriz)

Retorna a soma direta de A e B, isto é, uma matriz contendo A no canto
superior esquerdo e B no canto inferior direito. Se A e B forem ambas
quadradas, a matriz resultante será diagonal em blocos.

# diff
Resultado:  o mesmo tipo que o argumento
Argumento:  y (série, matriz ou lista)

Calcula a primeira diferença. Se y for uma série ou uma lista de séries,
os valores iniciais serão iguais a NA. Se y for uma matriz, a
diferenciação é feita por colunas e os valores iniciais serão iguais a
0.

Quando for retornada uma lista, cada uma das variáveis será
automaticamente nomeada conforme o modelo d_varname, onde varname é o nome
da série original. O nome será truncado caso necessário e pode ser
ajustado caso já exista uma variável com o mesmo nome.

Ver também"cum", "ldiff", "sdiff".

# digamma
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna a função digama (ou Psi) de x e consiste na derivada logarítmica
da função gama.

# dnorm
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna a densidade da distribuição normal padrão em x. Para obter a
densidade para uma distribuição normal não-padrão em x, utilize o
escore-z de x como argumento da função dnorm e multiplique o resultado
pela jacobiana da transformação z, ou seja, 1/sigma, conforme ilustrado a
seguir:

	  mu = 100
	  sigma = 5
	  x = 109
	  fx = (1/sigma) * dnorm((x-mu)/sigma)

Ver também"cnorm", "qnorm".

# dropcoll
Resultado:  lista
Argumentos: X (lista)
            epsilon (escalar, opcional)

Retorna uma lista com os mesmo elementos de X, mas excluindo as séries
colineares. Assim, se todas as séries em X forem linearmente independentes,
a lista resultante será simplesmente uma cópia de X.

O algoritmo utiliza a decomposição QR (tranformação de Householder), de
forma que está sujeita a erro de precisão finita. Para avaliar a
sensibilidade do algoritmo, um segundo parâmetro (opcional) epsilon pode
ser especificado para tornar o teste de colinearidade mais ou menos estrito,
conforme desejado. O valor padrão para epsilon é 1.0e-8. Ajustando epsilon
para um maior valor eleva a probabilidade de uma série ser descartada.

Exemplo:

	  nulldata 20
	  set seed 9876
	  series foo = normal()
	  series bar = normal()
	  series foobar = foo + bar
	  list X = foo bar foobar
	  list Y = dropcoll(X)
	  list print X
	  list print Y
	  # defina épsilon como sendo um valor bastante pequeno
	  list Y = dropcoll(X, 1.0e-30)
	  list print Y

produz

	  ? list print X
	  foo bar foobar
	  ? list print Y
	  foo bar
	  ? list Y = dropcoll(X, 1.0e-30)
	  Replaced list Y
	  ? list print Y
	  foo bar foobar

# dsort
Resultado:  o mesmo tipo que o argumento
Argumento:  x (série ou vetor)

Ordena x de forma decrescente, descartando observações com valores
ausentes quando x for uma série. Ver também"sort", "values".

# dummify
Resultado:  lista
Argumentos: x (série)
            omitval (escalar, opcional)

O argumento x deve ser uma série discreta. Essa função cria um conjunto
de variáveis dummy, sendo uma para cada um dos valores distintos na série.
Por padrão o menor valor é tratado como a categoria omitida e não é
explicitamente representado.

O segundo argumento (opcional) representa o valor de x que deve ser tratado
como sendo a categoriaomitida. O efeito quando o argumento único for dado
é equivalente a utilizar o seguinte comando: dummify(x, min(x)). Para
produzir um conjunto completo de dummies, ou seja, sem a categoria omitida,
pode-se usar dummify(x, NA).

As variáveis geradas são automaticamente nomeadas de acordo com o seguinte
padrão: Dvarname_i onde varname é o nome da séries original e i é um
índice iniciado em 1. A porção que representa o nome original da série
será truncado, caso seja necessário, e ajustado no caso de não ser único
no conjunto de nomes assim construído.

# easterday
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Com o argumento x representando um ano, retorna a data da Páscoa no
calendário gregoriano no formato mês + dia/100. Note que 10 de abril é,
nesta convenção, 4.1. Assim, 4.2 representa 20 de abril e não 2 de abril
(que seria representado por 4.02).

	  scalar e = easterday(2014)
	  scalar m = floor(e)
	  scalar d = 100*(e-m)

# ecdf
Resultado:  matriz
Argumento:  y (série ou vetor)

Calcula a função distribuição acumulada (FDA) empírica de y. Esta é
retornada em uma matriz com duas colunas: a primeira contém os valores
únicos e ordenados de y e a segunda a frequência relativa cumulativa, isto
é, a quantidade de vezes em que o valor da observação é menor ou igual
ao valor na primeira coluna, dividida pelo número total deobservações.

# eigengen
Resultado:  matriz
Argumentos: A (matriz quadrada)
            &U (referência a matriz, ou null)

Calcula os autovalores e, opcionalmente, os autovetores, da matriz A de
ordem n x n. Se todos os autovalores forem reais uma matriz n x 1 é
retornada. Caso contrário, o resultado é uma matriz n x 2, com a primeira
coluna contendo os componentes reais e a segunda coluna os componentes
imaginários. Não é garantido que os autovalores sejam classificados em
alguma ordem particular.

Existem duas possibilidades para o segundo argumento. Ele deve ser o nome de
uma matriz existente precedida por & (para indicar o "endereço" da matriz
em questão), sendo que nesse caso um resultado auxiliar é armazenado nesta
matriz. A outra possibilidade é a utilização da palavra-chave null, sendo
que nesse caso o resultado auxiliar não é produzido.

Se o segundo argumento for não-nulo, a matriz especificada será
sobrescrita com o resultado auxiliar. Vale salientar que não é necessário
que a matriz existente tenha a dimensão adequada para receber o resultado.
A matriz U é organizada da seguinte forma:

  Se o i-ésimo autovalor for real, a i-ésima coluna de U irá conter o
  autovetor correspondente;

  Se o i-ésimo autovalor for complexo, a i-ésima coluna de U irá conter a
  parte real do autovetor correspondente e a coluna seguinte a parte
  imaginária. O autovetor para o autovalor conjugado é a conjugada do
  autovetor.

Em outras palavras, os autovetores são armazenados na mesma ordem que os
autovalores, mas os autovetores reais ocupam uma coluna, enquanto que os
autovetores complexos ocupam duas (sendo que a parte real é armazenada
primeiro). O número total de colunas ainda é n, pois o autovetor conjugado
é ignorado.

Ver também"eigensym", "eigsolve", "qrdecomp", "svd".

# eigensym
Resultado:  matriz
Argumentos: A (matriz simétrica)
            &U (referência a matriz, ou null)

Funciona da mesma forma que "eigengen", mas o argumento A deve ser
simétrico (sendo que neste caso os cálculos podem ser reduzidos).
Diferentemente de "eigengen", autovalores são retornados em ordem
ascendente.

Note: se o interesse é na decomposição espectral de uma matriz da forma
X'X, onde X é uma matriz grande, é preferível calculá-la via operador
X'X ao invés de utilizar a sintaxe mais geral X'*X. A primeira expressão
utiliza um algoritmo especializado que tem a dupla vantagem de ser mais
eficiente computacionalmente e de garantir que o resultado seja livre, por
construção, dos artefatos de precisão de máquina que podem torná-la
numericamente não-simétrico.

# eigsolve
Resultado:  matriz
Argumentos: A (matriz simétrica)
            B (matriz simétrica)
            &U (referência a matriz, ou null)

esolve o problema do autovalor generalizado |A - lambdaB| = 0, onde A e B
são simétricas e B é positiva definida. Os autovalores são retornados
diretamente, ordenados de forma ascendente. Se for utilizado o terceiro
argumento (opcional) ele deve ser o nome de uma matriz existente precedida
por &. Neste caso os autovetores generalizados serão escritos nesta matriz.

# epochday
Resultado:  escalar ou série
Argumentos: ano (escalar ou série)
            mês (escalar ou série)
            dia (escalar ou série)

Retorna o número do dia na época corrente especificada pelo ano, mês e
dia. O número do dia é igual a 1 para o dia 1 de janeiro do ano 1 depois
de Cristo, no calendário gregoriano proléptico, e 733786 na data
2010-01-01. Se algum dos argumentos for uma série, os valores retornados
também terão a forma de uma série, caso contrário será retornado um
escalar.

Por omissão os valores do ano, mês e dia assumem-se serem relativos ao
calendário gregoriano, mas se o ano fôr um valor negativo a
interpretação muda para o calendário juliano.

Para a inversa dessa função, veja "isodate". Veja também a função
"juldate" para o calendário juliano.

# errmsg
Resultado:  texto
Argumento:  errno (número inteiro)

Retorna a mensagem de erro do Gretl associada a errno. Veja também
"$error".

# exists
Resultado:  número inteiro
Argumento:  name (texto)

Retorna um valor não-nulo se name é o identificador de um objeto
existente, seja um escalar, uma série, uma matriz, uma lista, uma variável
de texto, um pacote ("bundle") ou um arranjo (" array"). Caso contrário
retorna 0. Veja também "typeof".

# exp
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna e^x. Note que no caso de matrizes a função é aplicada em cada
elemento. Para a função exponencial matricial veja "mexp".

# fcstats
Resultado:  matriz
Argumentos: y (série ou vetor)
            f (série ou vetor)

Produz um vetor coluna contendo várias estatísticas que podem ser
utilizadas para avaliar a série f, que consiste na previsão da série y,
ao longo da amostra selecionada. Dois vetores de mesmo tamanho podem ser
utilizados no lugar das duas séries.

O vetor é constituído pelas seguintes estatísticas:

	  1  Erro Médio (ME)
	  2  Raiz do Erro Quadrado Médio (RMSE)
	  3  Erro Absoluto Médio (MAE)
	  4  Erro Percentual Médio (MPE)
	  5  Erro Percentual Absoluto Médio (MAPE)
	  6  U de Theil
	  7  Proporção do viés, UM
	  8  Proporção da regressão, UR
	  9  Proporção do distúrbio, UD

Para maiores detalhes sobre o cálculo dessas estatísticas e a
interpretação dos valores de U, veja o guia de utilização do Gretl
(Capítulo 31).

# fdjac
Resultado:  matriz
Argumentos: b (vetor coluna)
            fcall (chamada a função)

Calcula uma aproximação numérica para a jacobiana associada ao vetor b de
ordem n e a função de transformação especificada pelo argumento fcall. A
chamada da função deve ter b como primeiro argumento (tanto na forma
direta quanto na forma de ponteiro), seguido por quaisquer argumentos
adicionais que podem ser necessários e o valor retornado deverá ser uma
matriz de ordem m x 1. Se executada com sucesso, fdjac retorna uma matriz de
ordem m x n contendo a jacobiana. Exemplo:

	  matrix J = fdjac(theta, myfunc(&theta, X))

A função pode utilizar três diferentes métodos: diferença anterior,
diferença bilateral ou extrapolação de Richardson com 4 nós.
Respectivamente:

J_0 = (f(x+h) - f(x))/h

J_1 = (f(x+h) - f(x-h))/2h

J_2 = [8(f(x+h) - f(x-h)) - (f(x+2h) - f(x-2h))] /12h

As três alternativas acima trazem, geralmente, um dilema entre acurácia e
velocidade. É possível escolher os métodos através do comando "set",
ajustando a variável fdjac_quality em 0, 1 ou 2.

Para maiores detalhes e exemplos veja o capítulo sobre métodos numéricos
no guia de utilização do Gretl (Capítulo 33).

Ver também"BFGSmax", "set".

# fft
Resultado:  matriz
Argumento:  X (matriz)

Calcula a transformada de Fourier real discreta. Se a matriz de entrada X
tiver n colunas, a saída terá 2n colunas, onde as partes reais são
armazenadas nas colunas ímpares e as complexas nas pares.

Quando seja necessário calcular a transformada de Fourier em vários
vetores com o mesmo número de elementos, é mais eficiente, do ponto de
vista numérico, agrupar esses vetores em uma única matriz ao invés de
aplicar a função fft em cada vetor de forma separada. Ver também"ffti".

# ffti
Resultado:  matriz
Argumento:  X (matriz)

Calcula a inversa da transformada de Fourier real discreta. Assume-se que X
contém n colunas complexas, com a parte real nas colunas ímpares e a parte
real nas pares. Assim, o número total de colunas deverá ser 2n. Uma matriz
com n colunas é retornada. returned.

Quando seja necessário calcular a inversa da transformada de Fourier em
vários vetores com o mesmo número de elementos, é mais eficiente, do
ponto de vista numérico, agrupar esses vetores em uma única matriz ao
invés de aplicar a função fft em cada vetor de forma separada. Ver
também"fft".

# filter
Resultado:  ver abaixo
Argumentos: x (série ou matriz)
            a (escalar ou vetor, opcional)
            b (escalar ou vetor, opcional)
            y0 (escalar, opcional)

Calcula uma filtragem semelhante ao ARMA do argumento x. A transformação
pode ser escrita como

y_t = a_0 x_t + a_1 x_t-1 + ... a_q x_t-q + b_1 y_t-1 + ... b_py_t-p

Se o argumento x for uma série, o resultado será também uma série. Caso
contrário, se x for uma matriz com T linhas e k colunas, o resultado será
uma matriz com o mesmo tamanho e com a filtragem sendo realizada coluna por
coluna.

Os argumentos a e b são opcionais. Eles podem ser escalares, vetores ou a
palavra-chave null.

Se a for um escalar, isto é usado como a_0 e implica em q=0. Se ele for um
vetor com q+1 elementos, eles contêm os coeficientes de a_0 a a_q. Se a for
null ou for omitido, isso é equivalente a definir a_0 =1 e q=0.

Se b for um escalar, isto é usado como b_1 e implica em p=1. Se ele for um
vetor com p elementos, eles contêm os coeficientes de b_1 a b_p. Se b for
null ou for omitido, isso é equivalente a definir B(L)=1.

O argumento escalar opcional y0 for tomado para representa todos os valores
de y anteriores ao início da amostra (usado apenas quando p>0). Se for
omitido, subentende-se que é igual a 0. Assume-se que valores
pré-amostrais de x são sempre 0.

Ver também"bkfilt", "bwfilt", "fracdiff", "hpfilt", "movavg", "varsimul".

Exemplo:

	  nulldata 5
	  y = filter(index, 0.5, -0.9, 1)
	  print index y --byobs
	  x = seq(1,5)' ~ (1 | zeros(4,1))
	  w = filter(x, 0.5, -0.9, 1)
	  print x w

produz

          index            y

          1            1     -0.40000
          2            2      1.36000
          3            3      0.27600
          4            4      1.75160
          5            5      0.92356

          x (5 x 2)

          1   1
          2   0
          3   0
          4   0
          5   0

          w (5 x 2)

          -0.40000     -0.40000
          1.3600      0.36000
          0.27600     -0.32400
          1.7516      0.29160
          0.92356     -0.26244

# firstobs
Resultado:  número inteiro
Argumento:  y (série)

Retorna o número da primeira observação não ausente da série y. Note
que se alguma forma de subamostragem estiver sendo utilizada o valor
retornado poderá ser menor que o valor retornado pela função "$t1". Ver
também"lastobs".

# fixname
Resultado:  texto
Argumento:  rawname (texto)

Tem a intenção de ser utilizada em conjunto com o comando "join". Retorna
o resultado da conversão de rawname em um identificador válido do Gretl,
que deve ser iniciado por uma letra, conter apenas letras ASCII, dígitos e
traço inferior ("underscore"), e não deve ter mais que 31 caracteres. As
regras utilizadas na conversão são:

1. Remover quaisquer caracteres que não sejam letras no início do nome.

2. Até o limite de 31 caracteres não ter sido ultrapassado ou a entrada
tiver sido exaurida: transcreve os caracteres "legais", omite os caracteres
"ilegais", com exceção dos espaços, e substitui os espaços por traços
inferiores. Se o o caractere anterior for um traço inferior o espaço será
omitido.

# floor
Resultado:  o mesmo tipo que o argumento
Argumento:  y (escalar, série ou matriz)

Consiste na função piso. Retorna o maior inteiro menor que ou igual x.
Note que "int" e floor possuem efeitos distintos em argumentos negativos:
int(-3.5) gera -3, enquanto floor(-3.5) gera -4.

# fracdiff
Resultado:  série
Argumentos: y (série)
            d (escalar)

Retorna a diferença fracionária de ordem d para a series y.

Note que teoricamente a diferenciação fracionária é um filtro
infinitamente longo. Na prática, valores antes da amostra de y_t são
assumidos com sendo iguais a zero.

É possível utilizar valores de d negativos. Nesse caso é realizada a
integração fracionária.

# gammafun
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna a função gama de x.

# genseries
Resultado:  escalar
Argumentos: varname (texto)
            rhs (série)

Permite que sejam geradas séries cujos nomes não são conhecidos a priori
e/ou que sejam criadas séries e adicionadas a uma lista utilizando apenas
uma única operação.

O primeiro argumento fornece o nome da série a ser criada (ou modificada) e
pode ser um texto literal, uma variável de texto ("string"), ou uma
expressão cujo resultado seja uma variável de texto. O segundo argumento,
rhs (abreviação em inglês de "lado direito"), define a fonte da série:
isto pode ser o nome de uma série existente ou uma expressão cujo
resultado seja uma série, da forma que aparece do lado direito do sinal de
igualdade quando se definem séries da forma usual.

O valor de retorno dessa função é o número ID das séries no conjunto de
dados, um valor que pode ser utilizado para incluir as séries em uma lista
(ou -1 caso a execução da função falhe).

Por exemplo, suponha que se queira adicionar n séries aleatórias com
distribuição normal ao conjunto de dados e colocá-las em uma lista. O
código a seguir fará isso:

	  list Normals = null
	  loop i=1..n --quiet
	      Normals += genseries(sprintf("norm%d", i), normal())
	  endloop

Ao término da execução a lista Normals irá conter as séries norm1,
norm2 e assim sucessivamente.

# getenv
Resultado:  texto
Argumento:  s (texto)

Se uma variável de ambiente de nome s estiver definida a função retorna
uma variável com o texto dessa variável, caso contrário, retorna um texto
vazio. Veja também "ngetenv".

# getline
Resultado:  escalar
Argumentos: source (texto)
            target (texto)

Essa função lê sucessivamente as linhas de source, que deve ser uma
variável de texto ("string"). A cada chamada uma linha do texto é escrita
em target (que também deve ser uma variável de texto) com o caractere de
nova linha removido. O valor retornado é 1, se existir algo a ser lido
(incluindo-se linhas em branco), ou 0, se todas as linhas de source tiverem
sido lidas.

A seguir é apresentado um exemplo onde o conteúdo de um arquivo de texto
é dividido em linhas:

	  string s = readfile("data.txt")
	  string line
	  scalar i = 1
	  loop while getline(s, line)
	      printf "line %d = '%s'\n", i++, line
	  endloop

Neste exemplo pode-se ter a certeza de que o texto foi exaurido quando o
loop terminar. Se não for desejado exaurir todas as linhas do texto pode-se
chamar a função getline, sendo que sucessivas chamadas substituirão o
conteúdo de target pela nova linha lida. Para reiniciar a leitura a partir
da primeira linha de source basta utilizar null no argumento target (ou
apenas deixá-lo em branco). Exemplos:

	  getline(s, line) # recupera uma única linha
	  getline(s, null) # reinicia a leitura

Note que apesar de a posição de leitura avançar em cada chamada de
getline, o argumento source não é modificado por essa função, apenas
target é alterado.

# ghk
Resultado:  matriz
Argumentos: C (matriz)
            A (matriz)
            B (matriz)
            U (matriz)
            &dP (referência a matriz, ou null)

Calcula a aproximação GHK (Geweke, Hajivassiliou, Keane) para a função
de distribuição normal multivariada. Veja, por exemplo, Geweke (1991). O
valor retornado é um vetor de probabilidades de ordem n x 1.

O argumento C (m x m) deve fornecer o fator de Cholesky (triangular
inferior) da matriz de covariância de m variáveis normais. Ambos os
argumentos A e B devem ser de ordem n x m, fornecendo, respectivamente, os
limites inferior e superior aplicados às variáveis em cada uma das n
observações. Quando as variáveis não possuírem limites é necessário
que tal característica seja indicada através da constante "$huge" ou de
sua negativa.

A matriz U deve ter ordem m x r, sendo r o número de elementos
pseudo-aleatórios extraídos da distribuição uniforme. Funções
convenientes para a criação de U são "muniform" e "halton".

A seguir encontra-se um caso relativamente simples onde as probabilidades
multivariadas podem ser calculada de forma analítica. As séries P e Q
devem ser numericamente muito similares entre si, sendo P a probabilidade
"verdadeira" e Q sua aproximação GHK:

	  nulldata 20
	  series inf1 = -2*uniform()
	  series sup1 = 2*uniform()
	  series inf2 = -2*uniform()
	  series sup2 = 2*uniform()

	  scalar rho = 0.25
	  matrix V = {1, rho; rho, 1}

	  series P = cdf(D, rho, inf1, inf2) - cdf(D, rho, sup1, inf2) \
	  - cdf(D, rho, inf1, sup2) + cdf(D, rho, sup1, sup2)

	  C = cholesky(V)
	  U = halton(2, 100)

	  series Q = ghk(C, {inf1, inf2}, {sup1, sup2}, U)

O argumento opcional dP pode ser usado para recuperar a matriz n x k de
derivadas das probabilidades, onde k é igual a 2m + m (m + 1)/2. As
primeiras m colunas contêm as derivadas em relação aos limites
inferiores, as próximas m as derivadas em relação aos limites superiores
e as colunas restantes as derivadas em relação aos elementos únicos da
matriz C na ordem "vech".

# gini
Resultado:  escalar
Argumento:  y (série)

Retorna o índice de desigualdade de Gini para a série y.

# ginv
Resultado:  matriz
Argumento:  A (matriz)

Retorna A^+, a Moore-Penrose ou inversa generalizada de A, calculada via
decomposição em valores singulares.

Essa matriz possui as seguintes propriedades: A A^+ A = A and A^+ A A^+ =
A^+. Além disso, os produtos A A^+ e A^+ A são simétricos por
construção.

Ver também"inv", "svd".

# halton
Resultado:  matriz
Argumentos: m (número inteiro)
            r (número inteiro)
            offset (número inteiro, opcional)

Retorna uma matriz m x r contendo m sequências de Halton de cumprimento r.
O m é limitado a um máximo de 40. As sequências são contruídas
utilizando os primeiros m primos. Por padrão os primeiros 10 elementos de
cada sequência são descartados, mas isso pode ser ajustado via argumento
opcional offset, que deve ser um número inteiro não negativo. Maiores
detalhes podem ser encontrados em Halton e Smith (1964).

# hdprod
Resultado:  matriz
Argumentos: X (matriz)
            Y (matriz)

Calcula o produto direto horizontal. Os dois argumentos devem ter o mesmo
número de linhas, r. O valor retornado é uma matriz com r linhas, onde a
i-ésima linha corresponde ao produto de Kronecker das linhas
correspondentes de X e Y.

Esta operação é chamada de "produto horizontal direto" em conformidade
com sua implementação na linguagem de programação GAUSS. Sua equivalente
na álgebra linear padrão seria chamada de produto linha a linha de
Khatri-Rao.

Exemplo: o código

	  A = {1,2,3; 4,5,6}
	  B = {0,1; -1,1}
	  C = hdprod(A, B)

produz a seguinte matriz:

          0    1    0    2    0    3
         -4    4   -5    5   -6    6

# hfdiff
Resultado:  lista
Argumentos: hfvars (lista)
            multiplier (escalar)

Dada uma "MIDAS list", produz uma lista com o mesmo tamanho contendo as
primeiras diferenças de alta frequência. O segundo argumento é opcional e
tem como valor padrão 1: ele pode ser utilizado para multiplicar as
diferenças por alguma constante.

# hfldiff
Resultado:  lista
Argumentos: hfvars (lista)
            multiplier (escalar)

Dada uma "MIDAS list", produz uma lista com o mesmo tamanho contendo as
diferenças logarítmicas de alta frequência. O segundo argumento é
opcional e tem como valor padrão 1: ele pode ser utilizado para multiplicar
as diferenças por alguma constante. Um exemplo da utilização desse
argumento é utilizar o valor 100 para obter as variações percentuais
(aproximadas).

# hflags
Resultado:  lista
Argumentos: minlag (número inteiro)
            maxlag (número inteiro)
            hfvars (lista)

Dada uma "MIDAS list", hfvars, produz uma lista contendo as defasagens de
auta frequência de minlag a maxlag. Deve-se utilizar valores positivos para
defasagens ( t - 1) e negativos para adiantamentos (t + 1). Por exemplo, se
minlag for -3 e maxlag for 5 então a lista retornada irá conter 9 séries:
3 adiantamentos, o valor atual e 5 defasagens.

Note que a efasagem de alta frequência 0 corresponde ao primeiro período
de alta frequência dentro de um período de baixa frequência, por exemplo,
o primeiro mês de um trimestre ou o primeiro dia de um mês.

# hflist
Resultado:  lista
Argumentos: x (vetor)
            m (número inteiro)
            prefix (texto)

Produz a partir de um vetor x uma lista MIDAS ("MIDAS list") de m séries,
onde m é a razão entre a frequência das observações para a variável em
x em relação a frequência base do conjunto de dados corrente. O valor de
m deve ser ao menos 3 e o comprimento de x deve ser m vezes o comprimento da
amostra selecionada corrente.

Os nomes das séries na lista retornada são definidos a partir de um dado
prefixo, dado pelo argumento prefix (este deve ser um texto ASCII com 24 ou
menos caracteres e que seja um identificador válido para o Gretl) mais 1 ou
mais prefixos representando o subperíodo da observação. Um erro será
apresentado se algum desses nomes seja idêntico a nomes de objetos já
existentes.

# hpfilt
Resultado:  série
Argumentos: y (série)
            lambda (escalar, opcional)

Retorna o componente cíclico do filtro de Hodrick-Prescott aplicado à
série y. Se o parâmetro de suavização lambda não for fornecido o Gretl
usará valores padrão com base na periodicidade dos dados. O parâmetro
será igual a 100 vezes o quadrado da periodicidade (100 para dados anuais,
1600 para dados trimestrais, etc.). Ver também"bkfilt", "bwfilt".

# I
Resultado:  matriz quadrada
Argumento:  n (número inteiro)

Retorna uma matriz identidade com n linhas e colunas.

# imaxc
Resultado:  vetor linha
Argumento:  X (matriz)

Retorna um vetor com os números das linhas onde as colunas de X atingem
seus valores máximos.

Ver também"imaxr", "iminc", "maxc".

# imaxr
Resultado:  vetor coluna
Argumento:  X (matriz)

Retorna um vetor com os números das colunas onde as linhas de X atingem
seus valores máximos.

Ver também"imaxc", "iminr", "maxr".

# imhof
Resultado:  escalar
Argumentos: M (matriz)
            x (escalar)

Calcula Prob(u'Au < x) para uma forma quadrática em variáveis normais
padrão, u, utilizando o procedimento desenvolvido por Imhof (1961).

Se o primeiro argumento, M, for uma matriz quadrada ela será utilizada para
especificar A, caso contrário, se for um vetor coluna, será utilizada como
sendo os autovalores pré-calculados de A, caso contrário um erro será
apresentado.

Ver também"pvalue".

# iminc
Resultado:  vetor linha
Argumento:  X (matriz)

Retorna um vetor com os números das linhas onde as colunas de X atingem
seus valores mínimos.

Ver também"iminr", "imaxc", "minc".

# iminr
Resultado:  vetor coluna
Argumento:  X (matriz)

Retorna um vetor com os números das colunas onde as linhas de X atingem
seus valores mínimos.

Ver também"iminc", "imaxr", "minr".

# inbundle
Resultado:  número inteiro
Argumentos: b (lote)
            key (texto)

Verifica se um pacote ("bundle") b contém um item com o nome key. O valor
retornado é um código (na forma de um número inteiro) para o tipo de
item: 0 caso não seja encontrado, 1 para escalar, 2 para série, 3 para
matriz, 4 para variável de texto, 5 para pacote ("bundle") e 6 para arranjo
("array"). A função "typestr" pode ser utilizada para se obter o nome do
tipo do item na forma de variável de texto com base em seu código.

# infnorm
Resultado:  escalar
Argumento:  X (matriz)

Retorna a norma infinito de X, isto é, o máximo ao longo das linhas de X
da soma dos valores absolutos dos elementos da linha.

Ver também"onenorm".

# inlist
Resultado:  número inteiro
Argumentos: L (lista)
            y (série)

Retorna a posição de y na lista L, ou 0 se y não estiver presente em L.

O segundo argumento pode ser dado tanto como o nome da série quanto como o
número ID da série. Se é sabido que uma série com dado nome (como por
exemplo foo) existe, então é possível chamar essa função da seguinte
forma:

	  pos = inlist(L, foo)

O que a expressão acima está solicitando é: "Informe a posição da
série foo na lista L (sendo 0 se ela não estiver incluída na lista L)".
Entretanto, se não houver certeza se a série com dado nome existe, deve-se
inserir o nome entre aspas. Isso é feito da seguinte forma:

	  pos = inlist(L, "foo")

Neste caso o que está sendo solicitado é: "Se existir uma série chamada
foo na lista L, me informe sua posição ou 0 caso ela não exista."

# int
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna a parte inteira x, truncando a parte fracional. Note que int e
"floor" possuem efeitos distintos em argumentos negativos: int(-3.5) gera
-3, enquanto floor(-3.5) gera -4. Ver também"ceil".

# inv
Resultado:  matriz
Argumento:  A (matriz quadrada)

Retorna a inversa de A. Se A for singular ou não quadrada, uma mensagem de
erro é produzida e nada é retornado. Note que o Gretl confere
automaticamente a estrutura de A e utiliza o procedimento numérico mais
eficiente para realizar a inversão.

Os tipos de matriz que o Gretl confere são: identidade, diagonal,
simétrica e positiva definida, simétrica mas não positiva definida e
triangular.

Observação: faz sentido utilizar essa função apenas se o intuito for
utilizar a inversa de A mais de uma vez. Se o objetivo for apenas calcular
uma expressão da forma A^-1B, será preferível utilizar os operadores de
"divisãon" \ e /. Veja guia de utilização do Gretl (Capítulo 15) para
detalhes.

Ver também"ginv", "invpd".

# invcdf
Resultado:  o mesmo tipo que o argumento
Argumentos: d (texto)
            ... (ver abaixo)
            p (escalar, série ou matriz)

Calculadora da função de distribuição acumulada inversa. Retorna x tal
que P(X <= x) = p, onde a distribuição de X é especificada pela letra d.
Entre os argumentos d e p, zero ou mais argumentos adicionais são
necessários para que se especifique os parâmetros da distribuição. Isso
é feito da seguinte forma:

  Normal padrão (c = z, n ou N): sem argumentos extras

  Gama (g ou G): forma; escala

  t de Student (t): graus de liberdade

  Qui-quadrado (c, x ou X): graus de liberdade

  F de Snedecor F (f ou F): graus de liberdade (num.); graus de liberdade
  (den.)

  Binomial (b ou B): probabilidade; tentativas

  Poisson (p ou P): média

  GED padronizada (E): forma

  Qui-quadrado não-central (ncX): graus de liberdade, parâmetro de
  não-centralidade

  F não-central (ncF): graus de liberdade (num.), graus de liberdade
  (den.), parâmetro de não-centralidade

  t não-central (nct): graus de liberdade, parâmetro de não-centralidade

Ver também"cdf", "critical", "pvalue".

# invmills
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna a razão inversa de Mills em x, isto é a razão entre a densidade
normal padrão e o complemento para para a função de distribuição normal
padrão, ambas avaliadas em x.

Essa função utiliza um algoritmo dedicado que fornece maior precisão
quando comparado ao cálculo via "dnorm" e "cnorm", mas a diferençae entre
os dois métodos é considerável apenas para valores muito negativos de x.

Ver também"cdf", "cnorm", "dnorm".

# invpd
Resultado:  matriz quadrada
Argumento:  A (matriz positiva definida)

Retorna a inversa da matriz simétrica positiva definida A. Essa função é
ligeiramente mais rápida que "inv" para matrizes grandes, uma vez que não
é verificado se a matriz é simétrica. Por essa razão, essa função deve
ser utilizada com cuidado.

Observação: se o intuito for inverter uma matriz na forma X'X, onde X é
uma matriz grande, é preferível computá-la via operador X'X ao invés de
utilizar a sintaxe mais geral X'*X. A primeira expressão utiliza um
algoritmo especializado que tem a dupla vantagem de ser mais eficiente
computacionalmente e de garantir que o resultado seja livre, por
construção, dos artefatos de precisão de máquina que podem torná-la
numericamente não-simétrico.

# irf
Resultado:  matriz
Argumentos: target (número inteiro)
            shock (número inteiro)
            alpha (escalar entre 0 e 1, opcional)

Essa função está disponível apenas quando o último modelo estimado foi
um VAR ou um VECM. Ela retorna uma matriz contendo as respostas estimadas da
variável target a um impulso (choque) de 1 desvio padrão na variável
shock. Essas variáveis são identificadas de acordo com suas posições na
especificação do modelo: por exemplo, se para target e shock são dados os
valores 1 e 3, respectivamente, a matriz que será retornada fornece as
respostas da primeira variável no sistema a um choque na terceira
variável.

Se o terceiro argumento alpha, que é opcional, for dado, a matriz retornada
terá três colunas: a estimativa pontual das respostas, seguida dos limites
inferior e superior de um intervalo de confiança obtido via bootstrap de 1
- α. Onde alpha = 0.1 corresponde a 90 por cento de confiança. Se alpha
for omitido ou igualado a zero, apenas a estimativa pontual será fornecida.

O número de períodos (linhas) da resposta é determinado automaticamente
com based na frequencia dos dados, mas isso pode ser ajustado via comando
"set", como por exemplo set horizon 10.

# irr
Resultado:  escalar
Argumento:  x (série ou vetor)

Retorna a Taxa Interna de Retorno para x, considerado como sendo uma
sequência de pagamentos (negativo) e recebimentos (positivo). Ver
também"npv".

# isconst
Resultado:  número inteiro
Argumentos: y (série ou vetor)
            panel-code (número inteiro, opcional)

Sem o segundo argumento (opcional), retorna 1 caso y tenha um valor
constante ao longo da amostra selecionada (ou ao longo de toda sua extensão
no caso de y ser um vetor), caso contrário retorna 0.

O segundo argumento somente é aceito se o conjunto de dados corrente for um
painel e y for uma série. Neste caso um valor de panel-code igual a 0 faz a
função verificar se a série não varia em relação ao tempo. Um valor
igual a 1 faz a função verificar se a série não varia entre as unidades
de corte transversal (ou seja, se o valor de y é o mesmo para todos os
grupos).

Se y for uma série, valores ausentes são ignorados durante a verificação
da constância da série.

# isdiscrete
Resultado:  número inteiro
Argumento:  name (texto)

Se name for um identificador para uma série correntemente definida, a
função retorna 1 se a série for marcada como sendo discreta, caso
contrário retorna 0. Se name não identifica uma série a função retorna
NA.

# isdummy
Resultado:  número inteiro
Argumento:  x (série ou vetor)

Se todos os valores contidos em x são iguais a 0 ou 1 (ou ausentes), a
função retorna o número de ocorrências do valor 1, caso contrário
retorna 0.

# isnan
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar ou matriz)

Dado um escalar como argumento, retorna 1 se x não for um número, "Not a
Number" (NaN), caso contrário 0. Dada uma matriz como argumento, retorna
uma matriz com a mesma dimensão com elementos iguais a 1 nas posições
onde o elemento correspondente da matriz de entrada for NaN e 0 nas demais
posições.

# isnull
Resultado:  número inteiro
Argumento:  name (texto)

Retorna 0 se name for o identificador de um objeto correntemente definido,
seja um escalar, uma série, uma matriz, uma lista, uma variável de texto
ou um pacote ("bundle"). Caso contrário 1.

Esta função é considerada obsoleta e recomenda-se substituí-la pela
(negação de) "exists".

# isoconv
Resultado:  escalar
Argumentos: date (série)
            &year (referência a série)
            &month (referência a série)
            &day (referência a série, opcional)

Dada uma série date contendo datas no formato ISO 8601 "básico"
(YYYYMMDD), essa função escreve os componentes ano, mês e (opcionalmente)
dia em séries nomeadas pelos argumentos year, month e dayecond. Um exemplo,
assumindo que a série dates contém os valores adequados de 8 dígitos,
seria:

	  series y, m, d
	  isoconv(dates, &y, &m, &d)

Essa função retorna 0 em caso de sucesso e um valor não-nulo em caso de
erro.

# isodate
Resultado:  ver abaixo
Argumentos: ed (escalar ou série)
            as-string (booleano, opcional)

O argumento ed é interpretado como um dia na época corrente (que por sua
vez é igual a 1 para o primeiro dia de janeiro do ano 1 depois de Cristo,
no calendário gregoriano proléptico). O valor padrão de retorno -- de
mesmo tipo que o de ed -- é um número com 8 dígitos, ou uma série
composta por tais números, seguindo o padrão YYYYMMDD (formato ISO 8601
"básico"), fornecendo a data correspondente no calendário gregoriano ao
dia na época.

Se ed for (apenas) um escalar e o segundo argumento opcional as-string for
não-nulo, o valor de retorno não é numérico mas sim uma variável de
texto ("string") no padrão YYYY-MM-DD (padrão ISO 8601 "estendido").

Para a função inversa veja "epochday". Veja também a função "juldate".

# iwishart
Resultado:  matriz
Argumentos: S (matriz simétrica)
            v (número inteiro)

Dado S (uma matriz de ordem p x p positiva definida), retorna um valor
extraído da distribuição Inversa de Wishart com v graus de liberdade. A
matriz retornada é também uma p x p. O algoritmo de Odell e Feiveson
(1966) é utilizado.

# jsonget
Resultado:  texto
Argumentos: buf (texto)
            path (texto)

The argument buf should be a JSON buffer, as may be retrieved from a
suitable website via the "curl" function, and the path argument should be a
JsonPath specification.

This function returns a variável de texto ("string") representando the data
found in the buffer at the specified path. Data types of double
(floating-point), int (integer) and variável de texto are supported. In the
case of doubles or ints, their variável de texto representation is returned
(using the "C" locale for doubles). If the object to which path refers is an
arranjo ("array"), the members are printed one per line in the returned
variável de texto.

An accurate account of JsonPath syntax can be found at
http://goessner.net/articles/JsonPath/. However, please note that the
back-end for jsonget is provided by json-glib, which does not necessarily
support all elements of JsonPath. Moreover, the exact functionality of
json-glib may differ depending on the version you have on your system. See
http://developer.gnome.org/json-glib/ if you need details.

Dito isto, os seguintes operadores deverão estar disponíveis para jsonget:

  root node, via caracter $

  operador descendente recursivo: ..

  operador wildcard: *

  subscript operator: []

  set notation operator, por exemplo [i,j]

  slice operator: [start:end:step]

# juldate
Resultado:  ver abaixo
Argumentos: ed (escalar ou série)
            as-string (booleano, opcional)

The argument ed is interpreted as an epoch day, which equals 1 for the first
of January in the year AD 1 on the proleptic Gregorian calendar. The default
return value -- of the same type as ed -- is an 8-digit number, or a series
of such numbers, on the pattern YYYYMMDD (ISO 8601 "basic" format), giving
the Julian calendar date corresponding to the epoch day.

If ed is a scalar (only) and the optional second argument as-string is
non-zero, the return value is not numeric but rather a string on the pattern
YYYY-MM-DD (ISO 8601 "extended" format).

See also "isodate".

# kdensity
Resultado:  matriz
Argumentos: x (série ou vetor)
            scale (escalar, opcional)
            control (booleano, opcional)

Computes a kernel density estimate para a series or vector x. The returned
matrix has two columns, the first holding a set of evenly spaced abscissae
and the second the estimated density at each of these points.

The optional scale parameter can be used to adjust the degree of smoothing
relative to the default of 1.0 (higher values produce a smoother result).
The control parameter acts as a boolean: 0 (the default) means that the
Gaussian kernel is used; a non-zero value switches to the Epanechnikov
kernel.

A plot of the results may be obtained using the "gnuplot" command, as in

	  matrix d = kdensity(x)
	  gnuplot 2 1 --matrix=d --with-lines --fit=none

# kdsmooth
Resultado:  escalar
Argumentos: &Mod (referência a lote)
            MSE (booleano, opcional)

Performs disturbance smoothing for a Kalman bundle previously set up by
means of "ksetup" and returns 0 on successful completion or 1 if numerical
problems are encountered.

On successful completion, the smoothed disturbances will be available as
Mod.smdist.

The optional MSE argument determines the contents of the Mod.smdisterr key.
If 0 or omitted, this matrix will contain the unconditional standard errors
of the smoothed disturbances, which are normally used to compute the
so-called auxiliary residuals. Otherwise, Mod.smdisterr will contain the
estimated root mean square deviations of the auxiliary residuals from their
true value.

Para maiores detalhes veja guia de utilização do Gretl (Capítulo 32).

Ver também"ksetup", "kfilter", "ksmooth", "ksimul".

# kfilter
Resultado:  escalar
Argumento:  &Mod (referência a lote)

Performs a forward, filtering pass on a Kalman bundle previously set up by
means of "ksetup" and returns 0 on successful completion or 1 if numerical
problems are encountered.

Se a operação for completada com sucesso os erros de previsão de 1 passo
à frente estarão disponíveis como Mod.prederr e a sequência de suas
variâncias como Mod.pevar. Além disso, Mod.llt dará acesso a um T-vector
contendo o log da verossimilhança por observação.

Para maiores detalhes veja guia de utilização do Gretl (Capítulo 32).

Ver também"kdsmooth", "ksetup", "ksmooth", "ksimul".

# kmeier
Resultado:  matriz
Argumentos: d (série ou vetor)
            cens (série ou vetor, opcional)

Given a sample of duration data, d, possibly accompanied by a record of
censoring status, cens, computes the Kaplan-Meier nonparametric estimator of
the survival function (Kaplan and Meier, 1958). The returned matrix has
three columns holding, respectively, the sorted unique values in d, the
estimated survival function corresponding to the duration value in column 1
and the (large sample) standard error of the estimator, calculated via the
method of Greenwood (1926).

If the cens series is given, the value 0 is taken to indicate an uncensored
observation while a value of 1 indicates a right-censored observation (that
is, the period of observation of the individual in question has ended before
the duration or spell has been recorded as terminated). If cens is not
given, it is assumed that all observations are uncensored. (Note: the
semantics of cens may be extended at some point to cover other types of
censoring.)

Ver também"naalen".

# kpsscrit
Resultado:  matriz
Argumentos: T (escalar)
            trend (booleano)

Retorna um vetor linha contendo os valores críticos aos níveis de 10, 5 e
1 porcento do teste KPSS para a estacionariedade de uma série temporal. O
argumento T deve fornecer o número de observações e o argumento trend
deve ser igual a 1 se o teste inclui uma constante, ou 0, caso contrário.

Os valores críticos são baseados nas superfícies de resposta estimados
conforme sugerido por Sephton (Economics Letters,1995). Veja também o
comando "kpss".

# ksetup
Resultado:  lote
Argumentos: Y (série, matriz ou lista)
            H (escalar ou matriz)
            F (escalar ou matriz)
            Q (escalar ou matriz)
            C (matriz, opcional)

Sets up a Kalman bundle, that is an object which contains all the
information needed to define a linear state space model of the form

  y(t) = H'a(t)

and state transition equation

  a(t+1) = F a(t) + u(t)

onde Var(u) = Q.

Objects created via this function can be later used via the dedicated
functions "kfilter" for filtering, "ksmooth" and "kdsmooth" for smoothing
and "ksimul" for performing simulations.

The class of models that gretl can handle is in fact much wider than the one
implied by the representation above: it is possible to have time-varying
models, models with diffuse priors and exogenous variável in the
measurement equation and models with cross-correlated innovations. For
further details, see guia de utilização do Gretl (Capítulo 32).

Ver também"kdsmooth", "kfilter", "ksmooth", "ksimul".

# ksimul
Resultado:  escalar
Argumento:  &Mod (referência a lote)

Utiliza um pacote ("bundle") de Kalman previamente definido através da
função "ksetup" para simular dados.

Para detahes veja guia de utilização do Gretl (Capítulo 32).

Ver também"ksetup", "kfilter", "ksmooth".

# ksmooth
Resultado:  matriz
Argumento:  &Mod (referência a lote)

Performs a fixed-point smoothing (backward) pass on a Kalman bundle
previously set up by means of "ksetup" and returns 0 on successful
completion or 1 if numerical problems are encountered.

On successful completion, the smoothed states will be available as Mod.state
and the sequence of their covariance matrizes as Mod.stvar. Para maiores
detalhes veja guia de utilização do Gretl (Capítulo 32).

Ver também"ksetup", "kdsmooth", "kfilter", "ksimul".

# kurtosis
Resultado:  escalar
Argumento:  x (série)

Retorna o excesso de curtose da série x, descartando quaisquer
observações ausentes.

# lags
Resultado:  lista ou matriz
Argumentos: p (escalar ou vetor)
            y (série, lista ou matriz)
            bylag (booleano, opcional)

Se o primeiro argumento for um escalar, gera as defasagens de 1 até p da
série y, se y for uma lista, retorna as defasagens de todas as séries na
lista e se for uma matriz, retorna as defasagens de todas as colunas na
matriz. Se p = 0 e y for uma série ou lista, são geradas defasagens até o
máximo da periodicidade dos dados. Caso contrário, o valor de p deve ser
positivo.

Se o primeiro argumento for um vetor, as defasagens serão aquelas
especificadas no vetor. Um uso típico neste caso seria fornecer p como, por
exemplo, seq(3,7), omitindo assim a primeira e a segunda defasagens.
Entretanto ambém é possível fornecer um vetor não contínuo como em
{3,5,7}, contanto que as defasagens estejam sempre ordenadas de forma
crescente.

Quando o valor retornado for uma lista, as variáveis geradas são nomeadas
automaticamente de acordo com o esquema varname_i, onde varname é o nome da
série original e i é a defasagem específica. A parte original do nome é
truncada, caso necessário, e pode ser ajustada no caso de
não-singularidade no conjunto de nomes assim construído.

Quando y for uma lista, ou uma matriz com mais de uma coluna, e a ordem de
defasagem for maior que 1, a ordenação padrão dos termos no valor
retornado pelafunção é feita por variável: todas as defasagens da
primeira série ou coluna seguida por todas as defasagens da segunda e assim
sucessivamente. O terceiro argumento (opcional) pode ser utilizado para
alterar esse comportamento: se bylag for não-nulo então os termos são
ordenados por defasagem: defasagem 1 de todas as séries ou colunas, seguida
pela defasagem 2 de todas as séries e colunas e assim sucessivamente.

Veja também "mlag" para o uso com matrizes.

# lastobs
Resultado:  número inteiro
Argumento:  y (série)

Retorna o número da última observação não ausente da série y. Note que
se alguma forma de subamostragem estiver sendo utilizada o valor retornado
poderá ser maior que o valor retornado pela função "$t2". Ver
também"firstobs".

# ldet
Resultado:  escalar
Argumento:  A (matriz quadrada)

Retorna o log natural do determinante de A, calculado via decomposição LU.
Ver também"det", "rcond", "cnumber".

# ldiff
Resultado:  o mesmo tipo que o argumento
Argumento:  y (série ou lista)

Calcula as diferenças logarítmicas. Os valores iniciais são considerados
como NA.

Quando uma lista for retornada, as variáveis individuais são
automaticamente nomeadas de acordo com o esquema ld_varname, onde varname é
o nome da série original. Se necessário, o nome será truncado e poderá
ser ajustado caso o nome resultante já esteja sendo utilizado pelo Gretl.

Ver também"diff", "sdiff".

# lincomb
Resultado:  série
Argumentos: L (lista)
            b (vetor)

Calcula uma nova série como uma combinação linear das séries na lista L.
Os coeficientes são dados pelo vetor b cujo tamanho deve ser igual ao
número de séries em series in L.

Ver também"wmean".

# linearize
Resultado:  série
Argumento:  x (série)

É necessário possuir o TRAMO instalado. Retorna uma versão "linearizada"
da série de entrada. Isto é, uma série onde quaisquer valores ausentes
são substituídos por valores interpolados e onde as observações
aberrantes são ajustadas. O mecanismo completamente automático do TRAMO é
usado para isso. Consulte a documentação do TRAMO para detalhes.

Note que se a série de entrada não possuir valores ausentes e e
observações aberrantes (conforme idetificadas pelo TRAMO), a função
retornará uma cópia da série original.

# ljungbox
Resultado:  escalar
Argumentos: y (série)
            p (número inteiro)

Calcula a estatística Q de Ljung-Box para a série y, utilizando a ordem de
defasagem p, ao longo da amostra selecionada. A defasagem deve ser maior ou
igual a 1 e menor que o número de observações disponíveis.

Essa estatística pode ser testada contra a distribuição qui-quadrado com
p graus de liberdade para verificar a hipótese nula de que a série y não
é serialmente correlacionada. Ver também"pvalue".

# lngamma
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna o log da função gama de x.

# loess
Resultado:  série
Argumentos: y (série)
            x (série)
            d (número inteiro, opcional)
            q (escalar, opcional)
            robust (booleano, opcional)

Performs locally-weighted polynomial regression and returns a series holding
predicted values of y for each non-missing value of x. The method is as
described by William Cleveland (1979).

The optional arguments d and q specify the order of the polynomial in x and
the proportion of the data points to be used in local estimation,
respectively. The default values are d = 1 and q = 0.5. The other acceptable
values for d are 0 and 2. Setting d = 0 reduces the local regression to a
form of moving average. The value of q must be greater than 0 and cannot
exceed 1; larger values produce a smoother outcome.

If a non-zero value is given for the robust argument the local regressions
are iterated twice, with the weights being modified based on the residuals
from the previous iteration so as to give less influence to outliers.

Veja também "nadarwat". Adicionalmente, para detalhes acerca de métodos
não-paramétricos veja guia de utilização do Gretl (Capítulo 36)..

# log
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série, matriz ou lista)

Retorna o logaritmo natural de x. Gera NA para valores não-positivos. Note
que ln é um pseudônimo aceitável para log.

Quando uma lista for retornada, as variáveis individuais serão
automaticamente nomeadas de acordo com o modelo l_varname, onde varname é o
nome da série original. O nome será truncado se necessário e pode ser
ajustado no caso de já estar sendo usado pelo Gretl.

# log10
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna o logaritmo na base 10 de x. A função irá gerar NA para valores
não-positivos.

# log2
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna o logaritmo na base 2 de x. A função irá gerar NA para valores
não-positivos.

# logistic
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna a função logística do argumento x, isto é, e^x/(1 + e^x). Se x
for ma matriz, a função será aplicada em cada elemento.

# lower
Resultado:  matriz quadrada
Argumento:  A (matriz)

Retorna uma matriz triangular inferior de ordem n x n. Os elementos da
diagonal e abaixo desta são iguais aos elementos correspondentes de A e os
demais iguais a zero.

Ver também"upper".

# lrvar
Resultado:  escalar
Argumentos: y (série ou vetor)
            k (número inteiro)

Retorna a variância de longo prazo de y, calculada utilizando um núcleo de
Bartlett com tamanho de janela igual a k. O tamanho padrão da janela (isto
é, a parte inteira da raiz cúbica do tamanho da amostra) pode ser
selecionado dando valor negativo para k.

# max
Resultado:  escalar ou série
Argumento:  y (série ou lista)

Se o argumento y for uma série, retorna, na forma de um escalar, o valor
máximo das observações não ausentes na série. Se o argumento for uma
lista, retorna uma série onde cada elemento é o valor máximo em cada
observação entre as séries listadas.

Ver também"min", "xmax", "xmin".

# maxc
Resultado:  vetor linha
Argumento:  X (matriz)

Retorna um vetor com os valores máximos das colunas de X.

Ver também"imaxc", "maxr", "minc".

# maxr
Resultado:  vetor coluna
Argumento:  X (matriz)

Retorna um vetor com os valores máximos das linhas X.

Ver também"imaxr", "maxc", "minr".

# mcorr
Resultado:  matriz
Argumento:  X (matriz)

Calcula a matriz de correlações tratando cada coluna de X como sendo uma a
variável. Ver também"corr", "cov", "mcov".

# mcov
Resultado:  matriz
Argumento:  X (matriz)

Calcula a matriz de covariâncias tratando cada coluna de X como sendo uma
variável. Ver também"corr", "cov", "mcorr".

# mcovg
Resultado:  matriz
Argumentos: X (matriz)
            u (vetor, opcional)
            w (vetor, opcional)
            p (número inteiro)

Retorna uma matriz covariograma para uma matriz X de ordem T x k
(normalmente contendo regressores), um vetor u (opcional) com T elementos
(normalmente contendo resíduos), um vetor de pesos w (optional) com p+1
elementos e uma ordem de defasagem p, que deve ser maior ou igual a 0.

A matriz retornada é dada por

sum_{j=-p}^p sum_j w_{|j|} (X_t' u_t u_{t-j} X_{t-j})

Se u for dado como null os termos u são omitidos e se w for dado como null
todos o pesos são considerados iguais a 1.

# mean
Resultado:  escalar ou série
Argumento:  x (série ou lista)

Se x for uma série a função retorna a média amostral (na forma de um
escalar), descartando quaisquer observações ausentes.

Se x for uma lista a função retorna uma série y tal que y_t é a média
dos valores das variáveis da lista na observação t, ou NA se existir
algum valor ausente em t.

# meanc
Resultado:  vetor linha
Argumento:  X (matriz)

Retorna um vetor com as médias das colunas de X. Ver também"meanr",
"sumc", "sdc".

# meanr
Resultado:  vetor coluna
Argumento:  X (matriz)

Retorna um vetor com as médias das linhas de X. Ver também"meanc", "sumr".

# median
Resultado:  escalar ou série
Argumento:  x (série ou lista)

Se x for uma série, a função retorna sua mediana amostral (na forma de um
escalar), ignorando quaisquer observações ausentes.

Se x for uma lista, a função retorna uma séries y tal que y_t é a
mediana dos valores das variáveis da lista na observação t, ou NA se
existir algum valor ausente em t.

# mexp
Resultado:  matriz quadrada
Argumento:  A (matriz quadrada)

Calcula a matriz exponencial de A utilizando o algoritmo 11.3.1 de Golub e
Van Loan (1996).

# mgradient
Resultado:  matriz
Argumentos: p (número inteiro)
            theta (vetor)
            type (número inteiro)

Analytical derivatives for MIDAS weights. Let k denote the number of
elements in the vector of hyper-parameters, theta. This function returns a p
x k matrix holding the gradient of the vector of weights (as calculated by
"mweights") with respect to the elements of theta. The first argument
represents the desired lag order and the last argument specifies the type of
parameterization. See mweights for an account of the acceptable type values.

Ver também"mweights", "mlincomb".

# min
Resultado:  escalar ou série
Argumento:  y (série ou lista)

Se o argumento y for uma série, retorna, na forma de um escalar, o valor
mínimo das observações não ausentes na série. Se o argumento for uma
lista, retorna uma série onde cada elemento é o valor mínimo em cada
observação entre as séries listadas.

Ver também"max", "xmax", "xmin".

# minc
Resultado:  vetor linha
Argumento:  X (matriz)

Retorna um vetor com os valores mínimos das colunas de X.

Ver também"iminc", "maxc", "minr".

# minr
Resultado:  vetor coluna
Argumento:  X (matriz)

Retorna um vetor com os valores mínimos das linhas de X.

Ver também"iminr", "maxr", "minc".

# missing
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou lista)

Retorna uma variável binária igual a 1 se x for NA e 0, caso contrário.
Se x for uma série, a comparação é feita em cada um de seus elementos.
Se x for uma lista de séries, a função retorna uma série igual a 1 nas
observações nas quais ao menos uma das séries apresente um NA e 0, caso
contrário.

Ver também"misszero", "ok", "zeromiss".

# misszero
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar ou série)

Converte NAs em zeros. Se x for uma série a conversão será feita elemento
por elemento. Ver também"missing", "ok", "zeromiss".

# mlag
Resultado:  matriz
Argumentos: X (matriz)
            p (escalar ou vetor)
            m (escalar, opcional)

Shifts up or down the rows of X. If p is a positive scalar, retorna uma
matrix in which the columns of X are shifted down by p rows and the first p
rows are filled with the value m. If p is a negative number, X is shifted up
and the last rows are filled with the value m. If m is omitted, it is
understood to be zero.

If p is a vector, the above operation is carried out for each element in p,
joining the resulting matrizes horizontally.

See also "lags".

# mlincomb
Resultado:  série
Argumentos: hfvars (lista)
            theta (vetor)
            type (número inteiro)

A convenience MIDAS function which combines "lincomb" with "mweights". Given
a list hfvars, it constructs a series which is a weighted sum of the
elements of the list, the weights based on the vector of hyper-parameters
theta and the type of parameterization: see mweights for details. Note that
"hflags" is generally the best way to create a list suitable as the first
argument to this function.

To be explicit, the call

	  series s = mlincomb(hfvars, theta, 2)

is equivalent to

	  matrix w = mweights(nelem(hfvars), theta, 2)
	  series s = lincomb(hfvars, w)

but use of mlincomb saves on some typing and also some CPU cycles.

# mnormal
Resultado:  matriz
Argumentos: r (número inteiro)
            c (número inteiro)

Retorna uma matriz com r linhas e c colunas, preenchida com variáveis
pseudo aleatórias com distribuição normal padrão. Ver também"normal",
"muniform".

# mols
Resultado:  matriz
Argumentos: Y (matriz)
            X (matriz)
            &U (referência a matriz, ou null)
            &V (referência a matriz, ou null)

Returns a k x n matrix of parameter estimates obtained by MQO regression of
the T x n matrix Y on the T x k matrix X.

If the third argument is not null, the T x n matrix U will contain the
residuals. If the final argument is given and is not null then the k x k
matrix V will contain (a) the matriz de covariâncias of the parameter
estimates, if Y has just one column, or (b) X'X^-1 if Y has multiple
columns.

By default, estimates are obtained via decomposição de Cholesky, with a
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.

Ver também"mpols", "mrls".

# monthlen
Resultado:  número inteiro
Argumentos: mês (número inteiro)
            ano (número inteiro)
            dias na semana (número inteiro)

Retorna o número de dias (relevantes) no mês e ano especificados (no
calendário gregoriano proléptico). O argumento dias na semana, que pode
ser igual a 5, 6 ou 7, indica o número de dias da semana que devem ser
considerados (se for escolhido 6 os domingos são omitidos e se for
escolhido 5 os sábados e os domingos serão omitidos).

# movavg
Resultado:  série
Argumentos: x (série)
            p (escalar)
            control (número inteiro, opcional)
            y0 (escalar, opcional)

Depending on the value of the parameter p, returns either a simple or an
exponentially weighted moving average of the input series x.

If p > 1, a simple p-term moving average is computed, that is, the
arithmetic mean of x from period t to t-p+1. If a non-zero value is supplied
para o optional control parameter the MA is centered, otherwise it is
"trailing". The optional y0 argument is ignored.

If p is a positive fraction, an exponential moving average is computed:

y(t) = p*x(t) + (1-p)*y(t-1)

By default the output series, y, is initialized using the first value of x,
but the control parameter may be used to specify the number of initial
observações that should be averaged to produce y(0). A zero value for
control indicates that all the observações should be used. Alternatively,
an initializer may be specified using the optional y0 argument; in that case
the control argument is ignored.

# mpols
Resultado:  matriz
Argumentos: Y (matriz)
            X (matriz)
            &U (referência a matriz, ou null)

Works exactly as "mols", except that the calculations are done in multiple
precision using the GMP library.

By default GMP uses 256 bits for each floating point number, but you can
adjust this using the environment variável GRETL_MP_BITS, como por exemplo
GRETL_MP_BITS=1024.

# mrandgen
Resultado:  matriz
Argumentos: d (texto)
            p1 (escalar)
            p2 (escalar, condicional)
            p3 (escalar, condicional)
            rows (número inteiro)
            cols (número inteiro)
Exemplos:   matrix mx = mrandgen(u, 0, 100, 50, 1)
            matrix mt14 = mrandgen(t, 14, 20, 20)

Funciona da mesma forma que "randgen" exceto pelo fato de retornar uma
matriz ao invés de uma série. Os argumentos iniciais para essa função
(os números que a distribuição selecionada depende) são descritos por
randgen, mas eles devem ser seguidos por dois inteiros para especificar o
número de linhas e colunas da matriz aleatória desejada.

O primeiro exemplo acima gera um vetor coluna com 50 elementos seguindo uma
distribuição uniforme, enquanto que o segundo exemplo especifica uma
matriz aleatória de ordem 20 x 20 com valores extraídos da distribuição
t com 14 graus de liberdade.

Ver também"mnormal", "muniform".

# mread
Resultado:  matriz
Argumentos: fname (texto)
            import (booleano, opcional)

Lê uma matriz armazenada no arquivo chamado fname . Se o arquivo possuir a
extensão ".gz " é assumido que ele foi comprimido no formato gzip, se
tiver a extensão ".bin" é assumido que o arquivo está em formato binário
(veja "mwrite" para detalhes). Caso contrário assume-se que é um arquivo
de texto simples, seguindo as seguintes especificações:

  O arquivo pode começar com qualquer qualquer quantidade de comentários,
  definidos por linhas iniciadas com o caractere #. Essas linhas serão
  ignoradas.

  A primeira que não for de comentário deve conter dois inteiros,
  separados por um espaço ou uma tabulação, indicando o número de linhas
  e colunas, respectivamente.

  As colunas devem estar separadas por espaços ou por tabulações.

  O separador decimal deve ser o ponto (".").

Se no primeiro argumento não estiver especificado o caminho completo até o
arquivo ele será em vários locais que sejam considerados como sendo
"prováveis". O primeiro deles será o diretório de trabalho em uso
"workdir". Entretanto, se o segundo argumento da função, import, for um
valor não-nulo o arquivo será procurado no diretório "@dotdir". Isto
ocorre para que essa função seja utilizada em conjunto com as que exportam
matrizes presentes no contexto do comando "foreign". Nesse caso o argumento
fname deve ser um nome simples, sem que se especique o caminho para o
arquivo.

Ver também"bread", "mwrite".

# mreverse
Resultado:  matriz
Argumento:  X (matriz)

Retorna uma matriz contendo as linhas de X em ordem reversa. Para obter uma
matriz na qual as colunas de X apareçam em ordem reversa pode-se utilizar:

	  matrix Y = mreverse(X')'

# mrls
Resultado:  matriz
Argumentos: Y (matriz)
            X (matriz)
            R (matriz)
            q (vetor coluna)
            &U (referência a matriz, ou null)
            &V (referência a matriz, ou null)

Mínimos quadrados restritos: retorna uma matriz k x n de parâmetros
estimados obtidos através da regressão via mínimos quadrados da matriz Y,
de ordem T x n, contra a matriz X, de ordem T x k, sujeitos à restrição
linear RB = q, onde B representa o vetor de coeficientes empilhados. R deve
possuir kn colunas. Cada linha dessa matriz representa uma restrição
linear. O número de linhas em q deve coincidir com o número de linhas em
R.

Se o quinto argumento não for null, a matriz U de ordem T x n irá
armazenar os resíduos. Se o argumento final for dado e não for null então
a matriz V de ordem k x k irá armazenar a contraparte restrita da matriz X'
X^-1. A matriz de variância das estimativas para a equação i pode ser
construída multiplicando-se a sub-matriz apropriada de V por uma estimativa
do erro para esta equação.

# mshape
Resultado:  matriz
Argumentos: X (matriz)
            r (número inteiro)
            c (número inteiro)

Rearranja os elementos de X em uma matriz com r linhas e c colunas. Os
elementos de X são copiados e escritos na matriz de destino. A cópia tem
início na coluna 1, linha 1, depois linha 2 e assim sucessivamente. Se X
tiver menos que k = rc elementos, estes são repetidos de forma cíclica.
Caso contrário, se X tiver mais elementos, apenas os primeiros k elementos
serão utilizados.

Ver também"cols", "rows", "unvech", "vec", "vech".

# msortby
Resultado:  matriz
Argumentos: X (matriz)
            j (número inteiro)

Retorna uma matriz onde as linhas de X são reordenadas de forma crescente
de acordo com os elementos da coluna j. Essa ordenação é estável: linhas
que compartilham o mesmo valor na coluna j não serão invertidas.

# muniform
Resultado:  matriz
Argumentos: r (número inteiro)
            c (número inteiro)

Retorna uma matriz com r linhas e c colunas, preenchida com números
pseudo-aleatórios seguindo uma distribuição uniforme (0,1). Observação:
o método preferencial para gerar escalares pseudo-aleatórios com
distribuição uniforme é através da utilização da função "randgen1".

Ver também"mnormal", "uniform".

# mweights
Resultado:  matriz
Argumentos: p (número inteiro)
            theta (vetor)
            type (número inteiro)

Returns a p-vector of MIDAS weights to be applied to p lags of a
high-frequency series, based on the vector theta of hyper-parameters.

The type argument identifies the type of parameterization, which governs the
required number of elements, k, in theta: 1 = normalized exponential Almon
(k at least 1, typically 2); 2 = normalized beta with zero last (k = 2); 3 =
normalized beta with non-zero last lag (k = 3); and 4 = Almon polynomial (k
at least 1).

Ver também"mgradient".

# mwrite
Resultado:  número inteiro
Argumentos: X (matriz)
            fname (texto)
            export (booleano, opcional)

Writes the matrix X to a file named fname. By default this file will be
plain text; the first line will hold two integers, separated by a tab
character, representando the number of rows and columns; on the following
lines the matrix elements appear, in scientific notation, separated by tabs
(one line per row). See below for alternative formats.

If a file fname already exists, it will be overwritten. The return value is
0 on successful completion; if an error occurs, such as the file being
unwritable, the return value will be non-zero.

The output file will be written in the currently set "workdir", unless the
filename variável de texto ("string") contains a full path specification.
However, if a non-zero value is given para o export argument, the output
file will be written into the user's "dot" directory, onde it is accessible
by default via the matrix-loading functions offered in the context of the
"foreign" command. In this case a plain filename, without any path
component, should be given para o second argument.

Matrizes stored via the mwrite function in its default form can be easily
read by other programs; veja guia de utilização do Gretl (Capítulo 15)
para detalhes.

Two mutually exclusive inflections of this function are available, as
follows:

  If fname has the suffix ".gz" the the file is written with gzip
  compression.

  If fname has the suffix ".bin" then the file is written in binary format.
  In this case the first 19 bytes contain the characters
  gretl_binary_matrix, the next 8 bytes contain two 32-bit integers giving
  the number of rows and columns, and the remainder of the file contains the
  matrix elements as little-endian "doubles", in column-major order. If
  gretl is run on a big-endian system, the binary values are converted to
  little endian on writing, and converted to big endian on reading.

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
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
not recommended for very large matrices, since decompression can be quite
slow.

Ver também"mread".

# mxtab
Resultado:  matriz
Argumentos: x (série ou vetor)
            y (série ou vetor)

Retorna uma matriz 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
(both series or both column vectors), and because of the typical usage of
this function, are assumed to contain integer values only.

Ver também"values".

# naalen
Resultado:  matriz
Argumentos: d (série ou vetor)
            cens (série ou vetor, opcional)

Given a sample of duration data, d, possibly accompanied by a record of
censoring status, cens, computes the Nelson-Aalen nonparametric estimator of
the hazard function (Nelson, 1972; Aalen, 1978). The returned matrix has
three columns holding, respectively, the sorted unique values in d, the
estimated cumulated hazard function corresponding to the duration value in
column 1, and the standard error of the estimator.

If the cens series is given, the value 0 is taken to indicate an uncensored
observation while a value of 1 indicates a right-censored observation (that
is, the period of observation of the individual in question has ended before
the duration or spell has been recorded as terminated). If cens is not
given, it is assumed that all observations are uncensored. (Note: the
semantics of cens may be extended at some point to cover other types of
censoring.)

Ver também"kmeier".

# nadarwat
Resultado:  série
Argumentos: y (série)
            x (série)
            h (escalar)

Retorna o Nadaraya-Watson nonparametric estimator of the conditional mean of
y given x. It retorna uma série holding the nonparametric estimate of
E(y_i|x_i) for each nonmissing element of the series x.

The kernel function K is given by K = exp(-x^2 / 2h) for |x| < T and zero
otherwise.

The argument h, known as the bandwidth, is a parameter (a positive real
number) given by the user. This is usually a small number: larger values of
h make m(x) smoother; a popular choice is n^-0.2. More details are given in
guia de utilização do Gretl (Capítulo 36).

The scalar T is used to prevent numerical problems when the kernel function
is evaluated too far away from zero and is called the trim parameter.

The trim parameter can be adjusted via the nadarwat_trim setting, as a
multiple of h. The default value is 4.

The user may provide a negative value para a bandwidth: this is interpreted
as conventional syntax to obtain the leave-one-out estimator, that is a
variant of the estimator that does not use the i-th observation for
evaluating m(x_i). This makes the Nadaraya-Watson estimator more robust
numerically and its usage is normally advised when the estimator is computed
for inference purposes. Of course, the bandwidth actually used is the
absolute value of h.

# nelem
Resultado:  número inteiro
Argumento:  L (lista, matriz, lote ou cadeia)

Retorna o número de elementos no argumento que, por sua vez, pode ser uma
lista, uma matriz, um pacote ("bundle") ou um arranjo ("array"). A função
não pode ser utilizada em séries.

# ngetenv
Resultado:  escalar
Argumento:  s (texto)

Se uma variável de ambiente de nome s estiver definida e possuir um valor
numérico a função retorna este valor, caso contrário, retorna NA. Veja
também "getenv".

# nlines
Resultado:  escalar
Argumento:  buf (texto)

Retorna a quantidade de linhas completas (isto é, linhas que terminam com
um caractere de nova linha) em buf.

Exemplo:

        string web_page = readfile("http://gretl.sourceforge.net/")
        scalar number = nlines(web_page)
        print number

# NMmax
Resultado:  escalar
Argumentos: &b (referência a matriz)
            f (chamada a função)
            maxfeval (número inteiro, opcional)

Numerical maximization via the Nelder-Mead derivative-free simplex method.
On input the vector b should hold the initial values of a set of parameters,
and the argument f should specify a call to a function that calculates the
(scalar) criterion to be maximized, given the current parameter values and
any other relevant data. On successful completion, NMmax returns the
maximized value of the criterion, and b holds the parameter values which
produce the maximum.

The optional third argument may be used to set the maximum number of
function evaluations; if it is omitted or set to zero the maximum defaults
to 2000. As a special signal to this function the maxfeval value may be set
to a negative number. In this case the absolute value is taken, and NMmax
flags an error if the best value found for the objective function at the
maximum number of function evaluations is not a local optimum. Otherwise
non-convergence in this sense is not treated as an error.

If the object is in fact minimization, either the function call should
return the negative of the criterion or alternatively NMmax may be called
under the alias NMmin.

For more details and examples see the chapter on numerical methods in guia
de utilização do Gretl (Capítulo 33). Ver também"simann".

# nobs
Resultado:  número inteiro
Argumento:  y (série)

Retorna o número de observações não ausentes para a variável y na
amostra corrente selecionada.

# normal
Resultado:  série
Argumentos: mu (escalar)
            sigma (escalar)

Generates a series of Gaussian pseudo-random variates with mean mu and
desvio padrão sigma. If no arguments are supplied, standard normal variates
N(0,1) are produced. The values are produced using the Ziggurat method
(Marsaglia and Tsang, 2000).

Ver também"randgen", "mnormal", "muniform".

# normtest
Resultado:  matriz
Argumentos: y (série ou vetor)
            method (texto, opcional)

Performs a test for normality of y. By default this is the Doornik-Hansen
test but the optional method argument can be used to select an alternative:
use swilk to get the Shapiro-Wilk test, jbera for Jarque-Bera test, or
lillie for the Lilliefors test.

The second argument may be given in either quoted or unquoted form. In the
latter case, however, if the argument is the name of a string variable the
value of the variable is substituted. The following shows three acceptable
ways of calling for a Shapiro-Wilk test:

	  matrix nt = normtest(y, swilk)
	  matrix nt = normtest(y, "swilk")
	  string testtype = "swilk"
	  matrix nt = normtest(y, testtype)

The returned matrix is 1 x 2; it holds the test statistic and its p-value.
See also the "normtest" command.

# npcorr
Resultado:  matriz
Argumentos: x (série ou vetor)
            y (série ou vetor)
            method (texto, opcional)

Calculates a measure of correlation between x and y using a nonparametric
method. If given, the third argument should be either kendall (for Kendall's
tau, version b, the default method) or spearman (for Spearman's rho).

The return value is a 3-vector holding the correlation measure plus a test
statistic and p-value for the null hypothesis of no correlation. Note that
if the sample size is too small the test statistic and/or p-value may be NaN
(not a number, or missing).

See also "corr" for Pearson correlation.

# npv
Resultado:  escalar
Argumentos: x (série ou vetor)
            r (escalar)

Retorna o Net Present Value of x, considered as a sequence of payments
(negative) and receipts (positive), evaluated at annual discount rate r,
which must be expressed as a decimal fraction, not a percentage (0.05 rather
than 5%). The first value is taken as dated "now" and is not discounted. To
emulate an NPV function in which the first value is discounted, prepend zero
to the input sequence.

Supported data frequencies are annual, quarterly, monthly, and undated
(undated data are treated as if annual).

Ver também"irr".

# NRmax
Resultado:  escalar
Argumentos: &b (referência a matriz)
            f (chamada a função)
            g (chamada a função, opcional)
            h (chamada a função, opcional)

Numerical maximization via the Newton-Raphson method. On input the vector b
should hold the initial values of a set of parameters, and the argument f
should specify a call to a function that calculates the (scalar) criterion
to be maximized, given the current parameter values and any other relevant
data. If the object is in fact minimization, this function should return the
negative of the criterion. On successful completion, NRmax returns the
maximized value of the criterion, and b holds the parameter values which
produce the maximum.

The optional third and fourth arguments provide means of supplying
analytical derivatives and an analytical (negative) Hessian, respectively.
The functions referenced by g and h must take as their first argument a
pre-defined matrix that is of the correct size to contain the gradient or
Hessian, respectively, given in pointer form. They also must take the
parameter vector as an argument (in pointer form or otherwise). Other
arguments are optional. If either or both of the optional arguments are
omitted, a numerical approximation is used.

Para maiores detalhes and exemplos see the chapter on numerical methods in
guia de utilização do Gretl (Capítulo 33). Ver também"BFGSmax", "fdjac".

# nullspace
Resultado:  matriz
Argumento:  A (matriz)

Computes the right nullspace of A, via the singular value decomposition: the
result is a matrix B such that the product AB is a zero matrix, except when
A has full column rank, in which case an empty matrix is returned.
Otherwise, if A is m x n, B will be n by (n - r), where r is the rank of A.

If A is not of full column rank, then the vertical concatenation of A and
the transpose of B produces a full rank matrix.

Example:

      A = mshape(seq(1,6),2,3)
      B = nullspace(A)
      C = A | B'

      print A B C

      eval A*B
      eval rank(C)

Produces

      ? print A B C
      A (2 x 3)

      1   3   5
      2   4   6

      B (3 x 1)

      -0.5
         1
      -0.5

      C (3 x 3)

         1      3      5
         2      4      6
      -0.5      1   -0.5

      ? eval A*B
      -4.4409e-16
      -4.4409e-16

      ? eval rank(C)
      3

Ver também"rank", "svd".

# obs
Resultado:  série

Retorna uma série of consecutive integers, setting 1 at the start of the
conjunto de dados. Note that the result is invariant to subsampling. This
function is especially useful with conjuntos de dados de séries temporais.
Note: you can write t instead of obs with the same effect.

Ver também"obsnum".

# obslabel
Resultado:  texto
Argumento:  t (número inteiro)

Retorna o rótulo da observação t, onde t é número que representa esta
observação. A função inversa é dada por "obsnum".

# obsnum
Resultado:  número inteiro
Argumento:  s (texto)

obsnum Retorna o número que corresponde a observação especificada pela
variável s. Note que o resultado desta função não é afetado por
subamostragenss. Ela é especialmente útil em dados de séries temporais.
Por exemplo, o código seguinte

	  open denmark
	  k = obsnum(1980:1)

fornece k = 25, indicando que o primeiro trimestre de 1980 é a vigésima
quinta observação nos dados denmark.

Ver também"obs", "obslabel".

# ok
Resultado:  ver abaixo
Argumento:  x (escalar, série, matriz ou lista)

If x is a scalar, returns 1 if x is not NA, otherwise 0. If x is a series,
retorna uma série with value 1 at observações with non-missing values and
zeros elsewhere. If x is a list, the output is a series with 0 at
observações for which at least one series in the list has a missing value,
and 1 otherwise.

If x is a matrix the behavior is a little different, since matrizes cannot
contain NAs: the function retorna uma matrix of the same dimensions as x,
with 1s in positions corresponding to finite elements of x and 0s in
positions onde the elements are non-finite (either infinities or
not-a-number, as per the IEEE 754 standard).

Ver também"missing", "misszero", "zeromiss". But note that these functions
are not aplicável to matrizes.

# onenorm
Resultado:  escalar
Argumento:  X (matriz)

Retorna a 1-norm of the matrix X, that is, the maximum across the columns of
X of the sum of absolute values of the column elements.

Ver também"infnorm", "rcond".

# ones
Resultado:  matriz
Argumentos: r (número inteiro)
            c (número inteiro)

Retorna uma matriz com r linhas e c colunas preenchida com valores iguais a
1.

Ver também"seq", "zeros".

# orthdev
Resultado:  série
Argumento:  y (série)

É aplicável somente se o conjunto de dados corrente tiver uma estrutura de
painel. Computes the forward orthogonal deviations for variável y.

This transformation is sometimes used instead of differencing to remove
individual effects from dados em painel. For compatibility with first
differences, the deviations are stored one passo à frente of their true
temporal location (that is, the value at observation t is the deviation
that, strictly speaking, belongs at t - 1). That way one loses the first
observation in each time series, not the last.

Ver também"diff".

# pdf
Resultado:  o mesmo tipo que o argumento
Argumentos: d (texto)
            ... (ver abaixo)
            x (escalar, série ou matriz)
Exemplos:   f1 = pdf(N, -2.5)
            f2 = pdf(X, 3, y)
            f3 = pdf(W, forma, escala, y)

Calculadora da função densidade de probabilidade. Retorna a densidade em x
da distribuição identificada pelo código d. Veja "cdf" para detalhes
acerca dos argumentos requeridos. As distribuições suportadas pela
função pdf são: normal, t de Student, qui-quadrado, F, Gama, Weibull,
Erro Generalizado, Binomial e Poisson. Note que para a Binomial e a Poisson
o que de fato é calculado é a massa de probabilidade no ponto
especificado. Para t de Student, qui-quadrado e F também estão disponiveis
as suas variantes não-centrais.

Para a distribuição normal veja também "dnorm".

# pergm
Resultado:  matriz
Argumentos: x (série ou vetor)
            bandwidth (escalar, opcional)

If only the first argument is given, computes the sample periodogram para a
given series or vector. If the second argument is given, computes an
estimate of the spectrum of x using a Bartlett lag window of the given
bandwidth, up to a maximum of half the number of observações (T/2).

Retorna uma matriz with two columns and T/2 rows: the first column holds the
frequency, omega, from 2pi/T to pi, and the second the corresponding
spectral density.

# pexpand
Resultado:  série
Argumento:  v (vetor)

É aplicável somente se o conjunto de dados corrente tiver uma estrutura de
painel. Realiza a operação inversa de "pshrink". Isto é, dado um vetor de
comprimento igual ao número de indivíduos na amostra (de painel) corrente,
retorna uma série na qual cada valor é repetido T vezes, onde T representa
o comprimento temporal do painel. A série resultante é dessa forma não
variante em relação ao tempo.

# pmax
Resultado:  série
Argumentos: y (série)
            mask (série, opcional)

É aplicável somente se o conjunto de dados corrente tiver uma estrutura de
painel. Retorna uma série contendo o máximo da variável y para cada
unidade de corte transversal (isso é repetido parar cada período de
tempo).

Se o segundo argumento (opcional) for fornecido, as observações onde o
valor de mask for igual a zero são ignoradas.

Ver também"pmin", "pmean", "pnobs", "psd", "pxsum", "pshrink", "psum".

# pmean
Resultado:  série
Argumentos: y (série)
            mask (série, opcional)

É aplicável somente se o conjunto de dados corrente tiver uma estrutura de
painel. Retorna uma série contendo a média temporal da variável y para
cada unidade de corte transversal. Os valores são repetidos para cada
período e as observações ausentes são ignoradas no cálculo das médias.

Se o segundo argumento (opcional) for fornecido, as observações onde o
valor de mask for igual a zero são ignoradas.

Ver também"pmax", "pmin", "pnobs", "psd", "pxsum", "pshrink", "psum".

# pmin
Resultado:  série
Argumentos: y (série)
            mask (série, opcional)

É aplicável somente se o conjunto de dados corrente tiver uma estrutura de
painel. Retorna uma série contendo o mínimo da variável y para cada
unidade de corte transversal (isso é repetido para cada período de tempo).

Se o segundo argumento (opcional) for fornecido, as observações onde o
valor de mask for igual a zero são ignoradas.

Ver também"pmax", "pmean", "pnobs", "psd", "pshrink", "psum".

# pnobs
Resultado:  série
Argumentos: y (série)
            mask (série, opcional)

É aplicável somente se o conjunto de dados corrente tiver uma estrutura de
painel. Retorna uma série contendo o número de observações válidas em y
para cada unidade de corte transversal (isso é repetido para cada período
de tempo).

Se o segundo argumento (opcional) for fornecido, as observações onde o
valor de mask for igual a zero são ignoradas.

Ver também"pmax", "pmin", "pmean", "psd", "pshrink", "psum".

# polroots
Resultado:  matriz
Argumento:  a (vetor)

Finds the roots of a polynomial. If the polynomial is of degree p, the
vector a should contain p + 1 coeficientes in ascending order, i.e. starting
with the constant and ending with the coefficient on x^p.

If all the roots are real they are returned in a vetor coluna of length p,
otherwise a p x 2 matrix is returned, the real parts in the first column and
the imaginary parts in the second.

# polyfit
Resultado:  série
Argumentos: y (série)
            q (número inteiro)

Fits a polynomial trend of order q to the input series y using the method of
orthogonal polynomials. The series returned holds the fitted values.

# princomp
Resultado:  matriz
Argumentos: X (matriz)
            p (número inteiro)
            covmat (booleano, opcional)

Let the matrix X be T x k, contendo T observações on k variáveis. The
argument p must be a positive integer less than or equal to k. This function
returns a T x p matrix, P, holding the first p principal components of X.

The optional third argument acts as a boolean switch: if it is non-zero the
principal components are computed on the basis of the matriz de
covariâncias of the columns of X (the default is to use the correlation
matrix).

The elements of P are computed as the sum from i to k of Z_ti times v_ji,
onde Z_ti is the standardized value of variável i at observation t and v_ji
is the jth eigenvector of the correlation (or covariance) matrix of the
X_is, with the eigenvectors ordered by decreasing value of the corresponding
autovalores.

Ver também"eigensym".

# prodc
Resultado:  vetor linha
Argumento:  X (matriz)

Retorna o produto dos elementos das colunas de X. Ver também"prodr",
"meanc", "sdc", "sumc".

# prodr
Resultado:  vetor coluna
Argumento:  X (matriz)

Retorna o produto dos elementos das linhas de X. Ver também"prodc",
"meanr", "sumr".

# psd
Resultado:  série
Argumentos: y (série)
            mask (série, opcional)

É aplicável somente se o conjunto de dados corrente tiver uma estrutura de
painel. Retorna uma série contendo desvio padrão amostral da variável y
para cada unidade de corte transversal (sendo os valores repetidos para cada
período de tempo). O denominador utilizado o tamanho da amostra em cada
unidade menos 1, a menos que o número de observações válidas para dada
unidade ser 1 (nesse caso será retornado 0) ou 0 (nesse caso será
retornado NA).

Se o segundo argumento (opcional) for fornecido, as observações onde o
valor de mask for igual a zero são ignoradas.

Observação: essa função torna possível testar se dada variável (como
por exemplo, X) não varia ao longo do tempo utilizando a condição
max(psd(X)) == 0.

Ver também"pmax", "pmin", "pmean", "pnobs", "pshrink", "psum".

# psdroot
Resultado:  matriz quadrada
Argumento:  A (matriz simétrica)

Performs a generalized variant of the decomposição de Cholesky of the
matrix A, which must be positive semidefinite (but which may be singular).
If the input matrix is not square an error is flagged, but symmetry is
assumed and not tested; only the lower triangle of A is read. The result is
a lower-triangular matrix L which satisfies A = LL'. Indeterminate elements
in the solution are set to zero.

For the case onde A is positive definite, see "cholesky".

# pshrink
Resultado:  matriz
Argumento:  y (série)

É aplicável somente se o conjunto de dados corrente tiver uma estrutura de
painel. Retorna um vetor coluna contendo a primeira observação válida da
série y para cada unidade de corte transversal no painel, ao longo
extensão da amostra corrente. Se uma unidade não possuir observações
válidas da série de entrada ela será ignorada.

Essa função fornece uma maneira de compactar as séries retornadas por
funções como "pmax" e "pmean", nas quais um valor pertecente a cada
unidade de corte transversal é repetido para cada período de tempo.

Veja "pexpand" para a operação inversa.

# psum
Resultado:  série
Argumentos: y (série)
            mask (série, opcional)

É aplicável somente se o conjunto de dados corrente tiver uma estrutura de
painel. Retorna uma série contendo a soma ao longo do tempo da variável y
para cada unidade de corte transversal. Os valores são repetidos para cada
período e as observações ausentes são ignoradas no cálculo das somas.

Se o segundo argumento (opcional) for fornecido, as observações onde o
valor de mask for igual a zero são ignoradas.

Ver também"pmax", "pmean", "pmin", "pnobs", "psd", "pxsum", "pshrink".

# pvalue
Resultado:  o mesmo tipo que o argumento
Argumentos: c (caractere)
            ... (ver abaixo)
            x (escalar, série ou matriz)
Exemplos:   p1 = pvalue(z, 2.2)
            p2 = pvalue(X, 3, 5.67)
            p2 = pvalue(F, 3, 30, 5.67)

Calculadora de P-valores. Retorna P(X > x), onde a distribuição de X é
especificada pela letra c. Entre os argumentos c e x, zero ou mais
argumentos adicionais são necessários para que especifique os parâmetros
da distribuição. Veja "cdf" para detalhes. As distribuições suportadas
pela função pvalue são: normal padrão, t, qui-quadrada, F, gama,
binomial, Poisson, Weibull e Erro Generalizado.

Ver também"critical", "invcdf", "urcpval", "imhof".

# pxnobs
Resultado:  série
Argumentos: y (série)
            mask (série, opcional)

É aplicável somente se o conjunto de dados corrente tiver uma estrutura de
painel. Retorna uma série contendo o número de observações válidas de y
em cada período de tempo (essa operação é repetida para cada unidade de
corte transversal).

Se o segundo argumento (opcional) for fornecido, as observações onde o
valor de mask for igual a zero são ignoradas.

Note que esta função opera em uma dimensão diferente da função "pnobs".

# pxsum
Resultado:  série
Argumentos: y (série)
            mask (série, opcional)

É aplicável somente se o conjunto de dados corrente tiver uma estrutura de
painel. Retorna uma série contendo a soma dos valores de y para cada
unidade de corte transversal em cada período de tempo (sendo os valores
repetidos para cada unidade de corte).

Se o segundo argumento (opcional) for fornecido, as observações onde o
valor de mask for igual a zero são ignoradas.

Note que esta função opera em uma dimensão diferente da função "psum".

# qform
Resultado:  matriz
Argumentos: x (matriz)
            A (matriz simétrica)

Computes the quadratic form Y = xAx'. Using this function instead of
ordinary matrix multiplication guarantees more speed and better accuracy,
when A is a generic symmetric matrix. However, in the special case when A is
the identity matrix, the simple expression x'x performs much better than
qform(x',I(rows(x)).

If x and A are not conformable, or A is not symmetric, an error is returned.

# qlrpval
Resultado:  escalar
Argumentos: X2 (escalar)
            df (número inteiro)
            p1 (escalar)
            p2 (escalar)

P-values para o estatística de teste from the QLR sup-Wald test for a
structural break at an unknown point (see "qlrtest"), as per Bruce Hansen
(1997).

The first argument, X2, denotes the (qui-quadrado form of) the maximum Wald
estatística de teste and df denotes its graus de liberdade. The third and
fourth arguments represent, as decimal fractions of the overall estimation
range, the starting and ending points of the central range of observações
over which the successive Wald tests are calculated. Por exemplo if the
standard approach of 15 percent trimming is adopted, you would set p1 to
0.15 and p2 to 0.85.

Ver também"pvalue", "urcpval".

# qnorm
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna os quantis para a distribuição normal padrão. Se x não estiver
entre 0 e 1, será retornado NA. Ver também"cnorm", "dnorm".

# qrdecomp
Resultado:  matriz
Argumentos: X (matriz)
            &R (referência a matriz, ou null)

Calcula a decomposição QR de uma matriz X de ordem m x n, isto é, X = QR
onde Q é uma matriz ortogonal m x n e R é uma matriz triangular superior n
x n. A matriz Q é retornada diretamente, enquanto que R pode ser obtida via
utilização do segundo argumento (opcional).

Ver também"eigengen", "eigensym", "svd".

# quadtable
Resultado:  matriz
Argumentos: n (número inteiro)
            type (número inteiro, opcional)
            a (escalar, opcional)
            b (escalar, opcional)

Returns an n x 2 matrix for use with Gaussian quadrature (numerical
integration). The first column holds the nodes or abscissae, the second the
weights.

The first argument specifies the number of points (rows) to compute. The
second argument codes para o type of quadrature: use 1 for Gauss-Hermite
(the default); 2 for Gauss-Legendre; or 3 for Gauss-Laguerre. The
significance of the optional parameters a and b depends on the selected
type, as explained below.

Gaussian quadrature is a method of approximating numerically the definite
integral of some function of interest. Let the function be represented as
the product f(x)W(x). The types of quadrature differ in the specification of
the component W(x): in the Hermite case this is exp(-x^2); in the Laguerre
case, exp(-x); and in the Legendre case simply W(x) = 1.

For each specification of W, one can compute a set of nodes, x_i, and
weights, w_i, such that the sum from i=1 to n of w_i f(x_i) approximates the
desired integral. The method of Golub and Welsch (1969) is used.

When the Gauss-Legendre type is selected, the optional arguments a and b can
be used to control the lower and upper limits of integration, the default
values being -1 and 1. (In Hermite quadrature the limits are fixed at minus
and plus infinity, while in the Laguerre case they are fixed at 0 and
infinity.)

In the Hermite case a and b play a different role: they can be used to
replace the default form of W(x) with the (closely related) normal
distribution with mean a and desvio padrão b. Supplying values of 0 and 1
for these parameters, por exemplo, has the effect of making W(x) into the
standard normal pdf, which is equivalent to multiplying the default nodes by
the square root of two and dividing the weights by the square root of pi.

# quantile
Resultado:  escalar ou matriz
Argumentos: y (série ou matriz)
            p (escalar entre 0 e 1)

If y is a series, returns the p-quantile para as series. Por exemplo, when p
= 0.5, the median is returned.

If y is a matrix, returns a row vector contendo the p-quantiles para as
columns of y; that is, each column is treated as a series.

In addition, for matrix y an alternate form of the second argument is
supported: p may be given as a vector. In that case the return value is an m
x n matrix, onde m is the number of elements in p and n is the number of
columns in y.

# randgen
Resultado:  série
Argumentos: d (texto)
            p1 (escalar ou série)
            p2 (escalar ou série, condicional)
            p3 (escalar, condicional)
Exemplos:   series x = randgen(u, 0, 100)
            series t14 = randgen(t, 14)
            series y = randgen(B, 0.6, 30)
            series g = randgen(G, 1, 1)
            series P = randgen(P, mu)

Gerador de número aleatório de uso geral. O argumeto d é um texto
("string") (sendo geralmente composto por apenas um caractere) que
especifica a distribuição da qual serão extraídos os pseudo-números. Os
argumentos p1 a p3 especificam os parâmetros da distribuição selecionada,
sendo que o número de parâmetros depende da distribuição escolhida. Para
distribuições que não a beta-binomial, os parâmetros p1 e p2 (se for
aplicável) podem estar na forma escalar ou de série. Se forem utilizados
na forma escalar a série resultante será identicamente distribuída. Se
forem utilizadas séries em p1 ou p2 a distribuição será condicional ao
valor do parâmetro em cada observação. No caso da beta-binomial todos os
parâmetros devem ser escalares.

Especificidades são apresentadas abaixo: o código para cada distribuição
é mostrado entre parênteses, seguido da interpretação do argumento p1 e,
quando for aplicável, p2 e p3.

  Uniforme (contínua) (u ou U): mínimo, máximo

  Uniforme (discreta) (i): mínimo, máximo

  Normal (z, n ou N): média, desvio padrão

  t de Student (t): graus de liberdade

  Qui-quadrado (c, x ou X): graus de liberdade

  F de Snedecor (f ou F): graus de liberdade (num.), graus de liberdade
  (den.)

  Gama (g ou G): forma, escala

  Binomial (b ou B): probabilidade, quantidade de tentativas

  Poisson (p ou P): média

  Weibull (w ou W): forma, escala

  Erro Generalizado (E): forma

  Beta (beta): forma1, forma2

  Beta-Binomial (bb): tentativas, forma1, forma2

Ver também"normal", "uniform", "mrandgen", "randgen1".

# randgen1
Resultado:  escalar
Argumentos: d (caractere)
            p1 (escalar)
            p2 (escalar, condicional)
Exemplos:   scalar x = randgen1(z, 0, 1)
            scalar g = randgen1(g, 3, 2.5)

Funciona da mesma forma que "randgen" exceto pelo fato de retornar um
escalar ao invés de uma série.

O primeiro exemplo acima retorna um valor da distribuição normal padrão,
enquanto que o segundo especifica um valor a ser extraído da distribuição
Gama com forma 3 e escala 2.5.

Ver também"mrandgen".

# randint
Resultado:  número inteiro
Argumentos: min (número inteiro)
            max (número inteiro)

Retorna um inteiro pseudo-aleatório no intervalo fechado [min, max]. Ver
também"randgen".

# rank
Resultado:  número inteiro
Argumento:  X (matriz)

Retorna o posto de X, calculada numericamente via decomposição em valores
singulares. Ver também"svd".

# ranking
Resultado:  o mesmo tipo que o argumento
Argumento:  y (série ou vetor)

Retorna uma série ou vetor com os ranks de y. O rank para a observação i
é o número de elementos que são menores que y_i mais 1. Se houver
números iguais a y_i adiciona-se 0,5. Intuitivamente, pode-se pensar em uma
partida de xadrez, onde uma vitória vale 1 ponto e um empate vale 0,5
pontos). É adicionado 1 ao rank de forma que o menor rank possível é 1 ao
invés de 0.

Ver também"sort", "sortby".

# rcond
Resultado:  escalar
Argumento:  A (matriz quadrada)

Retorna o reciprocal condition number for A with respect to the 1-norm. In
many circumstances, this is a better measure of the sensitivity of A to
numerical operations such as inversion than the determinant.

The value is computed as the reciprocal of the product, 1-norm of A times
1-norm of A-inverse.

Ver também"det", "ldet", "onenorm".

# readfile
Resultado:  texto
Argumentos: fname (texto)
            codeset (texto, opcional)

Se um arquivo com o nome fname existir e puder ser lido, a função retorna
um texto ("string") com o conteúdo desse arquivo, caso contrário retorna
um erro. Se fname não contiver o caminho completo até o arquivo, ele será
procurado em algumas localizações "prováveis", começando pelo "workdir"
corrente.

Se fname começar com o identificador de um protocolo de internet suportado
(http://, ftp:// ou https://), libcurl será utilizado para baixar o
arquivo. Veja também "curl" para baixar arquivos de forma mais elaborada.

Se o texto a ser lido não estiver codificado como UTF-8, Gretl tentará
recodificá-lo a partir da codificação corrente se esta não for UTF-8,
ou, caso contrário, a partir da codificação ISO-8859-15. Se essa
estratégia padrão não funcionar é possível utilizar o segundo argumento
(que é opcional) para especificar a codificação. Por exemplo, caso seja
desejada a leitura de texto com codificação Microsoft 1251 e esta não
seja a configuração local, pode-se fornecer o segundo argumento "cp1251".

Exemplos:

        string web_page = readfile("http://gretl.sourceforge.net/")
        print web_page

        string current_settings = readfile("@dotdir/.gretl2rc")
        print current_settings

Veja também as funções "sscanf" e "getline".

# regsub
Resultado:  texto
Argumentos: s (texto)
            match (texto)
            repl (texto)

Retorna uma cópia de s onde todas as ocorrências do padrão match são
substituídas por repl. Os argumentos match e repl são interpretados como
expressões regulares no estilo Perl.

Veja também "strsub" para substituições simples de textos.

# remove
Resultado:  número inteiro
Argumento:  fname (texto)

Deleta o arquivo fname caso ele exista e seja gravável pelo usuário.
Retorna 0 em caso de sucesso e um valor não-nulo se o arquivo não existir
ou não puder ser removido.

Se fname contiver o caminho completo para o arquivo o Gretl tentará
deletá-lo e retornará um erro se ele não existir ou não puder ser
apagado por algum motivo (um exemplo seria um arquivo do tipo
somente-leitura). Se fname não contiver o caminho completo então será
assumido que o arquivo está no diretório de trabalho ("workdir"). Se o
arquivo não existir ou não for gravável o Gretl não irá procurá-lo em
nenhum outro diretório.

# replace
Resultado:  o mesmo tipo que o argumento
Argumentos: x (série ou matriz)
            find (escalar ou vetor)
            subst (escalar ou vetor)

Substitui cada elemento de x igual ao i-ésimo elemento de find pelo
correspondente elemento de subst.

Se find for um escalar, subst também deve ser um escalar. Se find e subst
forem vetores, eles precisam ter o mesmo número de elementos. Mas se find
for um vetor e subst um escalar, então todas as ocorrências serão
substituídas por subst.

Exemplo:

	  a = {1,2,3;3,4,5}
	  find = {1,3,4}
	  subst = {-1,-8, 0}
	  b = replace(a, find, subst)
	  print a b

produz

          a (2 x 3)

          1   2   3
          3   4   5

          b (2 x 3)

          -1    2   -8
          -8    0    5

# resample
Resultado:  o mesmo tipo que o argumento
Argumentos: x (série ou matriz)
            blocksize (número inteiro, opcional)

The initial description of this function pertains to corte transversal or
séries temporais data; see below for the case of dados em painel.

Resamples from x with replacement. In the case of a series argument, each
value of the returned series, y_t, is drawn from among all the values of x_t
with equal probability. When a matrix argument is given, each row of the
returned matrix is drawn from the rows of x with equal probability.

O argumento opcional blocksize represents the block size for resampling by
moving blocks. If this argument is given it should be a positive integer
greater than or equal to 2. The effect is that the output is composed by
random selection with replacement from among all the possible contiguous
sequences of length blocksize in the input. (In the case of matrix input,
this means contiguous rows.) If the length of the data is not an integer
multiple of the block size, the last selected block is truncated to fit.

If the argument x is a series and the conjunto de dados takes the form of a
panel, resampling by moving blocks is not supported. The basic form of
resampling is supported, but has this specific interpretation: the data are
resampled "by individual". Suppose you have a panel in which 100 individuals
are observed over 5 periods. Then the returned series will again be composed
of 100 blocks of 5 observações: each block will be drawn with equal
probability from the 100 individual séries temporais, with the séries
temporais order preserved.

# round
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Arredondamento para o número inteiro mais próximo. Note que quando x
estiver exatamente entre dois inteiros, o arredondamento é feito de moda a
"se afastar de zero", assim, por exemplo, 2.5 é arredondado para 3, mas
round(-3.5) retorna -4. Esta é uma convenção comum em programas de
planilha eletrônica, mas outros programas podem gerar resultados
diferentes. Ver também"ceil", "floor", "int".

# rownames
Resultado:  número inteiro
Argumentos: M (matriz)
            S (cadeia de texto ou lista)

Adiciona nomes para as linhas da matriz M de ordem m x n . Se S for uma
lista, os nomes serão os das séries listadas. A lista precisa ter m
membros. Se S for um arranjo (" array") de variáveis de texto ("string"),
ele precisa ter m elementos. Para manter a compatibilidade com versões
anteriores do Gretl, uma única variável de texto também pode ser
utilizada como segundo argumento. Nesse caso ela precisa ter m textos
separados por espaços.

Retorna o valor 0 se as linhas forem nomeadas com sucesso. Caso contrário
será retornado um valor não-nulo. Veja também "colnames".

Exemplo:

	  matrix M = {1, 2; 2, 1; 4, 1}
	  strings S = array(3)
	  S[1] = "Row1"
	  S[2] = "Row2"
	  S[3] = "Row3"
	  rownames(M, S)
	  print M

# rows
Resultado:  número inteiro
Argumento:  X (matriz)

Retorna o número de linhas da matriz X. Ver também"cols", "mshape",
"unvech", "vec", "vech".

# sd
Resultado:  escalar ou série
Argumento:  x (série ou lista)

Se x for uma série a função retorna o desvio padrão amostral,
descartando as observações ausentes.

Se x for uma lista a função retorna uma série y tal que y_t representa o
desvio padrão amostral dos valores das variáveis na lista na observação
t, ou NA se existirem valores ausentes em t.

Ver também"var".

# sdc
Resultado:  vetor linha
Argumentos: X (matriz)
            df (escalar, opcional)

Retorna os desvios padrão das colunas da matriz X . Se df for positivo ele
será utilizado como o divisor para as variâncias das colunas, caso
contrário o divisor será igual ao número de linhas em X (isto é, não
será aplicada a correção de graus de liberdade). Ver também"meanc",
"sumc".

# sdiff
Resultado:  o mesmo tipo que o argumento
Argumento:  y (série ou lista)

Calcula diferenças sazonais: y(t) - y(t-k), onde k é a periodicidade do
conjunto de dados corrente (veja "$pd"). Valores iniciais são definidos
como NA.

Quando uma lista for retornada, as variáveis individuais são
automaticamente nomeadas de acordo com o seguinte padrão sd_varname, onde
varname é o nome da série original. A porção que representa o nome
original da série será truncado, caso seja necessário, e ajustado no caso
de não ser único no conjunto de nomes assim construído.

Ver também"diff", "ldiff".

# seasonals
Resultado:  lista
Argumentos: baseline (número inteiro, opcional)
            center (booleano, opcional)

Aplicável somente se o conjunto de dados tiver uma estrutura de série
temporal com periodicidade maior que 1. Retorna uma lista com variáveis
dummy que representam os períodos sazonais. As dummies sazonais são
nomeadas como S1, S2 e assim por diante.

O argumento opcional baseline pode ser utilizado para excluir um período do
conjunto de dummies. Por exemplo, se for fornecido um valor igual a 1 em um
conjunto de dados trimestrais a lista retornada conterá as dummies apenas
para os trimestres 2, 3 e 4. Se este argumento for omitido ou for igual a 0
serão geradas as dummies para todos os períodos. É importante notar que o
argumento deve ser um número inteiro e menor ou igual a periodicidade dos
dados.

O argumento center, se for não-nulo, faz com que as dummies sejam
centradas, isto é, que sejam subtraídas suas médias populacionais. Por
exemplo, com dados trimestrais as dummies sazonais centradas terão valores
iguais a -0.25 e 0.75 ao invés de 0 e 1.

# selifc
Resultado:  matriz
Argumentos: A (matriz)
            b (vetor linha)

Seleciona em A apenas as colunas para as quais o elemento correspondente em
b é não-nulo. b deve ser um vetor linha com o mesmo número de colunas de
A.

Ver também"selifr".

# selifr
Resultado:  matriz
Argumentos: A (matriz)
            b (vetor coluna)

Seleciona em A apenas as linhas para as quais o elemento correspondente em b
é não-nulo. b deve ser um vetor coluna com o mesmo número de linhas de A.

Ver também"selifc", "trimr".

# seq
Resultado:  vetor linha
Argumentos: a (escalar)
            b (escalar)
            k (escalar, opcional)

Retorna um vetor com a sequência crescente de a até b se o primeiro
argumento for menor que o segundo. Se o primeiro argumento for maior que o
segundo a sequência será decrescente. Em ambos os casos o
incremento/decremento será de 1 unidade.

Se o argumento opcional k for dado a função retorna um vetor com a
sequência iniciada em a e aumentada, caso a for menor b), em k unidades a
cada passo. A sequência será finalizada no maior valor possível que seja
menor ou igual a b. Se o primeiro argumento for maior que o segundo a
sequencia será reduzida em k unidades e será finalizada no menor valor
possível que seja maior ou igual a b). O argumento k deve ser positivo.

Ver também"ones", "zeros".

# setnote
Resultado:  número inteiro
Argumentos: b (lote)
            key (texto)
            note (texto)

Insere uma nota descritiva para o objeto identificado por key em um pacote
("bundle ") b. Esta nota será apresentada quando o comando print for
utilizado no pacote. A função retorna 0 em caso de sucesso e um valor
não-nulo em caso de falha (por exemplo, se não existir o objeto key em b).

# simann
Resultado:  escalar
Argumentos: &b (referência a matriz)
            f (chamada a função)
            maxit (número inteiro, opcional)

Implements simulated annealing, which may be helpful in improving the
initialization for a numerical optimization problem.

On input the first argument holds the initial value of a parameter vector
and the second argument specifies a function call which returns the (scalar)
value of the maximand. The optional third argument specifies the maximum
number of iterations (which defaults to 1024). On successful completion,
simann returns the final value of the maximand and b holds the associated
parameter vector.

Para maiores detalhes and an example see the chapter on numerical methods in
guia de utilização do Gretl (Capítulo 33). Ver também"BFGSmax", "NRmax".

# sin
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna o seno de x. Ver também"cos", "tan", "atan".

# sinh
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna o seno hiperbólico de x.

Ver também"asinh", "cosh", "tanh".

# skewness
Resultado:  escalar
Argumento:  x (série)

Retorna o valor de assimetria para a série x, descartando queisquer
observações ausentes.

# sleep
Resultado:  escalar
Argumento:  ns (número inteiro)

Not of any direct use for econometrics, but can be useful for testing
parallelization methods. This function simply causes the current thread to
"sleep" -- that is, do nothing -- for ns seconds. On wake-up, the function
returns 0.

# sort
Resultado:  o mesmo tipo que o argumento
Argumento:  x (série ou vetor)

Ordena x de forma ascendente, descartando observações com valores ausentes
quando x for uma série. Ver também"dsort", "values". Especificamente para
matrizes veja "msortby".

# sortby
Resultado:  série
Argumentos: y1 (série)
            y2 (série)

Retorna uma série contendo os elementos de y2 ordenados de acordo com os
valores crescente do primeiro argumento y1. Ver também"sort", "ranking".

# sprintf
Resultado:  texto
Argumentos: format (texto)
            ... (ver abaixo)

The returned variável de texto ("string") is constructed by printing the
values of the trailing arguments, indicated by the dots above, under the
control of format. It is meant to give you great flexibility in creating
variável de textos. The format is used to specify the precise way in which
you want the arguments to be printed.

In general, format must be an expression that evaluates to a variável de
texto, but in most cases will just be a variável de texto literal (an
alphanumeric sequence surrounded by double quotes). Some character sequences
in the format have a special meaning: those beginning with the percent
character (%) are interpreted as "placeholders" para os items contained in
the argument list; moreover, special characters such as the newline
character are represented via a combination beginning with a backslash.

Por exemplo, o códgo abaixo

	  scalar x = sqrt(5)
	  string claim = sprintf("sqrt(%d) is (roughly) %6.4f.\n", 5, x)
	  print claim

produzirá

	  sqrt(5) is (roughly) 2.2361.

onde %d indicates that we want an integer at that place in the output; since
it is the leftmost "percent" expression, it is matched to the first
argument, that is 5. The second special sequence is %6.4f, which stands for
a decimal value with 4 digits after the decimal separator and at least 6
digits wide. The number of such sequences must match the number of arguments
following the format variável de texto.

See the help page para o "printf" command for more details about the syntax
you can use in format variável de textos.

# sqrt
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna a raíz quadrada positiva de x. Gera NA quando utilizada em valores
negativos.

Note que se o argumento for uma matriz, a operação será realizada para
cada elemento. Além disso, dado que as matrizes não podem conter valores
NA, a função irá gerar um erro se exitirem valores negativos. Para a
"raíz quadrada matricial" veja "cholesky".

# square
Resultado:  lista
Argumentos: L (lista)
            cross-products (booleano, opcional)

Retorna uma lista cotendo os quadrados das variáveis na lista L. Seus
elementos são nomeados de acordo com o seguinte esquema :sq_varname. Se o
segundo argumento (opcional) estiver presente e tiver um valor não-nulo, a
lista também incluirá os produtos cruzados dos elementos de L que, por sua
vez, são nomeados de acordo com o seguinte esquema: var1_var2. Nesses
esquemas os nomes das séries de entrada serão truncados caso seja
necessário e os nomes de saída podem ser ajustados em caso de de nomes
duplicados na lista retornada.

# sscanf
Resultado:  número inteiro
Argumentos: src (texto)
            format (texto)
            ... (ver abaixo)

Reads values from src under the control of format and assigns these values
to one or more trailing arguments, indicated by the dots above. Retorna o
número of values assigned. This is a simplified version of the sscanf
function in the C programming language.

src may be either a literal variável de texto ("string"), enclosed in
double quotes, or the name of a predefined variável de texto variável.
format is defined similarly to the format variável de texto in "printf"
(more on this below). args should be a comma-separated list contendo the
names of pre-defined variáveis: these are the targets of conversion from
src. (For those used to C: one can prefix the names of numerical variáveis
with & but this is not required.)

Literal text in format is matched against src. Conversion specifiers start
with %, and recognized conversions include %f, %g or %lf for floating-point
numbers; %d for integers; %s for variável de textos; and %m for matrizes.
You may insert a positive integer after the percent sign: this sets the
maximum number of characters to read para a given conversion (or the maximum
number of rows in the case of matrix conversion). Alternatively, you can
insert a literal * after the percent to suppress the conversion (thereby
skipping any characters that would otherwise have been converted para o
given type). For example, %3d converts the next 3 characters in source to an
integer, if possible; %*g skips as many characters in source as could be
converted to a single floating-point number.

Matrix conversion works thus: the scanner reads a line of input and counts
the (space- or tab-separated) number of numeric fields. This defines the
number of columns in the matrix. By default, reading then proceeds for as
many lines (rows) as contain the same number of numeric columns, but the
maximum number of rows to read can be limited as described above.

In addition to %s conversion for variável de textos, a simplified version
of the C format %N[chars] is available. In this format N is the maximum
number of characters to read and chars is a set of acceptable characters,
enclosed in square brackets: reading stops if N is reached or if a character
not in chars is encountered. The function of chars can be reversed by giving
a circumflex, ^, as the first character; in that case reading stops if a
character in the given set is found. (Unlike C, the hyphen does not play a
special role in the chars set.)

If the source variável de texto does not (fully) match the format, the
number of conversions may fall short of the number of arguments given. This
is not in itself an error so far as gretl is concerned. However, you may
wish to check the number of conversions performed; this is given by the
return value.

Some exemplos follow:

	  scalar x
	  scalar y
	  sscanf("123456", "%3d%3d", x, y)

	  sprintf S, "1 2 3 4\n5 6 7 8"
	  S
	  matrix m
	  sscanf(S, "%m", m)
	  print m

# sst
Resultado:  escalar
Argumento:  y (série)

Retorna a soma dos quadrados dos desvios em relação à média das
observações não ausentes na série y. Ver também"var".

# stringify
Resultado:  número inteiro
Argumentos: y (série)
            S (cadeia de texto)

Provides a means of defining variável de texto ("string") values para a
series y. Two conditions must be satisfied for this to work: the target
series must have nothing but integer values, none of them less than 1, and
the arranjo ("array") S must have at least n elements onde n is the largest
value in y. In addition each element of S must be valid UTF-8. Ver
também"strvals".

The value returned is zero on success or a positive error code on error.

# strlen
Resultado:  número inteiro
Argumento:  s (texto)

Retorna o número de caracteres no texto ("string") s. Note que isso não
será necessariamente igual ao número de bytes se alguns caracteres
estiverem fora do intervalo de impressão ASCII.

Exemplo:

        string s = "regression"
        scalar number = strlen(s)
        print number

# strncmp
Resultado:  número inteiro
Argumentos: s1 (texto)
            s2 (texto)
            n (número inteiro, opcional)

Compara dois textos ("string") e retorna um inteiro menor que, igual ou
maior que 0 se s1 se for, respectivamente menor que, igual ou maior que s2,
até o primeiro caractere n. Se n for omitido a comparação irá prosseguir
até onde for possível.

Caso deseje apenas verificar se dois textos são iguais não é necessário
utilizar esta função. Ao invés disso é pode-se usar a seguinte
expressão: if (s1 == s2)....

# strsplit
Resultado:  texto ou cadeia de texto
Argumentos: s (texto)
            i (número inteiro, opcional)

Sem um segundo argumento, retorna o arranjo ("array ") com textos ("string")
resultante da separação de s de acordo com os espaços em branco.

Se for fornecido um segundo argumento, retorna o elemento i do texto s,
após ter sido separado por espaços. O índice i tem base 1 e irá gerar um
erro se i for menor que 1. Caso s não contiver espaços e i for igual a 1,
uma cópia do texto será retornada. Se i exceder o número de elementos
separados por espaços, uma variável de texto vazia será retornada.

Exemplos:

        string basket = "banana apple jackfruit orange"

        strings fruits = strsplit(basket)
        eval fruits[1]
        eval fruits[2]
        eval fruits[3]
        eval fruits[4]

        string favorite = strsplit(basket, 3)
        eval favorite

# strstr
Resultado:  texto
Argumentos: s1 (texto)
            s2 (texto)

Procura em s1 o texto s2. Se o texto for encontrado a função retorna uma
cópia da parte de s1 que começa com s2, caso contrário retorna um texto
vazio.

Exemplo:

        string s1 = "Gretl is an econometrics package"
        string s2 = strstr(s1, "an")
        print s2

# strstrip
Resultado:  texto
Argumento:  s (texto)

Retorna uma cópia de s na qual os espaços em branco do início e do fim do
texto são removidos.

Exemplo:

        string s1 = "    A lot of white space.  "
        string s2 = strstrip(s1)
        print s1 s2

# strsub
Resultado:  texto
Argumentos: s (texto)
            find (texto)
            subst (texto)

Retorna uma cópia de s na qual todas as ocorrências de find são
substituídas por subst. Veja também "regsub" para substituições mais
complexas via expressões regulares.

Exemplo:

        string s1 =  "Hello, Gretl!"
        string s2 = strsub(s1, "Gretl", "Hansl")
        print s2

# strvals
Resultado:  cadeia de texto
Argumento:  y (série)

If the series y is variável de texto ("string")-valued, returns an arranjo
("array") contendo all its distinct values, ordered by the associated
numerical values starting at 1. If y is not variável de texto-valued an
empty variável de textos array is returned. Ver também"stringify".

# substr
Resultado:  texto
Argumentos: s (texto)
            start (número inteiro)
            end (número inteiro)

Retorna uma parte do texto s começando em start e terminando em end,
inclusive.

Exemplos:

        string s1 = "Hello, Gretl!"
        string s2 = substr(s1, 8, 12)
        print s2

        string s3 = substr("Hello, Gretl!", 8, 12)
        print s3

# sum
Resultado:  escalar ou série
Argumento:  x (série, matriz ou lista)

Se x for uma série, retorna a soma, na forma de um escalar, das
observações não ausentes em x. Veja também "sumall".

Se x for uma matriz, retorna a soma dos elementos da matriz.

Se x for uma lista, retorna uma série y na qual y_t é a soma dos valores
das variáveis da lista na observação t, ou NA se existir qualquer valor
ausente em t.

# sumall
Resultado:  escalar
Argumento:  x (série)

Retorna a soma das observações de x dentro da amostra selecionada. Se
existir qualquer valor ausente a função retornará NA. Use "sum" caso
deseje que os valores correntes sejam descartados.

# sumc
Resultado:  vetor linha
Argumento:  X (matriz)

Retorna um vetor com a soma das colunas de X Ver também"meanc", "sumr".

# sumr
Resultado:  vetor coluna
Argumento:  X (matriz)

Retorna um vetor com a soma das linhas de X Ver também"meanr", "sumc".

# svd
Resultado:  vetor linha
Argumentos: X (matriz)
            &U (referência a matriz, ou null)
            &V (referência a matriz, ou null)

Performs the singular values decomposition decomposição em valores
singulares of the matrix X.

The singular values are returned in a row vector. The left and/or right
singular vectors U and V may be obtained by supplying non-null values for
arguments 2 and 3, respectively. For any matrix A, the code

	  s = svd(A, &U, &V)
	  B = (U .* s) * V

should yield B identical to A (apart from machine precision).

Ver também"eigengen", "eigensym", "qrdecomp".

# tan
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna a tangente de x. Ver também"atan", "cos", "sin".

# tanh
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar, série ou matriz)

Retorna a tangente hiperbólica de x.

Ver também"atanh", "cosh", "sinh".

# toepsolv
Resultado:  vetor coluna
Argumentos: c (vetor)
            r (vetor)
            b (vetor)

Solves a Toeplitz system of linear equations, that is Tx = b onde T is a
square matrix whose element T_i,j equals c_i-j for i>=j and r_j-i for i<=j.
Note that the first elements of c and r must be equal, otherwise an error is
returned. Upon successful completion, the function returns the vector x.

The algorithm used here takes advantage of the special structure of the
matrix T, which makes it much more efficient than other unspecialized
algorithms, especially for large problems. Warning: in certain cases, the
function may spuriously issue a singularity error when in fact the matrix T
is nonsingular; this problem, however, cannot arise when T is positive
definite.

# tolower
Resultado:  texto
Argumento:  s (texto)

Retorna uma cópia de s na qual todos os caracteres maiúsculos são
convertidos em minúsculos.

Exemplos:

        string s1 = "Hello, Gretl!"
        string s2 = tolower(s1)
        print s2

        string s3 = tolower("Hello, Gretl!")
        print s3

# toupper
Resultado:  texto
Argumento:  s (texto)

Retorna uma cópia de s na qual todos os caracteres minúsculos são
convertidos em maiúsculos.

Exemplos:

        string s1 = "Hello, Gretl!"
        string s2 = toupper(s1)
        print s2

        string s3 = toupper("Hello, Gretl!")
        print s3

# tr
Resultado:  escalar
Argumento:  A (matriz quadrada)

Retorna o traço de uma matriz quadrada A, isto é, a soma dos elementos de
sua diagonal. Ver também"diag".

# transp
Resultado:  matriz
Argumento:  X (matriz)

Retorna a transposta de X. Observação: esta função é raramente
utilizada. Para transpor uma matriz, na maior parte dos casos, pode-se
simplesmente utilizar o operador de transposição: X'.

# trimr
Resultado:  matriz
Argumentos: X (matriz)
            ttop (número inteiro)
            tbot (número inteiro)

Retorna uma cópia da matriz X com ttop linhas superiores excluídas e tbot
linhas inferiores excluídas. Os dois últimos argumentos devem ser
não-negativos e sua soma deve ser menor que o total de linhas de X.

Ver também"selifr".

# typeof
Resultado:  número inteiro
Argumento:  name (texto)

Returns a numeric type-code if name is the identifier of a currently defined
object: 1 for scalar, 2 for series, 3 for matrix, 4 for string, 5 for
bundle, 6 for array and 7 for list. Otherwise returns 0. The function
"typestr" may be used to get the string corresponding to the return value.

This function can also be used to retrieve the type of a bundle member or
array element. For example:

	  matrices M = array(1)
	  eval typestr(typeof(M))
	  eval typestr(typeof(M[1]))

The first eval result is "array" and the second is "matrix".

# typestr
Resultado:  texto
Argumento:  typecode (número inteiro)

Retorna o nome do tipo de dado correspondente a typecode. Pode ser utilizada
em conjunto com as funções "typeof" e "inbundle". O valor retornado pode
ser "scalar", "series", "matrix", "string", "bundle", "array" ou "null".

# uniform
Resultado:  série
Argumentos: a (escalar)
            b (escalar)

Cria uma variável pseudo-aleatória uniforme no intervalo ( a, b) ou, se
não forem fornecidos argumentos, será utilizado o intervalo (0,1). O
algoritmo utilizado por padrão é o "SIMD-oriented Fast Mersenne Twister"
desenvolvido por Saito and Matsumoto (2008).

Ver também"randgen", "normal", "mnormal", "muniform".

# uniq
Resultado:  vetor coluna
Argumento:  x (série ou vetor)

Retorna um vetor contendo os elementos distintos de x de forma não
ordenada, mas na ordem em que aparecem em x. Veja "values" para a variante
desta função que retorna os valores ordenados.

# unvech
Resultado:  matriz quadrada
Argumento:  v (vetor)

Retorna uma matriz simétrica de ordem n x n rearranjando os elementos de v.
O número de elementos de v deve ser um inteiro triangular, ou seja, um
número k tal que exista um inteiro n que tenha a seguinte propriedade: k =
n(n+1)/2. Esta função é a inversa de "vech".

Ver também"mshape", "vech".

# upper
Resultado:  matriz quadrada
Argumento:  A (matriz quadrada)

Retorna uma matriz triangular superior de ordem n x n. Os elementos da
diagonal e acima desta são iguais aos elementos correspondentes de A e os
demais iguais a zero.

Ver também"lower".

# urcpval
Resultado:  escalar
Argumentos: tau (escalar)
            n (número inteiro)
            niv (número inteiro)
            itv (número inteiro)

P-valores para a estatística de teste do teste de raízes unitárias de
Dickey-Fuller e do teste de cointegração de Engle-Granger, conforme James
MacKinnon (1996).

The arguments are as follows: tau denotes the estatística de teste; n is
the number of observações (or 0 for an asymptotic result); niv is the
number of potentially cointegrated variáveis when testing for
cointegração (or 1 for a univariate unit-root test); and itv is a code
para o model specification: 1 for no constant, 2 for constant included, 3
for constant and linear trend, 4 for constant and quadratic trend.

Note that if the test regression is "augmented" with lags of the dependent
variável, then you should give an n value of 0 to get an asymptotic result.

Ver também"pvalue", "qlrpval".

# values
Resultado:  vetor coluna
Argumento:  x (série ou vetor)

Retorna um vetor contendo os elementos distintos de x ordenados de forma
ascendente. Caso deseje truncar a parte decimal antes de aplicar a função,
utilize a expressão values(int(x)).

Ver também"uniq", "dsort", "sort".

# var
Resultado:  escalar ou série
Argumento:  x (série ou lista)

If x is a series, returns the (scalar) sample variance, skipping any missing
observações.

If x is a list, retorna uma série y such that y_t is the sample variance of
the values of the variáveis in the list at observation t, or NA if there
are any valores ausentes at t.

In each case the sum of squared deviations from the mean is divided by (n -
1) for n > 1. Otherwise the variance is given as zero if n = 1, or as NA if
n = 0.

Ver também"sd".

# varname
Resultado:  texto
Argumento:  v (número inteiro ou lista)

Se for utilizado um inteiro como argumento, a função retorna o nome da
variável com número ID igual a v ou um erro se esta variável não
existir.

Se for utilizado uma lista como argumento, retorna o texto ("string")
contendo os nomes das variáveis na lista, separados por vírgulas. Se for
fornecida uma lista vazia será retornado um texto vazio. Para obter um
arranjo ("array ") de textos pode-se utilizar "varnames".

Exemplo:

        open broiler.gdt
        string s = varname(7)
        print s

# varnames
Resultado:  cadeia de texto
Argumento:  L (lista)

Retorna um arranjo ("array") de textos ("string ") contendo os names das
variáveis na lista L. Se a lista for vazia será retornado um arranjo
vazio.

Exemplo:

        open keane.gdt
        list L = year wage status
        strings S = varnames(L)
        eval S[1]
        eval S[2]
        eval S[3]

# varnum
Resultado:  número inteiro
Argumento:  varname (texto)

Retorna o número ID da variável varname ou NA se a variável não existir.

# varsimul
Resultado:  matriz
Argumentos: A (matriz)
            U (matriz)
            y0 (matriz)

Simulates a p-order n-variável VAR, that is y(t) = A1 y(t-1) + ... + Ap
y(t-p) + u(t). The coefficient matrix A is composed by stacking the A_i
matrizes horizontally; it is n x np, with one row per equation. This
corresponds to the first n rows of the matrix $compan provided by gretl's
var and vecm commands.

The u_t vectors are contained (as rows) in U (T x n). Initial values are in
y0 (p x n).

If the VAR contains deterministic terms and/or exogenous regressors, these
can be handled by folding them into the U matrix: each row of U then becomes
u(t) = B'x(t) + e(t).

The output matrix has T + p rows and n columns; it holds the initial p
values of the endogenous variáveis plus T simulated values.

Ver também"$compan", "var", "vecm".

# vec
Resultado:  vetor coluna
Argumento:  X (matriz)

Empilha as colunas de X como um vetor coluna. Ver também"mshape", "unvech",
"vech".

# vech
Resultado:  vetor coluna
Argumento:  A (matriz quadrada)

Retorna em um vetor coluna os elementos de A que estão em sua diagonal e
acima dela. Normalmente essa função é utilizada em matrizes simétricas.
Neste caso a essa operação pode ser revertida através da função
"unvech". Ver também"vec".

# weekday
Resultado:  o mesmo tipo que o argumento
Argumentos: ano (escalar ou série)
            mês (escalar ou série)
            dia (escalar ou série)

Retorna o dia da semana (domingo = 0, segunda-feira = 1, etc.) para a(s)
data(s) especificadas por três argumentos ou NA se a data for inválida.
Note que os três argumentos devem ser do mesmo tipo, ou seja, devem ser
todos do tipo escalar (inteiro) ou todos do tipo séries.

# wmean
Resultado:  série
Argumentos: Y (lista)
            W (lista)

Retorna uma série y tal que y_t é a média ponderada dos valores das
variáveis na lista Y na observação t, com os respectivos pesos dados
pelos valores das variáveis na lista W em t. Os pesos podem assim variar no
tempo. As listas Y e W devem ter o mesmo tamanho e os pesos devem ser
não-negativos.

Ver também"wsd", "wvar".

# wsd
Resultado:  série
Argumentos: Y (lista)
            W (lista)

Retorna uma série y tal que y_t é o desvio padrão amostral poderado dos
valores das variáveis na lista Y na observação t, com os respectivos
pesos dados pelos valores das variáveis na lista W em t. Os pesos podem
assim variar no tempo. As listas Y e W devem ter o mesmo tamanho e os pesos
devem ser não-negativos.

Ver também"wmean", "wvar".

# wvar
Resultado:  série
Argumentos: X (lista)
            W (lista)

Retorna uma série y tal que y_t é a variância amostral poderada dos
valores das variáveis na lista Y na observação t, com os respectivos
pesos dados pelos valores das variáveis na lista W em t. Os pesos podem
assim variar no tempo. As listas Y e W devem ter o mesmo tamanho e os pesos
devem ser não-negativos.

Ver também"wmean", "wsd".

# xmax
Resultado:  escalar
Argumentos: x (escalar)
            y (escalar)

Retorna o maior valor na comparação entre x e y. Se algum dos valores for
ausente será retornado NA.

Ver também"xmin", "max", "min".

# xmin
Resultado:  escalar
Argumentos: x (escalar)
            y (escalar)

Retorna o menor valor na comparação entre x e y. Se algum dos valores for
ausente será retornado NA.

Ver também"xmax", "max", "min".

# zeromiss
Resultado:  o mesmo tipo que o argumento
Argumento:  x (escalar ou série)

Converte zeros para NAs. Se x for uma série a conversão será feita
elemento por elemento. Ver também"missing", "misszero", "ok".

# zeros
Resultado:  matriz
Argumentos: r (número inteiro)
            c (número inteiro)

Retorna uma matriz nula com r linhas e c colunas. Ver também"ones", "seq".