expressions/@xltv/props.txt

   1 Help on properties of the linear time-variant expression class (pfltv).\r
   2 \r
   3 'expression'\r
   4 The expression supplied by the user.\r
   5 \r
   6 'str'\r
   7 A string representing the expression.\r
   8 \r
   9 'exprsize'\r
  10 The size of the expression, [m n], where m is the number of rows and n is the number of columns\r
  11 of the generated output. A 0 means that the particular size couldn't be determined and has to be set manually, if\r
  12 this property is needed (which isn't the case most of the time).\r
  13 \r
  14 'gradx'\r
  15 The gradient of the expression with respect to x.\r
  16 \r
  17 'gradw'\r
  18 The gradient of the expression with respect to w.\r
  19 \r
  20 'xvars'\r
  21 A cell array containing the names of the states.\r
  22 Not used in this class and just included for consistency.\r
  23 \r
  24 'uvars'\r
  25 A cell array containing the name of the elements forming u(t).\r
  26 Not used in this class and just included for consistency.\r
  27 \r
  28 'wvars'\r
  29 A cell array containing the name of the elements forming w(t).\r
  30 Not used in this class and just included for consistency.\r
  31 \r
  32 'islinear'\r
  33 Is true for linear expressions and false otherwise.\r
  34 Since this class is linear, this property is set to 'true'.\r
  35 \r
  36 'evalvar'\r
  37 Some data objects, such as pfltv that use matrix multiplication, don't support\r
  38 xvars, uvars and wvars. These objects need to know what variable(s) to use in the\r
  39 evaluation. 'evalvar' contains this information. The variables x, t, w and u\r
  40 are represented by the numbers 1, 2, 3 and 4 respectively.\r
  41 evalvar=1 means that x will be used in the evaluation.\r
  42 evalvar=[1 3] means that [x; u] will be used (x and u are, like always,\r
  43 row vectors or scalars).\r
  44 Example - the eval command of pfltv ('expression' is a matrix):\r
  45 evalvar=1 returns expression*x\r
  46 evalvar=[1 4 3] returns expression*[x; w; u]\r
  47 Note that pfltv doesn't support empty evalvar vectors. For that\r
  48 kind of functionallity, see pfarray.\r
  49 \r
  50 'varsize'\r
  51 Only needed when evaluating multiple variables, ie when 'evalvar' is a vector.\r
  52 When differentiating an expression based on multiple variables, we need to know\r
  53 the size of each variable (column vector) in order to extract the right columns of the\r
  54 matrix. 'varsize' must be a vector of 4 elements representing the size of\r
  55 [x t u w]. Not that if a particular variable isn't evaluated (ie its index is\r
  56 not present in the evalvar vector), its size does not matter and can be set to 0.\r
  57 Example: x=[1 2 3]', w=[1 2]', u=3 and evalvar=[1 4 3], the 'varsize' argument\r
  58 must be set to [3 x 2 1], where x can be anything (preferably 1, since t is always\r
  59 a scalar).\r
  60 The gradient with respect to w will be a 6x6 matrix where column 4 and 5 will be\r
  61 extracted from the expression matrix, and the remaining columns will contain zeros.\r
  62 \r
  63 'description'\r
  64 A short description of the object.\r