PredictorMap class

Specification of a mapping for a predictor model.

Construction

• obj = PredictorMap(nY,nU)  constructs a mapping of dimensions $n_{Y}$ by $n_{U}$ .

Properties

• Variable

  character array	string

  Variable of transfer functions in predictor mapping. See documentation on the equivalent property in the transfer function object tf. 'z^-1' by default.

• Ts

  scalar

  Sample time of transfer functions in predictor mapping. See documentation on the equivalent property in the transfer function object tf. -1 by default

• isSymmetric

  scalar

  Indicates if mapping is symmetric, in which case all other (array) properties must be symmetric.

• s

  $[n_{Y},n_{U}]$ array

  Indicates interconnections. Elements can be either:

  • 0: No interconnection from element i to element j
  • 1: Interconnection from element i to element j

• p

  $[n_{Y},n_{U}]$ array

  Indicates which elements are free/parametrized during estimation. Elements can be either:

  • NaN: No interconnection from element i to element j.
  • 0: Fixed dynamics from element i to element j.
  • 1: Parametrized dynamics from element i to element j.

• f

  $[n_{Y},n_{U}]$ array

  Indicates which elements are fixed during estimation. Elements can be either:

  • NaN: No interconnection from element i to element j.
  • 0: Parametrized dynamics from element i to element j.
  • 1: Fixed dynamics from element i to element j.

• d

  $[n_{Y},n_{U}]$ integer array

  Number of delays of elements.

• monic

  $[n_{Y},n_{U}]$ array

  Indicates if the numerator of elements are monic (i.e. the first non-zero coefficient is equal to 1). Elements should be set to 1 if monic, and to 0 if not.

• e

  $[n_{Y},n_{U}]$ MIMO tf object

  Transfer functions of elements. This property is updated when npnum or npden are modified, but can also be modified directly. When npnum is updated, leading zeros are added to the numerator of the transfer function equal to the number of delays, and the first nonzero element is set to 1 for monic elements.

• pnum

  $[n_{Y},n_{U}]$ cell array of $[1,:]$ double arrays

  Parameter values of numerators of elements. Set this to specify the values of fixed elements and initial values of parametrized elements. The transfer functions in the e property are updated, taking into account the d and monic properties.

• pden

  $[n_{Y},n_{U}]$ cell array of $[1,:]$ double arrays

  Parameter values of denominators of elements. Set this to specify the values of fixed elements and initial values of parametrized elements. The transfer functions in the e property are updated.

• npnum

  $[n_{Y},n_{U}]$ integer array

  Number of numerator parameters of elements. Increasing elements of this array pads the corresponding elements of pnum with zeros to the desired array length, whereas decreasing these elements truncates the corresponding elements of pnum.

• npden

  $[n_{Y},n_{U}]$ integer array

  Number of denominator parameters of elements. Increasing elements of this array pads the corresponding elements of pden with zeros to the desired array length, whereas decreasing these elements truncates the corresponding elements of pden.

Methods