ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

Product of Elements

1 つのスカラー入力のコピーまたは逆数、あるいは 1 つの非スカラー入力をベクトルやスカラーに変換

  • ライブラリ:
  • Simulink / Math Operations

    HDL Coder / HDL Floating Point Operations

    HDL Coder / Math Operations

説明

Product of Elements ブロックは、1 つのスカラー、ベクトルまたは行列を入力します。ブロックを使用して以下のことを行うことができます。

  • スカラー入力を変化させずにコピーする

  • スカラー入力の逆数 (1 を入力スカラーで除算)

  • すべての要素を乗算するか、要素の連続した逆数をとることで、ベクトルまたは行列をスカラーに変換

  • 次のいずれかのオプションを使用して、行列をベクトルに変換します。

    • 各行または列の要素を乗算する

    • 各行または列の要素の連続した逆数をとる

Product of Elements ブロックは、機能的には、事前設定された 2 つのパラメーター値をもつ Product ブロックです。

  • 乗算: 要素単位(.*)

  • 入力数: *

これらのパラメーターのいずれかに既定でない値を設定すると、Product of Elements ブロックを機能的に等価な Product ブロックまたは Divide ブロックに変更できます。

端子

入力

すべて展開する

乗算または除算する 1 番目の入力。スカラー、ベクトル、行列または N 次元配列として指定します。

データ型: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | Boolean | fixed point

乗算または除算する N 番目の入力。スカラー、ベクトル、行列または N 次元配列として指定します。

データ型: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | Boolean | fixed point

他の入力に乗算する入力信号。

依存関係

1 つ以上の X 端子を有効にするには、[入力の数] パラメーターに対して 1 つ以上の * 文字を指定します。

データ型: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | Boolean | fixed point

除算または逆演算の入力信号。

依存関係

1 つ以上の ÷ 端子を有効にするには、[入力の数] パラメーターに対して 1 つ以上の / 文字を指定します。

データ型: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | Boolean | fixed point

出力

すべて展開する

入力を乗算、除算、または逆数を求めることで計算される出力。

データ型: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | Boolean | fixed point

パラメーター

すべて展開する

メイン

ブロックの 2 つのプロパティを制御します。

  • ブロックの入力端子の数

  • 各入力が出力されるときに乗算されるかまたは除算されるか

指定に関する詳細は次の通りです。

  • 1*、または /

    このブロックは 1 つの入力端子をもっています。要素単位モードでは、ブロックは Product of Elements ブロックで記述されたとおりに入力を処理します。行列モードでは、パラメーター値が 1 または * の場合、ブロックは入力値を出力します。値が / である場合、入力は正方行列 (縮退した場合としてスカラーを含む) でなければなりません。ブロックは逆行列を出力します。詳細については、要素単位モードおよび行列モードを参照してください。

  • 整数値 > 1

    ブロックがもつ入力数は整数値で指定されます。[乗算] パラメーターで指定される要素単位モードまたは行列モードによって、入力は互いに乗算されます。詳細については、要素単位モードおよび行列モードを参照してください。

  • 2 つ以上の */ から成る単純文字列

    ブロックは文字ベクトルの長さで与えられる入力数をもちます。* に相当する各入力は、乗算され、出力されます。/ に対応する各入力は除算され、出力されます。演算は、[乗算] パラメーターで指定されるように、要素単位モードまたは行列モードで行われます。詳細については、要素単位モードおよび行列モードを参照してください。

プログラムでの使用

ブロック パラメーター: Inputs
型: 文字ベクトル
値: '2' | '*' | '**' | '*/' | '*/*' | ...
既定の設定: '*'

ブロックが [要素単位(.*)] または [行列 (*)] の乗算を実行するかどうかを指定します。

プログラムでの使用

ブロック パラメーター: Multiplication
型: 文字ベクトル
値: 'Element-wise(.*)' | 'Matrix(*)'
既定の設定: 'Element-wise(.*)'

