dsp.CumulativeSum

(To be removed) Cumulative sum of channel, column, or row elements

expand all in page

dsp.CumulativeSumwill be removed in a future release. Use thecumsumfunction instead. For more information, seeCompatibility Considerations.

Description

Thedsp.CumulativeSumSystem object™ computes the cumulative sum of channel, column, or row elements.

To compute the cumulative sum of channel, column, or row elements:

Create thedsp.CumulativeSumobject and set its properties.
Call the object with arguments, as if it were a function.

To learn more about how System objects work, seeWhat Are System Objects?

Creation

Syntax

csum = dsp.CumulativeSum

csum = dsp.CumulativeSum(Name,Value)

Description

example

csum= dsp.CumulativeSumreturns a cumulative sum System object,csum, which computes the running cumulative sum for each channel in the input.

csum= dsp.CumulativeSum(Name,Value)returns a cumulative sum object,csum, with each specified property set to the specified value. Enclose each property name in single quotes. Unspecified properties have default values.

Properties

expand all

Unless otherwise indicated, properties arenontunable, which means you cannot change their values after calling the object. Objects lock when you call them, and thereleasefunction unlocks them.

If a property istunable, you can change its value at any time.

For more information on changing property values, seeSystem Design in MATLAB Using System Objects.

`Dimension`—Computation dimension for cumulative sum
`Channels (running sum)`(default) |`Rows`|`Columns`

Specify the computation dimension asChannels (running sum),Rows, orColumns.

`ResetInputPort`—Enable resetting cumulative sum through input port
`false`(default) |`true`

Set this property totrueto enable resetting the cumulative sum. When you set this property totrue, you also specify a reset input to the object algorithm to reset the cumulative sum.

`ResetCondition`—Reset condition for cumulative sum
`Rising edge`(default) |`Falling edge`|`Either edge`|`Non-zero`

指定事件的复位输入端口resets the cumulative sum asRising edge,Falling edge,Either edge, orNon-zero.

Dependencies

This property applies when you set theResetInputPortproperty totrue.

Fixed-Point Properties

`RoundingMethod`—Rounding method for fixed-point operations
`Floor`(default) |`Ceiling`|`Convergent`|`Nearest`|`Round`|`Simplest`|`Zero`

Specify the rounding method as one ofCeiling,Convergent,Floor,Nearest,Round,Simplest, orZero.

`OverflowAction`—Overflow action for fixed-point operations
`Wrap`(default) |`Saturate`

Specify the overflow action as one ofWraporSaturate.

`AccumulatorDataType`—Accumulator word and fraction lengths
`Same as input`(default) |`Custom`

Specify the accumulator fixed-point data type asSame as inputorCustom.

`CustomAccumulatorDataType`—Custom accumulator word and fraction lengths
`numerictype([], 32, 30)`(default) |numerictype

Specify the accumulator fixed-point type as a scalednumerictype(Fixed-Point Designer)object with aSignednessofAuto.

Dependencies

This property applies when you set theAccumulatorDataTypeproperty toCustom.

`OutputDataType`—Output word and fraction lengths
`Same as accumulator`(default) |`Same as input`|`Custom`

Specify the output fixed-point data type asSame as accumulator,Same as input, orCustom.

`CustomOutputDataType`—Custom output word and fraction lengths
`numerictype([], 16, 15)`(default) |numerictype

Specify the output fixed-point type as a scalednumerictype(Fixed-Point Designer)object with aSignednessofAuto.

Dependencies

This property applies when you set theOutputDataTypeproperty toCustom.

Usage

Syntax

y = csum(x)

y = csum(x,r)

Description

example

y= csum(x)computes the cumulative sum along the specified dimension for the inputx.

y= csum(x,r)resets the System object state based on theResetConditionproperty value and the value of the reset signal,r. You can only reset the state if theResetInputPortproperty istrue.

Input Arguments

expand all

`x`—Data input
vector|matrix

Data input, specified as a vector or a matrix.

`r`—Reset signal
scalar

Reset signal used to reset the running cumulative sum, specified as a scalar. The object resets the running cumulative sum if the reset signal satisfies theResetCondition.

Dependencies

This input is applicable only whenDimensionis set to'Channels (running sum)'andResetInputPortis set totrue.

Output Arguments

expand all

`y`— Cumulative sum
vector | matrix

Cumulative sum of the input signal, returned as a vector or a matrix.

The size, data type, and complexity characteristics of the output signal match that of the input signal.

Object Functions

To use an object function, specify the System object as the first input argument. For example, to release system resources of a System object namedobj, use this syntax:

release(obj)

expand all

Common to All System Objects

`step`	RunSystem objectalgorithm
`release`	Release resources and allow changes toSystem objectproperty values and input characteristics
`reset`	Reset internal states ofSystem object

Examples

collapse all

Cumulative Sum of 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)becomesstep(obj,x).

Use thedsp.CumulativeSumobject to compute the cumulative sum of a matrix.

csum = dsp.CumulativeSum; x = magic(2)

x =2×21 3 4 2

y = csum(x)

y =2×21 3 5 5

The cumulative sum is computed column-wise along each channel.

Algorithms

