xref: /dports/math/gretl/gretl-2021d/share/gretl_gui_fnref.pt

## Accessors

# $ahat access
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 access
Resultado: 	escalar

Retorna o Critério de Informação de Akaike do último modelo estimado, quando disponível. Veja <@pdf="guia de utilização do Gretl#chap:criteria"> (Capítulo 28) para detalhes sobre os cálculos.

# $bic access
Resultado: 	escalar

Retorna o Critério de Informação Bayesiano de Schwarz para o último modelo estimado, quando disponível. Veja <@pdf="guia de utilização do Gretl#chap:criteria"> (Capítulo 28) para detalhes sobre os cálculos.

# $chisq access
Resultado: 	escalar

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

# $coeff access
Resultado: 	matriz ou escalar
Argumento: 	<@var="s">  (nome do coeficiente, opcional)

Quando utilizado sem argumentos, <@lit="$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 <@var="s">. Ver também <@ref="$stderr">, <@ref="$vcv">.

Exemplo:

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

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 access
Resultado: 	texto

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

# $compan access
Resultado: 	matriz

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

# $datatype access
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 access
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 access
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 access
Resultado: 	escalar

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

# $diagtest access
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 <@pdf="guia de utilização do Gretl#chap:system"> (Capítulo 34) para detalhes e também <@ref="$diagpval">.

# $dotdir access
Resultado: 	texto

Este acessor retorna o caminho onde Gretl guarda os ficheiros temporários, por exemplo quando se usa a função <@ref="mwrite"> com um argumento não-nulo.

# $dw access
Resultado: 	escalar

Retorna a estatística de Durbin–Watson para a correlação de primeira ordem do último modelo estimado (quando disponível).

# $dwpval access
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 à 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 a função de acesso retorna <@lit="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 access
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 access
Resultado: 	escalar

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

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

Ver também <@xrf="catch">, <@ref="errmsg">.

# $ess access
Resultado: 	escalar

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

# $evals access
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 access
Resultado: 	matriz

Deve ser utilizada após o comando <@xrf="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 access
Resultado: 	matriz

Deve ser utilizada após o comando <@xrf="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 access
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 <@mth="h"> linhas, onde <@mth="h"> indica a quantidade de períodos do horizonte de previsão que, por sua vez, pode ser escolhida via comando <@lit="set horizon"> ou de forma automática com base na frequência dos dados.

Para um VAR com <@mth="p"> variáveis, a matriz possui <@mth="p"> <@sup="2"> colunas: as primeiras <@mth="p"> colunas contêm a FEVD para a primeira variável do VAR, as <@mth="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 <@mth="i"> causado por uma inovação na variável <@mth="j"> é então encontrado na coluna (<@mth="i"> – 1) <@mth="p"> + <@mth="j">.

Para uma variante mais flexível desta funcionalidade, ver a função <@ref="fevd">.

# $Fstat access
Resultado: 	escalar

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

# $gmmcrit access
Resultado: 	escalar

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

# $h access
Resultado: 	série

Deve ser utilizada após o comando <@lit="garch">. Retorna a série da variância condicional estimada.

# $hausman access
Resultado: 	vetor linha

Deve ser utilizada após a estimação de um modelo via <@lit="tsls"> ou <@lit="panel"> com a opção de efeitos aleatórios. Retorna um vetor 1×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 access
Resultado: 	escalar

Retorna o Critério de Informação de Hannan-Quinn para o último modelo estimado, quando disponível. Veja <@pdf="guia de utilização do Gretl#chap:criteria"> (Capítulo 28) para detalhes sobre os cálculos.

# $huge access
Resultado: 	escalar

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

# $jalpha access
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 access
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 access
Resultado: 	matriz quadrada

Deve ser utilizada após a estimação de um VECM e retorna a matriz de covariâncias estimada para os elementos 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 <@lit="restrict"> com a opção <@lit="--full">, uma matriz singular com <@mth="(n+m)r "> linhas será retornada (sendo <@mth="n"> o número de variáveis endógenas, <@mth="m"> o número de variáveis exógenas restritas ao espaço de cointegração e <@mth="r"> a ordem de cointegração).

Exemplo: o código

<code>
     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
</code>

produz a seguinte saída.

<code>
     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
</code>

# $lang access
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, <@lit="en"> para inglês, <@lit="jp"> para japonês, <@lit="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 <@lit="pt_PT"> enquanto o português do Brasil é representado por <@lit="pt_BR">.

Se o idioma não puder ser determinado será retornado o texto “<@lit="unknown">”.

# $llt access
Resultado: 	série

Para determinados 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 access
Resultado: 	escalar

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

# $macheps access
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.

# $mapfile access
Resultado: 	texto

Se tiver sido carregado dados de um ficheiro de formas GeoJSON ou ESRI, retorna o nome do ficheiro que deve obter o mapa de polígonos, caso contrário retorna uma cadeia de texto vazia. Isto está preparado para ser usado com a função <@ref="geoplot">.

# $mnlprobs access
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 access
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. Todas as funções de acesso de modelos regulares são incluídas e são referenciados por chaves iguais aos nomes das funções de acesso regulares menos o cifrão inicial. Assim, por exemplo, os resíduos aparecem sob a chave <@lit="uhat"> e o quadrado da soma dos erros sob <@lit="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:

<code>
     ols y 0 x
     bundle b = $model
     print b
</code>

# $mpirank access
Resultado: 	número inteiro

Se gretl foi compilado com suporte MPI, e o programa foi iniciado em modo MPI, retorna o “posto” de base 0 o ID do processo actual. Caso contrário retorna –1.

# $mpisize access
Resultado: 	número inteiro

Se gretl foi compilado com suporte MPI, e o programa foi iniciado em modo MPI, retorna o número do processo MPi actualmente em execução. Caso contrário retorna 0.

# $ncoeff access
Resultado: 	número inteiro

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

# $nobs access
Resultado: 	número inteiro

Retorna o número de observações na amostra atualmente selecionada. Veja também: <@ref="$tmax">.

# $now access
Resultado: 	vetor

Produz um vector de dois elementos: o primeiro elemento é o número de segundos decorridos desde1970-01-01 00:00:00 +0000 (UTC), que é uma medida utilizada muito frequentemente no mundo da informatica para representar a hora. O segundo é a data actual no formato “básico” ISO 8601, que é <@lit="YYYYMMDD">; para processar o segundo elemento pode-se usar a função <@ref="epochday">.

# $nvars access
Resultado: 	número inteiro

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

# $obsdate access
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 <@xrf="setobs">). A série que será retornada é composta por números com 8 dígitos seguindo o padrão <@lit="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 <@xrf="join">.

# $obsmajor access
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 (indivíduo: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 <@ref="$obsminor">, <@ref="$obsmicro">.

# $obsmicro access
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 <@ref="$obsmajor">, <@ref="$obsminor">.

# $obsminor access
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 (indivíduo: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, <@lit="$obsminor"> retorna o mês de cada observação.

Ver também <@ref="$obsmajor">, <@ref="$obsmicro">.

# $parnames access
Resultado: 	cadeia de texto

Depois da estimação de um modelo de uma só equação, produz um vector de texto contendo os nomes dos parâmetros do modelo. Os números do nomes correspondem ao número dos elementos no vector <@ref="$coeff"> .

Para modelos especificados com uma lista de regressores o resultado será o mesmo que

<code>
     varnames($xlist)
</code>

(ver <@ref="varnames">), mas <@lit="$parnames"> é mais geral, pois que funciona também com modelos sem lista de regressores (<@xrf="nls">, <@xrf="mle">, <@xrf="gmm">).

# $pd access
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 access
Resultado: 	escalar

Retorna o valor de π com dupla precisão.

# $pkgdir access
Resultado: 	texto

Uma ferramenta especial para ser usada por autores de pacotes de funções. Retorna uma cadeia de texto vazia se não estiver em execução, e se estiver, retorna o caminho completo (de acordo com a plataforma) de onde o pacote está instalado. Por exemplo, o valor retornado pode ser:

<code>
     /usr/share/gretl/functions/foo
</code>

se for essa a directoria onde <@lit="foo.gfn"> estiver localizado. Isto permite escritores de pacotes aceder a recursos como sejam ficheiros de matrizes que tenham sido incluidos nos seus pacotes.

# $pvalue access
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: <@lit="chow">). Veja <@pdf="guia de utilização do Gretl#chap:genr"> (Capítulo 10) para detalhes.

Geralmente retorna um escalar, mas em alguns casos retorna uma matriz. Isso ocorre, por exemplo, com os p-valores dos testes lambda traço e lambda 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 <@ref="$test">.

# $qlrbreak access
Resultado: 	escalar

Deve ser utilizada após o comando <@xrf="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.

# $result access
Resultado: 	matriz ou bundle

Fornece a informação armazenada de alguns comandos que não têm acessores específicos. Tais comandos incluem <@xrf="corr">, <@xrf="fractint">, <@xrf="freq">, <@xrf="summary">, <@xrf="xtab">, <@xrf="vif"> e <@xrf="bkw"> ; neste caso o resultado é uma matriz, e ainda <@xrf="pkg">, que opcionalmente guarda como um resultado bundle.

# $rho access
Resultado: 	escalar
Argumento: 	<@var="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 <@lit="ar">, a sintaxe <@lit="$rho(n)"> retorna a estimativa correspondente de ρ(<@mth="n">).

# $rsq access
Resultado: 	escalar

Retorna o <@mth="R"><@sup="2"> não ajustado do último modelo estimado, quando disponível.

# $sample access
Resultado: 	série

Deve ser utilizada após a estimação de um modelo com equação simples e retorna 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:

<code>
     ols y 0 xlist
     genr sdum = $sample
     smpl sdum --dummy
</code>

# $sargan access
Resultado: 	vetor linha

Deve ser utilizada após o comando <@lit="tsls">. Retorna um vetor 1×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.

# $seed access
Resultado: 	escalar

Retorna o valor com que o gerador de números aleatórios de gretl foi inicializado (“semeado”). Se tiver sido definido por você, então não há necessidade de usar este acessor, mas pode ser de interesse se a “semente” tiver sido inicializada automaticamente (baseado no tempo em que o programa foi iniciado).

# $sigma access
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 modelo foi um sistema de equações, retorna a matriz de covariâncias dos resíduos das equações do sistema.

# $stderr access
Resultado: 	matriz ou escalar
Argumento: 	<@var="s">  (nome do coeficiente, opcional)

Quando utilizado sem argumentos, <@lit="$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 <@var="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 <@ref="$coeff">, <@ref="$vcv">.

# $stopwatch access
Resultado: 	escalar

Deve ser precedida pelo comando <@lit="set stopwatch"> que, por sua vez, ativa a medição de tempo da CPU. Na primeira utilização da função de acesso obtém-se a quantidade de segundos que se passaram desde o comando <@lit="set stopwatch">. A cada acesso o relógio será reiniciado de forma que as utilizações subsequentes de <@lit="$stopwatch"> irão fornecer os segundos da CPU entre as duas utilizações.

# $sysA access
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 <@xrf="system">.

# $sysB access
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 <@xrf="system">.

# $sysGamma access
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 <@xrf="system">.

# $sysinfo access
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.

<indent>
• <@lit="mpi">: inteiro, igual a 1 se o sistema suporta MPI (Message Passing Interface), caso contrário 0.
</indent>

<indent>
• <@lit="omp">: inteiro, igual a 1 se o Gretl foi compilado com suporte a Open MP, caso contrário 0.
</indent>

<indent>
• <@lit="nproc">: inteiro, indica o número de processadores disponíveis.
</indent>

<indent>
• <@lit="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 <@lit="nproc"> local. Se for especificado um arquivo de hosts MPI, <@lit="mpimax"> será igual a soma do número de processadores ou “slots” ao longo de todas a máquinas referenciadas no arquivo.
</indent>

<indent>
• <@lit="wordlen">: inteiro, igual a 32 ou 64 para sistemas de 32 bit e 64, respectivamente.
</indent>

<indent>
• <@lit="os">: texto representando o sistema operacional e é igual a <@lit="linux">, <@lit="osx">, <@lit="windows"> ou <@lit="other">.
</indent>

<indent>
• <@lit="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 <@lit="localhost">.
</indent>

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

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

# $system access
Resultado: 	lote

Deve seguir a estimação de um sistema de equações via comandos <@xrf="system">, <@xrf="var"> ou <@xrf="vecm">. Retorna um pacote (bundle) contendo os ítems que fazem parte do sistema. Todas as funções de acesso regulares são incluídas: estas estão referenciadas de acordo com indicadores que são iguais aos nomes de acesso regular, sem utilizar o símbolo cifrão. Por exemplo, os resíduos aparecem sob o indicador <@lit="uhat"> e os coeficientes sob <@lit="coeff">. Os os indicadores para as informações adicionais deverão ser auto-explicativos. Para verificar quais estão disponíveis pode-se exibir os conteúdos do pacote. Exemplo:

<code>
     var 4 y1 y2 y2
     bundle b = $system
     print b
</code>

Um pacote definido dessa forma pode ser utilizado como o argumento final (que é opcional) nas funções <@ref="fevd"> e <@ref="irf">.

# $T access
Resultado: 	número inteiro

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

# $t1 access
Resultado: 	número inteiro

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

# $t2 access
Resultado: 	número inteiro

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

# $test access
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: <@lit="chow">). Veja <@pdf="guia de utilização do Gretl#chap:genr"> (Capítulo 10) para detalhes.

Geralmente retorna um escalar, mas em alguns casos retorna uma matriz. Isso ocorre, por exemplo, com as estatísticas lambda traço e lambda 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 <@ref="$pvalue">.

# $tmax access
Resultado: 	número inteiro

Devolve o máximo valor possível para indicar o fim do intervalo de uma amostra alterada com o comando <@xrf="smpl">. Na maior parte das vezes, isto vai ser igual ao número de observações do conjunto de dados, mas numa função em Hansl, o valor <@lit="$tmax"> pode ser menor, pois em geral o acesso aos dados a partir do interior de funções está limitado ao intervalo amostral definido pela função chamadora.

Notar que, em geral, o <@lit="$tmax"> não é igual a <@ref="$nobs">, que indica número de observações do intervalo da amostra actual.

# $trsq access
Resultado: 	escalar

Retorna <@mth="TR"><@sup="2"> (tamanho da amostra multiplicado pelo R-quadrado) do último modelo, quando disponível.

# $uhat access
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 <@lit="$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 <@lit="$uhat"> sem parâmetros fornece a matriz de resíduos, uma coluna por equação.

# $unit access
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 access
Resultado: 	matriz ou escalar
Argumentos:	<@var="s1">  (nome do coeficiente, opcional)
		<@var="s2">  (nome do coeficiente, opcional)

Quando utilizado sem argumentos, <@lit="$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 <@var="s1"> e <@var="s2">. Ver também <@ref="$coeff">, <@ref="$stderr">.

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

# $vecGamma access
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 <@mth="p"> existem <@mth="p"> – 1 sub-matrizes.

# $version access
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 <@lit="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 <@lit="$version "> foi preservada mesmo com a mudança no esquema de versões.

# $vma access
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 <@lit="set horizon">. Veja <@pdf="guia de utilização do Gretl#chap:var"> (Capítulo 32) para detalhes.

# $windows access
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 <@xrf="shell">.

# $workdir access
Resultado: 	texto

Este acessor retorna o caminho por defeito onde Gretl lê e escreve os ficheiros. Uma descrição mais detalhada pode ser encontrada no Guia de Referência dos Comandos em <@xrf="workdir">.Note-se que esta variável pode ser alterada por meio do comando <@xrf="set">.

# $xlist access
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 <@ref="$sysB">). Se o último modelo foi um VAR ela retorna uma lista com os regressores exógenos, caso existam.

# $xtxinv access
Resultado: 	matriz

Após a estimação de um VAR ou VECM (apenas), retorna <@mth="X'X"><@sup="-1">, onde <@mth="X"> é a matriz comum de regressores utilizados em cada equação. Essa função de acesso não está disponível para VECMs estimados com restrições impostas na matriz de cargas(α).

# $yhat access
Resultado: 	série

Retorna os valores ajustados da última regressão.

# $ylist access
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 a função de acesso 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 math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna o valor absoluto de <@var="x">.

# acos math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna o arco-cosseno de <@var="x">, isto é, o valor cujo cosseno é <@var="x">. Resultado em radianos e o argumento deve estar entre –1 e 1.

# acosh math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

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

# aggregate stats
Resultado: 	matriz
Argumentos:	<@var="x">  (série ou lista)
		<@var="byvar">  (série ou lista)
		<@var="funcname">  (texto, opcional)

Na forma mais simples de uso, <@var="x"> é igual a <@lit="null">, <@var="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 <@var="byvar">, ordenados de forma crescente, e na segunda a quantidade de observações de <@var="byvar"> para cada um dos valores distintos. Por exemplo,

<code>
     open data4-1
     eval aggregate(null, bedrms)
</code>

mostrará que a serie <@lit="bedrms"> tem valores 3 (num total de 5 vezes) e 4 (num total de 9 vezes).

Se <@var="x"> e <@var="byvar"> são ambas séries individuais, e é indicado um terceiro argumento, o valor retornado é uma matriz com três colunas contendo, respectivamente, os valores distintos de <@var="byvar">, por ordem crescente; a contagem das observações em que o <@var="byvar"> toma em cada um desses valores; e os valores da estatística especificada por <@var="funcname"> calculada na série <@var="x">, usando apenas aquelas observações nas quais <@var="byvar"> tem valor igual aos dados na primeira coluna.

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

Os seguintes valores de <@var="funcname"> são suportados de forma “nativa”: <@ref="sum">, <@ref="sumall">, <@ref="mean">, <@ref="sd">, <@ref="var">, <@ref="sst">, <@ref="skewness">, <@ref="kurtosis">, <@ref="min">, <@ref="max">, <@ref="median">, <@ref="nobs"> e <@ref="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 <@lit="nobs">, a função <@lit="aggregate "> não é redundante como uma agregadora, uma vez que fornece o número de observações válidas (não ausentes) em <@var="x "> em cada combinação <@var="byvar">.

Para exemplificar isso, suponha que <@lit="region"> representa um código de uma região geográfica usando valores inteiros de 1 até <@mth="n"> e <@lit="income"> representa a renda doméstica. Então o cálculo a seguir deverá produzir uma matriz de ordem <@itl="n">×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:

<code>
     matrix m = aggregate(income, region, mean)
</code>

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

<code>
     list BY = gender race
     list X = income age
     matrix m = aggregate(X, BY, sd)
</code>

A utilização de <@lit="aggregate"> produzirá uma matriz de ordem 6×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 desvios padrão amostrais de <@lit="income"> e <@lit="age">.

Note que se <@var="byvar"> for uma lista, algumas combinações dos valores de <@var="byvar"> podem não estar presentes nos dados (fornecendo uma contagem igual a zero). Nesse caso os valores das estatísticas para <@var="x"> são considerados como <@lit="NaN"> (ou seja, não são números). Caso seja desejado ignorar esses casos é possível utilizar a função <@ref="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 <@var="byvar">, assim, pode-se utilizar o seguinte código:

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

# argname strings
Resultado: 	texto
Argumento: 	<@var="s">  (texto)

Seja <@var="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 data-utils
Resultado: 	ver abaixo
Argumento: 	<@var="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: <@lit="strings">, <@lit="matrices">, <@lit="bundles"> ou <@lit="lists">. O valor de retorno é um arranjo do tipo especificado e com <@var="n"> elementos “vazios” (exemplos: variável de texto/string vazia ou matriz nula). Exemplos de utilização:

<code>
     strings S = array(5)
     matrices M = array(3)
</code>

Veja também <@ref="defarray">.

# asin math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna o arco-seno de <@var="x">, isto é, o valor cujo seno é <@var="x">. Resultado em radianos e o argumento deve estar entre –1 e 1.

# asinh math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna o seno hiperbólico inverso de <@var="x">. Ver também <@ref="sinh">.

# assert programming
Resultado: 	escalar
Argumento: 	<@var="expr">  (escalar)

Esta função serve para testar ou despistar erros no código hansl. O argumento deve ser uma expressão escalar. O valor retornado é 1 se <@var="expr"> retorna um valor não-zero (o valor booleano “verdadeiro”, ou “sucesso”) ou 0 se a expressão é zero (o valor booleano “falso”, ou “insucesso”).

Por defeito, não há consequências se <@lit="assert"> falhar, para além do valor retornado ser zero. No entanto o comando <@xrf="set"> pode ser usado para fazer com que uma falha da verificação seja mais consequente. Existem dois níveis:

<code>
     # mostra uma mensagem de aviso mas continua a execução
     set assert warn
     # mostra uma mensagem de erro e interrompe a execução
     set assert stop
</code>

O comportamento padrão pode ser restaurado com o comando

<code>
     set assert off
</code>

Como simples exemplo, se num certo ponto no script hansl um escalar <@lit="x"> ser sempre não-negativo, este código controlará esta condição e terminará se ela não for satisfeita:

<code>
     set assert stop
     assert(x >= 0)
</code>

# atan math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna o arco-tangente de <@var="x">, isto é, o valor cuja tangente é <@var="x">. Resultado em radianos. Ver também <@ref="cos">, <@ref="sin">, <@ref="tan">.

# atan2 math
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="y">  (escalar, série ou matriz)
		<@var="x">  (escalar, série ou matriz)

Retorna o valor principal do arco-tangente de <@var="y">/<@var="x">, usando os sinais dos dois argumentos para determinar o quadrante do resultado, que é expresso em radianos, dentro do intervalo [–π, π].

Se os dois argumentos forem de tipos diferentes, o resultado é do tipo “mais alto” dos dois, seguindo a ordem, matriz > série > escalar. Por exemlo, se <@var="y"> é um escalar e <@var="x"> um vector de <@mth="n"> elementos (ou viceversa), o resultado é também um vector. Note-se que os argumentos matriciais deverem ser vectores, e que se nenhum deles for escalar, devem ter a mesma dimensão.

Ver também <@ref="tan">, <@ref="tanh">.

# atanh math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna a tangente hiperbólica inversa de <@var="x">. Ver também <@ref="tanh">.

# atof strings
Resultado: 	escalar
Argumento: 	<@var="s">  (texto)

Função semelhante à existente na linguagem de programação C, retorna o resultado da conversão da variável de texto (string) <@var="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 <@lit="atof"> (por questões de portabilidade) sempre assume que o caractere decimal é o “<@lit=".">”. Todos os caracteres que se seguem após a parte de <@var="s"> que pode ser convertida para um número de ponto flutuante são ignorados.

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

<code>
     # 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
</code>

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

# bessel math
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="type">  (caractere)
		<@var="v">  (escalar)
		<@var="x">  (escalar, série ou matriz)

Calcula uma das variantes da função de Bessel de ordem <@var="v"> e argumento <@var="x">. O valor retornado será do mesmo tipo de <@var="x">. A função específica é selecionada pelo primeiro argumento e deve ser <@lit="J">, <@lit="Y">, <@lit="I"> ou <@lit="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 <@lit="J">: função de Bessel de primeiro tipo. Se assemelha a uma onda senoidal amortecida. Definida para <@var="v"> real e <@var="x">. Se <@var="x"> for negativo então <@var="v"> deve ser um inteiro.

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

caso <@lit="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 <@lit="J">.

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

# BFGSmax numerical
Resultado: 	escalar
Argumentos:	<@var="&b">  (referência a matriz)
		<@var="f">  (chamada a função)
		<@var="g">  (chamada a função, opcional)

Realiza a maximização numérica via método de Broyden, Fletcher, Goldfarb e Shanno. O argumento <@var=" b"> deve conter os valores iniciais de um conjunto de parâmetros e o argumento <@var="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, <@lit="BFGSmax"> retorna o valor maximizado do critério e <@var="b"> armazena 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 <@var=" g"> deve ter como primeiro argumento uma matriz pré-definida que tenha o tamanho adequado para armazenar o gradiente, dado na forma de ponteiro. 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 <@pdf="guia de utilização do Gretl#chap:numerical"> (Capítulo 37). Ver também <@ref="BFGScmax">, <@ref="NRmax">, <@ref="fdjac">, <@ref="simann">.

# BFGSmin numerical
Resultado: 	escalar

É uma forma alternativa da função <@ref="BFGSmax">. Se invocada com este nome a função comporta-se como minimizadora.

# BFGScmax numerical
Resultado: 	escalar
Argumentos:	<@var="&b">  (referência a matriz)
		<@var="bounds">  (matriz)
		<@var="f">  (chamada a função)
		<@var="g">  (chamada a função, opcional)

Realiza a maximização com restrições via L-BFGS-B (BFGS com memória limitada, veja <@bib="Byrd, Lu, Nocedal e Zhu, 1995;byrd-etal95">). O argumento <@var="b "> deve conter os valores iniciais de um conjunto de parâmetros, <@var="bounds"> deve conter as restrições que aplicadas aos valores dos parâmetros (veja abaixo) e <@var="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, <@lit="BFGScmax"> retorna o valor maximizado do critério, sujeito às restrições em <@var="bounds"> e <@var="b"> contém os valores dos parâmetros que maximizam a função.

A matriz <@var="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 <@lit="-$huge"> e <@lit="$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:

<code>
     matrix bounds = {2, 0, $huge}
</code>

O quarto argumento, opcional, estabelece uma maneira de fornecer derivadas analíticas (caso contrário o gradiente será computado numericamente). A função gradiente <@var=" g"> deve ter como primeiro argumento uma matriz pré-definida que tenha o tamanho adequado para armazenar o gradiente, dado na forma de ponteiro. 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 <@pdf="guia de utilização do Gretl#chap:numerical"> (Capítulo 37). Ver também <@ref="BFGSmax">, <@ref="NRmax">, <@ref="fdjac">, <@ref="simann">.

# BFGScmin numerical
Resultado: 	escalar

É uma forma alternativa da função <@ref="BFGSmax">.Se invocada com este nome a função comporta-se como minimizadora.

# bincoeff math
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="n">  (escalar, série ou matriz)
		<@var="k">  (escalar, série ou matriz)

Calcula o coeficiente binomial, ou seja o número de maneiras com que <@var="k"> elementos possam ser escolhidos a partir dos <@var="n"> elementos sem repetições, independentemente da sua ordenação. Este número é também igual ao <@var="(k+1)">-esimo coeficiente da expansão polinomial da <@mth="(1+x)^n">.

Para argumentos inteiros, o resultado é <@mth="n!/k!(n-k)!">, mas a função aceita também aceita argumentos reais, e a fórmula generaliza-se com <@mth=" Γ(n+1)/( Γ(k+1) × Γ(n-k+1) )">

Quando <@var="k"> > <@var="n"> ou <@var="k"> < 0, a função retorna NA.

Se os dois argumentos forem de tipos diferentes, o resultado é do tipo “mais alto” dos dois, seguindo a ordem, matriz > série > escalar. Por exemlo, se <@var="n"> é um escalar e <@var="k"> um vector de <@mth="r"> elementos (ou viceversa), o resultado é também um vector. Note-se que os argumentos matriciais deverem ser vectores, e que se nenhum deles for escalar, devem ter a mesma dimensão.

Ver também <@ref="gammafun"> e <@ref="lngamma">.

# bkfilt timeseries
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="f1">  (número inteiro, opcional)
		<@var="f2">  (número inteiro, opcional)
		<@var="k">  (número inteiro, opcional)

Retorna o resultado da aplicação do filtro passa-banda de Baxter–King para a série <@var="y">. Os parâmetros opcionais <@var="f1"> e <@var="f2"> representam, respectivamente, os limites inferior e superior da amplitude de frequência a ser extraída, enquanto <@var="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 <@var="f1">, <@var="f2"> e <@var="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 <@var="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 <@ref="bwfilt">, <@ref="hpfilt">.

# bkw stats
Resultado: 	matriz
Argumentos:	<@var="V">  (matriz)
		<@var="parnames">  (cadeia de texto, opcional)
		<@var="verbose">  (booleano, opcional)

Calcula o test BKW para a colinearidade (ver <@bib="Belsley, Kuh and Welsch (1980);belsley-etal80">) dada a matriz covariança da estimativa dos parâmetros <@var="V">. O segundo argumento opcional, que pode ser um vector de texto ou uma cadeia de texto que contenha nomes separados por vírgulas, é usado para etiquetar a coluna que mostra a proporção da variância; o número de nomes deve ser igual à dimensão de <@var="V">. Depois de se ter estimado uma modelo em gretl, pode-se obter os parâmetros adequados por via dos acessores <@ref="$vcv"> e <@ref="$parnames">.

Por defeito esta função produz apenas a tabela BKW como matriz, mas se inserir um valor diferente de 0 como terceiro argumento, junto com a tabela é mostrado mais alguma análise.

Esta função também existe como comando que retorna o mesmo cálculo, <@xrf="bkw">, e que usa automaticamente o último modelo sem necessitar argumentos.

# boxcox transforms
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="y">  (série ou matriz)
		<@var="d">  (escalar)

Retorna a transformação de Box–Cox com parâmetro <@var="d"> para uma variável positiva <@var="y"> (ou a coluna da matriz <@var="y">).

