dsp.ArrayVectorSubtractor

(To be removed) Subtract vector from array along specified dimension

dsp.ArrayVectorSubtractor will be removed in a future release. 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:

1. Define and set up your array-vector subtraction object. See Construction.

2. Call step to subtract the vector according to the properties of dsp.ArrayVectorSubtractor. The behavior of step 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('PropertyName',PropertyValue,...) returns an array-vector subtraction object, avs, with each property set to the specified value.

Properties

Dimension	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 0. The default is 1.
VectorSource	Source of vector Specify the source of the vector values as one of Input port or Property. The default is Input port.
Vector	Vector values Specify the vector values. This property applies when you set the VectorSource property to Property. The default is [0.5 0.25]. This property is tunable.

 Fixed-Point Properties

FullPrecisionOverride	Full precision override for fixed-point arithmetic Specify whether to use full precision rules. If you set FullPrecisionOverride to true, which is the default, the object computes all internal arithmetic and output data types using full precision rules. These rules provide the most accurate fixed-point numerics. It also turns off the display of other fixed-point properties because they do not apply individually. These rules guarantee that no quantization occurs within the object. Bits are added, as needed, to ensure that no roundoff or overflow occurs. If you set FullPrecisionOverride to false, fixed-point data types are controlled through individual fixed-point property settings. For more information, see Full Precision for Fixed-Point System Objects.
RoundingMethod	Rounding method for fixed-point operations Specify the rounding method as Ceiling, Convergent, Floor , Nearest, Round, Simplest, or Zero. This property applies only if the object is not in full precision mode.
OverflowAction	Overflow action for fixed-point operations Specify the overflow action as one of Wrap or Saturate. The default is Wrap. This property applies only if the object is not in full precision mode.
VectorDataType	Vector word and fraction lengths Specify the vector fixed-point data type as Same word length as input or Custom. This property applies when you set the VectorSource property to Property. The default is Same word length as input.
CustomVectorDataType	Vector word and fraction lengths Specify the vector fixed-point type as a numerictype (Fixed-Point Designer) object with a Signedness of Auto. This property applies when you set the VectorSource property to Property and the VectorDataType property to Custom. The default is numerictype([],16,15).
AccumulatorDataType	Accumulator word and fraction lengths Specify the accumulator fixed-point data type as one of Full precision , Same as first input, or Custom. The default is Full precision.
CustomAccumulatorDataType	Accumulator word and fraction lengths Specify the accumulator fixed-point type as a scaled numerictype (Fixed-Point Designer) object with a Signedness of Auto. This property applies when you set the AccumulatorDataType property to Custom. The default is numerictype([],32,30).
OutputDataType	Output word and fraction lengths Specify the output fixed-point data type as Same as accumulator, Same as first input, or Custom. The default is Same as accumulator.
CustomOutputDataType	Output word and fraction lengths Specify the output fixed-point type as a scaled numerictype (Fixed-Point Designer) object with a Signedness of Auto. This property applies when you set the OutputDataType property to Custom. The default is numerictype([],16,15).

Methods

step	Subtract vector from array along specified dimension

Common to All System Objects
release	Allow System object property value changes

Examples

Subtract Vector From Matrix

Note

If you are using R2016a or an earlier release, replace each call to the object with the equivalent step syntax. For example, obj(x) becomes step(obj,x).

avs = dsp.ArrayVectorSubtractor;
a = ones(2);
x = [1 2]';
y = avs(a, x)

y = 2×2

     0     0
    -1    -1

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.

Compatibility Considerations

dsp.ArrayVectorSubtractor System object will be removed

Not recommended starting in R2021a

dsp.ArrayVectorSubtractor System object will be removed in a future release. Use the – operator instead.

Update Code

This table shows how the System object is typically used and explains how to update existing code to use the – operator.

Discouraged Usage	Recommended Replacement
avs = dsp.ArrayVectorSubtractor; a = ones(2); x = [1 2]'; y = avs(a, x) y = 2×2 0 0 -1 -1 If you are using a release prior to R2016b, replace avs(a,x) with step(avs,a,x).	y = a - x y = 2×2 0 0 -1 -1

Extended Capabilities

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

Usage notes and limitations:

See System Objects in MATLAB Code Generation (MATLAB Coder).

Introduced in R2012a