Documentation for Eidos function usage, which is a method of
Eidos.
Note that the R function is a stub, it does not do anything in R (except bring
up this documentation). It will only do
anything useful when used inside a slim_block function further
nested in a slim_script
function call, where it will be translated into valid SLiM code as part of a
full SLiM script.
eidos_usage(type)An object of type logical or string. Must be of length 1 (a
singleton). The default value is "rss". See details for description.
An object of type float. Return will be of length 1 (a singleton)
Documentation for this function can be found in the official SLiM manual: page NA.
Returns the memory usage. This is the amount of memory used by the current process, in MB (megabytes); multiply by 1024*1024 to get the usage in bytes. Memory usage is a surprisingly complex topic. One metric reported by usage() is the resident set size, or RSS, which includes memory usage from shared libraries, but does not include memory that is swapped out or has never been used. For most purposes, RSS is a useful metric of memory usage from a practical perspective. On some platforms (AIX, BSD, Solaris) the memory usage reported may be zero, but it should be correct on both macOS and Linux platforms. On macOS, memory pages that have not been used for a while may get compressed by the kernel to reduce the RSS of the process; the RSS metric reported by usage() will reflect the compressed size of such pages, not their original size, so surprising decreases in memory usage may be observed when the kernel decides to compress some memory pages. The RSS is requested with a type of "rss", which is the default; for historical reasons, it can also be requested with a type of F. Another metric reported by usage() is the peak RSS. This is just the highest RSS value that has ever been recorded by the kernel. It should generally mirror the behavior of RSS, except that it ratchets upward monotonically. The peak RSS is requested with a type of "rss_peak"; for historical reasons, it can also be requested with a type of T. The third metric currently reported by usage() is the virtual memory usage. This is essentially the amount of memory used by pages that have been assigned to the process, whether those pages are resident, compressed, or swapped. It is typically much larger than the RSS, because it includes various types of memory that are not counted in the RSS; indeed, for some system configurations the virtual memory usage can be reported as being the entire memory space of the computer. Whether it is a useful metric will be platform-dependent; caveat emptor. This function can be useful for documenting the memory usage of long runs as they are in progress. In SLiM, the RSS could also be used to trigger tree-sequence simplification with a call to treeSeqSimplify(), to reduce memory usage when it becomes too large, but keep in mind that the simplification process itself may cause a substantial spike in memory usage, and that page compression and swaps may reduce the RSS even though the memory actually used by tree-sequence recording continues to increase. When running under SLiM, other tools for monitoring memory usage include the slim command-line options -m[em] and -M[emhist], and the usage() and outputUsage() methods of Community; see the SLiM manual for more information.
This is documentation for a function in the SLiM software, and has been reproduced from the official manual, which can be found here: http://benhaller.com/slim/SLiM_Manual.pdf. This documentation is Copyright © 2016-2020 Philipp Messer. All rights reserved. More information about SLiM can be found on the official website: https://messerlab.org/slim/
Other Eidos:
Eidos,
eidos_abs(),
eidos_acos(),
eidos_all(),
eidos_any(),
eidos_apply(),
eidos_array(),
eidos_asFloat(),
eidos_asInteger(),
eidos_asLogical(),
eidos_asString(),
eidos_asin(),
eidos_assert(),
eidos_atan2(),
eidos_atan(),
eidos_beep(),
eidos_catn(),
eidos_cat(),
eidos_cbind(),
eidos_ceil(),
eidos_citation(),
eidos_clock(),
eidos_cmColors(),
eidos_color2rgb(),
eidos_colors(),
eidos_cor(),
eidos_cos(),
eidos_cov(),
eidos_createDirectory(),
eidos_cumProduct(),
eidos_cumSum(),
eidos_c(),
eidos_date(),
eidos_dbeta(),
eidos_debugIndent(),
eidos_defineConstant(),
eidos_defineGlobal(),
eidos_deleteFile(),
eidos_dexp(),
eidos_dgamma(),
eidos_diag(),
eidos_dim(),
eidos_dmvnorm(),
eidos_dnorm(),
eidos_drop(),
eidos_elementType(),
eidos_exists(),
eidos_exp(),
eidos_fileExists(),
eidos_filesAtPath(),
eidos_findInterval(),
eidos_float(),
eidos_floor(),
eidos_flushFile(),
eidos_format(),
eidos_functionSignature(),
eidos_functionSource(),
eidos_getSeed(),
eidos_getwd(),
eidos_heatColors(),
eidos_hsv2rgb(),
eidos_identical(),
eidos_ifelse(),
eidos_integerDiv(),
eidos_integerMod(),
eidos_integer(),
eidos_isFinite(),
eidos_isFloat(),
eidos_isInfinite(),
eidos_isInteger(),
eidos_isLogical(),
eidos_isNAN(),
eidos_isNULL(),
eidos_isObject(),
eidos_isString(),
eidos_length(),
eidos_license(),
eidos_log10(),
eidos_log2(),
eidos_logical(),
eidos_log(),
eidos_lowerTri(),
eidos_ls(),
eidos_match(),
eidos_matrixMult(),
eidos_matrix(),
eidos_max(),
eidos_mean(),
eidos_min(),
eidos_nchar(),
eidos_ncol(),
eidos_nrow(),
eidos_object(),
eidos_order(),
eidos_paste0(),
eidos_paste(),
eidos_pmax(),
eidos_pmin(),
eidos_pnorm(),
eidos_print(),
eidos_product(),
eidos_qnorm(),
eidos_quantile(),
eidos_rainbow(),
eidos_range(),
eidos_rank(),
eidos_rbeta(),
eidos_rbind(),
eidos_rbinom(),
eidos_rcauchy(),
eidos_rdunif(),
eidos_readCSV(),
eidos_readFile(),
eidos_repEach(),
eidos_rep(),
eidos_rev(),
eidos_rexp(),
eidos_rf(),
eidos_rgamma(),
eidos_rgb2color(),
eidos_rgb2hsv(),
eidos_rgeom(),
eidos_rlnorm(),
eidos_rmvnorm(),
eidos_rm(),
eidos_rnbinom(),
eidos_rnorm(),
eidos_round(),
eidos_rpois(),
eidos_runif(),
eidos_rweibull(),
eidos_sample(),
eidos_sapply(),
eidos_sd(),
eidos_seqAlong(),
eidos_seqLen(),
eidos_seq(),
eidos_setDifference(),
eidos_setIntersection(),
eidos_setSeed(),
eidos_setSymmetricDifference(),
eidos_setUnion(),
eidos_setwd(),
eidos_sin(),
eidos_size(),
eidos_sortBy(),
eidos_sort(),
eidos_source(),
eidos_sqrt(),
eidos_stop(),
eidos_strcontains(),
eidos_strfind(),
eidos_string(),
eidos_strprefix(),
eidos_strsplit(),
eidos_strsuffix(),
eidos_str(),
eidos_substr(),
eidos_sumExact(),
eidos_sum(),
eidos_suppressWarnings(),
eidos_sysinfo(),
eidos_system(),
eidos_tabulate(),
eidos_tan(),
eidos_tempdir(),
eidos_terrainColors(),
eidos_time(),
eidos_trunc(),
eidos_ttest(),
eidos_type(),
eidos_t(),
eidos_unique(),
eidos_upperTri(),
eidos_var(),
eidos_version(),
eidos_whichMax(),
eidos_whichMin(),
eidos_which(),
eidos_writeFile(),
eidos_writeTempFile()