O resultado é (<@mth="y"><@sup="d"> - 1)/<@mth="d"> para <@mth="d"> diferente de zero ou log(<@mth="y">) para <@mth="d"> = 0.

# bread data-utils
Resultado: 	lote
Argumentos:	<@var="fname">  (texto)
		<@var="import">  (booleano, opcional)

Lê um pacote (bundle) a partir de um arquivo de texto. A variável de texto (string) <@var="fname"> deve conter o nome do arquivo no qual o pacote será lido. Se esse nome tiver a extensão “<@lit=".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 <@lit="gretl-bundle">, utilizado para armazenar zero ou mais elementos <@lit="bundled-item">. Por exemplo:

<code>
     <?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>
</code>

Como esperado, tais arquivos são gerados automaticamente pela função associada <@ref="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 <@xrf="workdir"> corrente. Entretanto, se for dado um valor não-nulo para o argumento opcional <@var="import">, o arquivo será procurado no diretório “@dotdir”. Nesse caso o argumento <@var="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 <@ref="$error">.

Ver também <@ref="mread">, <@ref="bwrite">.

# brename data-utils
Resultado: 	escalar
Argumentos:	<@var="B">  (lote)
		<@var="antiga">  (texto)
		<@var="nova">  (texto)

Se o argumento bundle <@var="B"> contém um elemento com a etiqueta <@var="antiga">, esta é alterada para <@var="nova">; caso contrário, é mostrado um erro. Em caso de sucesso, retorna 0.

Esta não é uma operação muito comum, mas pode ser necessária em funções que trabalham com bundles, e <@lit="brename"> é uma ferramenta eficiente para essa tarefa. Exemplo:

<code>
     # controi um bundle contendo uma matriz grande
     bundle b
     b.X = mnormal(1000, 1000)
     if 0
         # muda o nome manualmente
         Xcopy = b.X
         delete b.X
         b.Y = Xcopy
         delete Xcopy
     else
         # melhor: mais eficiente
         brename(b, "X", "Y")
     endif
</code>

O primeiro método obriga a que a matriz seja copiada duas vezes, fora do bundle e depois insere com nova etiqueta, enquanto o método eficiente altera directamente a etiqueta.

# bwfilt timeseries
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="n">  (número inteiro)
		<@var="omega">  (escalar)

Retorna o resultado da aplicação de um filtro passa-baixo de Butterworth de ordem <@var="n"> e frequência de corte <@var="omega"> na série <@var="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 <@var="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 <@pdf="guia de utilização do Gretl#chap:tsfilter"> (Capítulo 30) para detalhes. Ver também <@ref="bkfilt">, <@ref="hpfilt">.

# bwrite data-utils
Resultado: 	número inteiro
Argumentos:	<@var="B">  (lote)
		<@var="fname">  (texto)
		<@var="export">  (booleano, opcional)

Escreve um pacote (bundle) <@var="B"> em um arquivo XML com nome <@var="fname">. Para uma descrição sumária de seu formato, veja <@ref="bread">. Se já existir um arquivo <@var="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 <@xrf="workdir">, a menos que a variável <@var="fname"> contenha um caminho para o diretório onde será armazenado. Entretanto, se for dado um valor não-nulo para o argumento <@var=" 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 <@var="fname"> tiver a extensão <@lit=".gz"> é aplicada a compressão gzip.

Ver também <@ref="bread">, <@ref="mwrite">.

# carg complex
Resultado: 	matriz
Argumento: 	<@var="C">  (matriz complexa)

Retorna uma matriz real <@itl="m">×<@itl="n"> contendo o “argumento” complexo de cada elemento da matriz complexa <@itl="m">×<@itl="n"> <@var="C">. O argumento do número complexo <@mth="z"> = <@mth="x"> + <@mth="yi"> também pode ser calculado como <@lit="atan2(y, x)">.

Ver também <@ref="cmod">, <@ref="atan2">.

# cdemean transforms
Resultado: 	matriz
Argumentos:	<@var="X">  (matriz)
		<@var="standardize">  (booleano, opcional)

Centraliza as colunas da matriz <@var="X"> em torno de suas médias. Se o segundo argumento (opcional) é diferente de zero, a coluna é normalizada, usando o desvio padrão ajustada com os graus de liberdade (ou seja <@mth="n"> – 1 como divisor, onde <@mth="n"> é o número de linhas de <@var="X">).

# cdf probdist
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="c">  (caractere)
		<@var="…">  (ver abaixo)
		<@var="x">  (escalar, série ou matriz)
Exemplos: 	<@lit="p1 = cdf(N, -2.5)">
		<@lit="p2 = cdf(X, 3, 5.67)">
		<@lit="p3 = cdf(D, 0.25, -1, 1)">

Calculadora da função de distribuição acumulada. Retorna <@mth="P(X ≤ x)">, onde a distribuição de <@mth="X"> é especificada pela letra <@var="c">. Entre os argumentos <@var=" c"> e <@var="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, <@ref="cnorm">):

<indent>
• Normal padrão (c = z, n ou N): sem argumentos extras
</indent>

<indent>
• Normal bivariada (D): coeficiente de correlação
</indent>

<indent>
• t de Student (t): graus de liberdade
</indent>

<indent>
• Qui-quadrado (c, x ou X): graus de liberdade
</indent>

<indent>
• F de Snedecor F (f ou F): graus de liberdade (num.); graus de liberdade (den.)
</indent>

<indent>
• Gama (g ou G): forma; escala
</indent>

<indent>
• Binomial (b ou B): probabilidade; quantidade de tentativas
</indent>

<indent>
• Poisson (p ou P): média
</indent>

<indent>
• Exponencial (exp): escala
</indent>

<indent>
• Weibull (w ou W): forma; escala
</indent>

<indent>
• Laplace (l ou L): media; escala
</indent>

<indent>
• Erro Generalizado (E): forma
</indent>

<indent>
• Qui-quadrado não-central (ncX): graus de liberdade, parâmetro de não-centralidade
</indent>

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

<indent>
• t não-central (nct): graus de liberdade, parâmetro de não-centralidade
</indent>

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 é <@lit="x = cdf(D, rho, z1, z2)"> onde <@lit="rho"> é a correlação entre as variáveis <@lit="z1"> e <@lit="z2">.

Ver também <@ref="pdf">, <@ref="critical">, <@ref="invcdf">, <@ref="pvalue">.

# cdiv complex
Resultado: 	matriz
Argumentos:	<@var="X">  (matriz)
		<@var="Y">  (matriz)

Divisão de números complexos. Os dois argumentos devem possuir o mesmo número de linhas, <@mth="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 <@itl="n">×2 ou, caso não exista a parte imaginária, um vetor com <@mth="n"> linhas. Ver também <@ref="cmult">.

# cdummify transforms
Resultado: 	lista
Argumento: 	<@var="L">  (lista)

Esta função devolve uma lista em que cada série do argumento <@var="L"> que tenha o atributo “codificado” é substituída por un conjunto de variáveis fictícias/dummy que representam cada um dos seus valores codificados, mas omitindo o valor mais pequeno/menor. Se o argumento <@var="L"> não contém nenhuma série codificada, o valor retornado vai ser idêntico ao argumento <@var="L">.

As variáveis fictícias/dummy, se geradas, terão os nomes criados de acordo com o padrão <@lit="D"><@var=" nome-da-variável "><@lit="_"><@var="vi"> onde <@var="vi"> é o <@var="i"><@itl="-ésimo"> valor representado da variável codificada. Caso alguns valores sejam negativos, será inserido “m” antes do valor (absoluto) de <@var="vi">.

Por exemplo, supondo que <@var="L"> contém, uma série codificada chamada <@lit="C1"> com valores –9, –7, 0, 1 e 2. Então, as variáveis dummy/fictícias geradas vão ser <@lit="DC1_m7"> (que codifica quando C1 = –7), <@lit="DC1_0"> (que codifica quando C1 = 0), etc.

Ver também <@ref="dummify">, <@ref="getinfo">.

# ceil math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

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

# cholesky linalg
Resultado: 	matriz quadrada
Argumento: 	<@var="A">  (matriz positiva definida)

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

# chowlin timeseries
Resultado: 	matriz
Argumentos:	<@var="Y">  (matriz)
		<@var="xfac">  (número inteiro)
		<@var="X">  (matriz, opcional)

Expande os dados de entrada, <@var="Y">, para uma frequência maior utilizando o método de <@bib="Chow e Lin (1971);chowlin71">. É assumido que as colunas de <@var="Y"> representam séries. A matriz retornada tem a mesma quantidade de colunas de <@var="Y"> e <@var="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 <@var="X"> for fornecido, suas colunas devem ser utilizadas como regressores adicionais. A função retornará um erro se o número de linhas em <@var="X"> não for igual a <@var="xfac"> vezes o número de linhas em <@var="Y">.

# cmod complex
Resultado: 	matriz
Argumento: 	<@var="C">  (matriz complexa)

Retorna uma matriz real <@itl="m">×<@itl="n"> contendo o valor absoluto (ou “módulo”) de cada elemento da matriz complexa <@itl="m">×<@itl="n"> <@var="C">. O módulo do número complexo <@mth="z"> = <@mth="x"> + <@mth="yi"> é igual à raiz quadrada de <@mth="x"><@sup="2"> + <@mth="y"><@sup="2">.

Ver também <@ref="carg">.

# cmult complex
Resultado: 	matriz
Argumentos:	<@var="X">  (matriz)
		<@var="Y">  (matriz)

Multiplicação complexa. Os dois argumentos devem ter o mesmo número de linhas, <@mth="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 <@itl="n">×2, ou, se o resultado não contiver parte imaginária, um vetor de tamanho <@mth="n">. Ver também <@ref="cdiv">.

# cnorm probdist
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

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

# cnumber linalg
Resultado: 	escalar
Argumento: 	<@var="X">  (matriz)

Retorna o número condicional da matriz <@var="X"> de ordem <@itl="n">×<@itl="k">, conforme definido em <@bib="Belsley, Kuh e Welsch (1980);belsley-etal80">. Se as colunas de <@var="X"> forem mutuamente ortogonais o número condicional de <@var="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) construir uma matriz <@mth="Z"> onde suas colunas são a divisão das colunas de <@var="X"> divididas por suas respectivas normas euclidianas; (2) construir <@mth="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 <@ref="rcond">.

# cnameget strings
Resultado: 	texto ou cadeia de texto
Argumentos:	<@var="M">  (matriz)
		<@var="col">  (número inteiro, opcional)

Se o argumento <@var="col"> for dado, retorna o nome da coluna <@var="col"> da matriz <@var="M">. Se as colunas de <@var="M"> não possuírem nomes então será retornada um texto (string) vazio. Se <@var="col"> for maior que o número de colunas da matriz será sinalizado um erro.

Se não se indicar o segundo argumento, retornará um vetor de texto que contém os nomes das colunas de <@var="M">, ou um vetor de texto vazio se <@var="M"> não tiver nomes de colunas atribuídos.

Exemplo:

<code>
     matrix A = { 11, 23, 13 ; 54, 15, 46 }
     cnameset(A, "Col_A Col_B Col_C")
     string name = cnameget(A, 3)
     print name
</code>

Ver também <@ref="cnameset">.

# cnameset matrix
Resultado: 	escalar
Argumentos:	<@var="M">  (matriz)
		<@var="S">  (cadeia de texto ou lista)

Adiciona nomes para as colunas da matriz <@var="M"> de ordem <@itl="T">×<@itl="k"> . Se <@var="S"> for uma lista, os nomes serão os das séries listadas. A lista precisa ter <@mth="k"> membros. Se <@var="S"> for um arranjo (array) de textos (string), ele precisa ter <@mth="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 <@mth="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 <@ref="rownames">.

Exemplo:

<code>
     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
</code>

# cols matrix
Resultado: 	número inteiro
Argumento: 	<@var="X">  (matriz)

Retorna o número de colunas da matriz <@var="X">. Ver também <@ref="mshape">, <@ref="rows">, <@ref="unvech">, <@ref="vec">, <@ref="vech">.

# complex complex
Resultado: 	matriz complexa
Argumentos:	<@var="A">  (escalar ou matriz)
		<@var="B">  (escalar ou matriz, opcional)

Retorna uma matriz complexa, onde <@var="A"> é utilisada para fornecer a parte real e <@var="B"> a parte imaginária. Se <@var="A"> é <@itl="m">×<@itl="n"> e <@var="B"> é um escalar, o resultado é <@itl="m">×<@itl="n"> com a parte imaginária constante—e recíprocamente o oposto, mas com a parte real constante. Se ambos os argumentos são matrizes, elas devem ser da mesmas dimensões. Por defeito, caso o segundo argumento seja omitido, a parte imaginária é igual a zero. Ver também <@ref="cswitch">.

# conj complex
Resultado: 	matriz complexa
Argumento: 	<@var="C">  (matriz complexa)

Retorna uma matriz complexa <@itl="m">×<@itl="n"> contendo o complexo conjugado de cada elemento da matriz complexa <@itl="m">×<@itl="n"> <@var="C">. O conjugado de um número complexo <@mth="z"> = <@mth="x"> + <@mth="yi"> é igual a <@mth="x"> – <@mth="yi">.

Ver também <@ref="carg">, <@ref="cmod">.

# conv2d linalg
Resultado: 	matriz
Argumentos:	<@var="A">  (matriz)
		<@var="B">  (matriz)

Calcula a convolução bidimensional das matrizes <@var="A"> e <@var="B">. Se <@var="A"> é <@itl="r">×<@itl="c"> e <@var="B"> é <@itl="m">×<@itl="n"> a matriz resultante terá <@mth="r+m-1"> linhas e <@mth="c+n-1"> colunas.

Ver também <@ref="fft">, <@ref="filter">.

# corr stats
Resultado: 	escalar
Argumentos:	<@var="y1">  (série ou vetor)
		<@var="y2">  (série ou vetor)

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

# corrgm timeseries
Resultado: 	matriz
Argumentos:	<@var="x">  (série, matriz ou lista)
		<@var="p">  (número inteiro)
		<@var="y">  (série ou vetor, opcional)

Se forem fornecidos apenas os dois primeiros argumentos a função calcula o correlograma de <@var="x"> para as defasagens de 1 até <@var="p">. Sendo <@mth="k"> o número de elementos em <@var="x"> (igual a 1 se <@var="x"> for uma série, ao número de colunas se <@var="x"> for uma matriz ou ao número de membros se <@var="x"> for uma lista). O valor retornado será uma matriz com <@var="p"> linhas e 2<@mth="k"> colunas, onde as <@mth="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 <@mth="k"> elementos em <@var="x"> e <@var="y">, partindo de <@mth="+"><@var="p"> até <@mth="-"><@var=" p">. A matriz retornada possui 2<@mth="p"> + 1 linhas e <@mth="k"> colunas. Se <@var="x"> for uma série ou lista e <@var="y"> for um vetor, <@var="y"> precisa ter linhas na mesma quantidade que o total de observações na amostra selecionada.

# cos math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna o cosseno de <@var="x">. Ver também <@ref="sin">, <@ref="tan">, <@ref="atan">.

# cosh math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna o cosseno hiperbólico de <@var="x">.

Ver também <@ref="acosh">, <@ref="sinh">, <@ref="tanh">.

# cov stats
Resultado: 	escalar
Argumentos:	<@var="y1">  (série ou vetor)
		<@var="y2">  (série ou vetor)

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

# critical probdist
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="c">  (caractere)
		<@var="…">  (ver abaixo)
		<@var="p">  (escalar, série ou matriz)
Exemplos: 	<@lit="c1 = critical(t, 20, 0.025)">
		<@lit="c2 = critical(F, 4, 48, 0.05)">

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

<indent>
• Normal padrão (c = z, n ou N): sem argumentos extras
</indent>

<indent>
• t de Student (t): graus de liberdade
</indent>

<indent>
• Chi square (c, x ou X): graus de liberdade
</indent>

<indent>
• F de Snedecor (f ou F): g.l. (num.); g.l. (den.)
</indent>

<indent>
• Binomial (b ou B): probabilidade; tentativas
</indent>

<indent>
• Poisson (p ou P): média
</indent>

<indent>
• Laplace (l ou L): média; escala
</indent>

<indent>
• Erro Generalizado (E): forma
</indent>

Ver também <@ref="cdf">, <@ref="invcdf">, <@ref="pvalue">.

# cswitch complex
Resultado: 	matriz
Argumentos:	<@var="A">  (matriz)
		<@var="modo">  (escalar)

Reinterpreta uma matriz real como contendo valores complexos ou viceversa. A acção exacta depende de <@var="modo"> (que pode ter os valores 1,2,3 ou 4) como se mostra a seguir:

modo 1: <@var="A"> deve ser uma matriz real com um número par de colunas. Produz uma matriz complexa com a metade das colunas; as colunas ímpares de <@var="A"> fornecem a parte real e as colunas pares as partes imaginárias.

modo 2: Produz o resultado inverso daquele em modo 1. <@var="A"> deve ser uma matriz complexa e o resultado é uma matriz real com o dobro das colunas de <@var="A">.

modo 3: <@var="A"> deve ser uma matriz real com um número par de linhas. Produz uma matriz complexa com a metade das linhas; as linhas ímpares de <@var="A"> fornecem a parte real e as linhas pares as partes imaginárias.

modo 4: Produz o resultado inverso daquele em modo modo 3. <@var="A"> deve ser uma matriz complexa e o resultado é uma matriz real com o dobro das linhas de <@var="A">.

Ver também <@ref="complex">.

# ctrans complex
Resultado: 	matriz complexa
Argumento: 	<@var="C">  (matriz complexa)

Retorna a matriz complexa <@itl="n">×<@itl="m"> contendo a transposta do conjugado da matriz complexa <@itl="m">×<@itl="n"> <@var="C">. O operador <@lit="'"> (primo) também produz a transposição conjugada de matrizes complexas. A função <@ref="transp"> pode ser usada em matrizes complexas mas produz a transposiçã0 “directa” (não coniugada).

# cum transforms
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (série ou matriz)

Acumula <@var="x"> (isto é, cria uma soma móvel). Quando <@var="x"> for uma série, produz uma série <@mth="y"> onde cada um de seus elementos é igual a soma dos valores de <@var="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 <@var="x"> for uma matriz, seus elementos são acumulados por colunas.

Ver também <@ref="diff">.

# curl data-utils
Resultado: 	escalar
Argumento: 	<@var="&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 <@var="b">, do tipo pacote (bundle), deve conter uma variável de texto (string) chamada <@lit="URL"> que fornece o endereço completo do recurso no host alvo. Outros elementos opcionais são apresentados a seguir.

<indent>
• “<@lit="header">”: a variável de texto especificando um header HTTP que será enviado para o host.
</indent>

<indent>
• “<@lit="postdata">”: a variável de texto contendo os dados que serão enviados para o host.
</indent>

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

Se outro elemento opcional do pacote, um escalar chamado <@lit="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 “<@lit="output">”.

Se um erro ocorrer na formulação da requisição (por exemplo, não existir a <@lit="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 “<@lit="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 uma consulta (query) JSON. Note o uso de <@xrf="sprintf"> para inserir aspas duplas no dado <@lit="POST">.

<code>
     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
</code>

Veja também as funções <@ref="jsonget"> e <@ref="xmlget"> para processamento de dados recebidos no formato JSON e XML, respectivamente.

# dayspan calendar
Resultado: 	número inteiro
Argumentos:	<@var="dia1">  (número inteiro)
		<@var="dia2">  (número inteiro)
		<@var="dias por semana">  (número inteiro)

Retorna o número de dias (relevantes) entre os dias <@var="dia1"> e <@var="dia2">, inclusive. Os <@var="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 época a partir de formas mais familiares de datas, ver <@ref="epochday">. Veja também: <@ref="smplspan">.

# defarray data-utils
Resultado: 	ver abaixo
Argumento: 	... (ver abaixo)

Permite a definição de uma variável do tipo arranjo (array) <@itl="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: <@lit="strings">, <@lit="matrices">, <@lit="bundles"> ou <@lit="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 <@mth="n"> elementos, onde <@mth="n"> é igual ao número de argumentos.

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

Veja também <@ref="array">.

# defbundle data-utils
Resultado: 	lote
Argumento: 	... (ver abaixo)

Permite a definição inicial de uma variável pacote (bundle) <@itl="por extenso">, com a indicação de zero ou mais pares com o formato <@var="chave">, <@var="membro">. Se contarmos os argumentos a partir de 1, cada argumento numerado ímpar tem de corresponder a uma cadeia de texto (chave) e cada argumento numerado par deve representar um objeto/objecto de um tipo que possa ser incluído num pacote.

Alguns exemplos simples:

<code>
     bundle b1 = defbundle("s", "Texto exemplo", "m", I(3))
     bundle b2 = defbundle("yn", normal(), "x", 5)
</code>

O primeiro exemplo é um pacote cujos membros são uma cadeia de texto e uma matriz. O segundo, um pacote com um membro que é uma série e outro que é escalar. Notar que não se pode especificar o tipo de cada argumento quando se utiliza esta função, por isso deve-se aceitar o tipo “natural” do argumento em questão. Por exemplo, se se pretendia acrescentar uma série com valor constante 5, a um pacote chamado <@lit="b1"> seria necessário escrever algo como o seguinte (depois de declarar <@lit="b1">):

<code>
     series b1.s5 = 5
</code>

Se não se fornecer nenhum argumento a esta função, isso equivale a criar um pacote vazio (ou esvaziar o conteúdo um pacote existente), o que também poderia ser feito via:

<code>
     bundle b = null
</code>

# deflist data-utils
Resultado: 	lista
Argumento: 	... (ver abaixo)

Gera uma lista (de séries já definidas) dados um ou mais argumentos apropriados. Cada argumento deve ser uma série já definida (indicada pelo seu nome ou número ID), uma lista definida previamente ou por uma expressão cujo resultado seja uma lista (incluindo um vetor que possa ser interpretado como um conjunto de números ID).

Um ponto a ser considerado é que esta função simplesmente concatena seus argumentos para produzir a lista que ela devolve. Quando se pretende que o valor a ser retornado não tenha duplicados (que não se refira a nenhuma série mais que uma vez), fica a cargo do utilizador garantir que esse requisito seja seguido.

# deseas timeseries
Resultado: 	série
Argumentos:	<@var="x">  (série)
		<@var="c">  (caractere, opcional)

Precisa que o TRAMO/SEATS e/ou X-12-ARIMA estejam instalados. Retorna a série <@var="x"> dessazonalizada (ou seja, sazonalmente ajustada). A série a ser dessazonalizada precisa ser mensal ou trimestral. Para utilizar o X-12-ARIMA deve-se fornecer <@lit="X"> como segundo argumento e para usar o TRAMO/SEATS deve-se fornecer <@lit="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 <@lit="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 linalg
Resultado: 	escalar
Argumento: 	<@var="A">  (matriz quadrada)

Retorna o determinante de <@var="A">, calculado via decomposição LU. Ver também <@ref="ldet">, <@ref="rcond">, <@ref="cnumber">.

# diag matrix
Resultado: 	matriz
Argumento: 	<@var="X">  (matriz)

Retorna a diagonal principal de <@var="X"> em um vetor coluna. Se <@var="X"> for uma matriz de ordem <@itl="m">×<@itl="n"> o número de elementos do vetor resultante será igual a min(<@mth="m">, <@mth="n">). Ver também <@ref="tr">.

# diagcat matrix
Resultado: 	matriz
Argumentos:	<@var="A">  (matriz)
		<@var="B">  (matriz)

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

# diff transforms
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="y">  (série, matriz ou lista)

Calcula a primeira diferença. Se <@var="y"> for uma série ou uma lista de séries, os valores iniciais serão iguais a <@lit="NA">. Se <@var="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 <@lit="d_"><@var="varname">, onde <@var="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 <@ref="cum">, <@ref="ldiff">, <@ref="sdiff">.

# digamma math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna a função digama (ou Psi) de <@var="x"> e consiste na derivada logarítmica da função gama.

# dnorm probdist
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

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

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

Ver também <@ref="cnorm">, <@ref="qnorm">.

# dropcoll transforms
Resultado: 	lista
Argumentos:	<@var="X">  (lista)
		<@var="epsilon">  (escalar, opcional)

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

O algoritmo utiliza a decomposição QR (transformaçã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) <@var="epsilon"> pode ser especificado para tornar o teste de colinearidade mais ou menos estrito, conforme desejado. O valor padrão para <@var="epsilon"> é 1.0e-8. Ajustando <@var="epsilon"> para um maior valor eleva a probabilidade de uma série ser descartada.

Exemplo:

<code>
     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
</code>

produz

<code>
     ? 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
</code>

# dsort matrix
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (série ou vetor)

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

# dummify transforms
Resultado: 	lista
Argumentos:	<@var="x">  (série)
		<@var="omitval">  (escalar, opcional)

O argumento <@var="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 <@var="x"> que deve ser tratado como sendo a categoria omitida. O efeito quando o argumento único for dado é equivalente a utilizar o seguinte comando: <@lit="dummify(x, min(x))">. Para produzir um conjunto completo de dummies, ou seja, sem a categoria omitida, pode-se usar <@lit="dummify(x, NA)">.

As variáveis geradas são automaticamente nomeadas de acordo com o seguinte padrão: <@lit="D"><@var="varname"><@lit="_"><@var="i"> onde <@var="varname"> é o nome da séries original e <@var="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 calendar
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Com o argumento <@var="x"> representando um ano, retorna a data da Páscoa no calendário gregoriano no formato <@mth="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).

<code>
     scalar e = easterday(2014)
     scalar m = floor(e)
     scalar d = 100*(e-m)
</code>

# ecdf stats
Resultado: 	matriz
Argumento: 	<@var="y">  (série ou vetor)

Calcula a função distribuição acumulada (FDA) empírica de <@var="y">. Esta é retornada em uma matriz com duas colunas: a primeira contém os valores únicos e ordenados de <@var="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 de observações.

# eigen linalg
Resultado: 	matriz
Argumentos:	<@var="A">  (matriz quadrada)
		<@var="&V">  (referência a matriz, ou <@lit="null">)
		<@var="&W">  (referência a matriz, ou <@lit="null">)

Calcula os valores próprios e, opcionalmente, os vectores próprios direito e/ou esquerdo, da matriz <@itl="n">×<@itl="n"> <@var="A">, que pode ser real ou complexa. O valores próprios são retornados num vector complexo.

Se você deseja obter o vector próprio direito na forma de matriz complexa, <@itl="n">×<@itl="n">), forneça o nome de uma matriz existente, precedida por <@lit="&"> para indicar o “endereço” da matriz em questão, comom segundo argumento. De outro modo, este argumento pode ser omitido.

Para obter o vector próprio esquerdo (igualmente, na forma de matriz complexa), fornecer o endereço da matrix como terceiro argumento. Note que se pretender os vectores esquerdos mas não os direitos, você deve usar a palavra chave <@lit="null"> como valor para o segundo argumento.

Ver também <@ref="eigensym">, <@ref="eigsolve">, <@ref="svd">.

# eigengen linalg
Resultado: 	matriz
Argumentos:	<@var="A">  (matriz quadrada)
		<@var="&U">  (referência a matriz, ou <@lit="null">)