乗算範囲の次元を [すべての次元] または [指定した次元] で指定します。

[すべての次元] を選択し、コンフィギュレーション パラメーター [行優先の配列レイアウトに最適化されたアルゴリズムを使用] を選択すると、Simulink® はシミュレーションに対して行優先アルゴリズムを有効にします。行優先のコードを生成するには、[行優先の配列レイアウトに最適化されたアルゴリズムを使用] を選択するほかに、コンフィギュレーション パラメーター [配列のレイアウト] (Simulink Coder) を [行優先] に設定します。列優先アルゴリズムと行優先のルゴリズムで異なるのは乗算の順序のみです。場合によっては、同じデータセットに対する演算順序が異なることから、列優先アルゴリズムと行優先アルゴリズムの出力の数値にわずかな差が生じることがあります。

[指定した次元] を選択する場合、[次元]1 または 2 と指定できます。

依存関係

このパラメーターを有効にするには、[入力の数]* に、[乗算][要素単位(.*)] に設定します。

プログラムでの使用

ブロック パラメーター: CollapseMode
型: 文字ベクトル
値: 'All dimensions' | 'Specified dimension'
既定の設定: 'All dimensions'

乗算範囲の次元を入力信号の次元数以下の整数として指定します。

依存関係

このパラメーターを有効にするには、次のように設定します。

  • [入力の数]* に設定

  • [乗算][要素単位(.*)] に設定

  • [乗算範囲][指定した次元] に設定

プログラムでの使用

ブロック パラメーター: CollapseDim
型: 文字ベクトル
値: '1' | '2' | ...
既定の設定: '1'

サンプル時間を -1 以外の値で指定します。詳細については、サンプル時間の指定を参照してください。

依存関係

このパラメーターは、明示的に -1 以外の値に設定されていない限り表示されません。詳細は、サンプル時間が推奨されないブロックを参照してください。

プログラムでの使用

ブロック パラメーター: SampleTime
型: 文字ベクトル
値: スカラー
既定の設定: '-1'

Signal Attributes

すべての入力信号が同じデータ型をもたなければならないかどうかを指定します。このパラメーターを有効にすると、入力信号のデータ型が異なる場合はシミュレーション中にエラーが発生します。

プログラムでの使用

ブロック パラメーター: InputSameDT
型: 文字ベクトル
値: 'off' | 'on'
既定の設定: 'off'

Simulink がチェックする出力範囲の下限値。

Simulink は、最小値を使って以下を行います。

メモ

[出力の最小値] により、実際の出力信号が飽和する (またはクリップされる) ことはありません。代わりに、Saturation ブロックを使用してください。

プログラムでの使用

ブロック パラメーター: OutMin
: 文字ベクトル
: '[ ]'| スカラー
既定の設定: '[ ]'

Simulink がチェックする出力範囲の上限値。

Simulink は、最大値を使って以下を行います。

メモ

[出力の最大値] により、実際の出力信号が飽和する (またはクリップされる) ことはありません。代わりに、Saturation ブロックを使用してください。

プログラムでの使用

ブロック パラメーター: OutMax
: 文字ベクトル
: '[ ]'| スカラー
既定の設定: '[ ]'

出力のデータ型を選択します。型は継承されるか、直接指定されるか、Simulink.NumericType などのデータ型オブジェクトとして表現されます。詳細については、信号のデータ型の制御を参照してください。

