Function reference • gips

Main functions

Functions for the main gips purpose: Finding the permutation under which a matrix is (approximately) invariant and estimating the covariance matrix.

gips() new_gips() validate_gips(): The constructor of a gips class.

find_MAP(): Find the Maximum A Posteriori Estimation

project_matrix(): Project matrix after optimization

Diagnostics

Functions for diagnostics of the gips optimization process or its results.

plot(<gips>): Plot optimized matrix or optimization gips object

print(<gips>): Printing gips object

summary(<gips>) print(<summary.gips>): Summarizing the gips object

compare_posteriories_of_perms() compare_log_posteriories_of_perms(): Compare the posteriori probabilities of 2 permutations

AIC(<gips>) BIC(<gips>): Akaike's An Information Criterion for gips class

logLik(<gips>): Extract the Log-Likelihood for gips class

Helper functions

Functions for pleasant work in gips.

as.character(<gips>): Transform the gips object to a character vector

gips_perm() new_gips_perm() validate_gips_perm(): Permutation object

print(<gips_perm>): Printing gips_perm object

as.character(<gips_perm>): Transform the gips_perm object to a character vector

forget_perms(): Forget the permutations for gips object optimized with save_all_perms = TRUE

get_probabilities_from_gips(): Extract probabilities for gips object optimized with return_probabilities = TRUE

Internal functions

Functions for internal calculations

log_posteriori_of_gips(): A log of a posteriori that the covariance matrix is invariant under permutation

prepare_orthogonal_matrix(): Prepare orthogonal matrix

get_structure_constants(): Get Structure Constants

calculate_gamma_function(): Calculate Gamma function