Calcula os autovalores e, opcionalmente, os autovetores, da matriz <@var="A"> de ordem <@itl="n">×<@itl="n">. Se todos os autovalores forem reais uma matriz <@itl="n">×1 é retornada. Caso contrário, o resultado é uma matriz <@itl="n">×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 <@lit="&"> (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 <@lit="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 <@var="U"> é organizada da seguinte forma:

<indent>
• Se o <@mth="i">-ésimo autovalor for real, a <@mth="i">-ésima coluna de <@mth="U"> irá conter o autovetor correspondente;
</indent>

<indent>
• Se o <@mth="i">-ésimo autovalor for complexo, a <@mth="i">-ésima coluna de <@var="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.
</indent>

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 é <@mth="n">, pois o autovetor conjugado é ignorado.

Ver também <@ref="eigensym">, <@ref="eigsolve">, <@ref="qrdecomp">, <@ref="svd">.

# eigensym linalg
Resultado: 	matriz
Argumentos:	<@var="A">  (matriz simétrica)
		<@var="&U">  (referência a matriz, ou <@lit="null">)

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

Note: se o interesse é na decomposição espectral de uma matriz da forma <@mth="X'X">, onde <@mth="X"> é uma matriz grande, é preferível calculá-la via operador <@lit="X'X"> ao invés de utilizar a sintaxe mais geral <@lit="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 linalg
Resultado: 	matriz
Argumentos:	<@var="A">  (matriz simétrica)
		<@var="B">  (matriz simétrica)
		<@var="&U">  (referência a matriz, ou <@lit="null">)

Resolve o problema do autovalor generalizado |<@mth="A"> – λ<@mth="B">| = 0, onde <@mth="A"> e <@mth="B"> são simétricas e <@mth="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 <@lit="&">. Neste caso os autovetores generalizados serão escritos nesta matriz.

# epochday calendar
Resultado: 	escalar ou série
Argumentos:	<@var="ano">  (escalar ou série)
		<@var="mês">  (escalar ou série)
		<@var="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 padrão os valores do <@var="ano">, <@var="mês"> e <@var="dia"> assumem-se serem relativos ao calendário gregoriano, mas se o ano for um valor negativo a interpretação muda para o calendário juliano.

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

# errmsg programming
Resultado: 	texto
Argumento: 	<@var="errno">  (número inteiro)

Retorna a mensagem de erro do Gretl associada a <@var="errno">. Veja também <@ref="$error">.

# errorif programming
Resultado: 	escalar
Argumentos:	<@var="condição">  (booleano)
		<@var="msg">  (texto)

Aplicável apenas no contexto de uma função cirada pelo utilizador. Se a <@var="condição"> é diferente de zero, termina a execução da função actual, mostrando a razão de erro; o argumento <@var="msg"> é então mostrado no écran como parte da resposta do chamador da função em questão.

O valor de retorno (1) desta função é puramente nominal.

# exists data-utils
Resultado: 	número inteiro
Argumento: 	<@var="name">  (texto)

Retorna um valor não-nulo se <@var="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 <@ref="typeof">.

# exp math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna <@mth="e"><@sup="x">. Note que no caso de matrizes a função é aplicada em cada elemento. Para a função exponencial matricial veja <@ref="mexp">.

# fcstats stats
Resultado: 	matriz
Argumentos:	<@var="y">  (série ou vetor)
		<@var="f">  (série, lista ou matriz)

Produz uma matriz contendo várias estatísticas que podem ser utilizadas para avaliar a série <@var="f">, que consiste na previsão da série observada <@var="y">.

Quando <@var="f"> é uma série ou um vetor/vector, o resultado é um vetor/vector coluna. Quando <@var="f"> é uma lista com <@mth="k"> membros ou uma matriz de ordem <@itl="T">×<@itl="k">, o resultado tem <@mth="k"> colunas, sendo que cada uma contém as estatísticas do elemento correspondente (série ou coluna) do argumento de entrada (série, vetor, lista ou matriz) como uma predição de <@var="y">.

Em todos os casos, a dimensão “vertical” do argumento de entrada (o comprimento da amostra corrente para uma série ou uma lista, e o número de linhas para uma matriz) deve coincidir entre os dois argumentos.

As linhas da matriz retornada são constituídas pelas seguintes estatísticas:

<code>
     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
</code>

Para mais detalhes sobre o cálculo dessas estatísticas e a interpretação dos valores de <@mth="U">, veja o <@pdf="guia de utilização do Gretl#chap:forecast"> (Capítulo 35).

# fdjac numerical
Resultado: 	matriz
Argumentos:	<@var="b">  (vetor coluna)
		<@var="fcall">  (chamada a função)
		<@var="h">  (escalar, opcional)

Calcula uma aproximação numérica para a jacobiana associada ao vetor <@var="b"> de ordem <@mth="n"> e a função de transformação especificada pelo argumento <@var="fcall">. A chamada da função deve ter <@var="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 <@itl="m">×1. Se executada com sucesso, <@lit="fdjac"> retorna uma matriz de ordem <@itl="m">×<@itl="n"> contendo a jacobiana. Exemplo:

Pode-se utilizar o terceiro argumento (opcional) para determinar o tamanho da medida <@mth="h"> que se usa no mecanismo de aproximação (ver mais abaixo). Quando se omite este argumento, o tamanho da medida determina-se automaticamente.

Aqui está um exemplo do seu uso:

<code>
     matrix J = fdjac(theta, myfunc(&theta, X))
</code>

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:

<@mth="J"><@sub="0"> = <@mth="(f(x+h) - f(x))/h">

<@mth="J"><@sub="1"> = <@mth="(f(x+h) - f(x-h))/2h">

<@mth="J"><@sub="2"> = <@mth="[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 <@xrf="set">, ajustando a variável <@lit="fdjac_quality"> em 0, 1 ou 2.

Para mais detalhes e exemplos veja o capítulo sobre métodos numéricos no <@pdf="guia de utilização do Gretl#chap:numerical"> (Capítulo 37).

Ver também <@ref="BFGSmax">, <@ref="numhess">, <@xrf="set">.

# feval programming
Resultado: 	ver abaixo
Argumentos:	<@var="nome-de-função">  (texto)
		... (ver abaixo)

Ferramenta sobretudo destinada a autores de funções. O primeiro argumento é o nome de uma função, e os restantes argumentos devem ser passados para a função em questão. Na práctica a função identificada como <@var="nome-de-função"> é tratada ela mesmo como sendo uma variável. O valor retornado é o que a função retorna de acordo com os argumentos especificados.

O exemplo abaixo mostra alguns usos possíveis:

<code>
     function scalar utility (scalar c, scalar sigma)
     return (c^(1-sigma)-1)/(1-sigma)
     end function

     strings S = defarray("log", "utility")

     # chama uma função interna com um argumento
     x = feval(S[1], 2.5)
     # chama uma função definida pelo utilizador
     x = feval(S[2], 5, 0.5)
     # uma função com dois argumentos
     func = "zeros"
     m = feval(func, 5-2, sqrt(4))
     print m
     # uma função com três argumentos
     x = feval("monthlen", 12, 1980, 5)
</code>

Existe uma analogia entre <@lit="feval"> e <@ref="genseries">: ambas as funções recebem a variaável como elemento sintático que no momento da composição é fixo.

# fevd timeseries
Resultado: 	matriz
Argumentos:	<@var="target">  (número inteiro)
		<@var="shock">  (número inteiro)
		<@var="sys">  (lote, opcional)

Essa função é uma alternativa mais flexível à função de acesso <@ref="$fevd"> para a obtenção da matriz de decomposição da variância do erro de previsão (FEVD) que pode ser obtida após a estimação de um VAR ou VECM. Quando utilizada sem o argumento final, <@var="sys">, está disponível apenas imediatamente após a estimação de um VAR ou VECM. Alternativamente, as informações de uma VAR ou VECM podem ser armazenadas em um pacote via função <@ref="$system"> que, por sua vez, pode ser utilizado como o último argumento da função <@lit="fevd">.

Os argumentos <@var="target"> e <@var="shock"> são índices das variáveis endógenas no sistema, com 0 indicando “todas”. Os seguintes exemplos ilustram sua utilização. No primeiro deles a matriz <@lit="fe1"> armazena as proporções da variância do erro de previsão para <@lit="y1"> causadas por <@lit="y1">, <@lit="y2"> e <@lit="y3"> (as linhas somam 1). No segundo, <@lit="fe2"> armazena as contribuições de <@lit="y2"> para a variância do erro de previsão de todas as três variáveis (logo as linhas não somam 1). No terceiro caso o valor retornado é um vetor coluna contendo a “própria parcela” da variância do erro de previsão de <@lit="y1">.

<code>
     var 4 y1 y2 y3
     bundle vb = $system
     matrix fe1 = fevd(1, 0, vb)
     matrix fe2 = fevd(0, 2, vb)
     matrix fe3 = fevd(1, 1, vb)
</code>

O número de períodos (linhas) ao longo dos quais a decomposição é traçada é determinado automaticamente com base na frequência dos dados, mas isso pode ser ajustado via comando <@xrf="set">, como por exemplo <@lit="set horizon 10">.

Ver também <@ref="irf">.

# fft linalg
Resultado: 	matriz
Argumento: 	<@var="X">  (matriz)

Calcula a transformada de Fourier real discreta. Se a matriz de entrada <@var="X"> tiver <@mth="n"> colunas, a saída terá 2<@mth="n"> 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 <@lit="fft"> em cada vetor de forma separada. Ver também <@ref="ffti">.

# fft2 linalg
Resultado: 	matriz
Argumento: 	<@var="X">  (matriz)

Transfromada discreta de Fourier. A matriz de entrada <@var="X"> pode ser real ou complexa. O resultado é uma matiz complexa de com a mesma dimensão de <@var="X">.

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 <@lit="fft2"> em cada vetor de forma separada. Ver também <@ref="ffti">.

# ffti linalg
Resultado: 	matriz
Argumento: 	<@var="X">  (matriz)

Calcula a inversa da transformada de Fourier real discreta. Assume-se que <@var="X"> contém <@mth="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 2<@mth="n">. Uma matriz com <@mth="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 <@lit="fft"> em cada vetor de forma separada. Ver também <@ref="fft">.

# filter timeseries
Resultado: 	ver abaixo
Argumentos:	<@var="x">  (série ou matriz)
		<@var="a">  (escalar ou vetor, opcional)
		<@var="b">  (escalar ou vetor, opcional)
		<@var="y0">  (escalar, opcional)

Calcula uma filtragem semelhante ao ARMA do argumento <@var="x">. A transformação pode ser escrita como

<@mth="y"><@sub="t"> = <@mth="a"><@sub="0"> <@mth="x"><@sub="t"> + <@mth="a"><@sub="1"> <@mth="x"><@sub="t-1"> + ... <@mth="a"><@sub="q"> <@mth="x"><@sub="t-q"> + <@mth="b"><@sub="1"> <@mth="y"><@sub="t-1"> + ... <@mth="b"><@sub="p"><@mth="y"><@sub="t-p">

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

Os argumentos <@var="a"> e <@var="b"> são opcionais. Eles podem ser escalares, vetores ou a palavra-chave <@lit="null">.

Se <@var="a"> for um escalar, isto é usado como <@mth="a"><@sub="0"> e implica em <@mth="q=0">. Se ele for um vetor com <@mth="q+1"> elementos, eles contêm os coeficientes de <@mth="a"><@sub="0"> a <@mth="a"><@sub="q">. Se <@var="a"> for <@lit="null"> ou for omitido, isso é equivalente a definir <@mth="a"><@sub="0"> <@mth="=1"> e <@mth="q=0">.

Se <@var="b"> for um escalar, isto é usado como <@mth="b"><@sub="1"> e implica em <@mth="p=1">. Se ele for um vetor com <@mth="p"> elementos, eles contêm os coeficientes de <@mth="b"><@sub="1"> a <@mth="b"><@sub="p">. Se <@var="b"> for <@lit="null"> ou for omitido, isso é equivalente a definir <@mth="B(L)=1">.

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

Ver também <@ref="bkfilt">, <@ref="bwfilt">, <@ref="fracdiff">, <@ref="hpfilt">, <@ref="movavg">, <@ref="varsimul">.

Exemplo:

<code>
     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
</code>

produz

<code>
          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
</code>

# firstobs data-utils
Resultado: 	número inteiro
Argumento: 	<@var="y">  (série)

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

# fixname strings
Resultado: 	texto
Argumentos:	<@var="rawname">  (texto)
		<@var="underscore">  (booleano, opcional)

Tem como intuito principal a utilização em conjunto com o comando <@xrf="join">. Retorna o resultado da conversão de <@var="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 caractere anterior for um traço inferior o espaço será omitido.

Se você estiver seguro de que a entrada não é muito extensa (e, dessa forma, não está sujeita a truncagem), você pode querer que um ou mais dos caracteres ilegais sejam substituídos por um traço inferior ao invés de simplesmente deletá-los. Isto pode produzir um identificador mais legível. Para que isso ocorra, forneça um valor diferente de 0 para o segundo argumento (que é opcional). Vale salientar que esse procedimento não é aconselhável quando o comando <@xrf="join"> for utilizado, uma vez que os nomes automaticamente “corrigidos ” não utilizarão o traço inferior.

# flatten data-utils
Resultado: 	ver abaixo
Argumentos:	<@var="A">  (cadeia de matrizes ou texto)
		<@var="alt">  (booleano, opcional)

Compacta um conjunto de matrizes numa única matriz ou conjunto de cadeias de texto numa única cadeia de texto.

No caso matricial, as matrizes contidas em <@var="A"> são, por defeito, concatenadas horizontalmente, mas se um valor diferente de zero for passado como argumento <@var="alt"> a concatenação é vertical. Em ambos os casos será mostrado um erro se as matrizes não forem compatíveis com a operação. Ver <@ref="msplitby"> para a operação inversa.

No caso de cadeia de texto, o resultado são as cadeias de texto em <@var="A">, e arranjadas uma por linha, por defeito. Se e um valor diferente de zero for passado como argumento <@var="alt"> as cadeias de texto são separadas por espaços aon invés de linhas.

# floor math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="y">  (escalar, série ou matriz)

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

# fracdiff timeseries
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="d">  (escalar)

Retorna a diferença fracionária de ordem <@var="d"> para a series <@var="y">.

Note que teoricamente a diferenciação fracionária é um filtro infinitamente longo. Na prática, valores antes da amostra de <@mth="y"><@sub="t"> são assumidos com sendo iguais a zero.

É possível utilizar valores de <@var="d"> negativos. Nesse caso é realizada a integração fracionária.

# fzero numerical
Resultado: 	escalar
Argumentos:	<@var="fcall">  (chamada a função)
		<@var="init">  (escalar ou vetor, opcional)
		<@var="toler">  (escalar, opcional)

Tenta encontrar a raiz unitária de uma função coninua (tipicamente não-linear) <@mth="f">, que é uma variável escalar <@mth="x"> tal que <@mth="f">(<@mth="x">) = 0. O argumento <@var="fcall"> deve chamar a função em causa; <@var="fcall"> pode incluir um número arbitrário de argumentos, mas o primeiro tem que ser um escalar actuando com <@mth="x">. Em caso de sucesso, a função retorna o valor da raiz.

O método utilizado é o de <@bib="Ridders (1979);ridders79">. Isto necessita de um intervalo inicial {<@mth="x"><@sub="0">, <@mth="x"><@sub="1">} tal que ambos os valores pertençam ao domínio da função e as respectivas imagens sejam de sinais opostos. Será mais provável obter melhores resultados, se o utilizador fornecer como segundo argumento, um vector cujos componentes sejam os valores extremos do intervalo. Se não for assim, pode-se fornecer um único valor escalar e <@lit="fzero"> tentará encontrar um intervalo adequado. Se o segundo argumento fôr omitido, <@mth="x"><@sub="0"> é inicializado com um valor positivo pequeno e nós procuramos um valor adequado para <@mth="x"><@sub="1">.

O argumento opcional <@var="toler"> pode ser utilizado para ajustar a diferença máxima aceitável de <@mth="f">(<@mth="x">) de zero, sendo o valor por defeito 1.0e–14.

Por defeito esta função opera silenciosamente, mas o progresso do processo iteractivo pode ser exposto usando o comando “<@lit="set max_verbose on">” antes de chamar <@lit="fzero">.

Seguem-se alguns simples exemplos:

<code>
     # Aproximação de Pi pesquisando um zero da
     # função sin() no intervalo 2.8 a 3.2
     x = fzero(sin(x), {2.8, 3.2})
     printf "\nx = %.12f vs pi = %.12f\n\n", x, $pi

     # Aproximação da 'constante Omega' partindo de x=0.5
     function scalar f(scalar x)
     return log(x) + x
     end function
     x = fzero(f(x), 0.5)
     printf "x = %.12f f(x) = %.15f\n", x, f(x)
</code>

# gammafun math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna a função gama de <@var="x">.

# genseries data-utils
Resultado: 	escalar
Argumentos:	<@var="varname">  (texto)
		<@var="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, <@var="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 <@mth="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:

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

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

# geoplot data-utils
Resultado: 	nada
Argumentos:	<@var="mapfile">  (texto)
		<@var="payload">  (série, opcional)
		<@var="options">  (lote, opcional)

Chama a produção de um mapa, quando existem dados geográficos apropriados. Na maior parte dos casos o argumento <@var="mapfile"> deve ser dado como <@ref="$mapfile">, um acessor que obtém o nome relevante do ficheiro GeoJSON ou do ficheiro de formas ESRI. O argumento opcional <@var="payload"> é usado para fornecer o nome de uma série com a qual se coloriza as regiões do mapa. E o argumento final <@var="options"> como bundle permite você definir inúmeras opções.

Veja a documentação do geoplot, <@adb="geoplot.pdf">, para mais detalhes e exemplos. Aqui se explica todas as configurações por via do argumento <@var="options">.

# getenv programming
Resultado: 	texto
Argumento: 	<@var="s">  (texto)

Se uma variável de ambiente de nome <@var="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 <@ref="ngetenv">.

# getinfo data-utils
Resultado: 	lote
Argumento: 	<@var="y">  (série)

Retorna, na forma de um pacote (bundle) informações sobre a série especificada, o que pode ser feito por meio de seu nome ou de seu número ID. O pacote retornado contém os atributos que podem ser definidos via comando <@xrf="setinfo">. Ele também contém informações relevantes adicionais das séries que tenham sido criadas por meio de transformações nos dados primários (defasagens, logs, etc.): isso inclui o nome do comando do Gretl para a transformação sob código “transform” e o nome da série primária associada sob o código “parent”. Para séries defasadas, o número específico de defasagens pode ser encontrado sob o código “lag”.

Exemplo de utilização:

<code>
     open data9-7
     lags QNC
     bundle b = getinfo(QNC_2)
     print b
</code>

Ao executar o código acima tem-se:

<code>
     has_string_table = 0
     lag = 2
     parent = QNC
     name = QNC_2
     graph_name =
     coded = 0
     discrete = 0
     transform = lags
     description = = QNC(t - 2)
</code>

Para verificar se a série 5 no conjunto de dados é um termo defasado pode-se proceder da seguinte forma:

<code>
     if getinfo(5).lag != 0
        printf "a série 5 é uma defasagem de %s\n", getinfo(5).parent
     endif
</code>

Deve-se ter em mente que a notação ponto (.) para acessar os membros do pacote pode ser utilizada mesmo este seja “anônimo” (ou seja, armazenado sem seu próprio nome).

# getkeys data-utils
Resultado: 	cadeia de texto
Argumento: 	<@var="b">  (lote)

Retorna um vetor de textos contendo os códigos que identificam os conteúdos de <@var="b">. Se o pacote (bundle) estiver vazio é retornado um vetor também vazio.

# getline strings
Resultado: 	escalar
Argumentos:	<@var="source">  (texto)
		<@var="target">  (texto)

Essa função lê sucessivamente as linhas de <@var="source">, que deve ser uma variável de texto (string). A cada chamada uma linha do texto é escrita em <@var="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 <@var="source"> tiverem sido lidas.

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

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

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 <@lit="getline">, sendo que sucessivas chamadas substituirão o conteúdo de <@var="target"> pela nova linha lida. Para reiniciar a leitura a partir da primeira linha de <@var="source "> basta utilizar <@lit="null"> no argumento <@var="target "> (ou apenas deixá-lo em branco). Exemplos:

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

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

# ghk stats
Resultado: 	matriz
Argumentos:	<@var="C">  (matriz)
		<@var="A">  (matriz)
		<@var="B">  (matriz)
		<@var="U">  (matriz)
		<@var="&dP">  (referência a matriz, ou <@lit="null">)

Calcula a aproximação GHK (Geweke, Hajivassiliou, Keane) para a função de distribuição normal multivariada. Veja, por exemplo, <@bib="Geweke (1991);geweke91">. O valor retornado é um vetor de probabilidades de ordem <@itl="n">×1.

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

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

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

<code>
     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)
</code>

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

# gini stats
Resultado: 	escalar
Argumento: 	<@var="y">  (série ou vetor)

Retorna o índice de desigualdade de Gini para a série ou o vetor (não negativos). Um valor de Gini igual a zero indica igualdade perfeita. O valor máximo de Gini para uma série com <@mth="n"> elementos é (<@mth="n"> – 1)/<@mth="n">, ocorrendo quando apenas um membro possui um valor positivo. Um Gini igual a 1,0 é, dessa forma, o limite aproximado por uma grande série com desigualdade máxima <@var="y">.

# ginv linalg
Resultado: 	matriz
Argumento: 	<@var="A">  (matriz)

Retorna <@mth="A"><@sup="+">, a Moore–Penrose ou inversa generalizada de <@var="A">, calculada via decomposição em valores singulares.

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

Ver também <@ref="inv">, <@ref="svd">.

# GSSmax numerical
Resultado: 	escalar
Argumentos:	<@var="&b">  (referência a matriz)
		<@var="f">  (chamada a função)
		<@var="toler">  (escalar, opcional)

Maximização de unidimensional via método Golden Section Search (GSS). A matriz <@var="b"> deve ser um vetor de ordem 3. Na entrada o primeiro elemento é ignorado enquanto que o segundo e o terceiro elementos determinam os limites inferior e superior da busca. O argumento <@var="fncall"> deve especificar a chamada a uma função que retorna o valor da variável a ser maximizada. O elemento 1 de <@var="b">, que irá armazenar o valor corrente do parâmetro ajustável quando a função for chamada, deve ser determinado como seu primeiro argumento. Quaisquer argumentos requeridos podem então ser incluídos em seguida. A função em questão de ser unimodal (ou seja, não deve possuir máximos locais, apenas o máximo global) ao longo da amostra estipulada, caso contrário não se pode garantir que o GSS irá encontrar o máximo.

Ao ser executada com sucesso <@lit="GSSmax"> retorna o valor ótimo da variável a ser maximizada, enquanto <@var="b"> armazena o valor do parâmetro ótimo juntamente dos limites de seu intervalo.

O terceiro argumento, que é opcional, pode ser utilizado para ajustar a convergência, isto é, a largura máxima aceitável do intervalo final do parâmetro. Se esse argumento não for fornecido, será utilizado o valor 0,0001.

Se o objetivo é de fato a minimização, a chamada à função deve retornar o critério com o sinal negativo. Alternativamente, ao invés de se utilizar <@lit="GSSmax"> pode-se utilizar a função <@lit="GSSmin">.

Exemplo de utilização:

<code>
      function scalar trigfunc (scalar theta)
          return 4 * sin(theta) * (1 + cos(theta))
      end function

      matrix m = {0, 0, $pi/2}
      eval GSSmax(&m, trigfunc(m[1]))
      printf "\n%10.7f", m
</code>

# GSSmin numerical
Resultado: 	escalar

É uma forma alternativa da função <@ref="GSSmax">. Se invocada com este nome a função comporta-se como minimizadora.

# halton matrix
Resultado: 	matriz
Argumentos:	<@var="m">  (número inteiro)
		<@var="r">  (número inteiro)
		<@var="offset">  (número inteiro, opcional)

Retorna uma matriz <@itl="m">×<@itl="r"> contendo <@mth="m"> sequências de Halton de comprimento <@mth="r">. O <@mth="m"> é limitado a um máximo de 40. As sequências são construídas utilizando os primeiros <@mth="m"> primos. Por padrão os primeiros 10 elementos de cada sequência são descartados, mas isso pode ser ajustado via argumento opcional <@var="offset">, que deve ser um número inteiro não negativo. Maiores detalhes podem ser encontrados em <@bib="Halton e Smith (1964);halton64">.

# hdprod linalg
Resultado: 	matriz
Argumentos:	<@var="X">  (matriz)
		<@var="Y">  (matriz)

Calcula o produto direto horizontal. Os dois argumentos devem ter o mesmo número de linhas, <@mth="r">. O valor retornado é uma matriz com <@mth="r"> linhas, onde a <@mth="i">-ésima linha corresponde ao produto de Kronecker das linhas correspondentes de <@var="X"> e <@var="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

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

produz a seguinte matriz:

<code>
          0    1    0    2    0    3
         -4    4   -5    5   -6    6
</code>

# hfdiff midas
Resultado: 	lista
Argumentos:	<@var="hfvars">  (lista)
		<@var="multiplier">  (escalar)

Dada uma <@xrf="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 midas
Resultado: 	lista
Argumentos:	<@var="hfvars">  (lista)
		<@var="multiplier">  (escalar)

Dada uma <@xrf="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 midas
Resultado: 	lista
Argumentos:	<@var="minlag">  (número inteiro)
		<@var="maxlag">  (número inteiro)
		<@var="hfvars">  (lista)

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

Note que a defasagem 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 midas
Resultado: 	lista
Argumentos:	<@var="x">  (vetor)
		<@var="m">  (número inteiro)
		<@var="prefix">  (texto)

Produz a partir de um vetor <@var="x"> uma lista MIDAS (<@xrf="MIDAS_list">) de <@var="m"> séries, onde <@var="m"> é a razão entre a frequência das observações para a variável em <@var="x"> em relação a frequência base do conjunto de dados corrente. O valor de <@var="m"> deve ser ao menos 3 e o comprimento de <@var="x"> deve ser <@var="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 <@var="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 timeseries
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="lambda">  (escalar, opcional)
		<@var="one-sided">  (booleano, opcional)

Retorna o componente cíclico do filtro de Hodrick–Prescott aplicado à série <@var="y">. Se o parâmetro de suavização <@var="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, 14400 para dados mensais, etc.).

Por padrão o filtro é a versão bilateral, “two-sided”, mas se o terceiro argumento (opcional) for um valor diferente de zero é computada a versão unilateral, “one-sided”, (de forma não prospectiva) é computada na forma proposta por <@bib="Stock and Watson (1999);stock-watson1999">.

O uso mais comum do filtro HP é a retirada de tendência de séries, mas se o interesse for pela tendência em si, basta utilizar a seguinte expressão:

<code>
     series hptrend = y - hfilt(y)
</code>

Ver também <@ref="bkfilt">, <@ref="bwfilt">.

# hyp2f1 math
Resultado: 	escalar ou matriz
Argumentos:	<@var="a">  (escalar)
		<@var="b">  (escalar)
		<@var="c">  (escalar)
		<@var="x">  (escalar ou matriz)

Retorna a função hipergeométrica de Gauss para o argumento real <@var="x">.

Se <@var="x"> é um escalar, a função retorna um escalar; se não, o resultado será uma matriz com a mesma dimensão que o argumento <@var="x">.

# I matrix
Resultado: 	matriz
Argumento: 	<@var="n">  (número inteiro)

Retorna uma matriz identidade com <@var="n"> linhas e colunas.

# Im complex
Resultado: 	matriz
Argumento: 	<@var="C">  (matriz complexa)

Retorna uma matriz real com a mesma dimensão que <@var="C">, contendo a parte imaginária da matriz de entrada. Ver também <@ref="Re">.

# imaxc stats
Resultado: 	vetor linha
Argumento: 	<@var="X">  (matriz)

Retorna um vetor com os números das linhas onde as colunas de <@var="X"> atingem seus valores máximos.

Ver também <@ref="imaxr">, <@ref="iminc">, <@ref="maxc">.

# imaxr stats
Resultado: 	vetor coluna
Argumento: 	<@var="X">  (matriz)

Retorna um vetor com os números das colunas onde as linhas de <@var="X"> atingem seus valores máximos.

Ver também <@ref="imaxc">, <@ref="iminr">, <@ref="maxr">.

# imhof probdist
Resultado: 	escalar
Argumentos:	<@var="M">  (matriz)
		<@var="x">  (escalar)

Calcula Prob(<@mth="u'Au"> < <@mth="x">) para uma forma quadrática em variáveis normais padrão, <@mth="u">, utilizando o procedimento desenvolvido por <@bib="Imhof (1961);imhof61">.

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

Ver também <@ref="pvalue">.

# iminc stats
Resultado: 	vetor linha
Argumento: 	<@var="X">  (matriz)

Retorna um vetor com os números das linhas onde as colunas de <@var="X"> atingem seus valores mínimos.

Ver também <@ref="iminr">, <@ref="imaxc">, <@ref="minc">.

# iminr stats
Resultado: 	vetor coluna
Argumento: 	<@var="X">  (matriz)

Retorna um vetor com os números das colunas onde as linhas de <@var="X"> atingem seus valores mínimos.

Ver também <@ref="iminc">, <@ref="imaxr">, <@ref="minr">.

# inbundle data-utils
Resultado: 	número inteiro
Argumentos:	<@var="b">  (lote)
		<@var="key">  (texto)

Verifica se um pacote (bundle) <@var="b"> contém um item com o nome <@var="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 <@ref="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 linalg
Resultado: 	escalar
Argumento: 	<@var="X">  (matriz)

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

Ver também <@ref="onenorm">.

# inlist data-utils
Resultado: 	número inteiro
Argumentos:	<@var="L">  (lista)
		<@var="y">  (série)

Retorna a posição de <@var="y"> na lista <@var="L">, ou 0 se <@var="y"> não estiver presente em <@var="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 <@lit="foo">) existe, então é possível chamar essa função da seguinte forma:

<code>
     pos = inlist(L, foo)
</code>

O que a expressão acima está solicitando é: “Informe a posição da série <@lit="foo"> na lista <@lit="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:

<code>
     pos = inlist(L, "foo")
</code>

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

# instring strings
Resultado: 	número inteiro
Argumentos:	<@var="s1">  (texto)
		<@var="s2">  (texto)

Função booleana relacionada à <@ref="strstr">. Retorna 1 se <@var="s1"> contiver <@var="s2">, 0 caso contrário. Assim, a expressão condicional

<code>
      if instring("cattle", "cat")
</code>

é logicamente equivalente a, mas mais eficiente que,

<code>
      if strlen(strstr("cattle", "cat")) > 0
</code>

# instrings strings
Resultado: 	matriz
Argumentos:	<@var="S">  (cadeia de texto)
		<@var="test">  (texto)

