matlab::data::Reference<Array>

Array への参照を取得するための C++ クラス

説明

Reference<Array> クラスを使用して、MATLAB^® 構造体や cell 配列など、コンテナーオブジェクトの Array 要素に対する参照を取得します。このクラスは配列を参照するすべての参照型の基底クラスであり、基本的な配列情報を提供します。ArrayRef は次のように定義されます。

using ArrayRef = Reference<Array>;

クラスの詳細

名前空間:	`matlab::data`
インクルード:	`ArrayReferenceExt.hpp`

メンバー関数

getType
getDimensions
getNumberOfElements
isEmpty

`getType`

ArrayType getType() const

戻り値

ArrayType

配列の型

スロー

`matlab::data::NotEnoughIndicesProvidedException`	インデックスの数が不足しています。
`matlab::data::InvalidArrayIndexException`	指定されたインデックスがこの `Array` に対して有効でないか、インデックスの 1 つが範囲外です。
`matlab::data::InvalidArrayTypeException`	`Array` 型が認識されません。

`getDimensions`

ArrayDimensions getDimensions() const

戻り値

ArrayDimensions

Array の次元のベクトル。

スロー

`matlab::data::NotEnoughIndicesProvidedException`	インデックスの数が不足しています。
`matlab::data::InvalidArrayIndexException`	指定されたインデックスがこの `Array` に対して有効でないか、インデックスの 1 つが範囲外です。

`getNumberOfElements`

size_t getNumberOfElements() const

戻り値

size_t

配列の要素数。

スロー

`matlab::data::NotEnoughIndicesProvidedException`	インデックスの数が不足しています。
`matlab::data::InvalidArrayIndexException`	指定されたインデックスがこの `Array` に対して有効でないか、インデックスの 1 つが範囲外です。

`isEmpty`

bool isEmpty() const

戻り値

bool

配列が空の場合は true を返し、空でない場合は false を返します。

スロー

`matlab::data::NotEnoughIndicesProvidedException`	インデックスの数が不足しています。
`matlab::data::InvalidArrayIndexException`	指定されたインデックスがこの `Array` に対して有効でないか、インデックスの 1 つが範囲外です。

`getReadOnlyElements`

template <typename T>
Range<TypedIterator, T const> getReadOnlyElements(const Reference<Array>& ref)

説明

Array または Reference<Array> の要素を含む範囲を取得します。範囲に含まれる反復子は const です。

パラメーター

const Reference<Array>& ref

Reference<Array>.

戻り値

Range<TypedIterator, T const>

入力 Reference<Array> の要素の begin 反復子および end 反復子を含む範囲。

スロー

matlab::data::InvalidArrayTypeException

Array には T 型は含まれません。

`getWritableElements`

template <typename T>
Range<TypedIterator, T> getWritableElements(Reference<Array>& ref)

説明

Array または Reference<Array> の要素を含む範囲を取得します。範囲に含まれる反復子は非 const です。

パラメーター

Reference<Array>& ref

Reference<Array>.

戻り値

Range<TypedIterator, T>

入力 Reference<Array> の要素の begin 反復子および end 反復子を含む範囲。

スロー

matlab::data::InvalidArrayTypeException

Array には T 型は含まれません。

バージョン履歴

R2017b で導入

参考

ArrayType