help/memsize

   1 NAME
   2     memsize - number of bytes required for value including overhead
   3
   4 SYNOPSIS
   5     memsize(x)
   6
   7 TYPES
   8     x           any
   9
  10     return      integer
  11
  12 DESCRIPTION
  13     This is analogous to the C operator sizeof.  It attempts to assess
  14     the number of bytes in memory used to store a value and all its
  15     components plus all of the related structue overhead.  Unlike
  16     sizeof(x), this builtin includes overhead.
  17
  18     Unlike size(x), this builtin incldues the trailing \0 byte on the
  19     end of strings.
  20
  21     Unlike sizeof(x), this builtin includes the size demonitor for integers
  22     and the imaginary part for complex values.  Storage for holding
  23     0, 1 and -1 values are also included.
  24
  25     The number returned by memsize(x) may be less than the actual number
  26     used because, for example, more memory may have been allocated for
  27     a string than is used: only the characters up to and including the
  28     first '\0' are counted in calculating the contribution of the
  29     string to memsize(x).
  30
  31     The number returned by memsize(x) may be greater (and indeed
  32     substantially greater) than the number of bytes actually used.
  33     For example, after:
  34
  35                 a = sqrt(2);
  36                 mat A[3] = {a, a, a};
  37
  38     the numerical information for a, A[0], A[1], A[2] are stored in the
  39     same memory, so the memory used for A is the same as if
  40     its 3 elements were null values.  The value returned by
  41     memsize(A) is calculated as A were defined by:
  42
  43                 mat A[3] = {sqrt(2), sqrt(2), sqrt(2)}.
  44
  45     Similar sharing of memory occurs with literal strings.
  46
  47     For associative arrays, both the name part and the value part of
  48     the name/value pair are counted.
  49
  50     The minimum value for memsize(x) occurs for the null and error values.
  51
  52 EXAMPLES
  53
  54     The results for examples like these will depend to some extent on
  55     the system being used.  The following were for an SGI R4k machine
  56     in 32-bit mode:
  57
  58     > print memsize(null())
  59     8
  60
  61     > print memsize(0), memsize(3), memsize(2^32 - 1), memsize(2^32)
  62     68 68 68 72
  63
  64     > x = sqrt(2, 1e-100); print memsize(x), memsize(num(x)), memsize(den(x))
  65     148 108 108
  66
  67     > print memsize(list()), memsize(list(1)), memsize(list(1,2))
  68     28 104 180
  69
  70     > print memsize(list())
  71     28
  72
  73     > print ,memsize(list(1)),memsize(list(1,2)),memsize(list(1,2,3))
  74     104 180 256
  75
  76     > mat A[] = {1}; mat B[] = {1,2}; mat C[] = {1,2,3}; mat D[100,100];
  77     > print memsize(A), memsize(B), memsize(C), memsize(D)
  78     124 192 260 680056
  79
  80     > obj point {x,y,z}
  81     > obj point P = {1,2,3}; print memsize(P)
  82     274
  83
  84 LIMITS
  85     It is assumed memsize(x) will fit into a system long integer.
  86
  87 LINK LIBRARY
  88     none
  89
  90 SEE ALSO
  91     size, sizeof, fsize, strlen, digits
  92