sum

fi 配列要素の和

ページ内をすべて折りたたむ

構文

S = sum(A)
S = sum(A,dim)
S = sum(___,type)

説明

S = sum(A) は fi 配列 A の異なる次元方向の和を返します。

  • A がベクトルの場合、sum(A) は要素の和を返します。

  • A が行列の場合、sum(A) は A の列をベクトルとして扱い、各列の和の行ベクトルを返します。

  • A が多次元配列の場合、sum(A) は大きさが 1 でない最初の次元の値をベクトルとして扱い、行ベクトルの配列を返します。

例

S = sum(A,dim) は A の次元 dim 方向の和を計算します。

例

S = sum(___,type) は type で指定されたクラスの配列を返します。

例

例

すべて折りたたむ

ライブ スクリプトを開く

fi ベクトルを作成し、コンストラクター内で fimath プロパティを指定します。 

A =  fi([1 2 5 8 5], 'SumMode', 'KeepLSB', 'SumWordLength', 32)
A = 
     1     2     5     8     5

          DataTypeMode: Fixed-point: binary point scaling
            Signedness: Signed
            WordLength: 16
        FractionLength: 11

        RoundingMethod: Nearest
        OverflowAction: Saturate
           ProductMode: FullPrecision
               SumMode: KeepLSB
         SumWordLength: 32
         CastBeforeSum: true

A の要素の合計を計算します。 

S = sum(A)
S = 
    21

          DataTypeMode: Fixed-point: binary point scaling
            Signedness: Signed
            WordLength: 32
        FractionLength: 11

        RoundingMethod: Nearest
        OverflowAction: Saturate
           ProductMode: FullPrecision
               SumMode: KeepLSB
         SumWordLength: 32
         CastBeforeSum: true

出力 S は SumWordLength が 32 に指定されたスカラーです。SumMode は KeepLSB に設定されていたため、S の FractionLength は 11 です。

ライブ スクリプトを開く

fi 配列を作成し、各列の要素の和を計算します。 

A=fi([1 2 8;3 7 0;1 2 2])
A = 
     1     2     8
     3     7     0
     1     2     2

          DataTypeMode: Fixed-point: binary point scaling
            Signedness: Signed
            WordLength: 16
        FractionLength: 11

S=sum(A)
S = 
     5    11    10

          DataTypeMode: Fixed-point: binary point scaling
            Signedness: Signed
            WordLength: 18
        FractionLength: 11

MATLAB® は A の各列の和を含む行ベクトルを返します。ceil(log2(size(A,1)))=2 であるため、S の WordLength は 2 ビット増加します。SumMode の既定の設定が FullPrecision であるため、FractionLength は変化しません。

ライブ スクリプトを開く

3 行 3 列の行列 A の 2 番目の次元 (dim=2) に沿って和を計算します。 

A=fi([1 2 8;3 7 0;1 2 2])
A = 
     1     2     8
     3     7     0
     1     2     2

          DataTypeMode: Fixed-point: binary point scaling
            Signedness: Signed
            WordLength: 16
        FractionLength: 11

S=sum(A, 2)
S = 
    11
    10
     5

          DataTypeMode: Fixed-point: binary point scaling
            Signedness: Signed
            WordLength: 18
        FractionLength: 11

MATLAB® は各行の要素の和からなる列ベクトルを返します。ceil(log2(size(A,2)))=2 であるため、S の WordLength は 18 です。

ライブ スクリプトを開く

A の列の和を計算し、出力配列 S が同じデータ型をもつようにします。 

A = fi([1 2 8;3 7 0;1 2 2])
A = 
     1     2     8
     3     7     0
     1     2     2

          DataTypeMode: Fixed-point: binary point scaling
            Signedness: Signed
            WordLength: 16
        FractionLength: 11

class(A)
ans = 
'embedded.fi'

S = sum(A, 'native')
S = 
     5    11    10

          DataTypeMode: Fixed-point: binary point scaling
            Signedness: Signed
            WordLength: 18
        FractionLength: 11

class(S)
ans = 
'embedded.fi'

MATLAB® は A のデータ型を維持し、タイプが embedded.fi の S の行ベクトルを返します。

入力引数

すべて折りたたむ

fi 入力配列。スカラー、ベクトル、行列または多次元配列として指定します。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | fi
複素数のサポート: あり

正の整数スカラーとして指定された、動作する対象の次元。dim は fi オブジェクトにすることもできます。値を指定しない場合、既定は、サイズが 1 と異なる最初の配列の次元です。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | fi

出力クラス。'double' または 'native' として指定します。出力クラスは演算と出力を行うデータ型を定義します。

  • type が 'double' の場合、sum は入力データ型にかかわらず、倍精度の配列を返します。

  • type が 'native' の場合、sum は入力配列 A と同じクラスの配列を返します。

データ型: char

出力引数

すべて折りたたむ

和の配列。スカラー、ベクトル、行列または多次元配列として返されます。

メモ

和の計算には、fimath オブジェクトが使用されます。SumMode が FullPrecision、KeepLSB、または KeepMSB に設定されている場合、sum(A) に対する増加分の整数ビット数は ceil(log2(size(A,dim))) です。

制限

  • sum はデータ型が Boolean の fi オブジェクトはサポートしていません。

拡張機能

すべて展開する

HDL コード生成
HDL Coder™ を使用して FPGA 設計および ASIC 設計のための VHDL、Verilog および SystemVerilog のコードを生成します。

バージョン履歴

R2006a より前に導入

参考

| | | | | | | | |