Verifica quais os elementos do arranjo de texto em <@var="S"> são iguais a <@var="test">. Retorna um vector de comprimento igual ao número de igualdades, contendo as posições correspondentes dentro do arranjo; ou uma matriz vazia em caso de não haver correspondências.

Exemplo:

<code>
     strings S = defarray("A", "B", "C", "B")
     eval instrings(S, "B")
     2
     4
</code>

# int math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

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

# inv linalg
Resultado: 	matriz
Argumento: 	<@var="A">  (matriz quadrada)

Retorna a inversa de <@var="A">. Se <@var="A"> for singular ou não quadrada, uma mensagem de erro é produzida e nada é retornado. Note que o Gretl confere automaticamente a estrutura de <@var="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 <@var="A"> mais de uma vez. Se o objetivo for apenas calcular uma expressão da forma <@mth="A"><@sup="-1"><@mth="B">, será preferível utilizar os operadores de “divisão” <@lit="\"> e <@lit="/">. Veja <@pdf="guia de utilização do Gretl#chap:matrices"> (Capítulo 17) para detalhes.

Ver também <@ref="ginv">, <@ref="invpd">.

# invcdf probdist
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="d">  (texto)
		<@var="…">  (ver abaixo)
		<@var="p">  (escalar, série ou matriz)

Calculadora da função de distribuição acumulada inversa. Retorna <@mth="x"> tal que <@mth="P(X ≤ x) = p">, onde a distribuição de <@mth="X"> é especificada pela letra <@var="d">. Entre os argumentos <@var="d"> e <@var="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:

<indent>
• Normal padrão (c = z, n ou N): sem argumentos extras
</indent>

<indent>
• Gama (g ou G): forma; escala
</indent>

<indent>
• t de Student (t): graus de liberdade
</indent>

<indent>
• Qui-quadrado (c, x ou X): graus de liberdade
</indent>

<indent>
• F de Snedecor F (f ou F): graus de liberdade (num.); graus de liberdade (den.)
</indent>

<indent>
• Binomial (b ou B): probabilidade; tentativas
</indent>

<indent>
• Poisson (p ou P): média
</indent>

<indent>
• Laplace (l ou L): média; escala
</indent>

<indent>
• GED padronizada (E): forma
</indent>

<indent>
• Qui-quadrado não-central (ncX): graus de liberdade, parâmetro de não-centralidade
</indent>

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

<indent>
• t não-central (nct): graus de liberdade, parâmetro de não-centralidade
</indent>

Ver também <@ref="cdf">, <@ref="critical">, <@ref="pvalue">.

# invmills probdist
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna a razão inversa de Mills em <@var="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 <@var="x">.

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

Ver também <@ref="cdf">, <@ref="cnorm">, <@ref="dnorm">.

# invpd linalg
Resultado: 	matriz quadrada
Argumento: 	<@var="A">  (matriz positiva definida)

Retorna a inversa da matriz simétrica positiva definida <@var="A">. Essa função é ligeiramente mais rápida que <@ref="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 <@mth="X'X">, onde <@mth="X"> é uma matriz grande, é preferível computá-la via operador <@lit="X'X"> ao invés de utilizar a sintaxe mais geral <@lit="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 timeseries
Resultado: 	matriz
Argumentos:	<@var="target">  (número inteiro)
		<@var="shock">  (número inteiro)
		<@var="alpha">  (escalar entre 0 e 1, opcional)
		<@var="sys">  (lote, opcional)

Sem utilizar o argumento <@var="sys">, opcional, essa função está disponível apenas quando o último modelo estimado foi um VAR ou um VECM. Alternativamente, as informações de uma VAR ou VECM podem ser armazenadas em um pacote via função <@ref="$system"> que, por sua vez, pode ser utilizado como o último argumento.

Ela retorna uma matriz contendo as respostas estimadas da variável <@var="target"> a um impulso (choque) de 1 desvio padrão na variável <@var="shock">. Essas variáveis são identificadas de acordo com suas posições na especificação do modelo: por exemplo, se para <@var="target"> e <@var="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 <@var="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 <@var="alpha"> = 0.1 corresponde a 90 por cento de confiança. Se <@var="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 base na frequência dos dados, mas isso pode ser ajustado via comando <@xrf="set">, como por exemplo <@lit="set horizon 10">.

Ver também <@ref="fevd">.

# irr math
Resultado: 	escalar
Argumento: 	<@var="x">  (série ou vetor)

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

# iscomplex data-utils
Resultado: 	escalar
Argumento: 	<@var="nome">  (texto)

Retorna 1 se <@var="nome"> é o nome de uma matriz complexa, 0 se é o nome de uma matriz real, ou <@lit="NA"> se nenhum dos dois.

# isconst data-utils
Resultado: 	número inteiro
Argumentos:	<@var="y">  (série ou vetor)
		<@var="panel-code">  (número inteiro, opcional)

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

O segundo argumento somente é aceito se o conjunto de dados corrente for um painel e <@var="y"> for uma série. Neste caso um valor de <@var="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 <@var="y"> é o mesmo para todos os grupos).

Se <@var="y"> for uma série, valores ausentes são ignorados durante a verificação da constância da série.

# isdiscrete data-utils
Resultado: 	número inteiro
Argumento: 	<@var="name">  (texto)

Se <@var="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 <@var="name"> não identifica uma série a função retorna <@lit="NA">.

# isdummy data-utils
Resultado: 	número inteiro
Argumento: 	<@var="x">  (série ou vetor)

Se todos os valores contidos em <@var="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 data-utils
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar ou matriz)

Dado um escalar como argumento, retorna 1 se <@var="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.

# isoconv calendar
Resultado: 	escalar
Argumentos:	<@var="date">  (série)
		<@var="&year">  (referência a série)
		<@var="&month">  (referência a série)
		<@var="&day">  (referência a série, opcional)

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

<code>
     series y, m, d
     isoconv(dates, &y, &m, &d)
</code>

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

# isocountry strings
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="país">  (texto ou cadeia de texto)
		<@var="tipo">  (número inteiro, opcional)

Esta função produz a correspondência da designação dos países segundo os quatro modos previstos na norma ISO 3166, que são

<indent>
1. Nome do país (em Inglês)
</indent>

<indent>
2. Código Alfa-2 (duas letras maiúsculas)
</indent>

<indent>
3. Código Alfa-3 (três letras maiúsculas)
</indent>

<indent>
4. Código numérico (com três digitos)
</indent>

Partindo de uma das quatro formas, a função retorna o código do país conforme a opção <@var="tipo">, que deve estar entre 1 e 4; se o argumento for omitido, a conversão é como se segue: quando o <@var="país"> é o nome de um país, o valor de retorno é o código Alfa-2; noutro casos, é retornado o nome do país. Adiante mostra-se várias chamadas válidas:

<code>
     ? eval isocountry("Bolivia")
     BO
     ? eval isocountry("Bolivia", 3)
     BOL
     ? eval isocountry("GB")
     United Kingdom of Great Britain and Northern Ireland
     ? eval isocountry("GB", 3)
     GBR
     ? strings S = defarray("ES", "DE", "SD")
     ? strings C = isocountry(S)
     ? print C
     Array of strings, length 3
     [1] "Spain"
     [2] "Germany"
     [3] "Sudan"
     ? matrix m = {4, 840}
     ? C = isocountry(m)
     ? print C
     Array of strings, length 2
     [1] "Afghanistan"
     [2] "United States of America"
</code>

O argumento <@var="país"> na forma 4 (código numérico), pode estar contido numa cadeia de texto ou num arranjo de texto (por exemplo, “032” para a Argentina), ou como uma variável numérica. Neste caso, <@var="país"> pode ser uma série ou um vector, mas a função dará erro se algum dos valores estiver for do intervalo entre 0 e 999.

Em qualquer dos casos (mesmo quando o modo 4 é selecionado) é retornado uma cadeia de texto ou um arranjo de texto; se são necessários valores numéricos, estes podem ser obidos usando a função <@ref="atof">. Se o <@var="país"> não for encontrado na tabela ISO 3166, o valor retornado é uma cadeia de texto vazia e é mostrado um aviso.

# isodate calendar
Resultado: 	ver abaixo
Argumentos:	<@var="ed">  (escalar ou série)
		<@var="as-string">  (booleano, opcional)

O argumento <@var="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 <@var="ed"> — é um número com 8 dígitos, ou uma série composta por tais números, seguindo o padrão <@lit=" YYYYMMDD"> (formato ISO 8601 “básico”), fornecendo a data correspondente no calendário gregoriano ao dia na época.

Se <@var="ed"> for (apenas) um escalar e o segundo argumento opcional <@var="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 <@lit="YYYY-MM-DD"> (padrão ISO 8601 “estendido”).

Para a função inversa veja <@ref="epochday">. Veja também a função <@ref="juldate">.

# isoweek calendar
Resultado: 	ver abaixo
Argumentos:	<@var="ano">  (escalar ou série)
		<@var="mês">  (escalar ou série)
		<@var="dia">  (escalar ou série)

Retorna o número da semana segundo o padrão ISO 8601, correspondente à data especificada nos três argumentos, ou <@lit="NA"> se a data não é válida. Note-se que todos os três argumentos têm que ser do mesmo tipo, sejam escalares (inteiros) ou séries.

As semanas ISO são numeradas de 01 a 53; a maior parte dos anos têm 52, mas em média, em 400 anos, 71 têm 53 semanas. De acordo com a definição ISO 8601, a semana 01 é aquela que contém a primeira quinta-feira do ano, seguindo o calendário Gregoriano. Para mais detalhes, ver <@url="https://en.wikipedia.org/wiki/ISO_week_date">.

# iwishart probdist
Resultado: 	matriz
Argumentos:	<@var="S">  (matriz simétrica)
		<@var="v">  (número inteiro)

Dado <@var="S"> (uma matriz de ordem <@itl="p">×<@itl="p"> positiva definida), retorna um valor extraído da distribuição Inversa de Wishart com <@var="v"> graus de liberdade. A matriz retornada é também uma <@itl="p">×<@itl="p">. O algoritmo de <@bib="Odell e Feiveson (1966);odell-feiveson66"> é utilizado.

# jsonget data-utils
Resultado: 	texto
Argumentos:	<@var="buf">  (texto)
		<@var="path">  (texto)
		<@var="nread">  (referência a escalar, opcional)

O argumento <@var="buf"> deve ser um buffer JSON, que ser obtido de alguma página na internet via função <@ref="curl">, e o argumento <@var="path"> deve ser uma especificação JsonPath.

Esta função retorna uma variável de texto (string) representando os dados encontrados no buffer no path especificado. Dados do tipo double (ponto flutuante), int (inteiro) e string (variável de texto) são suportados. No caso de doubles ou ints, sua representação em forma de texto é retornada (utilizando o locale “C” para os doubles). Se o objeto ao qual o <@var="path"> se refere for um arranjo (array), cada um dos membros será escrito em uma linha diferente na variável de texto retornada.

Por padrão, um erro será sinalizado se o <@var="path"> não possuir uma correspondência no buffer JSON, porém esse comportamento pode ser modificado se o terceiro argumento, opcional, for dado: nesse caso o argumento recupera o número de correspondências e uma variável de texto vazia é retornada caso nenhuma tenha sido encontrada. Por exemplo:

<code>
     ngot = 0
     ret = jsonget(jbuf, "$.some.thing", &ngot)
</code>

Apesar disso, um erro ainda será sinalizado no caso de uma consulta (query) mal formulada.

Para maiores detalhes sobre a sintaxe do JsonPath pode-se consultar o website <@url="http://goessner.net/articles/JsonPath/">. Entretanto, deve-se notar que o back-end para o <@lit="jsonget"> é fornecido pelo <@lit="json-glib"> que, por sua, vez não suporta todos os elementos do JsonPath. Além disso, a funcionalidade exata do <@lit="json-glib"> pode diferir dependendo da versão instalada no sistema. Para maiores detalhes ver: <@url="http://developer.gnome.org/json-glib/">

Dito isto, os seguintes operadores deverão estar disponíveis para <@lit="jsonget">:

<indent>
• root node, via caractere <@lit="$">
</indent>

<indent>
• operador descendente recursivo: <@lit="..">
</indent>

<indent>
• operador curinga/wildcard: <@lit="*">
</indent>

<indent>
• operador subscrito: <@lit="[]">
</indent>

<indent>
• operador de notação de conjunto, por exemplo <@lit="[i,j]">
</indent>

<indent>
• operador de repartição: <@lit="[start:end:step]">
</indent>

# jsongetb data-utils
Resultado: 	lote
Argumentos:	<@var="buf">  (texto)
		<@var="path">  (texto, opcional)

O argumento <@var="buf"> deve ser um buffer JSON que, por sua vez, pode ser obtido de um website apropriado via função <@ref="curl">. A especificação e a utilização do argumento opcional <@var="path">, são descritos abaixo.

O valor retornado pela função é um pacote (bundle) em que a estrutura basicamente emula a da entrada: objetos JSON se tornam pacotes (bundles) do Gretl e arrays JASON se tornam arranjos (arrays) do Gretl, com cada um armazenando tanto textos (strings) quanto pacotes (bundles). Nós de “valor” JSON se tornam ou membros de pacotes ou elementos de arranjos. No último caso, valores numéricos são convertidos em texto via função <@lit="sprintf">. Note que uma vez que arranjos do Gretl não podem ser aninhados, a entrada aceita por essa função é um pouco mais restritiva que a especificação JSON, que permite aninhamento de arrays.

O argumento opcional <@var="path"> pode ser utilizado para limitar os elementos JSON incluídos no bundle retornado. Note que isto não é um “JsonPath” conforme descrito na ajuda da função <@ref="jsonget">. É uma simples construção sujeita às seguintes especificações:

<indent>
• <@var="path"> é um array de elemento separados por barras, onde as barras (“/”) indicam a movimentação em um nível mais “profundo” na árvore JSON representada por <@var="buf">. Uma barra no início é permitida, mas não é necessária. Implicitamente o path sempre tem início na raiz. Não devem ser incluídos espaços em branco
</indent>

<indent>
• Cada elemento separado por barras deve assumir uma das seguintes formas: (a) um nome único, de forma que apenas um elemento JSON cujo nome coincide com um dado nível estrutural será incluído; ou (b) “*” (asterisco), de forma que todos os elementos de um dado nível são incluídos; ou (c) um array de nomes separados por vírgulas, delimitados por colchetes (“{” e “}”), de forma que apenas os elementos JSON cujos nomes coincidam com algum dos nomes dados serão incluídos.
</indent>

Veja também a função orientada à textos <@ref="jsonget">. A depender de seu objetivo uma dessas funções pode ser mais útil que a outra.

# juldate calendar
Resultado: 	ver abaixo
Argumentos:	<@var="ed">  (escalar ou série)
		<@var="as-string">  (booleano, opcional)

O argumento <@var="ed"> é interpretado como um dia de época que é igual a 1 no primeiro dia de janeiro do ano 1 depois de Cristo no calendário gregoriano proléptico. O valor de retorno padrão—do mesmo tipo de <@var="ed"> —é um número de 8 dígitos, ou uma série de tais números, seguindo o padrão <@lit="YYYYMMDD"> (formato ISO 8601 “básico”), fornecendo a data correspondente ao dia de época no calendário juliano.

Se <@var="ed"> for (apenas) um escalar e o segundo parâmetro <@var="as-string"> (que é opcional) for não-nulo, o valor retornado não será numérico e sim um texto (string) seguindo o padrão <@lit="YYYY-MM-DD"> (formato ISO 8601 “estendido”).

Veja também <@ref="isodate">.

# kdensity nonparam
Resultado: 	matriz
Argumentos:	<@var="x">  (série ou vetor)
		<@var="scale">  (escalar, opcional)
		<@var="control">  (booleano, opcional)

Calcula a estimativa de densidade pelo método do núcleo (kernel) para a série ou vetor <@var="x">. A matriz retornada tem duas colunas, com a primeira contendo um conjunto abscissas uniformemente espaçadas e a segunda a densidade estimada em cada um desses pontos.

O parâmetro opcional <@var="scale"> pode ser utilizado para ajustar o grau de suavização em relação ao valor padrão 1.0 (maiores valores geram resultados mais suavizados). O parâmetro <@var="control"> age como um booleano: 0 (que é o padrão) implica na utilização do núcleo gaussiano, enquanto que um valor não-nulo implica na utilização do núcleo de Epanechnikov.

Um gráfico dos resultados pode ser obtido via comando <@xrf="gnuplot">, como por exemplo:

<code>
     matrix d = kdensity(x)
     gnuplot 2 1 --matrix=d --with-lines --fit=none
</code>

# kdsmooth sspace
Resultado: 	escalar
Argumentos:	<@var="&Mod">  (referência a lote)
		<@var="MSE">  (booleano, opcional)

Realiza a suavização dos distúrbios para um pacote (bundle) de Kalman previamente definido via função <@ref="ksetup"> e retorna 0 caso a execução tenha sucesso ou 1 se se forem encontrados problemas numéricos.

Se a operação for completada com sucesso os distúrbios suavizados estarão disponíveis como <@lit="Mod.smdist">.

O argumento opcional <@var="MSE"> determina os conteúdos de <@lit="Mod.smdisterr">. Se for omitido ou for igual a 0, essa matriz irá conter os erros padrão não-condicionais dos distúrbios suavizados que, por sua vez, normalmente, são utilizados para calcular os chamados <@itl="resíduos auxiliares">. Caso contrário, <@lit="Mod.smdisterr"> irá conter a raiz do erro quadrado médio estimado dos resíduos auxiliares em relação aos seus valores verdadeiros.

Para maiores detalhes veja <@pdf="guia de utilização do Gretl#chap:kalman"> (Capítulo 36).

Ver também <@ref="ksetup">, <@ref="kfilter">, <@ref="ksmooth">, <@ref="ksimul">.

# kfilter sspace
Resultado: 	escalar
Argumento: 	<@var="&Mod">  (referência a lote)

Realiza a filtragem em um pacote (bundle) de Kalman previamente definido via <@ref="ksetup"> e retorna 0 caso a execução tenha sucesso ou 1 se forem encontrados problemas numéricos.

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

Para maiores detalhes veja <@pdf="guia de utilização do Gretl#chap:kalman"> (Capítulo 36).

Ver também <@ref="kdsmooth">, <@ref="ksetup">, <@ref="ksmooth">, <@ref="ksimul">.

# kmeier nonparam
Resultado: 	matriz
Argumentos:	<@var="d">  (série ou vetor)
		<@var="cens">  (série ou vetor, opcional)

Dada uma amostra de dados de duração, <@var="d">, possivelmente acompanhada por um registro de status de censura, <@var="cens">, calcula o estimador não-paramétrico de Kaplan–Meier da função de sobrevivência (<@bib="Kaplan e Meier, 1958;kaplan-meier">). A matriz retornada possui três colunas contendo, respectivamente, os valores únicos de <@var="d"> de forma ordenada, a função de sobrevivência estimada correspondente ao valor de duração na coluna 1 e o (elevado) erro padrão do estimador, calculado via método de <@bib="Greenwood (1926);greenwood26">.

Se a série <@var="cens"> for dada, um valor 0 serve para indicar uma observação não-censurada, enquanto que um valor 1 indica uma observação censurada à direita (isto é, o período de observação do indivíduo em questão terminou antes que a duração ou o período tenham sido registrados como finalizados). Se <@var="cens"> não for dado é assumido que todas as observações são não-censuradas. Observação: a interpretação de <@var="cens"> pode ser estendida em algum momento de forma a cobrir outros tipos de censura.

Ver também <@ref="naalen">.

# kpsscrit stats
Resultado: 	matriz
Argumentos:	<@var="T">  (escalar)
		<@var="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 <@var="T"> deve fornecer o número de observações e o argumento <@var="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 <@bib="Sephton (Economics Letters,1995);sephton95">. Veja também o comando <@xrf="kpss">.

# ksetup sspace
Resultado: 	lote
Argumentos:	<@var="Y">  (série, matriz ou lista)
		<@var="H">  (escalar ou matriz)
		<@var="F">  (escalar ou matriz)
		<@var="Q">  (escalar ou matriz)
		<@var="C">  (matriz, opcional)

Especifica um pacote (bundle) de Kalman, isto é, um objeto que contém todas as informações necessárias para se definir um modelo linear de espaço de estados na forma

  <@fig="kalman1">

e com a equação de transição de estados

  <@fig="kalman2">

onde Var<@mth="(u) = Q">.

Objetos criados através dessa função podem ser posteriormente utilizados via funções dedicadas <@ref="kfilter"> para filtragem, <@ref="ksmooth"> e <@ref="kdsmooth"> para suavização e <@ref="ksimul"> para realizar simulações.

A amplitude de classes de modelos que o Gretl pode manusear é, de fato, bem mais abrangente que o implicado pela representação acima: é possível a estimação de modelos com parâmetros variando no tempo, com prioris difusas, com variáveis exógenas na equação de medida e modelos com resíduos interrelacionados. Para maiores detalhes veja <@pdf="guia de utilização do Gretl#chap:kalman"> (Capítulo 36).

Ver também <@ref="kdsmooth">, <@ref="kfilter">, <@ref="ksmooth">, <@ref="ksimul">.

# ksimul sspace
Resultado: 	escalar
Argumento: 	<@var="&Mod">  (referência a lote)

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

Para maiores detalhes veja <@pdf="guia de utilização do Gretl#chap:kalman"> (Capítulo 36).

Ver também <@ref="ksetup">, <@ref="kfilter">, <@ref="ksmooth">.

# ksmooth sspace
Resultado: 	matriz
Argumento: 	<@var="&Mod">  (referência a lote)

Realiza uma suavização de ponto fixo em um pacote (bundle) de Kalman previamente definido via função <@ref="ksetup"> e retorna 0 caso a operação tenha sido realizada com sucesso ou 1 se surgirem problemas numéricos.

Em caso de sucesso, os estados suavizados estarão disponíveis como <@lit="Mod.state"> e a sequência de suas matrizes de covariância como <@lit="Mod.stvar">. Para maiores detalhes veja <@pdf="guia de utilização do Gretl#chap:kalman"> (Capítulo 36).

Ver também <@ref="ksetup">, <@ref="kdsmooth">, <@ref="kfilter">, <@ref="ksimul">.

# kurtosis stats
Resultado: 	escalar
Argumento: 	<@var="x">  (série)

Retorna o excesso de curtose da série <@var="x">, descartando quaisquer observações ausentes.

# lags transforms
Resultado: 	lista ou matriz
Argumentos:	<@var="p">  (escalar ou vetor)
		<@var="y">  (série, lista ou matriz)
		<@var="bylag">  (booleano, opcional)

Se o primeiro argumento for um escalar, gera as defasagens de 1 até <@var="p"> da série <@var="y">, se <@var="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 <@var=" p"> = 0 e <@var="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 <@var="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 <@var="p"> como, por exemplo, <@lit="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 <@lit="{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 <@var="varname"><@lit="_"><@var="i">, onde <@var="varname"> é o nome da série original e <@var="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 <@var="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 pela funçã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 <@var="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 <@ref="mlag"> para o uso com matrizes.

# lastobs data-utils
Resultado: 	número inteiro
Argumento: 	<@var="y">  (série)

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

# ldet linalg
Resultado: 	escalar
Argumento: 	<@var="A">  (matriz quadrada)

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

# ldiff transforms
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="y">  (série ou lista)

Calcula as diferenças logarítmicas. Os valores iniciais são considerados como <@lit="NA">.

Quando uma lista for retornada, as variáveis individuais são automaticamente nomeadas de acordo com o esquema <@lit="ld_"><@var="varname">, onde <@var="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 <@ref="diff">, <@ref="sdiff">.

# lincomb transforms
Resultado: 	série
Argumentos:	<@var="L">  (lista)
		<@var="b">  (vetor)

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

Ver também <@ref="wmean">.

# linearize transforms
Resultado: 	série
Argumento: 	<@var="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 identificadas pelo TRAMO), a função retornará uma cópia da série original.

# ljungbox stats
Resultado: 	escalar
Argumentos:	<@var="y">  (série)
		<@var="p">  (número inteiro)

Calcula a estatística Q de Ljung–Box para a série <@var="y">, utilizando a ordem de defasagem <@var="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 <@var="p"> graus de liberdade para verificar a hipótese nula de que a série <@var=" y"> não é serialmente correlacionada. Ver também <@ref="pvalue">.

# lngamma math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna o log da função gama de <@var="x">.

# loess nonparam
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="x">  (série)
		<@var="d">  (número inteiro, opcional)
		<@var="q">  (escalar, opcional)
		<@var="robust">  (booleano, opcional)

Realiza a regressão polinomial localmente ponderada (LOESS) e retorna uma série contendo os valores previstos de <@var="y "> para cada valor não-ausente de <@var="x">. O método utilizado é o descrito por <@bib=" Cleveland (1979);cleveland79">.

Os argumentos opcionais <@var="d"> e <@var="q "> especificam, respectivamente, a ordem do polinômio em <@var="x"> e a proporção dos pontos de dados a ser utilizada na estimação local. Por padrão os valores são <@var=" d"> = 1 e <@var="q"> = 0,5. Os outros valores aceitáveis para <@var="d"> são 0 e 2. Definir <@var=" d"> = 0 reduz a regressão local para a forma de uma média móvel. O valor de <@var="q"> deve ser maior que 0 e não pode exceder 1. Valores maiores produzem saídas mais suaves.

Se um valor não-nulo for dado ao argumento <@var="robust "> as regressões locais serão iteradas duas vezes, com os pesos sendo modificados com base nos resíduos da iteração prévia de forma a reduzir a influência das observações aberrantes (“ outliers”).

Veja também <@ref="nadarwat"> e, para maiores detalhes sobre métodos não-paramétricos, veja <@pdf="guia de utilização do Gretl#chap:nonparam"> (Capítulo 40).

# log math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série, matriz ou lista)

Retorna o logaritmo natural de <@var="x">. Gera <@lit="NA"> para valores não-positivos. Note que <@lit="ln"> é um pseudônimo aceitável para <@lit="log">.

Quando uma lista for retornada, as variáveis individuais serão automaticamente nomeadas de acordo com o modelo <@lit="l_"><@var="varname">, onde <@var="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 math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna o logaritmo na base 10 de <@var="x">. A função irá gerar <@lit="NA"> para valores não-positivos.

# log2 math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna o logaritmo na base 2 de <@var="x">. A função irá gerar <@lit="NA"> para valores não-positivos.

# logistic math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna a função logística do argumento <@var="x">, isto é, <@mth="e"><@sup="x">/(1 + <@mth="e"><@sup="x">). Se <@var="x"> for ma matriz, a função será aplicada em cada elemento.

# lower matrix
Resultado: 	matriz quadrada
Argumento: 	<@var="A">  (matriz)

Retorna uma matriz triangular inferior de ordem <@itl="n">×<@itl="n">. Os elementos da diagonal e abaixo desta são iguais aos elementos correspondentes de <@var="A"> e os demais iguais a zero.

Ver também <@ref="upper">.

# lrcovar timeseries
Resultado: 	matriz
Argumentos:	<@var="A">  (matriz)
		<@var="demean">  (booleano, opcional)

Retorna a matriz de variância-covariância de longo prazo das colunas de <@var="A">. Em primeiro lugar é retirada a média dos dados, a menos que o segundo argumento (que é opcional) seja igual a zero. O tipo de kernel/núcleo e o parâmetro de truncagem de defasagem (tamanho da janela) pode ser escolhido antes que a função seja chamada com as opções relacionadas ao HAC, que são oferecidas pelo comando <@xrf="set">, tais como <@lit="hac_kernel">, <@lit="hac_lag">, <@lit="hac_prewhiten">. Veja também a seção sobre dados de séries de tempo e matrizes de covariância no <@pdf="guia de utilização do Gretl#chap:robust_vcv"> (Capítulo 22).

Ver também <@ref="lrvar">.

# lrvar timeseries
Resultado: 	escalar
Argumentos:	<@var="y">  (série ou vetor)
		<@var="k">  (número inteiro)

Retorna a variância de longo prazo de <@var="y">, calculada utilizando um núcleo de Bartlett com tamanho de janela igual a <@var="k">. Se o segundo argumento for omitido, ou for um valor menor que zero, o tamanho da janela toma como padrão a parte inteira da raiz cúbica do tamanho da amostra.

Ver a função <@ref="lrcovar"> para o caso multivariado.

Per l'equivalente multivariato, si veda <@ref="lrcovar">.

# Lsolve linalg
Resultado: 	matriz
Argumentos:	<@var="L">  (matriz)
		<@var="b">  (matriz)

Resolve a equação <@mth="Ax = b"> para cada <@mth="x">, onde <@var="L"> é o factor de Cholesky (triangular baixa) da matriz definida positiva <@mth="A">, satisfazendo <@mth="LL' = A">. A matriz <@var="L"> pode ser obtida usando a função <@ref="cholesky"> com a matriz <@mth="A"> como argumento.

