gsi.diagExtract         package:compositions         R Documentation

_I_n_t_e_r_n_a_l _f_u_n_c_t_i_o_n_s: _G_e_t _t_h_e _d_i_a_g_o_n_a_l _o_f _a _m_a_t_r_i_x

_D_e_s_c_r_i_p_t_i_o_n:

     Get the main diagonal of a matrix, even if the matrix is 1x1.

_U_s_a_g_e:

     gsi.diagExtract(x)

_A_r_g_u_m_e_n_t_s:

       x: a matrix

_D_e_t_a_i_l_s:

     The difference to original 'diag' is that it always gives the
     diagonal and does nothing flawed in case of a 1x1 matrix or a
     single number considered as such matrix.

_V_a_l_u_e:

     a vector containing the main diagonal entries of x.

_N_o_t_e:

     Do not use gsi.* functions directly since they are internal
     functions of the package

_S_e_e _A_l_s_o:

     'gsi.diagGenerate', 'diag'

_E_x_a_m_p_l_e_s:

     data(SimulatedAmounts)
     gsi.diagExtract(var(acomp(sa.lognormals,c(1,2))))
     gsi.diagExtract(var(ilr(acomp(sa.lognormals,c(1,2)))))
     gsi.diagExtract(var(ilt(aplus(sa.lognormals,c(1)))))

