dsp.ArrayVectorSubtractor
(Removed) Subtract vector from array along specified dimension
dsp.ArrayVectorSubtractor
has been removed. Use the
–
operator instead. For more information, see Compatibility Considerations.
Description
The ArrayVectorSubtractor
object subtracts a vector
from an N-D array along a specified dimension.
To subtract a vector from an N-D array along a specified dimension:
Define and set up your array-vector subtraction object. See Construction.
Call
step
to subtract the vector according to the properties ofdsp.ArrayVectorSubtractor
. The behavior ofstep
is specified 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.
Construction
avs = dsp.ArrayVectorSubtractor
returns an array-vector
subtraction object, avs
, that subtracts the elements
of a vector from an N-D input array along the first dimension.
avs = dsp.ArrayVectorSubtractor('
returns an array-vector subtraction object, PropertyName
',PropertyValue
,...)avs
, with
each property set to the specified value.
Properties
|
Dimension along which to subtract vector elements from input Specify the dimension along which to subtract the elements of the vector
from the input array as an integer-valued scalar greater than
|
|
Source of vector Specify the source of the vector values as one of |
|
Vector values Specify the vector values. This property applies when you set the
|
Methods
step | Subtract vector from array along specified dimension |
Common to All System Objects | |
---|---|
release | Allow System object property value changes |
Examples
Algorithms
This object implements the algorithm, inputs, and outputs described on the Array-Vector Subtract block reference page. The object properties correspond to the block parameters, except:
The array-vector subtraction object does not have Minimum or Maximum options for data output. |