Os dois seguintes cálculos deve dar resultados iguais (excepto devido à precisão da máquina). mas a primeira variante baseada em <@lit="Lsolve"> permite reutilizar um factor de Cholesky já calculado e assim optimizar o tempo de cálculo para uma dada matriz <@mth="A"> e vários valores de <@mth="b">. A melhoria de velocidade será tanto maior quanto maior a dimensão das colunas de <@mth="A">.

<code>
     # variante 1
     matrix L = cholesky(A)
     matrix x = Lsolve(L, b)
     # variante 2
     matrix x = A \ b
</code>

# max stats
Resultado: 	escalar ou série
Argumento: 	<@var="y">  (série ou lista)

Se o argumento <@var="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 <@ref="min">, <@ref="xmax">, <@ref="xmin">.

# maxc stats
Resultado: 	vetor linha
Argumento: 	<@var="X">  (matriz)

Retorna um vetor com os valores máximos das colunas de <@var="X">.

Ver também <@ref="imaxc">, <@ref="maxr">, <@ref="minc">.

# maxr stats
Resultado: 	vetor coluna
Argumento: 	<@var="X">  (matriz)

Retorna um vetor com os valores máximos das linhas <@var="X">.

Ver também <@ref="imaxr">, <@ref="maxc">, <@ref="minr">.

# mcorr stats
Resultado: 	matriz
Argumento: 	<@var="X">  (matriz)

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

# mcov stats
Resultado: 	matriz
Argumento: 	<@var="X">  (matriz)

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

# mcovg stats
Resultado: 	matriz
Argumentos:	<@var="X">  (matriz)
		<@var="u">  (vetor, opcional)
		<@var="w">  (vetor, opcional)
		<@var="p">  (número inteiro)

Retorna uma matriz covariograma para uma matriz <@var=" X"> de ordem <@itl="T">×<@itl="k"> (normalmente contendo regressores), um vetor <@var="u"> (opcional) com <@mth="T"> elementos (normalmente contendo resíduos), um vetor de pesos <@var="w"> (opcional) com <@mth=" p">+1 elementos e uma ordem de defasagem <@var=" p">, que deve ser maior ou igual a 0.

A matriz retornada é o somatório com <@mth="j"> indo de <@mth="-p"> até <@mth="p"> de <@mth="w(|j|) * X(t)X(t-j)' * u(t)u(t-j)">, onde <@mth="X(t)'"> é a <@mth="t">-ésima linha de <@var="X">.

Se <@var="u"> for <@lit="null"> os termos <@mth="u"> são omitidos, e se <@var="w"> for <@lit="null"> todos os pesos são considerados como sendo iguais a 1,0.

Por exemplo, o seguinte código

<code>
     set seed 123
     X    = mnormal(6,2)
     Lag  = mlag(X,1)
     Lead = mlag(X,-1)
     print X Lag Lead
     eval X'X
     eval mcovg(X, , , 0)
     eval X'(X + Lag + Lead)
     eval mcovg(X, , , 1)
</code>

produz estes resultados:

<code>
     ? print X Lag Lead
     X (6 x 2)

       -0.76587      -1.0600
       -0.43188      0.30687
       -0.82656      0.40681
        0.39246      0.75479
        0.36875       2.5498
        0.28855     -0.55251

     Lag (6 x 2)

         0.0000       0.0000
       -0.76587      -1.0600
       -0.43188      0.30687
       -0.82656      0.40681
        0.39246      0.75479
        0.36875       2.5498

     Lead (6 x 2)

       -0.43188      0.30687
       -0.82656      0.40681
        0.39246      0.75479
        0.36875       2.5498
        0.28855     -0.55251
         0.0000       0.0000

     ? eval X'X
         1.8295       1.4201
         1.4201       8.7596

     ? eval mcovg(X,,, 0)
         1.8295       1.4201
         1.4201       8.7596

     ? eval X'(X + Lag + Lead)
         3.0585       2.5603
         2.5603       10.004

     ? eval mcovg(X,,, 1)
         3.0585       2.5603
         2.5603       10.004
</code>

# mean stats
Resultado: 	escalar ou série
Argumento: 	<@var="x">  (série ou lista)

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

Se <@var="x"> for uma lista a função retorna uma série <@mth="y"> tal que <@mth="y"><@sub="t"> é a média dos valores das variáveis da lista na observação <@mth="t">, ou <@lit="NA"> se existir algum valor ausente em <@mth="t">.

# meanc stats
Resultado: 	vetor linha
Argumento: 	<@var="X">  (matriz)

Retorna um vetor com as médias das colunas de <@var="X">. Ver também <@ref="meanr">, <@ref="sumc">, <@ref="sdc">.

# meanr stats
Resultado: 	vetor coluna
Argumento: 	<@var="X">  (matriz)

Retorna um vetor com as médias das linhas de <@var="X">. Ver também <@ref="meanc">, <@ref="sumr">.

# median stats
Resultado: 	escalar ou série
Argumento: 	<@var="x">  (série ou lista)

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

Se <@var="x"> for uma lista, a função retorna uma séries <@mth="y"> tal que <@mth="y"><@sub="t"> é a mediana dos valores das variáveis da lista na observação <@mth="t">, ou <@lit="NA"> se existir algum valor ausente em <@mth="t">.

# mexp linalg
Resultado: 	matriz quadrada
Argumento: 	<@var="A">  (matriz quadrada)

Calcula a matriz exponencial de <@var="A"> utilizando o algoritmo 11.3.1 de <@bib="Golub e Van Loan (1996);golub96">.

# mgradient midas
Resultado: 	matriz
Argumentos:	<@var="p">  (número inteiro)
		<@var="theta">  (vetor)
		<@var="type">  (número inteiro ou texto)

Derivadas analíticas para os pesos MIDAS. Seja <@mth="k "> o número de elementos no vetor de hiper-parâmetros, <@var="theta">. Esta função retorna uma matriz de ordem <@itl="p">×<@itl="k"> contendo o gradiente do vetor de pesos (conforme calculado por <@ref="mweights">) em relação aos elemento de <@var="theta">. O primeiro argumento representa a ordem de defasagem desejada e o último argumento especifica o tipo de parametrização. Veja <@lit=" mweights"> para uma explicação sobre os valores aceitáveis de <@var="type">.

Ver também <@ref="mweights">, <@ref="mlincomb">.

# min stats
Resultado: 	escalar ou série
Argumento: 	<@var="y">  (série ou lista)

Se o argumento <@var="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 <@ref="max">, <@ref="xmax">, <@ref="xmin">.

# minc stats
Resultado: 	vetor linha
Argumento: 	<@var="X">  (matriz)

Retorna um vetor com os valores mínimos das colunas de <@var="X">.

Ver também <@ref="iminc">, <@ref="maxc">, <@ref="minr">.

# minr stats
Resultado: 	vetor coluna
Argumento: 	<@var="X">  (matriz)

Retorna um vetor com os valores mínimos das linhas de <@var="X">.

Ver também <@ref="iminr">, <@ref="maxr">, <@ref="minc">.

# missing data-utils
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou lista)

Retorna uma variável binária igual a 1 se <@var="x"> for <@lit="NA"> e 0, caso contrário. Se <@var="x"> for uma série, a comparação é feita em cada um de seus elementos. Se <@var="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 <@lit="NA"> e 0, caso contrário.

Ver também <@ref="misszero">, <@ref="ok">, <@ref="zeromiss">.

# misszero data-utils
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar ou série)

Converte <@lit="NA">s em zeros. Se <@var="x"> for uma série a conversão será feita elemento por elemento. Ver também <@ref="missing">, <@ref="ok">, <@ref="zeromiss">.

# mlag matrix
Resultado: 	matriz
Argumentos:	<@var="X">  (matriz)
		<@var="p">  (escalar ou vetor)
		<@var="m">  (escalar, opcional)

Desloca para cima ou para baixo as linhas de <@var="X ">. Se <@var="p"> for um número positivo, retorna uma matriz na qual as colunas de <@var="X"> são deslocadas <@var="p"> linhas para baixo e as primeiras <@var="p"> linhas são preenchidas com o valor <@var="m">. Se <@var="p"> for um número negativo, <@var="X"> é deslocado para cima e as últimas linhas são preenchidas com o valor <@var="m ">. Se <@var="m"> não for fornecido, será considerado como sendo igual a zero.

Se <@var="p"> for um vetor, a operação acima é realizada para cada elemento em <@var="p">, combinando as matrizes resultantes horizontalmente.

Veja também <@ref="lags">.

# mlincomb midas
Resultado: 	série
Argumentos:	<@var="hfvars">  (lista)
		<@var="theta">  (vetor)
		<@var="type">  (número inteiro ou texto)

É uma função MIDAS de conveniência, combinando <@ref="lincomb"> com <@ref="mweights">. Dada uma lista <@var="hfvars">, a função calcula uma série que é uma soma ponderada dos elementos da lista, com os pesos baseados no vetor de hiper-parâmetros <@var="theta"> e o tipo de parametrização. Veja <@lit="mweights"> para maiores detalhes. Note que <@ref="hflags"> é, geralmente, a melhor forma de criar uma lista que pode ser adequadamente utilizada como primeiro argumento desta função.

De forma mais explícita, a chamada

<code>
     series s = mlincomb(hfvars, theta, 2)
</code>

é equivalente a

<code>
     matrix w = mweights(nelem(hfvars), theta, 2)
     series s = lincomb(hfvars, w)
</code>

A vantagem é que a utilização de <@lit="mlincomb"> é mais concisa e eficiente em termos de processamento.

# mlog linalg
Resultado: 	matriz quadrada
Argumento: 	<@var="A">  (matriz quadrada)

Calcula o logarimo matricial de <@var="A">. O algoritmo utilizado baseia-se na decomposição espectral, que necessita que <@var="A"> seja diagonizável. Ver taambé <@ref="mexp">.

# mnormal matrix
Resultado: 	matriz
Argumentos:	<@var="r">  (número inteiro)
		<@var="c">  (número inteiro)

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

# mols stats
Resultado: 	matriz
Argumentos:	<@var="Y">  (matriz)
		<@var="X">  (matriz)
		<@var="&U">  (referência a matriz, ou <@lit="null">)
		<@var="&V">  (referência a matriz, ou <@lit="null">)

Retorna uma matriz de ordem <@itl="k">×<@itl="n"> com os parâmetros obtidos da regressão MQO da matriz <@var="Y"> de ordem <@itl="T">×<@itl="n"> contra a matriz <@var="X"> de ordem <@itl="T">×<@itl="k">.

Se o terceiro argumento for diferente de <@lit="null">, a matriz <@var="U"> de ordem <@itl="T">×<@itl="n"> irá conter os resíduos. Se o último argumento for dado e for diferente de <@lit="null"> a matriz <@var="V"> de ordem <@itl="k">×<@itl="k"> irá conter (a) a matriz de covariância das estimativas dos parâmetros, se <@var="Y"> tiver apenas uma coluna, ou (b) <@mth="X'X"><@sup="-1"> se <@var="Y"> tiver múltiplas colunas.

Por padrão, estimativas são obtidas via decomposição de Cholesky. Caso as colunas de <@var="X"> apresentem elevada colinearidade é utilizada a decomposição QR. A utilização de SVD pode ser forçada via comando <@lit="set svd on">.

Ver também <@ref="mpols">, <@ref="mrls">.

# monthlen calendar
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="mês">  (número inteiro)
		<@var="ano">  (número inteiro)
		<@var="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 <@var="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 timeseries
Resultado: 	série
Argumentos:	<@var="x">  (série)
		<@var="p">  (escalar)
		<@var="control">  (número inteiro, opcional)
		<@var="y0">  (escalar, opcional)

Dependendo do valor do parâmetro <@var="p">, retorna a média móvel simples ou exponencialmente ponderada da série <@var="x">.

Se <@var="p"> > 1, é calculada a média móvel (MM/MA) simples de ordem <@var="p">, isto é, a média aritmética de <@mth="x"> do período <@mth="t"> até <@mth="t-p+1">. Se for escolhido um valor diferente de zero para o argumento opcional <@var="control"> é calculada a média móvel centrada, caso contrário é calculada a média móvel simples. Nesse caso, o argumento opcional <@var=" y0"> é ignorado.

Se <@var="p"> for uma fração positiva, é calculada a média móvel exponencial:

<@mth="y(t) = p*x(t) + (1-p)*y(t-1)">

Por padrão, a série de saída, <@mth="y">, é inicializada utilizando o primeiro valor de <@var="x">, mas o argumento <@var="control"> pode ser utilizado para especificar o número inicial de observações cuja média deve ser utilizada para produzir <@mth="y(0)">. Um valor zero para <@var="control"> indica que todas as observações devem ser utilizadas. Alternativamente, um valor de inicialização pode ser especificado utilizando o argumento opcional <@var="y0">. Nesse caso o argumento <@var="control "> é ignorado.

# mpiallred mpi
Resultado: 	número inteiro
Argumentos:	<@var="&object">  (referência ao objeto)
		<@var="op">  (texto)

Apenas disponível se gretl foi compilado com suporte MPI, e o programa foi iniciado em modo MPI (ver em <@mnu="gretlMPI">). Deve ser chamada por todos os processos. Esta função funciona como <@ref="mpireduce"> excepto que todos os processos, e não apenas o processo raiz, recebem uma cópia do objecto “reduzido” em lugar do original. É assim, equivalente a <@lit="mpireduce"> seguida de uma chamada a <@ref="mpibcast">, mas mais eficiente.

# mpibarrier mpi
Resultado: 	número inteiro

Apenas disponível se gretl foi compilado com suporte MPI, e o programa foi iniciado em modo MPI (ver em <@mnu="gretlMPI">). Não usa argumentos. Força a sincronização dos processos MPI: nenhum processo pode ultrapassar a barreira até que todos a tenham atingido.

<code>
     # nenhum passa deste ponto, até que todos o tenham atingido
     mpibarrier()
</code>

# mpibcast mpi
Resultado: 	número inteiro
Argumentos:	<@var="&objecto">  (referência ao objeto)
		<@var="raiz">  (número inteiro, opcional)

Apenas disponível se gretl foi compilado com suporte MPI, e o programa foi iniciado em modo MPI (ver em <@mnu="gretlMPI">). Deve ser chamada por todos os processos. Transmite o argumento <@var="objecto">, que deve ser dado na forma de ponteiro, a todos os processos. O objecto em questão deve ser uma matriz, um bundle, escalar, vector, texto ou lista, e ter seido declarado em todos os processos antes da trasnmissão. Nenhum processo poderá prosseguir para além da chamada a <@lit="mpibcast"> até que todos os processos a tenham executado com sucesso.

Por defeito a “raiz”, é a origem da transmissão, é o processo com o índice 0, mas isto pode ser modificado por via do segundo argumento (opcional), o qual deve ser um inteiro entre 0 e o número de processos MPI menos 1.

De seguida mostra-se um simples exemplo. Se a função completar com sucesso, todos os processos terão uma cópia da matriz <@lit="X"> definida no processo de índice 0.

<code>
     matrix X
     if $mpirank == 0
     X = mnormal(T, k)
     endif
     mpibcast(&X)
</code>

# mpirecv mpi
Resultado: 	objeto
Argumento: 	<@var="origem">  (número inteiro)

Apenas disponível se gretl foi compilado com suporte MPI, e o programa foi iniciado em modo MPI (ver em <@mnu="gretlMPI">). Para uma explicação, ver <@ref="mpisend">, que emparelha com <@lit="mpirecv"> e que tem ques estar sempre acoplada. O argumento <@var="origem"> especifica o índice do processo de onde deve ser recebido o objecto, dentro do intervalo inteiro entre 0 e o número de processos MPI menos 1.

# mpireduce mpi
Resultado: 	número inteiro
Argumentos:	<@var="&objecto">  (referência ao objeto)
		<@var="op">  (texto)
		<@var="raiz">  (número inteiro, opcional)

Apenas disponível se gretl foi compilado com suporte MPI, e o programa foi iniciado em modo MPI (ver em <@mnu="gretlMPI">). Deve ser chamada por todos os processos. Esta função recolhe objectos funzione (apenas escalares ou matrizes) e matrici) com nome específico, dado na forma de ponteiro, de todos os processo e “reduz”-los a um único objecto no nó raiz.

O argomunto <@lit="op"> específica a operação ou método de redução. Os métodos suportados para escalares são <@lit="sum">, <@lit="prod"> (produto), <@lit="max"> e <@lit="min">. Para matrizes os métodoa são <@lit="sum">, <@lit="prod"> (produto de Hadamard), <@lit="hcat"> (concatenação horizontal) e <@lit="vcat"> (concatenação vertical).

Por defeito, a “raiz”, a destinatária da redução é o processo MPI com índice 0, mas isto pode ser modificado por via do segundo argumento (opcional), o qual deve ser um inteiro entre 0 e o número de processos MPI menos 1.

De seguida mostra-se um exemplo. Se a função completar com sucesso, o processo raiz terá uma matriz <@lit="X"> que é a soma das matrizes <@lit="X"> de todos os processos.

<code>
     matrix X
     X = mnormal(T, k)
     mpireduce(&X, sum)
</code>

# mpiscatter mpi
Resultado: 	número inteiro
Argumentos:	<@var="&M">  (referência a matriz)
		<@var="op">  (texto)
		<@var="raiz">  (número inteiro, opcional)

Apenas disponível se gretl foi compilado com suporte MPI, e o programa foi iniciado em modo MPI (ver em <@mnu="gretlMPI">). Deve ser chamada por todos os processos. Esta função distribui partes de uma matriz no processo raiz por todos os processos. A matriz deve ter sido declarada em todos os processos, antes da chamada de <@lit="mpiscatter">, e deve ser dada na forma de ponteiro.

O argumento <@lit="op"> deve ser <@lit="byrows"> ou <@lit="bycols">. Seja <@mth="q"> o quociente entre o número de linhas da matriz a dividir pelo número de processos. No caso <@lit="byrows"> a raiz envia as primeiras <@mth="q"> linhas para o processo 0, as seguintes <@mth="q"> para o processo 1, e assim sucessivamente. Existe um resto na divisão, as linhas remanescentes são atribuídas ao último segmento. O caso <@lit="bycols"> é semelhante, mas a matriz é dividida por colunas.

Segue-se uma exemplo. Se existem 4 processos, todos (incluíndo o processo raiz) receberá uma parte 2500×10 do original <@lit="X"> como existia no processo raiz. Se você pretender preservar a matriz inteira no processo raiz, terá que fazer uma cópia dela antes de chamar. <@lit="mpiscatter">.

<code>
     matrix X
     if $mpirank == 0
     X = mnormal(10000, 10)
     endif
     mpiscatter(&X, byrows)
</code>

# mpisend mpi
Resultado: 	número inteiro
Argumentos:	<@var="objecto">  (objeto)
		<@var="destino">  (número inteiro)

Apenas disponível se gretl foi compilado com suporte MPI, e o programa foi iniciado em modo MPI (ver em <@mnu="gretlMPI">). Envia o objecto designado (que deve ser uma matriz, bundle, vector, escalar, texto ou lista) do processo corrente para aquele identificado pelo inteiro <@var="destino"> (de 0 a número de processos MPI menos 1).

A chamada desta função deve estar sempre emparelhada com uma chamada a <@ref="mpirecv"> no processo <@var="destino">, como no exemplo seguinte que envia uma matriz do índice 2 para o índice 3.

<code>
     if $mpirank == 2
     matrix C = cholesky(A)
     mpisend(C, 3)
     elif $mpirank == 3
     matrix C = mpirecv(2)
     endif
</code>

# mpols stats
Resultado: 	matriz
Argumentos:	<@var="Y">  (matriz)
		<@var="X">  (matriz)
		<@var="&U">  (referência a matriz, ou <@lit="null">)

Funciona de forma semelhante à função <@ref="mols">. A diferença é que os cálculos são realizados com precisão múltipla utilizando a biblioteca GMP.

Por padrão, a biblioteca GMP utiliza 256 bits para cada número de ponto flutuante. Isso pode ser ajustado via variável de ambiente <@lit="GRETL_MP_BITS">, por exemplo, <@lit="GRETL_MP_BITS=1024">.

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

Funciona da mesma forma que <@ref="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 <@lit="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×20 com valores extraídos da distribuição <@mth="t"> com 14 graus de liberdade.

Ver também <@ref="mnormal">, <@ref="muniform">.

# mread data-utils
Resultado: 	matriz
Argumentos:	<@var="fname">  (texto)
		<@var="import">  (booleano, opcional)

Lê uma matriz armazenada no arquivo chamado <@var="fname ">. Isto destina-se principalmente para ler arquivos com um format específico como descrito adiante, mas também pode ser usado em arquivos genéricos de texto delimitados. Neste último caso, ver a seção intitulada “Arquivos de texto delimitados” abaixo.

Se o arquivo possuir a extensão “<@lit=".gz ">” é assumido que ele foi comprimido no formato gzip, se tiver a extensão “<@lit=".bin">” é assumido que o arquivo está em formato binário (veja <@ref="mwrite"> para detalhes). Caso contrário, se o arquivo tiver a extensão “<@lit=".mat">” assume-se que é um arquivo de texto simples, seguindo as seguintes especificações:

<indent>
• O arquivo pode começar com qualquer qualquer quantidade de comentários, definidos por linhas iniciadas com o caractere <@lit="#">. Essas linhas serão ignoradas.
</indent>

<indent>
• 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.
</indent>

<indent>
• As colunas devem estar separadas por espaços ou por tabulações.
</indent>

<indent>
• O separador decimal deve ser o ponto (“<@lit=".">”).
</indent>

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 <@xrf="workdir">. Entretanto, se o segundo argumento da função, <@var="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 <@xrf="foreign">. Nesse caso o argumento <@var="fname"> deve ser um nome simples, sem que se especique o caminho para o arquivo.

<@itl="Arquivos de texto delimitados">

Se o arquivo possuir a extensão “<@lit=".csv">” as regras que regulam o formato do arquivo são diferentes, e mais relaxadas. Neste caso os dados concretos, <@itl="não"> devem ser antecedidos por uma linha com o número de linhas e colunas. Gretl tentará determinar o qual o delimitador (vírgula, ponto e vírgula ou espaço) e fazer o seu melhor para importar a matriz, permitindo o uso da vírgula como separador decimal se necessário. Note que o delimitador não deve ser uma tabulação, sob pena de criar confusão com os arquivos de formato matriz “nativos” do gretl.

Ver também <@ref="bread">, <@ref="mwrite">.

# mreverse matrix
Resultado: 	matriz
Argumentos:	<@var="X">  (matriz)
		<@var="bycol">  (booleano, opcional)

Retorna uma matriz contendo as linhas de <@var="X"> em ordem reversa. Para obter uma matriz contendo as colunas em ordem reversa pode-se utilizar um valor não-nulo como segundo argumento.

# mrls stats
Resultado: 	matriz
Argumentos:	<@var="Y">  (matriz)
		<@var="X">  (matriz)
		<@var="R">  (matriz)
		<@var="q">  (vetor coluna)
		<@var="&U">  (referência a matriz, ou <@lit="null">)
		<@var="&V">  (referência a matriz, ou <@lit="null">)

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

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

# mshape matrix
Resultado: 	matriz
Argumentos:	<@var="X">  (matriz)
		<@var="r">  (número inteiro)
		<@var="c">  (número inteiro)

Rearranja os elementos de <@var="X"> em uma matriz com <@var="r"> linhas e <@var="c"> colunas. Os elementos de <@var="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 <@var="X"> tiver menos que <@mth="k"> = <@mth="rc"> elementos, estes são repetidos de forma cíclica. Caso contrário, se <@var="X"> tiver mais elementos, apenas os primeiros <@mth="k"> elementos serão utilizados.

Ver também <@ref="cols">, <@ref="rows">, <@ref="unvech">, <@ref="vec">, <@ref="vech">.

# msortby matrix
Resultado: 	matriz
Argumentos:	<@var="X">  (matriz)
		<@var="j">  (número inteiro)

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

# msplitby matrix
Resultado: 	cadeia de matrizes
Argumentos:	<@var="X">  (matriz)
		<@var="v">  (vetor)

Retorna um arranjo de matrizes, o resultado de dividir verticalmente <@var="X"> segundo o controlo do vector <@var="v">. Este vector deve ser de comprimento igual ao número de linhas do argumento <@var="X">, e deverá conter valores inteiros com um mínimo de 1 e um máximo igual ao número de matrizes no arranjo desejado. Cada elemento de <@var="v"> indica o índice vectorial da matriz que corresponde à linha de <@var="X"> que deverá ser atríbuída.

No seguinte exemplo, divide-se uma matriz 3×3 em três matrizes: as primeiras duas linhas são atribuídas à primeira matriz; as segunda matriz fica vazia; e a terceira matriz recebe a linha 3 de <@var="X">.

<code>
     matrix X = {1,2,3; 4,5,6; 7,8,9}
     matrices M = msplitby(X, {1,1,3})
     print M
</code>

A saída mostra:

<code>
     Vetor ("array") de matrizes, comprimento 3
     [1] 2 x 3
     [2] null
     [3] 1 x 3
</code>

Ver <@ref="flatten"> para a operação inversa.

# muniform matrix
Resultado: 	matriz
Argumentos:	<@var="r">  (número inteiro)
		<@var="c">  (número inteiro)

Retorna uma matriz com <@var="r"> linhas e <@var="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 <@ref="randgen1">.

Ver também <@ref="mnormal">, <@ref="uniform">.

# mweights midas
Resultado: 	matriz
Argumentos:	<@var="p">  (número inteiro)
		<@var="theta">  (vetor)
		<@var="type">  (número inteiro ou texto)

Retorna um vetor de ordem <@mth="p"> de pesos MIDAS a serem aplicados nas <@mth="p"> defasagens de uma série de alta frequência, com base no vetor de hiper-parâmetros <@var="theta">.

O argumento <@var="type"> identifica o tipo de parametrização, a qual determina o número de elementos necessários, <@mth="k">, em <@var="theta">: 1 = exponencial normalizado de Almon (<@mth="k"> ao menos 1, tipicamente 2); 2 = beta normalizado com última defasagem nula (<@mth="k"> = 2); 3 = beta normalizado com última defasagem não-nula (<@mth="k"> = 3); e 4 = polinômio de Almon (<@mth="k"> ao menos 1). Note que no caso do beta normalizado os primeiros dois elementos de <@var="theta"> devem ser positivos.

O <@var="type"> pode ser fornecido como sem um código inteiro, como mostrado acima, ou por um dos seguintes textos (respectivamente): <@lit="nealmon">, <@lit="beta0">, <@lit="betan">, <@lit="almonp">. Se for utilizado texto, ele deve ser escrito com aspas duplas. Por exemplo, as duas expressões abaixo são equivalentes:

<code>
     W = mweights(8, theta, 2)
     W = mweights(8, theta, "beta0")
</code>

Ver também <@ref="mgradient">, <@ref="mlincomb">.

# mwrite data-utils
Resultado: 	número inteiro
Argumentos:	<@var="X">  (matriz)
		<@var="fname">  (texto)
		<@var="export">  (booleano, opcional)

Salva a matriz <@var="X"> em um arquivo especificado por <@var="fname">. Por padrão este arquivo será um arquivo de texto simples. A primeira linha terá dois números inteiros, separados por um caractere de tabulação (tab), representando o número de linhas e colunas. Nas linhas seguintes estarão os elementos da matriz, em notação científica, separados por tabulações (uma linha da matriz em cada linha do arquivo). Veja a seguir os formatos alternativos.

Se já existir um arquivo com o nome <@var="fname"> ele será sobrescrito. O valor a ser retornado pela função é 0 em caso de sucesso. Se ocorrer um erro na escrita, que pode ocorrer, por exemplo, se o arquivo estiver bloqueado, o valor de retorno será diferente de 0.

O arquivo de saída será salvo no <@xrf="workdir"> selecionado, a menos que no argumento <@var="filename"> seja escrito o caminho completo. Entretanto, se o argumento <@var="export"> for diferente de 0, o arquivo será salvo no diretório do usuário, ou seja, no diretório “@dotdir”, onde é acessado por padrão pelas funções que manipulam matrizes no contexto do comando <@xrf="foreign">. Nesse caso, um nome simples, sem a inclusão do caminho para o arquivo, deve ser usado como segundo argumento.

Matrizes armazenadas via função <@lit="mwrite"> na sua forma padrão podem ser facilmente lidas por outros programas. Para maiores detalhes veja <@pdf="guia de utilização do Gretl#chap:matrices"> (Capítulo 17).

Duas variantes, mutuamente exclusivas, estão disponíveis para esta função:

<indent>
• Se o nome dado para o arquivo, <@var="fname">, terminar com “<@lit=".gz">” então ele será armazenado com compressão gzip.
</indent>

<indent>
• Se <@var="fname"> terminar com “<@lit=".bin"> ” então o arquivo será armazenado no formato binário. Neste caso os primeiros 19 bytes contêm os caracteres <@lit=" gretl_binary_matrix">, os 8 bytes seguintes contêm dois inteiros de 32 bit, fornecendo o número de linhas e colunas da matriz, e o restante do arquivo contém os elementos da matriz como “doubles”, com extremidade do tipo little-endian, orientado a coluna (column-major). Se o Gretl for executado em um sistema com extremidade do tipo big-endian, os valores binários são convertidos para little-endian na escrita e convertidos para big-endian na leitura.
</indent>

