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

range 関数

このページではrange関数について説明していきます。

関数概要

range関数はap.Int型の指定の範囲の配列を作成します（例 : [0, 1, 2, 3, 4, 5]）。

基本的な使い方

もしも引数を1つだけ指定した場合、範囲の配列は0から指定された引数の値を-1した範囲になります。

import apysc as ap

ap.Stage(
    stage_width=0,
    stage_height=0,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)
range_arr: ap.Array[ap.Int] = ap.range(5)
ap.assert_equal(range_arr, [0, 1, 2, 3, 4])
ap.save_overall_html(dest_dir_path="range_basics_usage_1/")

また、もし2つの引数を指定した場合には範囲の配列は最初の引数の値～2つ目の引数の値を-1した範囲になります。

import apysc as ap

ap.Stage(
    stage_width=0,
    stage_height=0,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)
range_arr: ap.Array[ap.Int] = ap.range(2, 4)
ap.assert_equal(range_arr, [2, 3])
ap.save_overall_html(dest_dir_path="range_basics_usage_2/")

もし3つ引数を指定した場合には範囲の配列は最初の引数の値～2つ目の引数の値を-1した範囲となり、各値は3つ目に指定された引数の値のステップで設定されます。

import apysc as ap

ap.Stage(
    stage_width=0,
    stage_height=0,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)
range_arr: ap.Array[ap.Int] = ap.range(2, 10, 2)
ap.assert_equal(range_arr, [2, 4, 6, 8])
ap.save_overall_html(dest_dir_path="range_basics_usage_3/")

range 関数のAPI

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

[インターフェイスの構造] range(*args: Any) -> apysc._type.array.Array[apysc._type.int.Int]

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

整数の指定範囲の配列を生成します。

[返却値]

  • arr: Array[Int]

    • 生成された配列。

[コードサンプル]

>>> import apysc as ap
>>> range_arr: ap.Array[ap.Int] = ap.range(5)
>>> ap.assert_equal(range_arr, [0, 1, 2, 3, 4])
>>> range_arr = ap.range(2, 4)
>>> ap.assert_equal(range_arr, [2, 3])
>>> range_arr = ap.range(2, 10, 2)
>>> ap.assert_equal(range_arr, [2, 4, 6, 8])