APIリファレンス
GD.collection
配列や辞書の変換、ヒープ、キュー、キャッシュを扱います。時間のかかる処理は別スレッド、またはほかの処理と交代しながら進めます。Callableを使う操作も、SceneTreeのフレームを待たずにほかのタスクへ実行を譲ります。
メソッド
group_by(items: Array, key: Callable) -> Dictionarymap_values(src: Dictionary, fn: Callable) -> Dictionaryfilter_keys(src: Dictionary, pred: Callable) -> Dictionarypartition(items: Array, pred: Callable) -> Arraychunk(items: Array, size: int) -> Arrayunique_by(items: Array, key: Callable) -> Arrayunique(items: Array) -> Arraysort_by(items: Array, pick: Callable) -> Arraysort_key(items: Array, key: String) -> Arrayzip(a: Array, b: Array) -> Arraysum_of(items: Array, pick: Callable) -> floatmax_by(items: Array, pick: Callable) -> Variantmin_by(items: Array, pick: Callable) -> Variantindex_by(items: Array, key: Callable) -> Dictionarydeep_merge(base: Dictionary, over: Dictionary) -> Dictionarybinary_heap(pick: Callable = null) -> GDBinaryHeappriority_queue() -> GDPriorityQueuelru_cache(limit: int = 128, ttl_ms: int = 0) -> GDLRUCachememo(fn: Callable, limit: int = 128) -> GDMemoizedCallablegroup_by_async(items: Array, key: Callable) -> await Dictionarymap_values_async(src: Dictionary, fn: Callable) -> await Dictionaryfilter_keys_async(src: Dictionary, pred: Callable) -> await Dictionarypartition_async(items: Array, pred: Callable) -> await Arrayunique_by_async(items: Array, key: Callable) -> await Arraysort_by_async(items: Array, pick: Callable) -> await Arraysum_of_async(items: Array, pick: Callable) -> await floatmax_by_async(items: Array, pick: Callable) -> await Variantmin_by_async(items: Array, pick: Callable) -> await Variantindex_by_async(items: Array, key: Callable) -> await Dictionarychunk_async(items: Array, size: int) -> await Arrayunique_async(items: Array) -> await Arraysort_key_async(items: Array, key: String) -> await Arrayzip_async(a: Array, b: Array) -> await Arraydeep_merge_async(base: Dictionary, over: Dictionary) -> await Dictionary
group_by
group_by(items: Array, key: Callable) -> Dictionary英語原文Group values by selected keys.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
key | Callable | 省略不可 | 要素からグループ化・一意判定・索引用のキーを選ぶCallable。 |
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
map_values
map_values(src: Dictionary, fn: Callable) -> Dictionary英語原文Transform each dictionary value.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
src | Dictionary | 省略不可 | 読み取る、または変換する入力元。ファイル操作では元のパス。 |
fn | Callable | 省略不可 | 呼び出す関数(Callable)。受け取る引数は、このAPIの説明を参照してください。 |
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
filter_keys
filter_keys(src: Dictionary, pred: Callable) -> Dictionary英語原文Keep dictionary keys matching a predicate.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
src | Dictionary | 省略不可 | 読み取る、または変換する入力元。ファイル操作では元のパス。 |
pred | Callable | 省略不可 | 各項目の選択方法を真偽値で判定するCallable。 |
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
partition
partition(items: Array, pred: Callable) -> Array英語原文Partition an array by predicate result.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
pred | Callable | 省略不可 | 各項目の選択方法を真偽値で判定するCallable。 |
戻り値
Array
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
chunk
chunk(items: Array, size: int) -> Array英語原文Split an array into chunks of the specified size.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
size | int | 省略不可 | 1つの断片に含める要素数の上限。 |
戻り値
Array
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
unique_by
unique_by(items: Array, key: Callable) -> Array英語原文Remove values with duplicate selected keys.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
key | Callable | 省略不可 | 要素からグループ化・一意判定・索引用のキーを選ぶCallable。 |
戻り値
Array
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
unique
unique(items: Array) -> Array英語原文Remove duplicate values.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
戻り値
Array
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
sort_by
sort_by(items: Array, pick: Callable) -> Array英語原文Sort by selected values while retaining source order for equal keys.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
pick | Callable | 省略不可 | 各値から比較・集計用のキーを選ぶCallable。 |
戻り値
Array
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
sort_key
sort_key(items: Array, key: String) -> Array英語原文Sort by specified dictionary keys while retaining source order for equal keys.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
key | String | 省略不可 | 並び順を決める値が入ったフィールド名。 |
戻り値
Array
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
zip
zip(a: Array, b: Array) -> Array英語原文Pair elements at corresponding positions in two arrays.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
a | Array | 省略不可 | 1つ目の入力、または比較する値。 |
b | Array | 省略不可 | 2つ目の入力、または比較する値。 |
戻り値
Array
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
sum_of
sum_of(items: Array, pick: Callable) -> float英語原文Sum selected numeric values.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
pick | Callable | 省略不可 | 各値から比較・集計用のキーを選ぶCallable。 |
戻り値
float
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
max_by
max_by(items: Array, pick: Callable) -> Variant英語原文Return the element with the maximum selected value.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
pick | Callable | 省略不可 | 各値から比較・集計用のキーを選ぶCallable。 |
戻り値
Variant
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
min_by
min_by(items: Array, pick: Callable) -> Variant英語原文Return the element with the minimum selected value.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
pick | Callable | 省略不可 | 各値から比較・集計用のキーを選ぶCallable。 |
戻り値
Variant
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
index_by
index_by(items: Array, key: Callable) -> Dictionary英語原文Index elements in a dictionary by selected keys.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
key | Callable | 省略不可 | 要素からグループ化・一意判定・索引用のキーを選ぶCallable。 |
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
deep_merge
deep_merge(base: Dictionary, over: Dictionary) -> Dictionary英語原文Merge nested dictionaries recursively.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
base | Dictionary | 省略不可 | マージ・比較の基準となる値。 |
over | Dictionary | 省略不可 | 基準辞書の対応する項目を上書きする値。 |
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
binary_heap
binary_heap(pick: Callable = null) -> GDBinaryHeap英語原文Create a binary heap with selectable priorities.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
pick | Callable | null | 各値から比較・集計用のキーを選ぶCallable。 |
戻り値
GDBinaryHeap
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
priority_queue
priority_queue() -> GDPriorityQueue英語原文Create a priority queue.
引数
引数はありません。
戻り値
GDPriorityQueue
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
lru_cache
lru_cache(limit: int = 128, ttl_ms: int = 0) -> GDLRUCache英語原文Create an LRU cache with entry-count and expiry settings.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
limit | int | 128 | キャッシュに保持する項目数の上限。 |
ttl_ms | int | 0 | 項目の有効期間をミリ秒で指定。0は期限切れを無効にします。 |
戻り値
GDLRUCache
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
memo
memo(fn: Callable, limit: int = 128) -> GDMemoizedCallable英語原文Create an argument-keyed cache of callable results.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
fn | Callable | 省略不可 | 呼び出す関数(Callable)。受け取る引数は、このAPIの説明を参照してください。 |
limit | int | 128 | キャッシュに保持する項目数の上限。 |
戻り値
GDMemoizedCallable
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
group_by_async
group_by_async(items: Array, key: Callable) -> await Dictionary英語原文Dispatch large collection operations without callables to CPU workers.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
key | Callable | 省略不可 | 要素からグループ化・一意判定・索引用のキーを選ぶCallable。 |
戻り値
await Dictionary
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
map_values_async
map_values_async(src: Dictionary, fn: Callable) -> await Dictionary英語原文Distribute dictionary value mapping across scheduler turns.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
src | Dictionary | 省略不可 | 読み取る、または変換する入力元。ファイル操作では元のパス。 |
fn | Callable | 省略不可 | 呼び出す関数(Callable)。受け取る引数は、このAPIの説明を参照してください。 |
戻り値
await Dictionary
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
filter_keys_async
filter_keys_async(src: Dictionary, pred: Callable) -> await Dictionary英語原文Distribute dictionary key filtering across scheduler turns.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
src | Dictionary | 省略不可 | 読み取る、または変換する入力元。ファイル操作では元のパス。 |
pred | Callable | 省略不可 | 各項目の選択方法を真偽値で判定するCallable。 |
戻り値
await Dictionary
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
partition_async
partition_async(items: Array, pred: Callable) -> await Array英語原文Distribute array partitioning across scheduler turns.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
pred | Callable | 省略不可 | 各項目の選択方法を真偽値で判定するCallable。 |
戻り値
await Array
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
unique_by_async
unique_by_async(items: Array, key: Callable) -> await Array英語原文Distribute key-based deduplication across scheduler turns.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
key | Callable | 省略不可 | 要素からグループ化・一意判定・索引用のキーを選ぶCallable。 |
戻り値
await Array
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
sort_by_async
sort_by_async(items: Array, pick: Callable) -> await Array英語原文Distribute key extraction across scheduler turns, then sort on a CPU worker.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
pick | Callable | 省略不可 | 各値から比較・集計用のキーを選ぶCallable。 |
戻り値
await Array
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
sum_of_async
sum_of_async(items: Array, pick: Callable) -> await float英語原文Distribute numeric summation across scheduler turns.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
pick | Callable | 省略不可 | 各値から比較・集計用のキーを選ぶCallable。 |
戻り値
await float
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
max_by_async
max_by_async(items: Array, pick: Callable) -> await Variant英語原文Distribute maximum selection across scheduler turns.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
pick | Callable | 省略不可 | 各値から比較・集計用のキーを選ぶCallable。 |
戻り値
await Variant
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
min_by_async
min_by_async(items: Array, pick: Callable) -> await Variant英語原文Distribute minimum selection across scheduler turns.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
pick | Callable | 省略不可 | 各値から比較・集計用のキーを選ぶCallable。 |
戻り値
await Variant
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
index_by_async
index_by_async(items: Array, key: Callable) -> await Dictionary英語原文Distribute key-index construction across scheduler turns.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
key | Callable | 省略不可 | 要素からグループ化・一意判定・索引用のキーを選ぶCallable。 |
戻り値
await Dictionary
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
chunk_async
chunk_async(items: Array, size: int) -> await Array英語原文Dispatch array chunking to a CPU worker.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
size | int | 省略不可 | 1つの断片に含める要素数の上限。 |
戻り値
await Array
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
unique_async
unique_async(items: Array) -> await Array英語原文Dispatch deduplication to a CPU worker.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
戻り値
await Array
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
sort_key_async
sort_key_async(items: Array, key: String) -> await Array英語原文Dispatch dictionary-key sorting to a CPU worker.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
items | Array | 省略不可 | 変換・収集する入力要素を元の順番で並べたもの。 |
key | String | 省略不可 | 並び順を決める値が入ったフィールド名。 |
戻り値
await Array
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
zip_async
zip_async(a: Array, b: Array) -> await Array英語原文Dispatch array zipping to a CPU worker.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
a | Array | 省略不可 | 1つ目の入力、または比較する値。 |
b | Array | 省略不可 | 2つ目の入力、または比較する値。 |
戻り値
await Array
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
deep_merge_async
deep_merge_async(base: Dictionary, over: Dictionary) -> await Dictionary英語原文Dispatch nested dictionary merging to a CPU worker.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
base | Dictionary | 省略不可 | マージ・比較の基準となる値。 |
over | Dictionary | 省略不可 | 基準辞書の対応する項目を上書きする値。 |
戻り値
await Dictionary
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。