This object implements the algorithm, inputs, and outputs described on theCumulative Sumblock reference page. The object properties correspond to the block properties, except theReset portblock parameter corresponds to both theResetConditionand theResetInputPortobject properties.

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.

Usage notes and limitations:

SeeSystem Objects in MATLAB Code Generation(MATLAB Coder).

Version History

Introduced in R2012a

expand all

R2021b:`dsp.CumulativeSum`System objectwill be removed

Warns starting in R2021b

dsp.CumulativeSumSystem object will be removed in a future release. Use thecumsumfunction instead.

Update Code

此表显示了typicall系统对象y used and explains how to update existing code to use thecumsumfunction.

Discouraged Usage Recommended Replacement

Discouraged Usage	Recommended Replacement
Column-wise cumulative sum By default, the object computes the running sum along the columns (channels) since the`Dimension`property of the object is set to`'Channels (running sum)'`. csum = dsp.CumulativeSum; x = magic(2) x =2×21 3 4 2 y = csum(x) y =2×21 3 5 5 Row-wise cumulative sum To compute row-wise cumulative sum, set the`Dimension`property to`'Rows'`and rerun the object algorithm. release(csum); csum.Dimension ='Rows'; y = csum(x) y =2×21 4 4 6 If you are using a release prior to R2016b, replace`csum(x)`with`step(csum,x)`.	Column-wise cumulative sum y = cumsum(x,1) y =2×21 3 5 5 Row-wise cumulative sum y = cumsum(x,2) y =2×21 4 4 6

Column-wise cumulative sum

By default, the object computes the running sum along the columns (channels) since theDimensionproperty of the object is set to'Channels (running sum)'.

csum = dsp.CumulativeSum; x = magic(2)

x =2×21 3 4 2

y = csum(x)

y =2×21 3 5 5

Row-wise cumulative sum

To compute row-wise cumulative sum, set theDimensionproperty to'Rows'and rerun the object algorithm.

release(csum); csum.Dimension ='Rows'; y = csum(x)

y =2×21 4 4 6

If you are using a release prior to R2016b, replacecsum(x)withstep(csum,x).

Column-wise cumulative sum

y = cumsum(x,1)

y =2×21 3 5 5

Row-wise cumulative sum

y = cumsum(x,2)

y =2×21 4 4 6

dsp.CumulativeSum

Description

Creation

Syntax

Description

Properties

Dimension—Computation dimension for cumulative sumChannels (running sum)(default) |Rows|Columns

ResetInputPort—Enable resetting cumulative sum through input portfalse(default) |true

ResetCondition—Reset condition for cumulative sumRising edge(default) |Falling edge|Either edge|Non-zero

Dependencies

Fixed-Point Properties

RoundingMethod—Rounding method for fixed-point operationsFloor(default) |Ceiling|Convergent|Nearest|Round|Simplest|Zero

OverflowAction—Overflow action for fixed-point operationsWrap(default) |Saturate

AccumulatorDataType—Accumulator word and fraction lengthsSame as input(default) |Custom

CustomAccumulatorDataType—Custom accumulator word and fraction lengthsnumerictype([], 32, 30)(default) |numerictype

Dependencies

OutputDataType—Output word and fraction lengthsSame as accumulator(default) |Same as input|Custom

CustomOutputDataType—Custom output word and fraction lengthsnumerictype([], 16, 15)(default) |numerictype

Dependencies

Usage

Syntax

Description

Input Arguments

x—Data inputvector|matrix

r—Reset signalscalar

Dependencies

Output Arguments

y— Cumulative sumvector | matrix

Object Functions

Common to All System Objects

Examples

Cumulative Sum of Matrix

Algorithms

Extended Capabilities

C/C++ Code GenerationGenerate C and C++ code using MATLAB® Coder™.

Version History

R2021b:dsp.CumulativeSumSystem objectwill be removed

See Also

Functions

`Dimension`—Computation dimension for cumulative sum
`Channels (running sum)`(default) |`Rows`|`Columns`

`ResetInputPort`—Enable resetting cumulative sum through input port
`false`(default) |`true`

`ResetCondition`—Reset condition for cumulative sum
`Rising edge`(default) |`Falling edge`|`Either edge`|`Non-zero`

`RoundingMethod`—Rounding method for fixed-point operations
`Floor`(default) |`Ceiling`|`Convergent`|`Nearest`|`Round`|`Simplest`|`Zero`

`OverflowAction`—Overflow action for fixed-point operations
`Wrap`(default) |`Saturate`

`AccumulatorDataType`—Accumulator word and fraction lengths
`Same as input`(default) |`Custom`

`CustomAccumulatorDataType`—Custom accumulator word and fraction lengths
`numerictype([], 32, 30)`(default) |numerictype

`OutputDataType`—Output word and fraction lengths
`Same as accumulator`(default) |`Same as input`|`Custom`

`CustomOutputDataType`—Custom output word and fraction lengths
`numerictype([], 16, 15)`(default) |numerictype

`x`—Data input
vector|matrix

`r`—Reset signal
scalar

`y`— Cumulative sum
vector | matrix

C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.

R2021b:`dsp.CumulativeSum`System objectwill be removed