※この翻訳ドキュメントはスクリプトによって出力・同期されています。内容が怪しそうな場合はGitHubにissueを追加したり英語の原文の確認をお願いします。

Array クラスの index_of インターフェイス

このページではArrayクラスのindex_ofメソッドのインターフェイスについて説明します。

インターフェイス概要

index_ofメソッドは指定された値の配列内でのインデックスを返却します。

基本的な使い方

index_ofメソッドはvalue引数の指定を必要とし、値が配列内で見つかった場合にはそのインデックスを返却します。

import apysc as ap

ap.Stage()
arr: ap.Array[int] = ap.Array([1, 3, 5])
index: ap.Int = arr.index_of(value=3)
assert index == 1

もしも配列内で値が見つからなかった場合インデックスは-1となります。

import apysc as ap

ap.Stage()
arr: ap.Array[int] = ap.Array([1, 3, 5])
index: ap.Int = arr.index_of(value=2)
assert index == -1

index_of API

特記事項: このAPIドキュメントはドキュメントビルド用のスクリプトによって自動で生成・同期されています。そのためもしかしたらこの節の内容は前節までの内容と重複している場合があります。

[インターフェイスの構造] index_of(self, value: ~_ArrValue) -> apysc._type.int.Int


[インターフェイス概要]

指定された値のインデックス位置を検索しその値を返却します。


[引数]

  • value: *

    • 検索対象の任意の値。


[返却値]

  • index: Int

    • 値が見つかった位置のインデックス。もし配列が対象の値を含んでいない場合は-1となります。


[コードサンプル]

>>> import apysc as ap
>>> _ = ap.Stage()
>>> arr: ap.Array = ap.Array([1, 3, 5])
>>> arr.index_of(3)
Int(1)