dsp.ArrayVectorDivider

(To be removed) Divide array by vector along specified dimension

dsp.ArrayVectorDivider will be removed in a future release. Use the ./ operator instead. For more information, see Compatibility Considerations.

Description

The ArrayVectorDivider object divides an array by a vector along a specified dimension.

To divide an array by a vector along a specified dimension:

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

2. Call step to divide the array according to the properties of dsp.ArrayVectorDivider. 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.

Construction

avd = dsp.ArrayVectorDivider returns an array-vector division object, avd, that divides an input array by the elements of a vector along the first dimension of the array.

avd = dsp.ArrayVectorDivider('PropertyName',PropertyValue,...) returns an array-vector division object, avd, with each property set to the specified value.

Properties

Dimension	Dimension along which to divide input by vector elements Specify the dimension along which to divide the input array by the elements of a vector as a positive integer. The default is 1.
VectorSource	Source of vector Specify the source of the vector values as | Input port | 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

RoundingMethod	Rounding method for fixed-point operations Specify the rounding method as | Ceiling | Convergent | Floor | Nearest | Round | Simplest | Zero |. The default is Floor.
OverflowAction	Overflow action for fixed-point operations Specify the overflow action as | Wrap | Saturate |. The default is Wrap.
VectorDataType	Vector word and fraction lengths Specify the vector fixed-point mode as | Same word length as input | 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 data type as a scaled 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).
OutputDataType	Output word and fraction lengths Specify the output fixed-point data type as | Same as first input | Custom |. The default is Same as first input.
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	Divide array by vector

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

Examples

Divide a Matrix By a Vector

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).

avd = dsp.ArrayVectorDivider;
a = ones(2);
x = [2 3]';
y = avd(a, x)

y = 2×2

    0.5000    0.5000
    0.3333    0.3333

Algorithms

This object implements the algorithm, inputs, and outputs described on the Array-Vector Divide block reference page. The object properties correspond to the block parameters, except:

The array-vector division object does not have Minimum or Maximum options for data output.

Compatibility Considerations

dsp.ArrayVectorDivider System object will be removed

Not recommended starting in R2021a

dsp.ArrayVectorDivider 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

Column-wise array division By default, the object computes column-wise array division since the Dimension property of the object is set to 1. avd = dsp.ArrayVectorDivider; a = ones(2); x = [2; 3]; y = avd(a, x) y = 2×2 0.5000 0.5000 0.3333 0.3333 Row-wise array division To perform row-wise array division, set the Dimension property to 2 and rerun the object algorithm. release(avd); avd.Dimension = 2; y = avd(a, x) y = 2×2 0.5000 0.3333 0.5000 0.3333 If you are using a release prior to R2016b, replace avd(a,x) with step(avd,a,x).

Column-wise array division y = a ./ x y = 2×2 0.5000 0.5000 0.3333 0.3333 Row-wise array division y = a ./ x' y = 2×2 0.5000 0.3333 0.5000 0.3333

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