(To be removed) Add array to vector along specified dimension
dsp.ArrayVectorAdder
will be removed in a future release. Use the
+
operator instead. For more information, see Compatibility Considerations.
The ArrayVectorAdder
object adds an N-D array to a
vector along a specified dimension. The length of the vector must equal the size of the
N-D array along the specified dimension.
To add an N-D array to a vector along a specified dimension:
Define and set up your array-vector addition object. See Construction.
Call step
to add the N-D array according
to the properties of dsp.ArrayVectorAdder
. The
behavior of step
is specific to each object in
the toolbox.
Note
Starting in R2016b, instead of using the step
method to perform the operation defined by the System object™, you can call the object with arguments, as if it were a function. For
example, y = step(obj,x)
and y = obj(x)
perform equivalent operations.
ava = dsp.ArrayVectorAdder
returns an array-vector addition
object, ava
, that adds a vector to an N-D array along
the first dimension.
ava = dsp.ArrayVectorAdder('
returns an array-vector addition object, PropertyName
',PropertyValue
,
...)ava
, with
each property set to the specified value.
|
Dimension along which to add vector elements to input Specify the dimension along which to add the input array to the elements
of the vector as a positive integer. The length of the vector must match the
size of the N-D array along the specified dimension. The default is
|
|
Source of vector Specify the source of the vector values as | |
|
Vector values Specify the vector values. This property applies only when you set the
|
step | Add vector to N-D array |
Common to All System Objects | |
---|---|
release | Allow System object property value changes |
This object implements the algorithm, inputs, and outputs described on the Array-Vector Add block reference page. The object properties correspond to the block parameters, except:
The array-vector addition object does not have Minimum or Maximum options for data output. |