Documentation for Eidos function defineConstant
, 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_defineConstant(symbol, value)
An object of type string or any. Must be of length 1 (a singleton). See details for description.
An object of type string or any. See details for description.
An object of type void.
Documentation for this function can be found in the official SLiM manual: page NA.
Defines a new constant with the name symbol and the value specified by value. The name cannot previously be defined in any way (i.e., as either a variable or a constant). The defined constant acts identically to intrinsic Eidos constants such as T, NAN, and PI, and will remain defined for as long as the Eidos context lives even if it is defined inside a block being executed by executeLambda(), apply(), sapply(), or a Context-defined script block. Syntactically, value may be any value at all; semantically, however, if value is of object type then value's class must be under an internal memory-management scheme called "retain-release". Objects that are not under retain-release can cease to exist whenever the Context is finished using them, and thus a defined constant referencing such an object could become invalid, which must be prevented. Objects that are under retain-release will not cease to exist if they are referenced by a global constant; the reference to them from the global constant "retains" them and keeps them in existence. All object classes built into Eidos are under retain-release; see the SLiM manual (section "SLiM scoping rules") for discussion of which SLiM object classes are under retain-release. Section 4.5 of this manual discusses this topic further.
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_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_usage()
,
eidos_var()
,
eidos_version()
,
eidos_whichMax()
,
eidos_whichMin()
,
eidos_which()
,
eidos_writeFile()
,
eidos_writeTempFile()