Version: Nightly

get_defined_int

get_defined_int[name: StringSlice[StaticConstantOrigin]]() -> Int

Try to get an integer-valued define. Compilation fails if the name is not defined.

Parameters:

name (StringSlice): The name of the define.

Returns:

Int: An integer parameter value.

get_defined_int[name: StringSlice[StaticConstantOrigin], default: Int]() -> Int

Try to get an integer-valued define. If the name is not defined, return a default value instead.

Example:

from std.sys.defines import get_defined_int

def main() raises:
    comptime number = get_defined_int[
        "favorite_number",
        1 # Default value
    ]()
    parametrized[number]()

def parametrized[num: Int]():
    print(num)

If the program is app.mojo:

mojo run -D favorite_number=2 app.mojo
mojo run -D app.mojo

Note: useful for parameterizing SIMD vector sizes.

Parameters:

name (StringSlice): The name of the define.
default (Int): The default value to use.

Returns:

Int: An integer parameter value.