Zig/組込み関数

組込み関数

組込み関数( Builtin Functions )はコンパイラによって提供され、接頭辞に @ が付けられます。 パラメーターについての comptime キーワードは、そのパラメーターがコンパイル時に既知である必要があることを意味します。

組込み関数一覧

関数プロトタイプ	種別	説明
@addrSpaceCast(ptr: anytype) anytype	キャスト	ポインターを1つのアドレス空間から別のアドレス空間に変換します。新しいアドレス空間は結果の型に基づいて推論されます。現在のターゲットとアドレス空間に応じて、このキャストは無効、複雑な操作、または違法である場合があります。キャストが適法である場合、結果のポインターはポインターオペランドと同じメモリー位置を指します。同じアドレス空間間でのポインターのキャストは常に有効です。
@addWithOverflow(a: anytype, b: anytype) struct { @TypeOf(a, b), u1 }	数値演算	a + b を実行し、結果と可能なオーバーフロービットを持つタプルを返します。
@alignCast(ptr: anytype) anytype	アライメント	ptr は *T, ?*T, または []T のいずれかです。ポインターのアライメントを変更します。使用するアライメントは結果の型に基づいて推論されます。生成されたコードには、ポインターが約束されたようにアラインされていることを確認するためのポインターアライメント安全検査が追加されます。
@alignOf(comptime T: type) comptime_int	アライメント	この関数は、現在のターゲットがCのABIに適合するために、この型がアライメントされるべきバイト数を返します。ポインターの子供の型がこのアライメントを持っている場合、アライメントを省略することができます。
@as(comptime T: type, expression) T	キャスト	型強制を行います。このキャストは、変換が曖昧でなく安全である場合に許可され、可能な限り、型間の変換に好ましい方法とされています。
@atomicLoad(comptime T: type, ptr: *const T, comptime ordering: AtomicOrder) T	不可分操作	ポインターをアトミックにデリファレンスしてその値を返します。 T は、ポインター、bool、整数、浮動小数点数あるいは enum でなければなりません。
@atomicRmw(comptime T: type, ptr: *T, comptime op: AtomicRmwOp, operand: T, comptime ordering: AtomicOrder) T	不可分操作	メモリーをアトミックに変更した後、以前の値を返します。 T は、ポインター、bool、整数、浮動小数点数あるいは enum でなければなりません。
@atomicStore(comptime T: type, ptr: *T, value: T, comptime ordering: AtomicOrder) void	不可分操作	値をアトミックに保存します。 T は、ポインター、bool、整数、浮動小数点数あるいは enum でなければなりません。
@bitCast(value: anytype) anytype	キャスト	1つの型の値を別の型に変換します。戻り型は推論された結果型です。
@bitOffsetOf(comptime T: type, comptime field_name: []const u8) comptime_int	オフセット	フィールドのビットオフセットを、それを含む struct からの相対値で返します。
@bitSizeOf(comptime T: type) comptime_int	特性	型がパックされたstruct/unionのフィールドであった場合に、Tをメモリーに格納するために必要なビット数を返します。
@breakpoint()	デバッグ	プラットフォーム固有のデバッグトラップ命令を挿入し、デバッガがそこでブレークするようにします。
@mulAdd(comptime T: type, a: T, b: T, c: T) T	数値演算	積和演算（Fused multiply-add）を実行します。
@byteSwap(operand: anytype) T	キャスト	オペランドのバイト順序を逆転させます。
@bitReverse(integer: anytype) T	キャスト	整数値のビットパターンを逆転させます。
@offsetOf(comptime T: type, comptime field_name: []const u8) comptime_int	オフセット	フィールドのバイトオフセットを、それを含む struct からの相対値で返します。
@call(modifier: std.builtin.CallModifier, function: anytype, args: anytype) anytype	呼び出し	指定された関数を呼び出します。
@cDefine(comptime name: []const u8, value) void	マクロ定義	Cマクロを定義します。
@cImport(expression) type	C インタフェース	この関数は C コードを解析し、関数、型、変数、および互換性のあるマクロ定義を新しい空の構造体型にインポートし、その型を返します。expression はコンパイル時に解釈されます。この式内で、@cInclude、@cDefine、@cUndef の組み込み関数が動作し、一時バッファに追加され、それが C コードとして解析されます。通常、アプリケーション全体で 1 つの @cImport のみを持つべきです。これにより、コンパイラが複数回 clang を起動するのを防ぎ、インライン関数が重複しないようにします。複数の @cImport 式が必要な理由は次のとおりです： シンボルの衝突を回避するため（例：foo.h と bar.h がともに CONNECTION_COUNT を #define している場合） 異なるプリプロセッサの定義で C コードを解析するため
@cInclude(comptime path: []const u8) void	C インタフェース	この関数は @cImport 内でのみ発生します。これは c_import 一時バッファに #include <$path>\n を追加します。
@clz(operand: anytype) anytype	キャスト	整数の最上位ビット（ビッグエンディアンでの先頭ビット）からのゼロの数を数えます。
@cmpxchgStrong(comptime T: type, ptr: *T, expected_value: T, new_value: T, success_order: AtomicOrder, fail_order: AtomicOrder) ?T	不可分操作	強力な原子比較交換操作を実行し、現在の値が指定された期待値でない場合はnullを返します。
@cmpxchgWeak(comptime T: type, ptr: *T, expected_value: T, new_value: T, success_order: AtomicOrder, fail_order: AtomicOrder) ?T	不可分操作	弱い原子比較交換操作を実行し、現在の値が指定された期待値でない場合はnullを返します。
@compileError(comptime msg: []const u8) noreturn	コンパイル時エラー	意味解析されると、メッセージmsgを持つコンパイルエラーが発生します。
@compileLog(args: ...) void	コンパイルログ	引数をコンパイル時に出力します。
@constCast(value: anytype) DestType	キャスト	ポインターからconst修飾子を削除します。
@ctz(operand: anytype) anytype	キャスト	整数の最下位ビット（ビッグエンディアンでの末尾ビット）からのゼロの数を数えます。
@cUndef(comptime name: []const u8) void	マクロ定義解除	Cマクロを無効にします。
@cVaArg(operand: *std.builtin.VaList, comptime T: type) T	可変引数	Cマクロva_argを実装します。
@cVaCopy(src: *std.builtin.VaList) std.builtin.VaList	可変引数	Cマクロva_copyを実装します。
@cVaEnd(src: *std.builtin.VaList) void	可変引数	Cマクロva_endを実装します。
@cVaStart() std.builtin.VaList	可変引数	Cマクロva_startを実装します。
@divExact(numerator: T, denominator: T) T	数値演算	完全な除算。デノミネーター != 0 であり、@divTrunc(numerator, denominator) * denominator == numerator を保証する必要があります。
@divFloor(numerator: T, denominator: T) T	数値演算	床付きの除算。負の無限大に向かって丸めます。符号なし整数の場合、分子 / 分母と同じです。
@divTrunc(numerator: T, denominator: T) T	数値演算	切り捨て除算。ゼロに向かって丸めます。符号なし整数の場合、分子 / 分母と同じです。
@embedFile(comptime path: []const u8) *const [N:0]u8	ファイル操作	ファイルの内容を持つ、ヌル終端の固定サイズ配列へのコンパイル時定数ポインターを返します。
@enumFromInt(integer: anytype) anytype	キャスト	整数を列挙値に変換します。
@errorFromInt(value: std.meta.Int(.unsigned, @bitSizeOf(anyerror))) anyerror	キャスト	エラーの整数表現からグローバルエラーセット型に変換します。
@errorName(err: anyerror) [:0]const u8	文字列操作	エラーの文字列表現を返します。
@errorReturnTrace() ?*builtin.StackTrace	エラー処理	エラーの返り値が追跡されている場合、スタックトレースオブジェクトを返します。それ以外の場合はnullを返します。
@errorCast(value: anytype) anytype	キャスト	エラーセットまたはエラーユニオンの値を別のエラーセットに変換します。
@export(declaration, comptime options: std.builtin.ExportOptions) void	シンボル出力	出力オブジェクトファイルにシンボルを作成します。
@extern(T: type, comptime options: std.builtin.ExternOptions) T	外部シンボル参照	出力オブジェクトファイルに外部シンボルへの参照を作成します。
@fence(order: AtomicOrder) void	同期操作	発生前後のエッジを導入するために使用されます。
@field(lhs: anytype, comptime field_name: []const u8) (field)	フィールドアクセス	コンパイル時文字列でフィールドアクセスを実行します。
@fieldParentPtr(comptime ParentType: type, comptime field_name: []const u8, field_ptr: *T) *ParentType	ポインター操作	フィールドへのポインターから、構造体のベースポインターを返します。
@floatCast(value: anytype) anytype	キャスト	1つの浮動小数点数型から別の浮動小数点数型に変換します。
@floatFromInt(int: anytype) anytype	キャスト	整数を最も近い浮動小数点数表現に変換します。
@frameAddress() usize	デバッグ	現在のスタックフレームのベースポインターを返します。
@hasDecl(comptime Container: type, comptime name: []const u8) bool	メタ情報	コンテナに指定された名前の宣言があるかどうかを返します。
@hasField(comptime Container: type, comptime name: []const u8) bool	メタ情報	構造体、共用体、または列挙型の指定されたフィールド名が存在するかどうかを返します。
@import(comptime path: []const u8) type XXX	ビルド管理	path に対応する Zig ファイルを見つけ、まだ追加されていない場合にビルドに追加します。
@inComptime() bool	メタ情報	このビルトインがコンパイル時に実行されたかどうかを返します。
@intCast(int: anytype) anytype	キャスト	数値を同じ数値としてのみ変換します。
@intFromBool(value: bool) u1	キャスト	true を @as(u1, 1)、false を @as(u1, 0) に変換します。
@intFromEnum(enum_or_tagged_union: anytype) anytype	キャスト	列挙値を整数のタグ型に変換します。
@intFromError(err: anytype) std.meta.Int(.unsigned, @bitSizeOf(anyerror))	キャスト	エラーをエラーの整数表現に変換します。
@intFromFloat(float: anytype) anytype	キャスト	浮動小数点数の整数部分を変換します。
@intFromPtr(value: anytype) usize	キャスト	ポインターを usize に変換します。
@max(a: T, b: T) T	数値演算	a と b の最大値を返します。
@memcpy(noalias dest, noalias source) void	メモリ操作	メモリの領域を別の領域にコピーします。
@memset(dest, elem) void	メモリ操作	メモリ領域の全要素を elem に設定します。
@min(a: T, b: T) T	数値演算	a と b の最小値を返します。
@wasmMemorySize(index: u32) u32	メモリ操作	指定されたインデックスの Wasm メモリのサイズを Wasm ページ単位で返します。
@wasmMemoryGrow(index: u32, delta: u32) i32	メモリ操作	指定されたインデックスの Wasm メモリのサイズを増やします。
@mod(numerator: T, denominator: T) T	数値演算	剰余を返します。
@mulWithOverflow(a: anytype, b: anytype) struct { @TypeOf(a, b), u1 }	数値演算	オーバーフロー可能な掛け算を行い、結果と可能なオーバーフローのビットを返します。
@panic(message: []const u8) noreturn	デバッグ	パニックハンドラー関数を呼び出します。
@popCount(operand: anytype) anytype	ビット操作	整数の中でセットされたビットの数を数えます。
@prefetch(ptr: anytype, comptime options: PrefetchOptions) void	メモリアクセス	プリフェッチ命令を発行します。
@ptrCast(value: anytype) anytype	キャスト	1つの型のポインターを別の型のポインターに変換します。
@ptrFromInt(address: usize) anytype	キャスト	整数をポインターに変換します。
@rem(numerator: T, denominator: T) T	数値演算	剰余の計算を行います。符号なし整数の場合、これは numerator % denominator と同じです。呼び出し側は denominator > 0 を保証する必要があります。それ以外の場合、ランタイムセーフティチェックが有効になっている場合、操作は除算ゼロによる剰余が発生します。
@returnAddress() usize	デバッグ	この関数は、現在の関数がリターンしたときに実行される次のマシンコード命令のアドレスを返します。
@select(comptime T: type, pred: @Vector(len, bool), a: @Vector(len, T), b: @Vector(len, T)) @Vector(len, T)	条件付き選択	pred に基づいて a または b から要素を選択します。pred[i] が true の場合、結果の対応する要素は a[i] になり、そうでなければ b[i] になります。
@setAlignStack(comptime alignment: u29) void	スタックアライメント	関数のスタックアライメントが少なくとも指定されたバイト数になるように保証します。
@setCold(comptime is_cold: bool) void	最適化	現在の関数が（またはされない）まれに呼び出されることを最適化プログラムに伝えます。この関数は関数スコープ内でのみ有効です。
@setEvalBranchQuota(comptime new_quota: u32) void	コンパイル時コード	コンパイル時のコード実行が使用するバックワードブランチの最大数を増やします。新しいクォータがデフォルトのクォータ（1000）より小さい場合や、以前に明示的に設定されたクォータよりも小さい場合は、無視されます。
@setFloatMode(comptime mode: FloatMode) void	浮動小数点モード	浮動小数点演算の定義方法に関する現在のスコープのルールを変更します。
@setRuntimeSafety(comptime safety_on: bool) void	ランタイムセーフティ	関数呼び出しを含むスコープでランタイムセーフティチェックが有効かどうかを設定します。
@shlExact(value: T, shift_amt: Log2T) T	数値演算	左シフト演算（<<）を実行します。符号なし整数の場合、シフトアウトされる任意の1ビットがあると結果は未定義です。符号付き整数の場合、結果は、結果の符号ビットと一致しないビットがシフトアウトされた場合には未定義です。
@shlWithOverflow(a: anytype, shift_amt: Log2T) struct { @TypeOf(a), u1 }	数値演算	a << b を実行し、結果とオーバーフロービットの可能性があるタプルを返します。
@shrExact(value: T, shift_amt: Log2T) T	数値演算	右シフト演算（>>）を実行します。呼び出し側は、シフトが任意の1ビットをアウトさせないことを保証します。
@shuffle(comptime E: type, a: @Vector(a_len, E), b: @Vector(b_len, E), comptime mask: @Vector(mask_len, i32)) @Vector(mask_len, E)	ベクトル操作	マスクに基づいて a と b から要素を選択して新しいベクトルを構築します。
@sizeOf(comptime T: type) comptime_int	メモリ操作	メモリ内で T を格納するために必要なバイト数を返します。
@splat(scalar: anytype) anytype	ベクトル操作	各要素がスカラー値であるベクトルを生成します。
@reduce(comptime op: std.builtin.ReduceOp, value: anytype) E	ベクトル操作	指定された演算子 op を使用して、要素の水平リダクションを実行してスカラー値（型E）に変換します。
@src() std.builtin.SourceLocation	デバッグ	関数の名前とソースコード内の場所を表す SourceLocation 構造体を返します。
@sqrt(value: anytype) @TypeOf(value)	数値演算	浮動小数点数の平方根を計算します。利用可能な場合は専用のハードウェア命令を使用します。
@sin(value: anytype) @TypeOf(value)	数値演算	弧度法での正弦三角関数を計算します。利用可能な場合は専用のハードウェア命令を使用します。
@cos(value: anytype) @TypeOf(value)	数値演算	弧度法での余弦三角関数を計算します。利用可能な場合は専用のハードウェア命令を使用します。
@tan(value: anytype) @TypeOf(value)	数値演算	弧度法での正接三角関数を計算します。利用可能な場合は専用のハードウェア命令を使用します。
@exp(value: anytype) @TypeOf(value)	数値演算	自然対数の底eの指数関数を計算します。利用可能な場合は専用のハードウェア命令を使用します。
@exp2(value: anytype) @TypeOf(value)	数値演算	底が2の指数関数を計算します。利用可能な場合は専用のハードウェア命令を使用します。
@log(value: anytype) @TypeOf(value)	数値演算	浮動小数点数の自然対数を計算します。利用可能な場合は専用のハードウェア命令を使用します。
@log2(value: anytype) @TypeOf(value)	数値演算	底が2の対数を計算します。利用可能な場合は専用のハードウェア命令を使用します。
@log10(value: anytype) @TypeOf(value)	数値演算	底が10の対数を計算します。利用可能な場合は専用のハードウェア命令を使用します。
@abs(value: anytype) anytype	数値演算	整数または浮動小数点数の絶対値を返します。利用可能な場合は専用のハードウェア命令を使用します。
@floor(value: anytype) @TypeOf(value)	数値演算	指定された浮動小数点数より大きくない最大の整数値を返します。利用可能な場合は専用のハードウェア命令を使用します。
@ceil(value: anytype) @TypeOf(value)	数値演算	指定された浮動小数点数より小さくない最小の整数値を返します。利用可能な場合は専用のハードウェア命令を使用します。
@trunc(value: anytype) @TypeOf(value)	数値演算	指定された浮動小数点数を整数に丸め、ゼロに向かって丸めます。利用可能な場合は専用のハードウェア命令を使用します。
@round(value: anytype) @TypeOf(value)	数値演算	指定された浮動小数点数を整数に丸め、ゼロから遠ざけます。利用可能な場合は専用のハードウェア命令を使用します。
@subWithOverflow(a: anytype, b: anytype) struct { @TypeOf(a, b), u1 }	数値演算	a - b を実行し、結果と可能なオーバーフロービットを持つタプルを返します。
@tagName(value: anytype) [:0]const u8	データ変換	列挙値またはユニオン値を、名前を表す文字列リテラルに変換します。
@This() type	メタプログラミング	現在の関数呼び出しの内部の最も深い構造体、列挙体、または共用体を返します。
@trap() noreturn	デバッグ	プログラムを異常終了させるためにプラットフォーム固有のトラップ/ジャム命令を挿入します。
@truncate(integer: anytype) anytype	数値演算	整数型からビットを切り捨て、より小さいまたは同じサイズの整数型を生成します。利用可能な場合は専用のハードウェア命令を使用します。
@Type(comptime info: std.builtin.Type) type	メタプログラミング	型情報を型に再構成します。
@typeInfo(comptime T: type) std.builtin.Type	メタプログラミング	型のリフレクション情報を提供します。
@typeName(T: type) *const [N:0]u8	メタプログラミング	型の文字列表現を返します。
@TypeOf(...) type	メタプログラミング	式の型を返します。
@unionInit(comptime Union: type, comptime active_field_name: []const u8, init_expr) Union	メタプログラミング	ユニオンの初期化構文と同じですが、フィールド名は識別子トークンではなく、コンパイル時に既知の値です。
@Vector(len: comptime_int, Element: type) type	データ構造	ベクトルを作成します。
@volatileCast(value: anytype) DestType	データ変換	ポインタからvolatile修飾子を削除します。
@workGroupId(comptime dimension: u32) u32	プラットフォーム依存	指定された次元のカレントカーネル呼び出し内のワークグループのインデックスを返します。
@workGroupSize(comptime dimension: u32) u32	プラットフォーム依存	指定された次元のワークグループが持つワークアイテムの数を返します。
@workItemId(comptime dimension: u32) u32	プラットフォーム依存	指定された次元のワークグループ内のワークアイテムのインデックスを返します。この関数は0（含む）から @workGroupSize(dimension)（排他的）までの値を返します。