Note que se o armazenamento da matriz em um arquivo for para seu uso em outros programas não é aconselhável utilizar as variantes gzip ou binária. Mas se o intuito for a posterior leitura pelo próprio Gretl, esses formatos alternativos economizam espaço em disco e, no caso do armazenamento no formato binário, torna a leitura de grandes matrizes bem mais rápida. O formato gzip não é recomendado para matrizes muito grandes, uma vez que a descompressão desses arquivos é bastante lenta.

Ver também <@ref="mread">.

# mxtab stats
Resultado: 	matriz
Argumentos:	<@var="x">  (série ou vetor)
		<@var="y">  (série ou vetor)

Retorna uma matriz contendo a tabulação cruzada dos valores contidos em <@var="x"> (por linha) e <@var="y "> (por coluna). Os dois argumentos devem ser do mesmo tipo (ambos séries ou ambos vetores) e, devido à forma que essa função é comumente utilizada, assume-se que contêm apenas valores inteiros.

Ver também <@ref="values">.

# naalen nonparam
Resultado: 	matriz
Argumentos:	<@var="d">  (série ou vetor)
		<@var="cens">  (série ou vetor, opcional)

Dada uma amostra de dados de duração, <@var="d">, possivelmente acompanhada por um registro de status de censura, <@var="cens">, calcula o estimador não-paramétrico de Nelson–Aalen da função de risco (<@bib="Nelson, 1972;nelson72">; <@bib="Aalen, 1978;aalen78">). A matriz retornada possui três colunas contendo, respectivamente, os valores únicos de <@var="d"> de forma ordenada, a função de risco acumulada estimada correspondendo ao valor de duração na coluna 1 e o erro padrão do estimador.

Se a série <@var="cens"> for dada, um valor 0 serve para indicar uma observação não-censurada, enquanto que um valor 1 indica uma observação censurada à direita (isto é, o período de observação do indivíduo em questão terminou antes que a duração ou o período tenham sido registrados como finalizados). Se <@var="cens"> não for dado é assumido que todas as observações são não-censuradas. Observação: a interpretação de <@var="cens"> pode ser estendida em algum momento de forma a cobrir outros tipos de censura.

Ver também <@ref="kmeier">.

# nadarwat nonparam
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="x">  (série)
		<@var="h">  (escalar)

Estimador não paramétrico de Nadaraya–Watson da média condicional de <@var="y"> dado <@var="x">. Retorna uma série contendo a estimativa não-paramétrica de <@mth="E(y"><@sub=" i"><@mth="|x"><@sub="i"><@mth=")"> para cada valor não ausente da série <@var="x">.

A função núcleo (ou função kernel) <@mth="K"> é dada por <@mth="K = exp(-x"><@sup="2"><@mth=" / 2h)"> para <@mth="|x| < T"> e, caso contrário, zero.

O argumento <@var="h">, conhecido como largura de banda (bandwidth), é um número real positivo escolhido pelo usuário. Normalmente este é um número pequeno: maiores valores de <@var="h "> tornam <@mth="m(x)"> mais suave. Uma escolha comumente utilizada é definir <@var="h"> como sendo proporcional a <@mth="n"><@sup="-0.2">. Mais detalhes podem ser encontrados no <@pdf="guia de utilização do Gretl#chap:nonparam"> (Capítulo 40).

O escalar <@mth="T"> é utilizado para prevenir problemas numéricos quando a função núcleo é avaliada em um ponto muito distante de zero e é chamado de parâmetro de truncagem.

O parâmetro de truncagem pode ser alterado através do ajuste de <@lit="nadarwat_trim">, como um múltiplo de <@var="h ">. O valor padrão é 4.

O usuário pode fornecer valores negativos para a largura de banda: esta é interpretada como sintaxe convencional para obter o estimador leave-one-out. Este é uma variante do estimador que não usa a <@mth="i">-ésima observação para avaliar <@mth="m(x"><@sub="i"><@mth=")">. Isso faz com que o estimador de Nadaraya–Watson seja mais numericamente robusto e sua utilização é normalmente aconselhada quando o estimador é calculado com o propósito de realizar inferências. Vale salientar que a largura de banda utilizada é, na verdade, o valor absoluto de <@var="h">.

# nelem data-utils
Resultado: 	número inteiro
Argumento: 	<@var="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 programming
Resultado: 	escalar
Argumento: 	<@var="s">  (texto)

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

# nlines strings
Resultado: 	escalar
Argumento: 	<@var="buf">  (texto)

Retorna a quantidade de linhas completas (isto é, linhas que terminam com um caractere de nova linha) em <@var="buf">.

Exemplo:

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

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

Realiza a maximização numérica via método simplex sem derivadas de Nelder–Mead. O argumento <@var="b"> deve conter os valores iniciais de um conjunto de parâmetros e o argumento <@var="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 for completada com sucesso, <@lit="NMmax"> retorna o valor maximizado do critério e <@var="b"> armazena os valores dos parâmetros que maximizam a função.

O terceiro argumento, opcional, pode ser utilizado para determinar o número máximo de avaliações da função. Se for omitido ou for igual a zero o máximo de avaliações será, por padrão, igual a 2000. O valor do argumento <@var="maxfeval"> pode ser especificado como um número negativo. Neste caso é tomado o valor absoluto e a função <@lit="NMmax"> sinaliza um erro se o melhor valor encontrado para a função objetivo, respeitando o número máximo de avaliações de funções, não for um ótimo local. Caso contrário a falta de convergência neste sentido não é tratada como um erro.

Se de fato o objetivo for a minimização, a função pode retornar o valor negativo do critério. Alternativamente pode-se utilizar a função <@lit="NMmax"> através de sua forma alternativa <@lit=" NMmin">.

Para maiores detalhes e exemplos <@pdf="guia de utilização do Gretl#chap:numerical"> (Capítulo 37). Ver também <@ref="simann">.

# NMmin numerical
Resultado: 	escalar

É uma forma alternativa da função <@ref="NMmax">. Se invocada com este nome a função comporta-se como minimizadora.

# nobs stats
Resultado: 	número inteiro
Argumento: 	<@var="y">  (série)

Retorna o número de observações não ausentes para a variável <@var="y"> na amostra corrente selecionada.

# normal probdist
Resultado: 	série
Argumentos:	<@var="μ">  (escalar)
		<@var="σ">  (escalar)

Cria uma série de números gaussianos pseudo-aleatórios com média μ e desvio padrão σ. Se não forem fornecidos argumentos, será produzida uma série padrão normalizada <@mth="N">(0,1). Os valores são calculados utilizando o método Ziggurat <@bib="(Marsaglia e Tsang, 2000);marsaglia00">.

Ver também <@ref="randgen">, <@ref="mnormal">, <@ref="muniform">.

# normtest stats
Resultado: 	matriz
Argumentos:	<@var="y">  (série ou vetor)
		<@var="method">  (texto, opcional)

Realiza um teste de normalidade em <@var="y">. Por padrão é utilizado o teste de Doornik–Hansen, mas é possível escolher outros métodos via argumento opcional <@var="method">. Os testes disponíveis são: <@lit="swilk"> para o teste de Shapiro–Wilk, <@lit=" jbera"> para o teste de Jarque–Bera, ou <@lit="lillie "> para o de teste Lilliefors.

O segundo argumento pode ser fornecido com ou sem aspas. Porém, quando o argumento estiver na forma de uma variável de texto (string), o valor dessa variável é substituído. Os seguintes exemplos mostram três formas aceitáveis de se realizar o teste de Shapiro–Wilk:

<code>
     matrix nt = normtest(y, swilk)
     matrix nt = normtest(y, "swilk")
     string testtype = "swilk"
     matrix nt = normtest(y, testtype)
</code>

A matriz retornada tem ordem 1×2 e armazena a estatística de teste e seu p-valor. Veja também o comando <@xrf="normtest">.

# npcorr stats
Resultado: 	matriz
Argumentos:	<@var="x">  (série ou vetor)
		<@var="y">  (série ou vetor)
		<@var="method">  (texto, opcional)

Calcula uma medida de correlação entre <@var="x"> e <@var="y"> utilizando um método não-paramétrico. Se for dado, o terceiro argumento deve ser <@lit="kendall"> (para a versão b do tau de Kendall, sendo este o método padrão) ou <@lit="spearman"> (para o rô de Spearman).

O valor de retorno é um vetor de ordem 3 contendo a medida de correlação, a estatística de teste e o p-valor para a hipótese nula de não-autocorrelação. Note que se o tamanho da amostra for muito pequeno a estatística de teste e/ou p-valor podem <@lit="NaN"> (ou seja, não é um número ou é ausente).

Veja também <@ref="corr"> para a correlação de Pearson.

# npv math
Resultado: 	escalar
Argumentos:	<@var="x">  (série ou vetor)
		<@var="r">  (escalar)

Retorna o Valor Presente Líquido (VPL ou NPV) de <@var="x ">, considerado como sendo uma sequência de pagamentos (negativos) e recebimentos (positivos), avaliada à taxa de desconto anual <@var="r">, que deve ser expressa como uma fração decimal e não como uma porcentagem (ou seja, 0.05 ao invés de 5<@lit="%">). O primeiro valor é considerado como sendo o “agora” e não é descontado. Para emular a função <@lit="npv"> na qual o primeiro valor é descontado, basta inserir um zero no início da sequência.

A função pode ser utilizada com dados anuais, trimestrais, mensais e sem data (neste último caso, os dados são tratados como sendo anuais).

Ver também <@ref="irr">.

# NRmax numerical
Resultado: 	escalar
Argumentos:	<@var="&b">  (referência a matriz)
		<@var="f">  (chamada a função)
		<@var="g">  (chamada a função, opcional)
		<@var="h">  (chamada a função, opcional)

Realiza a maximização numérica via método de Newton–Raphson. O argumento <@var="b"> deve conter os valores iniciais de um conjunto de parâmetros e o argumento <@var="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, <@lit="NRmax"> retorna o valor maximizado do critério e <@var="b"> armazena os valores dos parâmetros que maximizam a função.

O terceiro e o quarto argumento, opcionais, estabelecem uma maneira de fornecer derivadas analíticas e uma hessiana (negativa) analítica, respectivamente. As funções representadas por <@var="g"> e <@var="h"> devem ter como seus primeiros argumentos uma matriz pré-definida que tenha o tamanho adequado para armazenar o gradiente ou hessiana, respectivamente, dado na forma de ponteiro. Elas também precisam ter o vetor de parâmetros como um argumento (na forma de ponteiro ou não). Outros argumentos são opcionais. Se alguns dos parâmetros opcionais forem omitidos, é utilizada uma aproximação numérica.

Para maiores detalhes e exemplos veja <@pdf="guia de utilização do Gretl#chap:numerical"> (Capítulo 37). Ver também <@ref="BFGSmax">, <@ref="fdjac">.

# NRmin numerical
Resultado: 	escalar

É uma forma alternativa da função <@ref="NRmax">. Se invocada com este nome a função comporta-se como minimizadora.

# nullspace linalg
Resultado: 	matriz
Argumento: 	<@var="A">  (matriz)

Calcula o espaço nulo direito de <@var="A">, via decomposição em valores singulares: o resultado é uma matriz <@mth="B"> tal que o produto <@mth="AB"> é uma matriz nula, exceto quando <@var="A"> tem posto completo, nesse caso uma matriz vazia é retornada. Caso contrário, se <@var="A"> é uma matriz <@itl="m">×<@itl="n">, <@mth="B"> terá dimensão <@mth="n"> por (<@mth="n"> – <@mth="r">), onde <@mth="r"> é o posto de <@var="A">.

Se <@var="A"> não tiver posto completo a concatenação vertical de <@var="A"> com a transposta de <@var="B"> produz uma matriz de posto completo.

Exemplo:

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

      print A B C

      eval A*B
      eval rank(C)
</code>

O exemplo acima produz:

<code>
      ? 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
</code>

Ver também <@ref="rank">, <@ref="svd">.

# numhess numerical
Resultado: 	matriz
Argumentos:	<@var="b">  (vetor coluna)
		<@var="fcall">  (chamada a função)
		<@var="d">  (escalar, opcional)

Calcula uma aproximação numérica para a hessiana associada ao vetor <@var="b"> de ordem <@mth="n"> e à função objetivo especificada pelo argumento <@var="fcall">. A chamada à função deve ter <@var="b"> como primeiro argumento (de forma direta ou na forma de ponteiro), seguido de quaisquer argumentos adicionais que possam ser necessários. A função retorna um escalar como resultado. Se executada com sucesso, <@lit="numhess"> retorna uma matriz de ordem <@itl="n">×<@itl="n"> contendo a hessiana que, por sua vez, é simétrica por construção.

O método utilizado é a extrapolação de Richardson, com quatro passos. O terceiro argumento, opcional, pode ser utilizado para ajustar a fração <@mth="d"> do valor do parâmetro utilizado no ajuste do tamanho do passo inicial. Se este argumento for omitido, será utilizado <@mth="d"> = 0,01 como padrão.

Exemplo::

<code>
     matrix H = numhess(theta, myfunc(&theta, X))
</code>

Ver também <@ref="BFGSmax">, <@ref="fdjac">.

# obs data-utils
Resultado: 	série

Retorna uma série de números inteiros consecutivos começando em 1 no início do conjunto de dados. Note que esse resultado não é afetado por subamostragem. Essa função é especialmente útil com conjunto de dados de séries temporais. Você também pode escrever <@lit="t"> ao invés de <@lit="obs"> para obter a série.

Ver também <@ref="obsnum">.

# obslabel data-utils
Resultado: 	texto
Argumento: 	<@var="t">  (número inteiro)

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

# obsnum data-utils
Resultado: 	número inteiro
Argumento: 	<@var="s">  (texto)

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

<code>
     open denmark
     k = obsnum(1980:1)
</code>

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

Ver também <@ref="obs">, <@ref="obslabel">.

# ok data-utils
Resultado: 	ver abaixo
Argumento: 	<@var="x">  (escalar, série, matriz ou lista)

Se <@var="x"> for um escalar, retorna 1 se <@var="x "> não for <@lit="NA">, caso contrário 0. Se <@var="x "> for uma série, retorna uma série com valor 1 nas observações sem valores ausentes e 0 onde houver valores ausentes. Se <@var="x"> for uma lista, a saída da função é uma série com 0 nas observações onde ao menos uma das séries na lista tenha valor ausente, caso contrário retorna 1.

Se <@var="x"> for uma matriz o comportamento da função é um pouco diferente, uma vez que matrizes não podem conter <@lit=" NA">'s. Assim, nesse caso, a função retorna uma matriz com as mesmas dimensões que <@var="x">, com 1's nas posições com elementos finitos de <@var="x"> and 0's nas posições onde os elementos são não-finitos (podendo ser números infinitos ou NaN, conforme padrão IEEE 754).

Ver também <@ref="missing">, <@ref="misszero">, <@ref="zeromiss">. Mas note que essas funções não são aplicáveis no caso de matrizes.

# onenorm linalg
Resultado: 	escalar
Argumento: 	<@var="X">  (matriz)

Retorna a norma-1 da matriz <@var="X">, isto é, a máxima soma dos valores absolutos dos elementos de cada coluna de <@var="X">.

Ver também <@ref="infnorm">, <@ref="rcond">.

# ones matrix
Resultado: 	matriz
Argumentos:	<@var="r">  (número inteiro)
		<@var="c">  (número inteiro)

Retorna uma matriz com <@mth="r"> linhas e <@mth="c"> colunas preenchida com valores iguais a 1.

Ver também <@ref="seq">, <@ref="zeros">.

# orthdev panel
Resultado: 	série
Argumento: 	<@var="y">  (série)

Aplicável apenas quando o conjunto de dados atualmente aberto é composto por dados em painel. Calcula os desvios ortogonais anteriores (ou seja, o desvio entre <@mth="t"> e <@mth="t+1">) da variável <@var="y ">.

Esta transformação é realizada algumas vezes ao invés da diferenciação para remover efeitos individuais do dado em painel. Para fins de compatibilidade com a primeira diferença, os desvios são armazenados um paso à frente em relação à sua verdadeira localização temporal (isto é, o valor na observação <@mth="t"> é o desvio que, estritamente falando, pertence ao tempo <@mth="t"> –1). Assim, perde-se a primeira observação em cada série de tempo, e não a última.

Ver também <@ref="diff">.

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

Calculadora de função densidade de probabilidade. Retorna a densidade em <@var="x"> da distribuição identificada pelo código <@var="d">. Veja <@ref="cdf"> para detalhes acerca dos argumentos (escalares) requeridos. As distribuições suportadas pela função <@lit="pdf"> são: normal, <@mth="t"> de Student, qui-quadrado, <@mth="F">, Gama, Exponencial, Weibull, Laplace, 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 <@mth="t"> de Student, qui-quadrado e <@mth="F"> também estão disponíveis as suas variantes não-centrais.

Para a distribuição normal veja também <@ref="dnorm">.

# pergm timeseries
Resultado: 	matriz
Argumentos:	<@var="x">  (série ou vetor)
		<@var="bandwidth">  (escalar, opcional)

Se apenas o primeiro argumento for dado, calcula o periodograma da amostra para dada variável ou vetor. Se o segundo argumento for dado, calcula uma estimativa do espectro de <@var="x"> utilizando janela de defasagem de Bartlett para a largura de banda dada, até o número de observações (<@mth="T">/2).

Retorna uma matriz com duas colunas e <@mth="T">/2 linhas: a primeira coluna contendo a frequência, ω, de 2π/<@mth="T"> até π e a segunda contendo a densidade espectral correspondente.

# pexpand panel
Resultado: 	série
Argumento: 	<@var="v">  (vetor)

É aplicável somente se o conjunto de dados corrente tiver uma estrutura de painel. Realiza a operação inversa de <@ref="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 <@mth="T"> vezes, onde <@mth="T"> representa o comprimento temporal do painel. A série resultante é dessa forma não variante em relação ao tempo.

# pmax panel
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="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 <@var="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 <@var="mask"> for igual a zero são ignoradas.

Ver também <@ref="pmin">, <@ref="pmean">, <@ref="pnobs">, <@ref="psd">, <@ref="pxsum">, <@ref="pshrink">, <@ref="psum">.

# pmean panel
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="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 <@var="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 <@var="mask"> for igual a zero são ignoradas.

Ver também <@ref="pmax">, <@ref="pmin">, <@ref="pnobs">, <@ref="psd">, <@ref="pxsum">, <@ref="pshrink">, <@ref="psum">.

# pmin panel
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="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 <@var="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 <@var="mask"> for igual a zero são ignoradas.

Ver também <@ref="pmax">, <@ref="pmean">, <@ref="pnobs">, <@ref="psd">, <@ref="pshrink">, <@ref="psum">.

# pnobs panel
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="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 <@var="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 <@var="mask"> for igual a zero são ignoradas.

Ver também <@ref="pmax">, <@ref="pmin">, <@ref="pmean">, <@ref="psd">, <@ref="pshrink">, <@ref="psum">.

# polroots math
Resultado: 	matriz
Argumento: 	<@var="a">  (vetor)

Encontra as raízes de um polinômio. Se o polinômio for de ordem <@mth="p">, o vetor <@var="a"> deverá conter <@mth="p"> + 1 coeficientes em ordem crescente, i.e. iniciando com a constante e terminando com o coeficiente de <@mth="x"><@sup="p">.

Se todas as raízes forem reais elas serão retornadas em um vetor coluna de comprimento <@mth="p">, caso contrário uma matriz de ordem <@itl="p">×2 será retornada, com as partes reais na primeira coluna e as partes imaginárias na segunda.

# polyfit transforms
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="q">  (número inteiro)

Ajusta uma tendência polinomial de ordem <@var="q"> à série <@var="y"> usando o método dos polinômios ortogonais. A série retornada contém os valores ajustados.

# princomp stats
Resultado: 	matriz
Argumentos:	<@var="X">  (matriz)
		<@var="p">  (número inteiro)
		<@var="covmat">  (booleano, opcional)

Seja a matriz <@var="X"> de ordem <@itl="T">×<@itl="k">, contendo <@mth="T"> observações de <@mth="k"> variáveis. O argumento <@var="p"> deve ser um inteiro positivo menor ou igual a <@mth="k">. Esta função retorna a matriz de ordem <@itl="T">×<@itl="p">, <@mth="P">, contendo os primeiros <@mth="p"> principais componentes de <@var="X">.

O terceiro argumento, opcional, age como uma chave booleana: se for um valor não-nulo os componentes principais são calculados com base na matriz de covariâncias das colunas de <@var="X"> (o padrão desta função é a utilização da matriz de correlação).

Os elementos de <@mth="P"> são calculados como sendo a soma de <@mth="i"> até <@mth="k"> de <@mth="Z"><@sub="ti"> multiplicado por <@mth="v"><@sub="ji">, onde <@mth="Z"><@sub="ti"> é o valor padronizado da variável <@mth="i"> na observação <@mth="t"> e <@mth="v"><@sub="ji"> é o <@mth="j">-ésimo autovetor da matriz de correlação (ou covariância) dos <@mth="X"><@sub="i">s, com os autovetores ordenados de forma decrescente de acordo com o valores dos autovalores correspondentes.

Ver também <@ref="eigensym">.

# prodc stats
Resultado: 	vetor linha
Argumento: 	<@var="X">  (matriz)

Retorna o produto dos elementos das colunas de <@var="X">. Ver também <@ref="prodr">, <@ref="meanc">, <@ref="sdc">, <@ref="sumc">.

# prodr stats
Resultado: 	vetor coluna
Argumento: 	<@var="X">  (matriz)

Retorna o produto dos elementos das linhas de <@var="X">. Ver também <@ref="prodc">, <@ref="meanr">, <@ref="sumr">.

# psd panel
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="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 <@mth="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 <@lit="NA">).

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

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

Ver também <@ref="pmax">, <@ref="pmin">, <@ref="pmean">, <@ref="pnobs">, <@ref="pshrink">, <@ref="psum">.

# psdroot linalg
Resultado: 	matriz quadrada
Argumento: 	<@var="A">  (matriz simétrica)

Calcula a variante generalizada da decomposição de Cholesky da matriz <@var="A">, que deve ser positiva semi-definida (mas que pode ser singular). Se a matriz de entrada não for quadrada é sinalizado um erro, apesar disso, a simetria é assumida pela função, mas não verificada. Apenas o triângulo inferior de <@var="A"> é lido. O resultado é uma matriz triangular inferior <@mth="L"> que satisfaz <@mth="A = LL'">. Elementos indeterminados na solução são zerados.

Para o caso onde <@var="A"> é positivo definido, veja <@ref="cholesky">.

# pshrink panel
Resultado: 	matriz
Argumento: 	<@var="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 <@var="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 <@ref="pmax"> e <@ref="pmean">, nas quais um valor pertencente a cada unidade de corte transversal é repetido para cada período de tempo.

Veja <@ref="pexpand"> para a operação inversa.

# psum panel
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="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 <@var="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 <@var="mask"> for igual a zero são ignoradas.

Ver também <@ref="pmax">, <@ref="pmean">, <@ref="pmin">, <@ref="pnobs">, <@ref="psd">, <@ref="pxsum">, <@ref="pshrink">.

# pvalue probdist
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="c">  (caractere)
		<@var="…">  (ver abaixo)
		<@var="x">  (escalar, série ou matriz)
Exemplos: 	<@lit="p1 = pvalue(z, 2.2)">
		<@lit="p2 = pvalue(X, 3, 5.67)">
		<@lit="p2 = pvalue(F, 3, 30, 5.67)">

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

Ver também <@ref="critical">, <@ref="invcdf">, <@ref="urcpval">, <@ref="imhof">.

# pxnobs panel
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="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 <@var="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 <@var="mask"> for igual a zero são ignoradas.

Note que esta função opera em uma dimensão diferente da função <@ref="pnobs">.

# pxsum panel
Resultado: 	série
Argumentos:	<@var="y">  (série)
		<@var="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 <@var="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 <@var="mask"> for igual a zero são ignoradas.

Note que esta função opera em uma dimensão diferente da função <@ref="psum">.

# qform linalg
Resultado: 	matriz
Argumentos:	<@var="x">  (matriz)
		<@var="A">  (matriz simétrica)

Calcula a forma quadrática <@mth="Y = xAx'">. A utilização desta função, ao invés da multiplicação matricial comum, garante mais velocidade e maior precisão quando <@var="A"> é uma matriz simétrica genérica. Porém, no caso especial onde <@var="A"> é uma matriz identidade, a simples expressão <@lit="x'x"> tem desempenho bastante superior em relação a <@lit="qform(x',I(rows(x))">.

Se <@var="x"> e <@var="A"> não forem compatíveis, ou <@var="A"> não for simétrica, é retornado um erro.

# qlrpval probdist
Resultado: 	escalar
Argumentos:	<@var="X2">  (escalar)
		<@var="df">  (número inteiro)
		<@var="p1">  (escalar)
		<@var="p2">  (escalar)

Fornece os <@mth="p">-valores para a estatística de teste do teste sup-Wald QLR para uma quebra estrutural em um ponto desconhecido (veja <@xrf="qlrtest">), conforme <@bib="Hansen (1997);hansen97">.

O primeiro argumento, <@var="X2">, representa a máxima estatística de teste (na forma de qui-quadrado) de Wald e <@var="df"> representa os graus de liberdade. O terceiro e o quarto argumento representa, na forma de frações decimais da amplitude de estimação geral, os pontos inicial e final da amplitude central das observações ao longo das quais os sucessivos testes de Wald são calculados. Por exemplo, se a abordagem padrão de corte de 15 por cento for utilizada <@var="p1"> deve ser igual a 0.15 e <@var="p2"> igual a 0.85.

Ver também <@ref="pvalue">, <@ref="urcpval">.

# qnorm probdist
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna os quantis para a distribuição normal padrão. Se <@var="x"> não estiver entre 0 e 1, será retornado <@lit="NA">. Ver também <@ref="cnorm">, <@ref="dnorm">.

# qrdecomp linalg
Resultado: 	matriz
Argumentos:	<@var="X">  (matriz)
		<@var="&R">  (referência a matriz, ou <@lit="null">)

Calcula a decomposição QR de uma matriz <@var="X"> de ordem <@itl="m">×<@itl="n">, isto é, <@mth="X = QR"> onde <@mth="Q"> é uma matriz ortogonal <@itl="m">×<@itl="n"> e <@mth="R"> é uma matriz triangular superior <@itl="n">×<@itl="n">. A matriz <@mth="Q"> é retornada diretamente, enquanto que <@mth="R"> pode ser obtida via utilização do segundo argumento (opcional).

Ver também <@ref="eigengen">, <@ref="eigensym">, <@ref="svd">.

# quadtable stats
Resultado: 	matriz
Argumentos:	<@var="n">  (número inteiro)
		<@var="type">  (número inteiro, opcional)
		<@var="a">  (escalar, opcional)
		<@var="b">  (escalar, opcional)

Retorna uma matriz de ordem <@itl="n">×2 para utilização a quadratura gaussiana (integração numérica). A primeira coluna contém os nós ou abscissas e a segunda os pesos.

O primeiro argumento especifica o número de pontos (linhas) a serem computados. O segundo argumento indica o tipo de quadratura: use 1 para Gauss–Hermite (tipo padrão); 2 para Gauss–Legendre; ou 3 para Gauss–Laguerre. O significado dos parâmetros opcionais <@var="a"> e <@var="b"> dependem da escolha do argumento <@var="type">, conforme explicado a seguir.

A quadratura gaussiana é um método para aproximar numericamente a integral definida de dada função de interesse. Seja a função representada pelo produto <@mth="f(x)W(x)">. Os tipos de quadratura diferem de acordo com a especificação do componente <@mth="W(x)">: no caso de Hermite ela é definida como exp(–<@mth="x"><@sup="2">); no caso de Laguerre, exp(–<@mth="x">); e no caso de Legendre como <@mth="W(x)"> = 1.

Para cada especificação de <@mth="W">, pode-se calcular um conjunto de abscissas, <@mth="x"><@sub="i">, e pesos, <@mth="w"><@sub="i">, tais que o somatório de <@mth="i">=1 até <@mth="n"> de <@mth="w"><@sub="i"> <@mth="f">(<@mth="x"><@sub="i">) se aproxima da integral desejada. O método de <@bib="Golub e Welsch (1969);golub69"> é utilizado.

Quando o tipo Gauss–Legendre é selecionado, os argumentos opcionais <@var="a"> e <@var="b"> podem ser utilizados para controlar os limites inferior e superior de integração, sendo os valores padrão –1 e 1. Na quadratura de Hermite os limites são fixados entre menos infinito e mais infinito, enquanto que no caso de Laguerre eles são fixados entre zero e infinito.

