expressions/@xltv/xltv.m

   1 function obj=xltv(varargin)\r
   2 % Holds an 3d array 2d matrices which forms linear expressions.\r
   3 %\r
   4 % Syntax: (* = optional)\r
   5 %\r
   6 % obj = xltv(expression, Ts*, evalvar*, varsize*, interpolate*);\r
   7 %\r
   8 % In arguments:\r
   9 %\r
  10 % 1. array\r
  11 %       Data array containing expressions.\r
  12 % 2* Ts\r
  13 %       Sample point vector\r
  14 % 2* []\r
  15 %       'Ts' is set to [0:size(array,3)-1]\r
  16 % 3* evalvar\r
  17 %       Some data objects, such as xltv that use matrix multiplication, don't support\r
  18 %       xvars, uvars and wvars. These objects need to know what variable(s) to use in the\r
  19 %       evaluation. 'evalvar' contains this information. The variables x, t, w and u\r
  20 %       are represented by the numbers 1, 2, 3 and 4 respectively.\r
  21 %       evalvar=1 means that x will be used in the evaluation.\r
  22 %       evalvar=[1 3] means that [x; u] will be used (x and u are, like always,\r
  23 %       row vectors or scalars).\r
  24 %       Example - the eval command of xltv ('expression' is a matrix):\r
  25 %       evalvar=1 returns expression*x\r
  26 %       evalvar=[1 4 3] returns expression*[x; w; u]\r
  27 %       Note that xltv doesn't support empty evalvar vectors. For that\r
  28 %       kind of functionallity, see xtable.\r
  29 % 3* []\r
  30 %       'evalvar' will be set to 1, ie x will be multiplied to the right when evaluating.\r
  31 % 4* varsize\r
  32 %       Only needed when evaluating multiple variables, ie when 'evalvar' is a vector.\r
  33 %       When differentiating an expression based on multiple variables, we need to know\r
  34 %       the size of each variable (column vector) in order to extract the right columns of the\r
  35 %       matrix. 'varsize' must be a vector of 4 elements representing the size of\r
  36 %       [x t u w]. Not that if a particular variable isn't evaluated (ie its index is\r
  37 %       not present in the evalvar vector), its size does not matter and can be set to 0.\r
  38 %       Example: x=[1 2 3]', w=[1 2]', u=3 and evalvar=[1 4 3], the 'varsize' argument\r
  39 %       must be set to [3 x 2 1], where x can be anything (preferably 1, since t is always\r
  40 %       a scalar).\r
  41 %       The gradient with respect to w will be a 6x6 matrix where column 4 and 5 will be\r
  42 %       extracted from the expression matrix, and the remaining columns will contain zeros.\r
  43 % 4* []\r
  44 %       All columns in the expression matrix will be treated equally when differentiating.\r
  45 % 5* interpolate\r
  46 %       Sets linear interpolation on=true or off=false.\r
  47 % 5* []\r
  48 %       'interpolate' is set to false, ie interpolation is turned off.\r
  49 %\r
  50 % Out arguments:\r
  51 %\r
  52 % 1. obj\r
  53 %       The resulting data object.\r
  54 \r
  55 % Toolbox for nonlinear filtering.\r
  56 % Copyright (C) 2005  Jakob Rosén <jakob.rosen@gmail.com>\r
  57 %\r
  58 % This program is free software; you can redistribute it and/or\r
  59 % modify it under the terms of the GNU General Public License\r
  60 % as published by the Free Software Foundation; either version 2\r
  61 % of the License, or (at your option) any later version.\r
  62 %\r
  63 % This program is distributed in the hope that it will be useful,\r
  64 % but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  65 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  66 % GNU General Public License for more details.\r
  67 %\r
  68 % You should have received a copy of the GNU General Public License\r
  69 % along with this program; if not, write to the Free Software\r
  70 % Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.\r
  71  \r
  72 if nargin==0\r
  73         % Empty constructor\r
  74         array=[];\r
  75 elseif isa(varargin{1},'xltv')\r
  76         % Copy constructor\r
  77         obj = varargin{1};\r
  78         return;                 %Exit\r
  79 else\r
  80         array=varargin{1};\r
  81 end;\r
  82 \r
  83 % Declare the arguments\r
  84 Ts=[];\r
  85 evalvar=[];\r
  86 varsize=[];\r
  87 interpolate=[];\r
  88 \r
  89 % Fetch arguments, if they exist\r
  90 if nargin>=2; Ts=varargin{2}; end;\r
  91 if nargin>=3; evalvar=varargin{3}; end;\r
  92 if nargin>=4; varsize=varargin{4}; end;\r
  93 if nargin>=5; interpolate=varargin{5}; end;\r
  94 \r
  95 if isempty(Ts)\r
  96         if length(array)\r
  97                 Ts=[0:size(array,3)-1];         % Ts default\r
  98         end\r
  99 end\r
 100 \r
 101 if isempty(evalvar)\r
 102         evalvar=1;      % evalvar default = use x as multiplicator\r
 103 end;\r
 104 \r
 105 if isempty(varsize)\r
 106         varsize=[0 0 0 0];      % x t u w\r
 107 end;\r
 108 \r
 109 if isempty(interpolate)\r
 110         interpolate=false;      % interpolate default\r
 111 end;\r
 112 \r
 113 exprsize=[size(array,1), size(array,2)];\r
 114 \r
 115 if length(array)\r
 116         if size(Ts)~=size(array,3)\r
 117                 error('''Ts'' and ''array'' do not match');\r
 118         end\r
 119 end\r
 120 \r
 121 \r
 122 if size(varsize,1)~=1||size(varsize,2)~=4\r
 123         error('''varsize'' must be a row vector of size 4.');\r
 124 end\r
 125 \r
 126 \r
 127 obj.array=array;\r
 128 obj.str='No string representation';\r
 129 obj.exprsize=exprsize;\r
 130 obj.Ts=Ts;\r
 131 obj.gradx=[];\r
 132 obj.gradw=[];\r
 133 obj.xvars={};\r
 134 obj.uvars={};\r
 135 obj.wvars={};\r
 136 obj.islinear=true;    \r
 137 obj.evalvar=evalvar;\r
 138 obj.varsize=varsize;\r
 139 obj.wchar='w';\r
 140 obj.interpolate=interpolate;\r
 141 obj.description='Linear time-variant (LTV) expression';\r
 142 obj.gradx_idxstart=[];          % PRIVATE\r
 143 obj.gradx_idxlength=[];         % PRIVATE!\r
 144 obj.gradw_idxstart=[];          % PRIVATE\r
 145 obj.gradw_idxlength=[];         % PRIVATE!\r
 146 obj=class(obj,'xltv');\r