継承オプションを選択すると、ブロックは次のように動作します。

  • 継承: 内部ルールによる継承 — Simulink は、組み込みターゲット ハードウェアのプロパティを考慮しつつ、数値の精度、パフォーマンス、および生成コードのサイズのバランスが取れるように、データ型を選択します。組み込みターゲット ハードウェアの設定を変更すると、内部ルールにより選択されるデータ型が変更される可能性があります。たとえば、ブロックが int8 型の入力に int16 のゲインを乗算し、ターゲット ハードウェア タイプとして [ASIC/FPGA] が指定されている場合、出力データ型は sfix24 です。ターゲット ハードウェアとして [Unspecified (assume 32-bit Generic)] (汎用 32 ビット マイクロプロセッサ) が指定された場合、出力データ型は int32 です。ターゲット マイクロプロセッサによって指定される語長では出力範囲に対応できない場合、Simulink は診断ビューアーにエラーを表示します。

    コードの効率と数値の精度が、ソフトウェアにより同時に最適化されるとは限りません。内部ルールが、数値精度またはパフォーマンスに対する要求を満たさない場合は、以下のいずれかを行ってください。

    • 出力データ型を明示的に指定する。

    • 単に 継承: 入力と同じ を選択します。

    • fixdt(1,32,16) のように既定のデータ型を明示的に指定し、固定小数点ツールを使用してモデルにデータ型を推奨する。詳細については、fxptdlg を参照してください。

    • 独自の継承ルールを指定するには、[継承: 逆伝播による継承] を使用し、Data Type Propagation ブロックを使用します。このブロックの使い方の例については、Signal Attributes ライブラリの Data Type Propagation Examples ブロックを参照してください。

  • 継承: 逆伝播による継承 — 駆動ブロックのデータ型を使用します。

  • 継承: 1 番目の入力と同じ — 1 番目の入力信号のデータ型を使用します。

プログラムでの使用

ブロック パラメーター: OutDataTypeStr
: 文字ベクトル
: 'Inherit: Inherit via internal rule | 'Inherit: Same as first input' | 'Inherit: Inherit via back propagation' | 'double' | 'single' | 'int8' | 'uint8' | 'int16' | 'uint16' | 'int32' | 'uint32' | 'int64' | 'uint64' | 'fixdt(1,16)' | 'fixdt(1,16,0)' | 'fixdt(1,16,2^0,0)' | '<data type expression>'
既定の設定: 'Inherit: Inherit via internal rule'

固定小数点ツールが、ブロックに指定した [出力] データ型をオーバーライドしないようにするには、このパラメーターを選択します。詳細については、[出力データ型の設定をロックする] の使用 (Fixed-Point Designer)を参照してください。

プログラムでの使用

ブロック パラメーター: LockScale
型: 文字ベクトル
値: 'off' | 'on'
既定の設定: 'off'

固定小数点演算の丸めモードを選択します。以下を選択できます。

正方向

正の無限大方向に正負の値を丸めます。MATLAB® 関数 ceil と等価です。

最も近い偶数方向

最も近い表現可能な値に数値を丸めます。同順位が発生した場合は、最も近い偶数の整数に丸めます。Fixed-Point Designer™ 関数 convergent と等価です。

負方向

負の無限大方向に正負の値を丸めます。MATLAB 関数 floor と等価です。

最も近い正の整数方向

最も近い表現可能な値に数値を丸めます。同順位が発生した場合は、正の無限大方向に丸めます。Fixed-Point Designer 関数 nearest と等価です。

最も近い整数方向

最も近い表現可能な値に数値を丸めます。同順位が発生した場合は、正の数値を正の無限大方向、負の数値を負の無限大方向に丸めます。Fixed-Point Designer 関数 round と等価です。

最も簡潔

負方向の丸めとゼロ方向の丸めのいずれかを選択し、できるだけ効率の高い丸めコードを生成します。

ゼロ方向

ゼロ方向に数値を丸めます。MATLAB 関数 fix と等価です。

詳細については、丸め (Fixed-Point Designer)を参照してください。

ブロック パラメーターは常に最近傍の表現可能な値に丸められます。ブロックパラメーターの丸めを直接制御するには、MATLAB の丸め関数を使用する式をマスク フィールドに入力します。

プログラムでの使用