No caso de Hermite <@var="a"> e <@var="b "> exercem um papel diferente: eles podem ser utilizados para substituir a forma padrão de <@mth="W ">(<@mth="x">) pela (proximanente relacionada) distribuição normal com média <@var="a"> e desvio padrão <@var="b">. Fornecendo os valores de 0 e 1 para estes parâmetros, por exemplo, tem o efeito de transformar <@mth="W">(<@mth="x ">) em uma FDP normal padrão, que é equivalente a multiplicar as abscissas padrão pela raiz quadrada de dois e dividir os pesos pela raiz quadrada de π.

# quantile stats
Resultado: 	escalar ou matriz
Argumentos:	<@var="y">  (série ou matriz)
		<@var="p">  (escalar entre 0 e 1)

Se <@var="y"> for uma série, retorna o quantil <@var="p"> da série. Por exemplo, quando <@mth=" p"> = 0,5, a mediana é retornada.

Se <@var="y"> for uma matriz, retorna um vetor linha contendo os <@var="p">-quantis das colunas de <@var="y">. Isto é, cada coluna é tratada como sendo uma série.

Adicionalmente, para a matriz <@var="y"> existe uma segunda alternativa para o segundo argumento: <@var="p "> pode ser dado como um vetor. Nesse caso o valor de retorno é uma matriz de ordem <@itl="m">×<@itl="n"> onde <@var="m "> representa o número de elementos em <@var="p"> e <@var="n"> é o número de colunas em <@var="y">.

# randgen probdist
Resultado: 	série
Argumentos:	<@var="d">  (texto)
		<@var="p1">  (escalar ou série)
		<@var="p2">  (escalar ou série, condicional)
		<@var="p3">  (escalar, condicional)
Exemplos: 	<@lit="series x = randgen(u, 0, 100)">
		<@lit="series t14 = randgen(t, 14)">
		<@lit="series y = randgen(B, 0.6, 30)">
		<@lit="series g = randgen(G, 1, 1)">
		<@lit="series P = randgen(P, mu)">

Gerador de número aleatório de uso geral. O argumento <@var="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 <@var="p1"> a <@var="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 <@var="p1"> e <@var="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 <@var="p1"> ou <@var="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 <@var="p1"> e, quando for aplicável, <@var="p2"> e <@var="p3">.

<indent>
• Uniforme (contínua) (u ou U): mínimo, máximo
</indent>

<indent>
• Uniforme (discreta) (i): mínimo, máximo
</indent>

<indent>
• Normal (z, n ou N): média, desvio padrão
</indent>

<indent>
• t de Student (t): graus de liberdade
</indent>

<indent>
• Qui-quadrado (c, x ou X): graus de liberdade
</indent>

<indent>
• F de Snedecor (f ou F): graus de liberdade (num.), graus de liberdade (den.)
</indent>

<indent>
• Gama (g ou G): forma, escala
</indent>

<indent>
• Binomial (b ou B): probabilidade, quantidade de tentativas
</indent>

<indent>
• Poisson (p ou P): média
</indent>

<indent>
• ExponenCial (exp): escala
</indent>

<indent>
• Weibull (w ou W): forma, escala
</indent>

<indent>
• Laplace (l ou L): média, escala
</indent>

<indent>
• Erro Generalizado (E): forma
</indent>

<indent>
• Beta (beta): forma1, forma2
</indent>

<indent>
• Beta-Binomial (bb): tentativas, forma1, forma2
</indent>

Ver também <@ref="normal">, <@ref="uniform">, <@ref="mrandgen">, <@ref="randgen1">.

# randgen1 probdist
Resultado: 	escalar
Argumentos:	<@var="d">  (caractere)
		<@var="p1">  (escalar)
		<@var="p2">  (escalar, condicional)
Exemplos: 	<@lit="scalar x = randgen1(z, 0, 1)">
		<@lit="scalar g = randgen1(g, 3, 2.5)">

Funciona da mesma forma que <@ref="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 <@ref="mrandgen">.

# randint probdist
Resultado: 	número inteiro
Argumentos:	<@var="min">  (número inteiro)
		<@var="max">  (número inteiro)

Retorna um inteiro pseudo-aleatório no intervalo fechado [<@var="min">, <@var="max">]. Ver também <@ref="randgen">.

# randperm probdist
Resultado: 	vetor
Argumentos:	<@var="n">  (número inteiro)
		<@var="k">  (número inteiro, opcional)

Se apenas é dado o primeiro argumento, retorna um vector linha contendo uma permutação aleatória dos inteiros de 1 a <@var="n">, sem repetição dos elementos. Se o segundo argumento é dado, ele tem que ser um inteiro no intervalo de 1 a <@var="n">; neste caso a função retorna um vector linha contendo <@var="k"> inteiros seleccionados aleatóriamente entre 1 e <@var="n"> sem substituição.

Caso se pretenda uma amostra de <@mth="k"> linhas de uma matriz <@lit="X"> com <@mth="n"> linhas (sem substituição), pode-se proceder como se mostra adiante:

<code>
     matrix S = X[randperm(n, k),]
</code>

E case se queira preservar a ordem original das linhas na amostra:

<code>
     matrix S = X[sort(randperm(n, k)),]
</code>

Ver também <@ref="resample"> para a reamostragem com substituição.

# rank linalg
Resultado: 	número inteiro
Argumento: 	<@var="X">  (matriz)

Retorna o posto de <@var="X">, calculada numericamente via decomposição em valores singulares. Ver também <@ref="svd">.

# ranking stats
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="y">  (série ou vetor)

Retorna uma série ou vetor com os ranks de <@mth=" y">. O rank para a observação <@mth="i"> é o número de elementos que são menores que <@mth=" y"><@sub="i"> mais 1. Se houver números iguais a <@mth="y"><@sub="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 <@ref="sort">, <@ref="sortby">.

# rcond linalg
Resultado: 	escalar
Argumento: 	<@var="A">  (matriz quadrada)

Retorna o número condicional recíproco para <@var="A"> em relação à norma-1. Em várias circunstâncias, é uma medida de sensibilidade melhor de <@var="A"> em relação a operações numéricas, tais como a inversão, que o determinante.

O valor é calculado como a recíproca do produto, norma-1 de <@var="A"> multiplicada pela norma-1 de <@var="A">-inverso.

Ver também <@ref="det">, <@ref="ldet">, <@ref="onenorm">.

# Re complex
Resultado: 	matriz
Argumento: 	<@var="C">  (matriz complexa)

Retorna uma matriz real com a mesma dimensão que <@var="C">, contendo a parte real dessa matriz de entrada. Ver também <@ref="Im">.

# readfile strings
Resultado: 	texto
Argumentos:	<@var="fname">  (texto)
		<@var="codeset">  (texto, opcional)

Se um arquivo com o nome <@var="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 <@var=" fname"> não contiver o caminho completo até o arquivo, ele será procurado em algumas localizações “prováveis”, começando pelo <@xrf="workdir"> corrente.

Se <@var="fname"> começar com o identificador de um protocolo de internet suportado (<@lit="http://">, <@lit="ftp://"> ou <@lit="https://">), libcurl será utilizado para baixar o arquivo. Veja também <@ref="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 <@lit=""cp1251"">.

Exemplos:

<code>
        string web_page = readfile("http://gretl.sourceforge.net/")
        print web_page

        string current_settings = readfile("@dotdir/.gretl2rc")
        print current_settings
</code>

Veja também as funções <@ref="sscanf"> e <@ref="getline">.

# regsub strings
Resultado: 	texto
Argumentos:	<@var="s">  (texto)
		<@var="match">  (texto)
		<@var="repl">  (texto)

Retorna uma cópia de <@var="s"> onde todas as ocorrências do padrão <@var="match"> são substituídas por <@var="repl">. Os argumentos <@var="match"> e <@var="repl"> são interpretados como expressões regulares no estilo Perl.

Veja também <@ref="strsub"> para substituições simples de textos.

# remove data-utils
Resultado: 	número inteiro
Argumento: 	<@var="fname">  (texto)

Deleta o arquivo <@var="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 <@var="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 <@var="fname"> não contiver o caminho completo então será assumido que o arquivo está no diretório de trabalho (<@xrf="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 data-utils
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="x">  (série ou matriz)
		<@var="find">  (escalar ou vetor)
		<@var="subst">  (escalar ou vetor)

Substitui cada elemento de <@var="x"> igual ao <@mth="i">-ésimo elemento de <@var="find"> pelo correspondente elemento de <@var="subst">.

Se <@var="find"> for um escalar, <@var="subst"> também deve ser um escalar. Se <@var="find"> e <@var="subst"> forem vetores, eles precisam ter o mesmo número de elementos. Mas se <@var="find"> for um vetor e <@var="subst"> um escalar, então todas as ocorrências serão substituídas por <@var="subst">.

Exemplo:

<code>
     a = {1,2,3;3,4,5}
     find = {1,3,4}
     subst = {-1,-8, 0}
     b = replace(a, find, subst)
     print a b
</code>

produz

<code>
          a (2 x 3)

          1   2   3
          3   4   5

          b (2 x 3)

          -1    2   -8
          -8    0    5
</code>

# resample stats
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="x">  (série ou matriz)
		<@var="blocksize">  (número inteiro, opcional)

A descrição inicial desta função refere-se aos dados de corte transversal ou de séries de tempo. Ao final é tratado o caso de dados em painel.

Realiza a reamostragem de <@var="x"> com substituição. Quando uma série é utilizada como argumento, cada valor da série de retorno, <@mth="y"><@sub="t">, é sorteado entre todos os valores de <@mth="x"><@sub="t"> com igual probabilidade. Quando uma matriz é utilizada como argumento, cada linha da matriz retornada é sorteada entre todas as linhas de <@var="x"> com igual probabilidade.

O argumento opcional <@var="blocksize"> representa o tamanho do bloco para a reamostragem via deslocamento de blocos. Caso este argumento seja dado, ele deve ser um número inteiro positivo maior ou igual a 2. Ao se utilizar este argumento a saída é composta pela seleção aleatória com substituição de todas as sequências contíguas possíveis com tamanho igual ao valor de <@var="blocksize"> na entrada (no caso da utilização de matrizes na entrada as linhas são contíguas). Se o comprimento do dado não for um número inteiro e múltiplo do tamanho do bloco, o bloco selecionado será truncado para se ajustar.

Se o argumento <@var="x"> for uma série e o conjunto de dados for do tipo painel, a reamostragem via deslocamento de blocos não é suportada. A forma básica de reamostragem é suportada, mas passa a ter a seguinte interpretação: os dados são reamostrado “por indivíduo”. Suponha que você tenha um painel no qual 100 indivíduos são observados ao longo de 5 períodos. Nesse caso a série retornada será novamente composta de 100 blocos de 5 observações: cada bloco será sorteado com igual probabilidade entre 100 séries de tempo individuais, com a ordem da série temporal sendo preservada.

# round math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Arredondamento para o número inteiro mais próximo. Note que quando <@mth="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 <@lit="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 <@ref="ceil">, <@ref="floor">, <@ref="int">.

# rnameget strings
Resultado: 	texto ou cadeia de texto
Argumentos:	<@var="M">  (matriz)
		<@var="row">  (número inteiro, opcional)

Se o argumento <@var="row"> for dado, retorna o nome da linha <@var="col"> da matriz <@var="M">. Se <@var="M"> não possuir nomes em suas linhas então será retornada um texto (string) vazio. Se <@var="row"> for maior que o número de linhas da matriz será sinalizado um erro.

Se não se indicar o segundo argumento, retornará um vetor de texto contendo os nomes das linhas de <@var="M">, ou um vetor de texto vazio se <@var="M"> não tiver nomes de linhas atribuídos.

Exemplo:

<code>
     matrix A = { 11, 23, 13 ; 54, 15, 46 }
     rnameset(A, "First Second")
     string name = rnameget(A, 2)
     print name
</code>

Ver também <@ref="rnameset">.

# rnameset matrix
Resultado: 	número inteiro
Argumentos:	<@var="M">  (matriz)
		<@var="S">  (cadeia de texto ou lista)

Adiciona nomes para as linhas da matriz <@var="M"> de ordem <@itl="m">×<@itl="n"> . Se <@var="S"> for uma lista, os nomes serão os das séries listadas. A lista precisa ter <@mth=" m"> membros. Se <@var="S"> for um arranjo (array) de variáveis de texto (string), ele precisa ter <@mth="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 <@mth="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 <@ref="cnameset">.

Exemplo:

<code>
     matrix M = {1, 2; 2, 1; 4, 1}
     strings S = array(3)
     S[1] = "Row1"
     S[2] = "Row2"
     S[3] = "Row3"
     rnameset(M, S)
     print M
</code>

# rows matrix
Resultado: 	número inteiro
Argumento: 	<@var="X">  (matriz)

Retorna o número de linhas da matriz <@var="X">. Ver também <@ref="cols">, <@ref="mshape">, <@ref="unvech">, <@ref="vec">, <@ref="vech">.

# schur complex
Resultado: 	matriz complexa
Argumentos:	<@var="A">  (matriz complexa)
		<@var="&Z">  (referência a matriz, ou <@lit="null">)
		<@var="&w">  (referência a matriz, ou <@lit="null">)

Executa a decomposição de Schur da matriz complexa <@var="A">, retornando uma matriz complexa triangular superior <@mth="T">. Caso seja fornecido o segundo argumento e seja diferente de <@lit="null"> a função retorna uma matriz complexa <@mth="Z"> contendo o vector de Schur associado a <@mth="A"> e <@mth="T">, tais que <@mth="A"> = <@mth="ZTZ"><@sup="H">. Se é dado um terceiro argumento retorna os valores próprios de <@mth="A"> num vector coluna complexo.

# sd stats
Resultado: 	escalar ou série
Argumento: 	<@var="x">  (série ou lista)

Se <@var="x"> for uma série a função retorna o desvio padrão amostral, descartando as observações ausentes.

Se <@var="x"> for uma lista a função retorna uma série <@mth="y"> tal que <@mth="y"><@sub="t"> representa o desvio padrão amostral dos valores das variáveis na lista na observação <@mth="t">, ou <@lit="NA"> se existirem valores ausentes em <@mth="t">.

Ver também <@ref="var">.

# sdc stats
Resultado: 	vetor linha
Argumentos:	<@var="X">  (matriz)
		<@var="df">  (escalar, opcional)

Retorna os desvios padrão das colunas da matriz <@var="X ">. Se <@var="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 <@var="X"> (isto é, não será aplicada a correção de graus de liberdade). Ver também <@ref="meanc">, <@ref="sumc">.

# sdiff transforms
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="y">  (série ou lista)

Calcula diferenças sazonais: <@mth="y(t) - y(t-k)">, onde <@mth="k"> é a periodicidade do conjunto de dados corrente (veja <@ref="$pd">). Valores iniciais são definidos como <@lit="NA">.

Quando uma lista for retornada, as variáveis individuais são automaticamente nomeadas de acordo com o seguinte padrão <@lit="sd_"><@var="varname">, onde <@var="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 <@ref="diff">, <@ref="ldiff">.

# seasonals data-utils
Resultado: 	lista
Argumentos:	<@var="baseline">  (número inteiro, opcional)
		<@var="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 <@lit="S1">, <@lit="S2"> e assim por diante.

O argumento opcional <@var="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 <@var="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 matrix
Resultado: 	matriz
Argumentos:	<@var="A">  (matriz)
		<@var="b">  (vetor linha)

Seleciona em <@var="A"> apenas as colunas para as quais o elemento correspondente em <@var="b"> é não-nulo. <@var="b"> deve ser um vetor linha com o mesmo número de colunas de <@var="A">.

Ver também <@ref="selifr">.

# selifr matrix
Resultado: 	matriz
Argumentos:	<@var="A">  (matriz)
		<@var="b">  (vetor coluna)

Seleciona em <@var="A"> apenas as linhas para as quais o elemento correspondente em <@var="b"> é não-nulo. <@var="b"> deve ser um vetor coluna com o mesmo número de linhas de <@var="A">.

Ver também <@ref="selifc">, <@ref="trimr">.

# seq matrix
Resultado: 	vetor linha
Argumentos:	<@var="a">  (escalar)
		<@var="b">  (escalar)
		<@var="k">  (escalar, opcional)

Retorna um vetor com a sequência crescente de <@var="a"> até <@var="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 <@var="k"> for dado a função retorna um vetor com a sequência iniciada em <@var="a"> e aumentada, caso <@var="a"> for menor <@var="b">), em <@var="k "> unidades a cada passo. A sequência será finalizada no maior valor possível que seja menor ou igual a <@var="b">. Se o primeiro argumento for maior que o segundo a sequência será reduzida em <@var="k"> unidades e será finalizada no menor valor possível que seja maior ou igual a <@var="b">). O argumento <@var="k "> deve ser positivo.

Ver também <@ref="ones">, <@ref="zeros">.

# setnote data-utils
Resultado: 	número inteiro
Argumentos:	<@var="b">  (lote)
		<@var="key">  (texto)
		<@var="note">  (texto)

Insere uma nota descritiva para o objeto identificado por <@var="key"> em um pacote (bundle) <@var="b">. Esta nota será apresentada quando o comando <@lit="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 <@var="key"> em <@var="b">).

# sgn math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna o sinal do <@var="x">, ou seja, 0 se <@var="x"> é zero, 1 se <@var="x"> é positivo, –1 se <@var="x"> é negativo, ou <@lit="NA"> se <@var="x"> é um não-número (Not a Number).

# simann numerical
Resultado: 	escalar
Argumentos:	<@var="&b">  (referência a matriz)
		<@var="f">  (chamada a função)
		<@var="maxit">  (número inteiro, opcional)

Implementa o algoritmo “simulated annealing” (conhecido também por recozimento simulado) que pode ser útil para melhorar a questão da inicialização em problemas de otimização numérica.

O primeiro argumento contém o valor inicial de vetor de parâmetros e o segundo especifica uma chamada de função que retorna o valor (escalar) valor da variável a ser maximizada. O terceiro argumento, que é opcional, especifica o número máximo de iterações (a quantidade padrão é 1024). Caso seja executada com sucesso, a função <@lit="simann "> retorna o valor final da variável a ser maximizada e <@var=" b"> armazena o vetor de parâmetros associado.

Para maiores detalhes e exemplo veja <@pdf="guia de utilização do Gretl#chap:numerical"> (Capítulo 37). Ver também <@ref="BFGSmax">, <@ref="NRmax">.

# sin math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna o seno de <@var="x">. Ver também <@ref="cos">, <@ref="tan">, <@ref="atan">.

# sinh math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna o seno hiperbólico de <@var="x">.

Ver também <@ref="asinh">, <@ref="cosh">, <@ref="tanh">.

# skewness stats
Resultado: 	escalar
Argumento: 	<@var="x">  (série)

Retorna o valor de assimetria para a série <@var="x">, descartando quaisquer observações ausentes.

# sleep programming
Resultado: 	escalar
Argumento: 	<@var="ns">  (número inteiro)

Faz com que o processo (thread) corrente “hiberne”— isto é, que interrompa suas atividades—por <@var="ns"> segundos. Ao despertar da hibernação, a função retorna o valor 0. Apesar de não ser diretamente relacionada à econometria, essa função pode ser útil para testes de métodos de paralelização.

# smplspan data-utils
Resultado: 	escalar
Argumentos:	<@var="startobs">  (texto)
		<@var="endobs">  (texto)
		<@var="pd">  (número inteiro)

Retorna o número de observações entre <@var="startobs"> e <@var="endobs"> (inclusive) de uma série temporal com frequência <@var="pd">.

Os dois primeiros argumentos devem ser dados na forma padrão do Gretl para dados anuais, trimestrais ou mensais— por exemplo, <@lit="1970">, <@lit="1970:1"> ou <@lit="1970:01"> para cada uma das frequências, respectivamente—ou como datas no formato ISO 8601, <@lit="YYYY-MM-DD">.

O argumento <@var="pd"> deve ser igual a 1, 4 ou 12 (anual, trimestral, mensal); uma das frequências diárias (5, 6, 7); ou 52 (semanal). Se <@var="pd"> for igual a 1, 4 ou 12, então pode-se utilizar datas no formato ISO 8601 nos dois primeiros argumentos se elas indicarem o início e o fim do período em questão. Por exemplo, <@lit="2015-04-01"> pode ser utilizada no lugar de <@lit="2015:2"> para representar o segundo trimestre de 2015.

Se um conjunto de dados já aberto e com frequência <@var="pd">, com uma suficiente quantidade de observações, então o resultado dessa função poderia ser facilmente emulada utilizando <@ref="obsnum">. A vantagem de <@lit="smplspan"> é o fato de poder calcular o número de observações sem que seja necessário um conjunto de dados adequado (ou até mesmo nenhum conjunto de dados). Exemplo:

<code>
     scalar T = smplspan("2010-01-01", "2015-12-31", 5)
     nulldata T
     setobs 7 2010-01-01
</code>

O código acima produz o seguinte resultado:

<code>
     ? scalar T = smplspan("2010-01-01", "2015-12-31", 5)
     Gerou-se o escalar T = 1565
     ? nulldata T
     periodicidade: 1, máx. obs: 1565
     intervalo das observações: 1 a 1565
     ? setobs 7 2010-01-01
     Intervalo completo dos dados: 2010-01-01 - 2014-04-14 (n = 1565)
</code>

Após utilizar esse código pode-se ter a certeza de que a última observação no conjunto de dados criado via comando <@xrf="nulldata"> será <@lit="2015-12-31">. Note que a obtenção do número 1565 seria bem mais complicada de sem o uso dessa função.

# sort matrix
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (série ou vetor)

Ordena <@var="x"> de forma ascendente, descartando observações com valores ausentes quando <@mth="x"> for uma série. Ver também <@ref="dsort">, <@ref="values">. Especificamente para matrizes veja <@ref="msortby">.

# sortby stats
Resultado: 	série
Argumentos:	<@var="y1">  (série)
		<@var="y2">  (série)

Retorna uma série contendo os elementos de <@var="y2"> ordenados de acordo com os valores crescente do primeiro argumento <@var="y1">. Ver também <@ref="sort">, <@ref="ranking">.

# sprintf strings
Resultado: 	texto
Argumentos:	<@var="format">  (texto)
		... (ver abaixo)

O texto (string) retornado é construído pela exibição dos valores dos argumentos finais, indicados pelas reticências acima, sob o controle do argumento <@var="format">. Esta função tem como objetivo oferecer mais flexibilidade na criação de textos. O argumento <@var=" format"> é utilizado para especificar de uma maneira precisa a forma como você deseja que os argumentos sejam exibidos.

Em geral, o argumento <@var="format"> (que pode ser chamado de texto de formatação) deve ser uma expressão avaliada como um texto, mas na maioria dos casos será apenas um texto literal (uma sequência alfanumérica delimitada por aspas duplas). Algumas sequências de caracteres em <@var="format"> têm um significado especial: aqueles iniciados pelo símbolo de porcentagem (%) são interpretados como “espaços reservados” para os ítens contidos na lista de argumentos. Além disso, caracteres especiais, tal como o que indica nova linha (<@lit="\n ">), são representados através da combinação com uma barra invertida.

Por exemplo, o código a seguir

<code>
     scalar x = sqrt(5)
     string claim = sprintf("sqrt(%d) é (aproximadamente) %6.4f.\n", 5, x)
     print claim
</code>

irá produzir

<code>
     sqrt(5) é (aproximadamente) 2.2361.
</code>

A expressão <@lit="%d"> dentro do argumento <@var="format"> indica que queremos na saída um número inteiro neste local. Como é a expressão “porcento” mais a esquerda, ela então tem efeito sobre o primeiro argumento, isto é, 5. A segunda sequência especial é <@lit="%6.4f">, que indica um valor decimal com ao menos 6 dígitos de largura e com ao menos 4 casas decimais. A quantidade de sequências como estas deve coincidir com o número de argumentos após o texto de formatação.

Ver também a ajuda para o comando <@xrf="printf"> para maiores detalhes sobre a sintaxe que você pode utilizar para a formatação de textos (strings).

# sqrt math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna a raiz quadrada positiva de <@var="x">. Gera <@lit="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 <@lit="NA">, a função irá gerar um erro se existirem valores negativos. Para a “raiz quadrada matricial” veja <@ref="cholesky">.

# square transforms
Resultado: 	lista
Argumentos:	<@var="L">  (lista)
		<@var="cross-products">  (booleano, opcional)

Retorna uma lista contendo os quadrados das variáveis na lista <@var="L">. Seus elementos são nomeados de acordo com o seguinte esquema :<@lit="sq_"><@var="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 <@var="L"> que, por sua vez, são nomeados de acordo com o seguinte esquema: <@var="var1"><@lit="_"><@var="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 strings
Resultado: 	número inteiro
Argumentos:	<@var="src">  (texto)
		<@var="format">  (texto)
		... (ver abaixo)

Lê os valores de <@var="src"> sob controle do argumeto <@var="format"> e os usa para determinar os valores de um ou mais argumentos subsequentes, indicados pelas reticências acima. A função retorna o número de valores determinados. Esta é uma versão simplificada da função <@lit="sscanf"> na linguagem de programação C.

O argumento <@var="src"> pode ser tanto um texto literal, delimitado por aspas duplas, ou o nome de uma variável de texto (string) previamente definida. O <@var="format"> é definido de forma similar ao texto de formatação utilizado em <@xrf="printf"> (mais detalhes serão dados abaixo). Os demais argumentos, representados acima pelas reticências devem ser uma lista separada por vírgulas contendo os nomes de variáveis pré-definidas: estas são os alvos da conversão de <@var="src">. Para os usuários com familiaridade com a linguagem C, pode-se prefixar os nomes de variáveis numéricas com <@lit="&">, mas isso não é uma exigência.

O texto literal em <@var="format"> é comparado com <@var="src ">. Especificadores de conversão começam com <@lit="%">, sendo os especificadores reconhecidos <@lit="%f">, <@lit="%g"> ou <@lit="%lf"> para números de ponto flutuante; <@lit="%d"> para inteiros; <@lit="%s"> para textos; e <@lit="%m"> para matrizes. Você pode inserir um número inteiro positivo após o símbolo de porcentagem: isso ajusta o número máximo de caracteres a serem lidos por dado especificador de conversão (ou o número máximo de linhas no caso de conversão de matrizes). Alternativamente, você pode inserir um asterisco (<@lit="*">) após o símbolo de porcentagem para suprimir a conversão (ignorando assim quaisquer caracteres que teriam sido convertidos para um dado tipo). Por exemplo, <@lit="%3d"> converte os próximos 3 caracteres de <@var="source"> em um número inteiro, se possível; <@lit="%*g"> ignora a quantidade necessária de caracteres de <@var="source"> para que se obtenha apenas um número de ponto flutuante.

A conversão de matrizes funciona da seguinte forma: a função lê uma linha da entrada e conta (com base na separação por espaço ou por tabulação) o número de campos numéricos. Isto define o número de colunas na matriz. Por padrão a leitura continua sendo feita enquanto enquanto a leitura de linhas devolver a mesma quantidade de colunas numéricas, mas o número máximo de linhas a serem lidas pode ser limitado de acorodo com o descrito acima.

No caso de textos, em adição especificador <@lit="%s">, também é possível utilizar uma versão simplificada do formato utilizado na linguagem C: <@lit="%"><@var="N"><@lit="["><@var="chars "><@lit="]">. Neste formato <@var="N"> é o número máximo de caracteres a serem lidos <@var="chars"> é um conjunto de caracteres aceitáveis, delimitados por colchetes: a leitura para se <@var="N"> for atingido ou se um caractere que não está em <@var=" chars"> for encontrado. O comportamento de <@var="chars"> pode ser revertido se for utilizado um circunflexo, <@lit="^">, como sendo o primeiro caractere. Neste caso a leitura para se um caractere no dado conjunto for encontrado. Diferentemente de C, o hífen não exerce papel especial no conjunto <@var="chars">.

Se o texto fonte (<@var="src">) não apresentar correspondência (completa) com o texto de formatação (<@var="format">), o número de conversões pode ficar abaixo do número de argumentos dados. Isto não é por si só um erro no que diz respeito ao Gretl. Caso queira verificar o número de conversões realizadas basta utilizar o valor retornado pela função.

Alguns exemplos:

<code>
     scalar x
     scalar y
     sscanf("123456", "%3d%3d", x, y)

     S = sprintf("1 2 3 4\n5 6 7 8")
     S
     matrix m
     sscanf(S, "%m", m)
     print m
</code>

# sst stats
Resultado: 	escalar
Argumento: 	<@var="y">  (série)

Retorna a soma dos quadrados dos desvios em relação à média das observações não ausentes na série <@var="y">. Ver também <@ref="var">.

# stack panel
Resultado: 	série
Argumentos:	<@var="L">  (lista)
		<@var="n">  (número inteiro)
		<@var="offset">  (número inteiro, opcional)

Destina-se a manipular dados em séries temporais para o tipo de dados empilhados requerido por gretl para dados de painel. O valor retornado é uma série obtida por empilhar “verticalmente” <@var="n"> observations de cada série da lista <@var="L">. Por defeito, são usadas as primeiras <@var="n"> (correspondendo ao argumento <@var="offset"> = 0) mas o ponto inicial pode ser deslocado ao se fornecer um valor positivo para <@var="offset">. Se a série resultante for maior que o conjunto de dados existente, serão acrescentadas observações conforme necessário.

Esta função pode lidar com dados de séries temporais lado-a-lado para um certo número de unidades de secção cruzada, e também no caso onde o tempo é expresso horizontalmente e cada linha representa uma unidade de secção cruzada.

Ver a secção intitulada “Detalhes de dados de painel” em <@pdf="guia de utilização do Gretl#chap:datafiles"> (Capítulo 4) para mais detalhes e exemplos de uso.

# stdize transforms
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="X">  (série, lista ou matriz)
		<@var="v">  (número inteiro, opcional)

Por defeito, retorna uma versão padronizada da série, lista ou matriz: os dados de entrada são centrados e divididos pelo seu desvio padrão amostral (com uma correção de graus de liberdade de 1). Os resultados são calculados por coluna no caso de uma matriz.

O segundo argumento (opcional) pode ser utilizado para influenciar o resultado. Um valor não negativo de <@var="v"> define os graus de liberdade usados no desvio padrão, assim, <@var="v"> = 0 resulta no estimador de máxima verosimilhança. Como caso especial, se <@var="v"> é igual a –1 apenas é feita a centragem.

# strftime calendar
Resultado: 	texto
Argumentos:	<@var="t">  (escalar)
		<@var="formato">  (texto, opcional)

O argumento <@var="t"> é interpretado como o número de segundos decorridos desde o início do ano 1970 no fuso horário UTC (Tempo Universal Coordenado, anteriomente designado como Tempo Médio de Greenwich (GMT) ); produz uma cadeia de texto com a data e hora correspondente. O formato por defeito é o mesmo que o padrão no sistema, mas pode ser modificado se o segundo argumento (opcional) é uma cadeia de texto de formatação.

Os valores adequados como argumentos <@var="t"> para esta função podem ser obtidos a partir do acessor <@ref="$now"> ou da função <@ref="strptime">.

Os detalhes da opção de formatação podem ser obtidos na página do manual de <@lit="strftime">, nos sistemas que o disponibilizam, ou num dos muitos sítios que têm essa informação, como por exemplo <@url="https://devhints.io/strftime">.

# stringify strings
Resultado: 	número inteiro
Argumentos:	<@var="y">  (série)
		<@var="S">  (cadeia de texto)

Fornece uma maneira de definir valores de texto para a série <@var="y">. Duas condições são necessárias para isso: a variável alvo deve ser formada apenas por números inteiros, com nenhum deles sendo menor que 1, e o arranjo (array) <@var="S "> deve possuir ao menos <@mth="n"> elementos, onde <@mth="n"> é o maior valor em <@var="y">. Adicionalmente, cada elemento de <@var="S"> deve estar representado com base na codificação UTF-8. Ver também <@ref="strvals">.

O valor retornado é zero em caso de sucesso ou um código positivo de erro caso a função não tenha sucesso.

# strlen strings
Resultado: 	número inteiro
Argumento: 	<@var="s">  (texto)

Retorna o número de caracteres no texto (string) <@var="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:

<code>
        string s = "regression"
        scalar number = strlen(s)
        print number
</code>

# strncmp strings
Resultado: 	número inteiro
Argumentos:	<@var="s1">  (texto)
		<@var="s2">  (texto)
		<@var="n">  (número inteiro, opcional)

Compara dois textos (string) e retorna um inteiro menor que, igual ou maior que 0 se <@var="s1"> se for, respectivamente menor que, igual ou maior que <@var="s2">, até o primeiro caractere <@var="n">. Se <@var="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: <@lit="if (s1 == s2)...">.

# strptime calendar
Resultado: 	escalar
Argumentos:	<@var="s">  (texto)
		<@var="formato">  (texto)

Esta função é a inversa de <@ref="strftime">; interpreta a cadeia de texto <@var="s"> como sendo data ou hora usando o <@var="formato"> especificado e retorna o número de segundos desde o início de 1970 (UTC).

As opções para o <@var="formato"> estão disponíveis na página do manual de <@lit="strptime">, nos sistemas que o disponibilizam, ou num dos muitos sítios com essa informação, como por exemplo <@url="http://man7.org/linux/man-pages/man3/strptime.3.html">.

O exemplo abaixo mostra como converter informação de data de um formato para outro.

<code>
     scalar tm = strptime("Thursday 02/07/19", "%A %m/%d/%y")
     eval strftime(tm) # default output
     eval strftime(tm, "%d %B, %Y")
</code>

Se a Língua é o Português, o resultado é

<code>
          ? scalar tm = strptime("Thursday 02/07/19", "%A %m/%d/%y")
          Gerou-se o escalar tm = 1,5495e+09
          ? eval strftime(tm) # default output
          qui 07 fev 2019 00:00:00
          ? eval strftime(tm, "%d %B, %Y")
          07 fevereiro, 2019
</code>

# strsplit strings
Resultado: 	texto ou cadeia de texto
Argumentos:	<@var="s">  (texto)
		<@var="i">  (número inteiro, opcional)
		<@var="sep">  (texto, opcional)

Em seu uso mais simples, ou seja, com apenas um argumento, retorna o arranjo (array) com textos (string) resultante da separação de <@var="s"> de acordo com os espaços em branco.

Se for fornecido um número inteiro e maior que zero como segundo argumento, retorna o elemento <@var="i"> do texto <@var="s">, após ter sido separado por espaços. Se <@var="i"> for menor irá gerar um erro. Se <@var="i"> for maior que o número total de elementos será retornado um texto vazio.

O terceiro argumento opcional pode ser utilizado para definir qual será o critério a ser utilizado para separar <@var="s">. Por exemplo:

<code>
      string basket = "banana,apple,jackfruit,orange"
      strings S = strsplit(basket,,",")
</code>

Os comandos acima irão separar o texto de entrada em um vetor contendo quatro textos utilizando a vírgula como separadora. A vírgula “extra” na entrada acima serve para indicar que o argumento <@var="i"> não foi utilizado.

As sequências de escape “<@lit="\n">” e “<@lit="\t">” são utilizadas para representar uma nova linha ou um espaço por tabulação no argumento opcional <@var="sep">. Caso o separador seja literalmente uma barra invertida deve-se utilizar a barra de forma duplicada, “<@lit="\\">”. Exemplo:

<code>
      string s = "c:\fiddle\sticks"
      strings S = strsplit(s, "\\")
</code>

# strstr strings
Resultado: 	texto
Argumentos:	<@var="s1">  (texto)
		<@var="s2">  (texto)

Procura em <@var="s1"> o texto <@var="s2">. Se o texto for encontrado a função retorna uma cópia da parte de <@var="s1"> que começa com <@var="s2">, caso contrário retorna um texto vazio.

Exemplo:

<code>
        string s1 = "Gretl is an econometrics package"
        string s2 = strstr(s1, "an")
        print s2
</code>

Se o objetivo for apenas verificar se <@var="s1"> contém <@var="s2"> (teste booleano), ver <@ref="instring">.

# strstrip strings
Resultado: 	texto
Argumento: 	<@var="s">  (texto)

Retorna uma cópia de <@var="s"> na qual os espaços em branco do início e do fim do texto são removidos.

Exemplo:

<code>
        string s1 = "    A lot of white space.  "
        string s2 = strstrip(s1)
        print s1 s2
</code>

# strsub strings
Resultado: 	texto
Argumentos:	<@var="s">  (texto)
		<@var="find">  (texto)
		<@var="subst">  (texto)

Retorna uma cópia de <@var="s"> na qual todas as ocorrências de <@var="find"> são substituídas por <@var="subst">. Veja também <@ref="regsub"> para substituições mais complexas via expressões regulares.

Exemplo:

<code>
        string s1 =  "Hello, Gretl!"
        string s2 = strsub(s1, "Gretl", "Hansl")
        print s2
</code>

# strvals strings
Resultado: 	cadeia de texto
Argumento: 	<@var="y">  (série)

Se uma série <@var="y"> for não-numérica, retorna um arranjo (array) contendo todos os seus valores distintos, ordenados pelos valores numéricos associados iniciados em 1. Se <@var="y"> não for não-numérico, retorna um arranjo de texto (strings) vazio. Observação: variáveis não-numéricas surgem, normalmente, quando existem séries cujas observações são textos. Ver também <@ref="stringify">.

# substr strings
Resultado: 	texto
Argumentos:	<@var="s">  (texto)
		<@var="start">  (número inteiro)
		<@var="end">  (número inteiro)

Retorna uma parte do texto <@var="s"> começando em <@var="start"> e terminando em <@var="end">, inclusive.

Exemplos:

<code>
        string s1 = "Hello, Gretl!"
        string s2 = substr(s1, 8, 12)
        string s3 = substr("Hello, Gretl!", 8, 12)
        print s2
        print s3
</code>

Esses exemplos fornecem:

<code>
      ? print s2
      Gretl
      ? print s3
      Gretl
</code>

Deve-se notar que em alguns casos pode-se desejar trocar a clareza da sintaxe pela sua simplicidade e usar operadores de seleção e incremento. Por exemplo:

<code>
          string s1 = "Hello, Gretl!"
          string s2 = s1[8:12]
          string s3 = s1 + 7
          print s2
          print s3
</code>

Esses exemplos fornecem:

<code>
      ? print s2
      Gretl
      ? print s3
      Gretl!
</code>

# sum stats
Resultado: 	escalar ou série
Argumento: 	<@var="x">  (série, matriz ou lista)

Se <@var="x"> for uma série, retorna a soma, na forma de um escalar, das observações não ausentes em <@var="x">. Veja também <@ref="sumall">.

Se <@var="x"> for uma matriz, retorna a soma dos elementos da matriz.

Se <@var="x"> for uma lista, retorna uma série <@mth="y"> na qual <@mth="y"><@sub="t"> é a soma dos valores das variáveis da lista na observação <@mth="t">, ou <@lit="NA"> se existir qualquer valor ausente em <@mth="t">.

# sumall stats
Resultado: 	escalar
Argumento: 	<@var="x">  (série)

Retorna a soma das observações de <@var="x"> dentro da amostra selecionada. Se existir qualquer valor ausente a função retornará <@lit="NA">. Use <@ref="sum"> caso deseje que os valores correntes sejam descartados.

# sumc stats
Resultado: 	vetor linha
Argumento: 	<@var="X">  (matriz)

Retorna um vetor com a soma das colunas de <@var="X"> Ver também <@ref="meanc">, <@ref="sumr">.

# sumr stats
Resultado: 	vetor coluna
Argumento: 	<@var="X">  (matriz)

Retorna um vetor com a soma das linhas de <@var="X"> Ver também <@ref="meanr">, <@ref="sumc">.

# svd linalg
Resultado: 	vetor linha
Argumentos:	<@var="X">  (matriz)
		<@var="&U">  (referência a matriz, ou <@lit="null">)
		<@var="&V">  (referência a matriz, ou <@lit="null">)

Realiza a decomposição em valores singulares da matriz <@var="X">.

Os valores singulares são retornados em um vetor linha. Os vetores singulares à esquerda e/ou à direta <@mth="U"> e <@mth="V"> podem ser obtidos ao se fornecer valores não-nulos para os argumentos 2 e 3, respectivamente. Para qualquer matriz <@lit="A">, o código

<code>
     s = svd(A, &U, &V)
     B = (U .* s) * V
</code>

deve gerar <@lit="B"> idêntico a <@lit="A"> (desconsiderando as possíveis discrepâncias geradas pela questão da precisão de máquina).

Ver também <@ref="eigengen">, <@ref="eigensym">, <@ref="qrdecomp">.

# svm nonparam
Resultado: 	série
Argumentos:	<@var="L">  (lista)
		<@var="param">  (lote)
		<@var="bmod">  (referência a lote, opcional)
		<@var="bprob">  (referência a lote, opcional)

Esta função permite o treinamento de um modelo SVM (Supervised Vector Machine) e a respectiva predição; o motor utilizado é a biblioteca LIBSVM. A lista passada como argumento <@var="L"> deve incluir a variável dependente, seguida pelas variáveis independentes, e o bundle <@var="param"> é usado para passar opções para o mecanismo SVM. A função retorna uma série contendo as predições SVM. Os dois outros parâmetros opcionais são ponteiros para bundles para recolher informação adicional após o treinamento e ou a predição.

Para mais detalhes, consultar a documentação em PDF: <@mnu="gretlSVM">.

# tan math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna a tangente de <@var="x">. Ver também <@ref="atan">, <@ref="cos">, <@ref="sin">.

# tanh math
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar, série ou matriz)

Retorna a tangente hiperbólica de <@var="x">.

Ver também <@ref="atanh">, <@ref="cosh">, <@ref="sinh">.

# tdisagg transforms
Resultado: 	matriz
Argumentos:	<@var="Y">  (série ou matriz)
		<@var="X">  (série, lista ou matriz, opcional)
		<@var="s">  (escalar)
		<@var="opções">  (lote, opcional)
		<@var="resultados">  (lote, opcional)

Produz desagregação temporal (conversão para maior frequência) da série temporal em <@var="Y">. O argumento <@var="s"> fornece o factor de expansão (por exemplo, 3 de trimestral para mensal). O argumento <@var="X"> pode conter uma ou mais covariáveis na frequência maior para auxiliar na desagregação. Podem ser passadas diversas opções em <@var="opções">, e os detalhes da desagregação podem ser obtidos por via nos <@var="resultados">.

Ver mais detalhes em <@pdf="guia de utilização do Gretl#chap:tdisagg"> (Capítulo 9).

# toepsolv linalg
Resultado: 	vetor coluna
Argumentos:	<@var="c">  (vetor)
		<@var="r">  (vetor)
		<@var="b">  (vetor)

Resolve um sistema de Toeplitz de equações lineares, isto é <@mth="Tx = b"> onde <@mth="T "> é uma matriz quadrada cujo elemento <@mth="T"><@sub="i,j"> é igual a <@mth="c"><@sub="i-j"> para <@mth="i>=j"> e <@mth="r"><@sub="j-i"> para <@mth="i<=j">. Note que os primeiros elementos de <@mth="c"> e <@mth="r"> precisam ser iguais, caso contrário um erro é retornado. Se executada com sucesso, a função retorna o vetor <@mth="x">.

O algoritmo utilizado por esta função se aproveita da estrutura especial que a matriz <@mth="T"> possui, o que o torna bem mais eficiente que outros algoritmos não especializados, em especial para grandes problemas. Atenção! Em certos casos a função pode, de forma espúria, emitir uma mensagem apontando que a matriz tem problemas de singularidade quando na verdade <@mth="T"> é não-singular. Este problema, entretanto, não pode ocorrer quando <@mth="T"> é definida positiva.

# tolower strings
Resultado: 	texto
Argumento: 	<@var="s">  (texto)

Retorna uma cópia de <@var="s"> na qual todos os caracteres maiúsculos são convertidos em minúsculos.

Exemplos:

<code>
        string s1 = "Hello, Gretl!"
        string s2 = tolower(s1)
        print s2

        string s3 = tolower("Hello, Gretl!")
        print s3
</code>

# toupper strings
Resultado: 	texto
Argumento: 	<@var="s">  (texto)

Retorna uma cópia de <@var="s"> na qual todos os caracteres minúsculos são convertidos em maiúsculos.

Exemplos:

<code>
        string s1 = "Hello, Gretl!"
        string s2 = toupper(s1)
        print s2

        string s3 = toupper("Hello, Gretl!")
        print s3
</code>

# tr linalg
Resultado: 	escalar
Argumento: 	<@var="A">  (matriz quadrada)

Retorna o traço de uma matriz quadrada <@var="A">, isto é, a soma dos elementos de sua diagonal. Ver também <@ref="diag">.

# transp linalg
Resultado: 	matriz
Argumento: 	<@var="X">  (matriz)

Retorna a transposta de <@var="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: <@lit="X'">.

# trimr matrix
Resultado: 	matriz
Argumentos:	<@var="X">  (matriz)
		<@var="ttop">  (número inteiro)
		<@var="tbot">  (número inteiro)

Retorna uma cópia da matriz <@var="X"> com <@var=" ttop"> linhas superiores excluídas e <@var="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 <@var="X">.

Ver também <@ref="selifr">.

# typeof data-utils
Resultado: 	número inteiro
Argumento: 	<@var="name">  (texto)

Retorna o código numérico de tipo se <@var="name"> for o identificador de um objeto definido: 1 para escalar, 2 para série, 3 para matriz, 4 para texto (string), 5 para pacote (bundle), 6 para arranjo (array) e 7 para lista. Caso contrário retorna 0. A função <@ref="typestr"> pode ser utilizada para obter o nome do objeto que corresponde ao código numérico.

Essa função também pode ser utilizada para obter o tipo de um membro de um pacote ou de um elemento de um arranjo. Por exemplo:

<code>
     matrices M = array(1)
     eval typestr(typeof(M))
     eval typestr(typeof(M[1]))
</code>

O primeiro resultado do comando <@lit="eval"> é “array ” e o segundo é “matrix”.

# typestr data-utils
Resultado: 	texto
Argumento: 	<@var="typecode">  (número inteiro)

Retorna o nome do tipo de dado correspondente a <@var="typecode">. Pode ser utilizada em conjunto com as funções <@ref="typeof"> e <@ref="inbundle">. O valor retornado pode ser “scalar”, “series”, “matrix”, “string”, “bundle”, “array” ou “null”.

# uniform probdist
Resultado: 	série
Argumentos:	<@var="a">  (escalar)
		<@var="b">  (escalar)

Cria uma variável pseudo-aleatória uniforme no intervalo (<@var=" a">, <@var="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 <@bib="Saito and Matsumoto (2008);saito_matsumoto08">.

Ver também <@ref="randgen">, <@ref="normal">, <@ref="mnormal">, <@ref="muniform">.

# uniq stats
Resultado: 	vetor coluna
Argumento: 	<@var="x">  (série ou vetor)

Retorna um vetor contendo os elementos distintos de <@var="x "> de forma não ordenada, mas na ordem em que aparecem em <@var="x">. Veja <@ref="values"> para a variante desta função que retorna os valores ordenados.

# unvech matrix
Resultado: 	matriz quadrada
Argumento: 	<@var="v">  (vetor)

Retorna uma matriz simétrica de ordem <@itl="n">×<@itl="n"> rearranjando os elementos de <@mth="v">. O número de elementos de <@mth="v"> deve ser um inteiro triangular, ou seja, um número <@mth="k"> tal que exista um inteiro <@mth="n"> que tenha a seguinte propriedade: <@mth="k = n(n+1)/2">. Esta função é a inversa de <@ref="vech">.

Ver também <@ref="mshape">, <@ref="vech">.

# upper matrix
Resultado: 	matriz quadrada
Argumento: 	<@var="A">  (matriz quadrada)

Retorna uma matriz triangular superior de ordem <@itl="n">×<@itl="n">. Os elementos da diagonal e acima desta são iguais aos elementos correspondentes de <@var="A"> e os demais iguais a zero.

Ver também <@ref="lower">.

# urcpval probdist
Resultado: 	escalar
Argumentos:	<@var="tau">  (escalar)
		<@var="n">  (número inteiro)
		<@var="niv">  (número inteiro)
		<@var="itv">  (número inteiro)

<@mth="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 <@bib="James MacKinnon (1996);mackinnon96">.

Os argumentos dessa função são: <@var="tau"> representa a estatística de teste; <@var="n"> representa o número de observações (ou 0 para um resultado assintótico); <@var="niv"> representa o número de variáveis potencialmente cointegradas quando se estiver testando a cointegração (ou 1 para testes univariados de raiz unitária) e; <@var="itv"> é um código para a especificação do modelo: 1 para teste sem constante, 2 para teste com constante, 3 para teste com contante e tendência linear, 4 para teste com constante e tendência quadrática.

Note que se a regressão de teste for “aumentada” com defasagens da variável dependente, então será necessário fornecer um valor <@var="n"> igual a 0 para obter resultados assintóticos.

Ver também <@ref="pvalue">, <@ref="qlrpval">.

# values stats
Resultado: 	vetor coluna
Argumento: 	<@var="x">  (série ou vetor)

Retorna um vetor contendo os elementos distintos de <@var="x"> ordenados de forma ascendente. Caso deseje truncar a parte decimal antes de aplicar a função, utilize a expressão <@lit="values(int(x))">.

Ver também <@ref="uniq">, <@ref="dsort">, <@ref="sort">.

# var stats
Resultado: 	escalar ou série
Argumento: 	<@var="x">  (série ou lista)

Se <@var="x"> for uma série, retorna a variância amostral na forma de um escalar, ignorando quaisquer observações ausentes.

Se <@var="x"> for uma lista, retorna uma série <@mth="y"> tal que <@mth="y"><@sub="t"> é a variância amostral dos valores das variáveis na lista na observação <@mth="t">, ou <@lit="NA"> se existir algum valor ausente em <@mth="t">.

Em cada caso, a soma dos desvios ao quadrado em relação à média é dividido por (<@mth="n"> – 1) para <@mth="n"> > 1. Caso contrário, a variância é igual a zero se <@mth="n "> = 1, ou é <@lit="NA"> se <@mth="n"> = 0.

Ver também <@ref="sd">.

# varname strings
Resultado: 	texto
Argumento: 	<@var="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 <@var="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 <@ref="varnames">.

Exemplo:

<code>
        open broiler.gdt
        string s = varname(7)
        print s
</code>

# varnames strings
Resultado: 	cadeia de texto
Argumento: 	<@var="L">  (lista)

Retorna um arranjo (array) de textos (string) contendo os nomes das variáveis na lista <@var="L">. Se a lista for vazia será retornado um arranjo vazio.

Exemplo:

<code>
        open keane.gdt
        list L = year wage status
        strings S = varnames(L)
        eval S[1]
        eval S[2]
        eval S[3]
</code>

# varnum data-utils
Resultado: 	número inteiro
Argumento: 	<@var="varname">  (texto)

Retorna o número ID da variável <@var="varname"> ou NA se a variável não existir.

# varsimul timeseries
Resultado: 	matriz
Argumentos:	<@var="A">  (matriz)
		<@var="U">  (matriz)
		<@var="y0">  (matriz)

Simula um VAR de ordem <@mth="p"> com <@mth="n"> variáveis, ou seja, <@mth="y(t) = A1 y(t-1) + ... + Ap y(t-p) + u(t)."> A matriz de coeficientes <@var="A"> é composta através do empilhamento das matrizes <@mth="A"><@sub="i"> horizontalmente, e tem ordem <@itl="n">×<@itl="np">, com uma linha por equação. Isso corresponde as primeiras <@mth="n"> linhas da matriz companheira, acessada via <@lit="$compan"> após o uso dos comandos <@lit="var"> e <@lit="vecm">.

Os vetores <@mth="u_t"> estão contidos (como linhas) em <@var=" U"> (<@itl="T">×<@itl="n">). Valores iniciais estão contidos em <@var="y0"> (<@itl="p">×<@itl="n">).

Se o VAR contiver termos determinísticos e/ou regressores exógenos, estes podem ser incluídos na matriz <@var="U">. Cada linha de <@var="U"> passa a incluir esses termos, ou seja, <@mth="u(t) = B'x(t) + e(t).">

A matriz de saída tem <@mth="T"> + <@mth="p"> linhas e <@mth="n"> colunas e armazena os <@mth="p"> valores iniciais das variáveis endógenas mais <@mth="T"> valores simulados.

Ver também <@ref="$compan">, <@xrf="var">, <@xrf="vecm">.

# vec matrix
Resultado: 	vetor coluna
Argumento: 	<@var="X">  (matriz)

Empilha as colunas de <@var="X"> como um vetor coluna. Ver também <@ref="mshape">, <@ref="unvech">, <@ref="vech">.

# vech matrix
Resultado: 	vetor coluna
Argumento: 	<@var="A">  (matriz quadrada)

Retorna em um vetor coluna os elementos de <@var="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 <@ref="unvech">. Ver também <@ref="vec">.

# weekday calendar
Resultado: 	o mesmo tipo que o argumento
Argumentos:	<@var="ano">  (escalar ou série)
		<@var="mês">  (escalar ou série)
		<@var="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 <@lit="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 transforms
Resultado: 	série
Argumentos:	<@var="Y">  (lista)
		<@var="W">  (lista)

Retorna uma série <@mth="y"> tal que <@mth="y"><@sub="t"> é a média ponderada dos valores das variáveis na lista <@var="Y"> na observação <@mth="t">, com os respectivos pesos dados pelos valores das variáveis na lista <@var="W"> em <@mth="t">. Os pesos podem assim variar no tempo. As listas <@var="Y"> e <@var="W"> devem ter o mesmo tamanho e os pesos devem ser não-negativos.

Ver também <@ref="wsd">, <@ref="wvar">.

# wsd transforms
Resultado: 	série
Argumentos:	<@var="Y">  (lista)
		<@var="W">  (lista)

Retorna uma série <@mth="y"> tal que <@mth="y"><@sub="t"> é o desvio padrão amostral ponderado dos valores das variáveis na lista <@var="Y"> na observação <@mth="t">, com os respectivos pesos dados pelos valores das variáveis na lista <@var="W"> em <@mth="t">. Os pesos podem assim variar no tempo. As listas <@var="Y"> e <@var="W"> devem ter o mesmo tamanho e os pesos devem ser não-negativos.

Ver também <@ref="wmean">, <@ref="wvar">.

# wvar transforms
Resultado: 	série
Argumentos:	<@var="X">  (lista)
		<@var="W">  (lista)

Retorna uma série <@mth="y"> tal que <@mth="y"><@sub="t"> é a variância amostral ponderada dos valores das variáveis na lista <@var="Y"> na observação <@mth="t">, com os respectivos pesos dados pelos valores das variáveis na lista <@var="W"> em <@mth="t">. Os pesos podem assim variar no tempo. As listas <@var="Y"> e <@var="W"> devem ter o mesmo tamanho e os pesos devem ser não-negativos.

Ver também <@ref="wmean">, <@ref="wsd">.

# xmax math
Resultado: 	escalar
Argumentos:	<@var="x">  (escalar)
		<@var="y">  (escalar)

Retorna o maior valor na comparação entre <@var="x"> e <@var="y">. Se algum dos valores for ausente será retornado <@lit="NA">.

Ver também <@ref="xmin">, <@ref="max">, <@ref="min">.

# xmin math
Resultado: 	escalar
Argumentos:	<@var="x">  (escalar)
		<@var="y">  (escalar)

Retorna o menor valor na comparação entre <@var="x"> e <@var="y">. Se algum dos valores for ausente será retornado <@lit="NA">.

Ver também <@ref="xmax">, <@ref="max">, <@ref="min">.

# xmlget data-utils
Resultado: 	texto
Argumentos:	<@var="buf">  (texto)
		<@var="path">  (texto ou cadeia de texto)

O argumento <@var="buf"> deve ser um buffer XML, que pode ser obtido de alguma página na internet via função <@ref="curl"> (ou lida a partir de arquivo via função <@ref="readfile">), e o argumento <@var="path"> deve ser uma especificação única ou um vetor de especificações.

Esta função retorna uma variável de texto (string) representando os dados encontrados no buffer XML no path especificado. Se múltiplos nós corresponderem com a expressão path, os itens dos dados são apresentados em linhas separadas no texto retornado. Se um vetor de paths for utilizado como segundo argumento, o texto retornado assume a forma de um buffer separado por vírgulas, com a coluna <@mth="i "> contendo as correspondências do path <@mth="i">. Nesse caso, se um texto obtido do buffer XML contiver quaisquer espaços ou vírgulas ela ficará entre aspas duplas.

Por padrão um erro é sinalizado se <@var="path"> não encontrar correspondência no buffer XML, mas esse comportamento é modificado se o terceiro argumento, que é opcional, for dado: nesse caso o argumento recupera o número de correspondências e uma variável de texto vazia é retornada caso não haja correspondências. Exemplo:

<code>
     ngot = 0
     ret = xmlget(xbuf, "//some/thing", &ngot)
</code>

Entretanto, um erro ainda é sinalizado no caso de uma consulta (query) mal formada.

Uma boa introdução sobre a utilização da sintaxe de XPath pode ser encontrada em <@url="https://www.w3schools.com/xml/xml_xpath.asp">. O backend para <@lit="xmlget"> é fornecido pelo módulo xpath do biblioteca libxml2 que, por sua vez, suporta o XPath 1.0 mas não o XPath 2.0.

Ver também <@ref="jsonget">, <@ref="readfile">.

# zeromiss transforms
Resultado: 	o mesmo tipo que o argumento
Argumento: 	<@var="x">  (escalar ou série)

Converte zeros para <@lit="NA">s. Se <@var="x"> for uma série a conversão será feita elemento por elemento. Ver também <@ref="missing">, <@ref="misszero">, <@ref="ok">.

# zeros matrix
Resultado: 	matriz
Argumentos:	<@var="r">  (número inteiro)
		<@var="c">  (número inteiro)

Retorna uma matriz nula com <@mth="r"> linhas e <@mth="c"> colunas. Ver também <@ref="ones">, <@ref="seq">.