ブロック パラメーター: RndMeth
型: 文字ベクトル
値: 'Ceiling' | 'Convergent' | 'Floor' | 'Nearest' | 'Round' | 'Simplest' | 'Zero'
既定の設定: 'Floor'

オーバーフローで飽和するかラップするかを指定します。

アクション根拠オーバーフローの影響

このチェック ボックスをオンにする (on)。

モデルでオーバーフローが発生する可能性があるので、生成コードに飽和保護を明示的に組み込むことをお勧めします。

オーバーフローは、データ型が表現できる最小値または最大値のいずれかに飽和します。

int8 (符号付き、8 ビット整数) データ型が表すことができる最大値は 127 です。この最大値を超えるブロックの演算結果により 8 ビット整数のオーバーフローが発生します。チェック ボックスがオンになっていると、ブロック出力は 127 で飽和します。同様に、ブロック出力は最小出力値である -128 で飽和します。

このチェック ボックスをオンにしない (off)。

生成コードの効率を最適化することをお勧めします。

ブロックが範囲外の信号を処理する方法を指定しすぎないようにすることをお勧めします。詳細については、信号範囲のエラーのチェックを参照してください。

オーバーフローは、データ型によって表現される適切な値にラップされます。

int8 (符号付き、8 ビット整数) データ型が表すことができる最大値は 127 です。この最大値を超えるブロックの演算結果により 8 ビット整数のオーバーフローが発生します。チェック ボックスをオフにすると、オーバーフローを引き起こした値は int8 として解釈され、意図しない結果が引き起こされる可能性があります。たとえば、int8 として表されるブロック結果 130 (バイナリで 1000 0010) は -126 です。

このチェック ボックスをオンにすると、飽和は出力や結果だけでなく、このブロックの内部演算すべてに適用されます。通常、オーバーフローが可能ではない場合は、コード生成プロセスで検出されます。この場合、コード ジェネレーターでは飽和コードは生成されません。

プログラムでの使用

ブロック パラメーター: SaturateOnIntegerOverflow
型: 文字ベクトル
値: 'off' | 'on'
既定の設定: 'off'

ブロックの特性

データ型

Boolean | double | fixed point | integer | single

直接フィードスルー

はい

多次元信号

はい

可変サイズの信号

はい

ゼロクロッシング検出

いいえ

アルゴリズム

Product of Elements ブロックは、これらのアルゴリズムを使用して、浮動小数点、組み込み整数および固定小数点型の入力に対して要素単位演算を実行します。

入力要素単位演算アルゴリズム

実数スカラー、u

乗算y = u
除算y = 1/u

要素 u1, u2, u3, ..., uN をもつ実数ベクトルまたは行列

乗算y = u1*u2*u3*...*uN
除算y = ((((1/u1)/u2)/u3).../uN)

複素数スカラー、u

乗算y = u
除算y = 1/u

要素 u1, u2, u3, ..., uN をもつ複素数ベクトルまたは行列

乗算y = u1*u2*u3*...*uN
除算y = ((((1/u1)/u2)/u3).../uN)

要素単位の乗算または除算用に指定された次元が行列の行または列である場合、このアルゴリズムはその行または列に適用されます。このモデルについて考えます。

一番上の Product of Elements ブロックは、4 つの要素の連続した逆数をとることで、行列入力をスカラーに変換します。

  • y = ((((1/2+i)/3)/4-i)/5)

一番下の Product of Elements ブロックは、2 番目の次元に沿って連続した逆数をとることで、行列入力をベクトルに変換します。

  • y(1) = ((1/2+i)/3)

  • y(2) = ((1/4-i)/5)

拡張機能

C/C++ コード生成
Simulink® Coder™ を使用して C および C++ コードを生成します。

PLC コード生成
Simulink® PLC Coder™ を使用して構造化テキスト コードを生成します。

固定小数点の変換
Fixed-Point Designer™ を使用して固定小数点システムの設計とシミュレーションを行います。

R2006a より前に導入